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	aws.sagemaker.feature_groups

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FeatureGroupName, RecordIdentifierFeatureName, EventTimeFeatureName, FeatureDefinitions, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resource	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

List all feature_groups in a region.

SELECT
region,
feature_group_name
FROM aws.sagemaker.feature_groups
WHERE region = 'us-east-1';

Gets all properties from a 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 aws.sagemaker.feature_groups
WHERE region = 'us-east-1' AND data__Identifier = '<FeatureGroupName>';

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 aws.sagemaker.feature_groups (
 FeatureGroupName,
 RecordIdentifierFeatureName,
 EventTimeFeatureName,
 FeatureDefinitions,
 region
)
SELECT 
'{{ FeatureGroupName }}',
 '{{ RecordIdentifierFeatureName }}',
 '{{ EventTimeFeatureName }}',
 '{{ FeatureDefinitions }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.feature_groups (
 FeatureGroupName,
 RecordIdentifierFeatureName,
 EventTimeFeatureName,
 FeatureDefinitions,
 OnlineStoreConfig,
 OfflineStoreConfig,
 ThroughputConfig,
 RoleArn,
 Description,
 Tags,
 region
)
SELECT 
 '{{ FeatureGroupName }}',
 '{{ RecordIdentifierFeatureName }}',
 '{{ EventTimeFeatureName }}',
 '{{ FeatureDefinitions }}',
 '{{ OnlineStoreConfig }}',
 '{{ OfflineStoreConfig }}',
 '{{ ThroughputConfig }}',
 '{{ RoleArn }}',
 '{{ Description }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: feature_group
    props:
      - name: FeatureGroupName
        value: '{{ FeatureGroupName }}'
      - name: RecordIdentifierFeatureName
        value: '{{ RecordIdentifierFeatureName }}'
      - name: EventTimeFeatureName
        value: '{{ EventTimeFeatureName }}'
      - name: FeatureDefinitions
        value:
          - FeatureName: '{{ FeatureName }}'
            FeatureType: '{{ FeatureType }}'
      - name: OnlineStoreConfig
        value:
          SecurityConfig:
            KmsKeyId: '{{ KmsKeyId }}'
          EnableOnlineStore: '{{ EnableOnlineStore }}'
          StorageType: '{{ StorageType }}'
          TtlDuration:
            Unit: '{{ Unit }}'
            Value: '{{ Value }}'
      - name: OfflineStoreConfig
        value:
          S3StorageConfig:
            S3Uri: '{{ S3Uri }}'
            KmsKeyId: null
          DisableGlueTableCreation: '{{ DisableGlueTableCreation }}'
          DataCatalogConfig:
            TableName: '{{ TableName }}'
            Catalog: '{{ Catalog }}'
            Database: '{{ Database }}'
          TableFormat: '{{ TableFormat }}'
      - name: ThroughputConfig
        value:
          ThroughputMode: '{{ ThroughputMode }}'
          ProvisionedReadCapacityUnits: '{{ ProvisionedReadCapacityUnits }}'
          ProvisionedWriteCapacityUnits: '{{ ProvisionedWriteCapacityUnits }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.feature_groups
WHERE data__Identifier = '<FeatureGroupName>'
AND region = 'us-east-1';

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