feature_groups

Creates, updates, deletes or gets a feature_group resource or lists feature_groups in a region

Overview

Name	feature_groups
Type	Resource
Description	Resource Type definition for AWS::SageMaker::FeatureGroup
Id	awscc.sagemaker.feature_groups

Fields

get (all properties)

Name	Datatype	Description
feature_group_name	string	The Name of the FeatureGroup.
record_identifier_feature_name	string	The Record Identifier Feature Name.
event_time_feature_name	string	The Event Time Feature Name.
▶feature_definitions	array	An Array of Feature Definition
▶online_store_config	object
▶offline_store_config	object
▶throughput_config	object
role_arn	string	Role Arn
description	string	Description about the FeatureGroup.
creation_time	string	A timestamp of FeatureGroup creation time.
feature_group_status	string	The status of the feature group.
▶tags	array	An array of key-value pair to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
feature_group_name	string	The Name of the FeatureGroup.
region	string	AWS region.

For more information, see AWS::SageMaker::FeatureGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	feature_groups	INSERT	FeatureGroupName, RecordIdentifierFeatureName, EventTimeFeatureName, FeatureDefinitions, region
delete_resource	feature_groups	DELETE	Identifier, region
update_resource	feature_groups	UPDATE	Identifier, PatchDocument, region
list_resources	feature_groups_list_only	SELECT	region
get_resource	feature_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual feature_group.

SELECT
  region,
  feature_group_name,
  record_identifier_feature_name,
  event_time_feature_name,
  feature_definitions,
  online_store_config,
  offline_store_config,
  throughput_config,
  role_arn,
  description,
  creation_time,
  feature_group_status,
  tags
FROM awscc.sagemaker.feature_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ feature_group_name }}';

list (identifiers only)

Lists all feature_groups in a region.

SELECT
  region,
  feature_group_name
FROM awscc.sagemaker.feature_groups_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new feature_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.sagemaker.feature_groups (
  FeatureGroupName,
  RecordIdentifierFeatureName,
  EventTimeFeatureName,
  FeatureDefinitions,
  region
)
SELECT
  '{{ feature_group_name }}',
  '{{ record_identifier_feature_name }}',
  '{{ event_time_feature_name }}',
  '{{ feature_definitions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.feature_groups (
  FeatureGroupName,
  RecordIdentifierFeatureName,
  EventTimeFeatureName,
  FeatureDefinitions,
  OnlineStoreConfig,
  OfflineStoreConfig,
  ThroughputConfig,
  RoleArn,
  Description,
  Tags,
  region
)
SELECT
  '{{ feature_group_name }}',
  '{{ record_identifier_feature_name }}',
  '{{ event_time_feature_name }}',
  '{{ feature_definitions }}',
  '{{ online_store_config }}',
  '{{ offline_store_config }}',
  '{{ throughput_config }}',
  '{{ role_arn }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: feature_group
  props:
    - name: feature_group_name
      value: '{{ feature_group_name }}'
    - name: record_identifier_feature_name
      value: '{{ record_identifier_feature_name }}'
    - name: event_time_feature_name
      value: '{{ event_time_feature_name }}'
    - name: feature_definitions
      value:
        - feature_name: '{{ feature_name }}'
          feature_type: '{{ feature_type }}'
    - name: online_store_config
      value:
        security_config:
          kms_key_id: '{{ kms_key_id }}'
        enable_online_store: '{{ enable_online_store }}'
        storage_type: '{{ storage_type }}'
        ttl_duration:
          unit: '{{ unit }}'
          value: '{{ value }}'
    - name: offline_store_config
      value:
        s3_storage_config:
          s3_uri: '{{ s3_uri }}'
          kms_key_id: null
        disable_glue_table_creation: '{{ disable_glue_table_creation }}'
        data_catalog_config:
          table_name: '{{ table_name }}'
          catalog: '{{ catalog }}'
          database: '{{ database }}'
        table_format: '{{ table_format }}'
    - name: throughput_config
      value:
        throughput_mode: '{{ throughput_mode }}'
        provisioned_read_capacity_units: '{{ provisioned_read_capacity_units }}'
        provisioned_write_capacity_units: '{{ provisioned_write_capacity_units }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: description
      value: '{{ description }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

Use the following StackQL query and manifest file to update a feature_group resource, using stack-deploy.

/*+ update */
UPDATE awscc.sagemaker.feature_groups
SET PatchDocument = string('{{ {
    "FeatureDefinitions": feature_definitions,
    "ThroughputConfig": throughput_config
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ feature_group_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.feature_groups
WHERE
  Identifier = '{{ feature_group_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the feature_groups resource, the following permissions are required:

Create

iam:PassRole,
kms:CreateGrant,
kms:DescribeKey,
glue:CreateTable,
glue:GetTable,
glue:CreateDatabase,
glue:GetDatabase,
sagemaker:CreateFeatureGroup,
sagemaker:DescribeFeatureGroup,
sagemaker:AddTags,
sagemaker:ListTags

Update

sagemaker:UpdateFeatureGroup,
sagemaker:DescribeFeatureGroup,
sagemaker:AddTags,
sagemaker:ListTags,
sagemaker:DeleteTags

Read

sagemaker:DescribeFeatureGroup,
sagemaker:ListTags

Delete

sagemaker:DeleteFeatureGroup,
sagemaker:DescribeFeatureGroup

List

sagemaker:ListFeatureGroups