Amazon SageMaker Service

2023/09/28 - Amazon SageMaker Service - 4 updated api methods

Changes  Online store feature groups supports Standard and InMemory tier storage types for low latency storage for real-time data retrieval. The InMemory tier supports collection types List, Set, and Vector.

CreateFeatureGroup (updated) Link ¶
Changes (request) 
{'FeatureDefinitions': {'CollectionConfig': {'VectorConfig': {'Dimension': 'integer'}},
                        'CollectionType': 'List | Set | Vector'},
 'OnlineStoreConfig': {'StorageType': 'Standard | InMemory'}}

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the ``FeatureGroup``s quota for your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.create_feature_group(
    FeatureGroupName='string',
    RecordIdentifierFeatureName='string',
    EventTimeFeatureName='string',
    FeatureDefinitions=[
        {
            'FeatureName': 'string',
            'FeatureType': 'Integral'|'Fractional'|'String',
            'CollectionType': 'List'|'Set'|'Vector',
            'CollectionConfig': {
                'VectorConfig': {
                    'Dimension': 123
                }
            }
        },
    ],
    OnlineStoreConfig={
        'SecurityConfig': {
            'KmsKeyId': 'string'
        },
        'EnableOnlineStore': True|False,
        'TtlDuration': {
            'Unit': 'Seconds'|'Minutes'|'Hours'|'Days'|'Weeks',
            'Value': 123
        },
        'StorageType': 'Standard'|'InMemory'
    },
    OfflineStoreConfig={
        'S3StorageConfig': {
            'S3Uri': 'string',
            'KmsKeyId': 'string',
            'ResolvedOutputS3Uri': 'string'
        },
        'DisableGlueTableCreation': True|False,
        'DataCatalogConfig': {
            'TableName': 'string',
            'Catalog': 'string',
            'Database': 'string'
        },
        'TableFormat': 'Glue'|'Iceberg'
    },
    RoleArn='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type FeatureGroupName:

string

param FeatureGroupName:

[REQUIRED]

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:

  • Must start and end with an alphanumeric character.

  • Can only contain alphanumeric character and hyphens. Spaces are not allowed.

type RecordIdentifierFeatureName:

string

param RecordIdentifierFeatureName:

[REQUIRED]

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

  • Must start and end with an alphanumeric character.

  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

type EventTimeFeatureName:

string

param EventTimeFeatureName:

[REQUIRED]

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

An EventTime can be a String or Fractional.

  • Fractional: EventTime feature values must be a Unix timestamp in seconds.

  • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

type FeatureDefinitions:

list

param FeatureDefinitions:

[REQUIRED]

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureType``s are ``Integral, Fractional and String.

FeatureName``s cannot be any of the following: ``is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinition``s per ``FeatureGroup.

  • (dict) --

    A list of features. You must include FeatureName and FeatureType. Valid feature FeatureType``s are ``Integral, Fractional and String.

    • FeatureName (string) --

      The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

    • FeatureType (string) --

      The value type of a feature. Valid values are Integral, Fractional, or String.

    • CollectionType (string) --

      A grouping of elements where each element within the collection must have the same feature type ( String, Integral, or Fractional).

      • List: An ordered collection of elements.

      • Set: An unordered collection of unique elements.

      • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

    • CollectionConfig (dict) --

      Configuration for your collection.

      • VectorConfig (dict) --

        Configuration for your vector collection type.

        • Dimension: The number of elements in your vector.

        • Dimension (integer) -- [REQUIRED]

          The number of elements in your vector.

type OnlineStoreConfig:

dict

param OnlineStoreConfig:

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig.

You can also include an Amazon Web Services KMS key ID ( KMSKeyId) for at-rest encryption of the OnlineStore.

The default value is False.

  • SecurityConfig (dict) --

    Use to specify KMS Key ID ( KMSKeyId) for at-rest encryption of your OnlineStore.

    • KmsKeyId (string) --

      The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

      The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

      • "kms:Encrypt"

      • "kms:Decrypt"

      • "kms:DescribeKey"

      • "kms:CreateGrant"

      • "kms:RetireGrant"

      • "kms:ReEncryptFrom"

      • "kms:ReEncryptTo"

      • "kms:GenerateDataKey"

      • "kms:ListAliases"

      • "kms:ListGrants"

      • "kms:RevokeGrant"

      The caller (either user or IAM role) to all DataPlane operations ( PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

      • "kms:Decrypt"

  • EnableOnlineStore (boolean) --

    Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

    The default value is False.

  • TtlDuration (dict) --

    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

    • Unit (string) --

      TtlDuration time unit.

    • Value (integer) --

      TtlDuration time value.

  • StorageType (string) --

    Option for different tiers of low latency storage for real-time data retrieval.

    • Standard: A managed low latency data store for feature groups.

    • InMemory: A managed data store for feature groups that supports very low latency retrieval.

type OfflineStoreConfig:

dict

param OfflineStoreConfig:

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

  • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.

  • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

  • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

  • S3StorageConfig (dict) -- [REQUIRED]

    The Amazon Simple Storage (Amazon S3) location of OfflineStore.

    • S3Uri (string) -- [REQUIRED]

      The S3 URI, or location in Amazon S3, of OfflineStore.

      S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

    • KmsKeyId (string) --

      The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

      The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

      • "kms:GenerateDataKey"

    • ResolvedOutputS3Uri (string) --

      The S3 path where offline records are written.

  • DisableGlueTableCreation (boolean) --

    Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena's naming recommendations.

    The default value is False.

  • DataCatalogConfig (dict) --

    The meta data of the Glue table that is autogenerated when an OfflineStore is created.

    • TableName (string) -- [REQUIRED]

      The name of the Glue table.

    • Catalog (string) -- [REQUIRED]

      The name of the Glue table catalog.

    • Database (string) -- [REQUIRED]

      The name of the Glue table database.

  • TableFormat (string) --

    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

type RoleArn:

string

param RoleArn:

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

type Description:

string

param Description:

A free-form description of a FeatureGroup.

type Tags:

list

param Tags:

Tags used to identify Features in each FeatureGroup.

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

    • Key (string) -- [REQUIRED]

      The tag key. Tag keys must be unique per resource.

    • Value (string) -- [REQUIRED]

      The tag value.

rtype:

dict

returns:

Response Syntax

{
    'FeatureGroupArn': 'string'
}

Response Structure

  • (dict) --

    • FeatureGroupArn (string) --

      The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.

DescribeFeatureGroup (updated) Link ¶
Changes (response) 
{'FeatureDefinitions': {'CollectionConfig': {'VectorConfig': {'Dimension': 'integer'}},
                        'CollectionType': 'List | Set | Vector'},
 'OnlineStoreConfig': {'StorageType': 'Standard | InMemory'}}

Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

See also: AWS API Documentation

Request Syntax

client.describe_feature_group(
    FeatureGroupName='string',
    NextToken='string'
)
type FeatureGroupName:

string

param FeatureGroupName:

[REQUIRED]

The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.

type NextToken:

string

param NextToken:

A token to resume pagination of the list of Features ( FeatureDefinitions). 2,500 Features are returned by default.

rtype:

dict

returns:

Response Syntax

{
    'FeatureGroupArn': 'string',
    'FeatureGroupName': 'string',
    'RecordIdentifierFeatureName': 'string',
    'EventTimeFeatureName': 'string',
    'FeatureDefinitions': [
        {
            'FeatureName': 'string',
            'FeatureType': 'Integral'|'Fractional'|'String',
            'CollectionType': 'List'|'Set'|'Vector',
            'CollectionConfig': {
                'VectorConfig': {
                    'Dimension': 123
                }
            }
        },
    ],
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'OnlineStoreConfig': {
        'SecurityConfig': {
            'KmsKeyId': 'string'
        },
        'EnableOnlineStore': True|False,
        'TtlDuration': {
            'Unit': 'Seconds'|'Minutes'|'Hours'|'Days'|'Weeks',
            'Value': 123
        },
        'StorageType': 'Standard'|'InMemory'
    },
    'OfflineStoreConfig': {
        'S3StorageConfig': {
            'S3Uri': 'string',
            'KmsKeyId': 'string',
            'ResolvedOutputS3Uri': 'string'
        },
        'DisableGlueTableCreation': True|False,
        'DataCatalogConfig': {
            'TableName': 'string',
            'Catalog': 'string',
            'Database': 'string'
        },
        'TableFormat': 'Glue'|'Iceberg'
    },
    'RoleArn': 'string',
    'FeatureGroupStatus': 'Creating'|'Created'|'CreateFailed'|'Deleting'|'DeleteFailed',
    'OfflineStoreStatus': {
        'Status': 'Active'|'Blocked'|'Disabled',
        'BlockedReason': 'string'
    },
    'LastUpdateStatus': {
        'Status': 'Successful'|'Failed'|'InProgress',
        'FailureReason': 'string'
    },
    'FailureReason': 'string',
    'Description': 'string',
    'NextToken': 'string',
    'OnlineStoreTotalSizeBytes': 123
}

Response Structure

  • (dict) --

    • FeatureGroupArn (string) --

      The Amazon Resource Name (ARN) of the FeatureGroup.

    • FeatureGroupName (string) --

      he name of the FeatureGroup.

    • RecordIdentifierFeatureName (string) --

      The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

    • EventTimeFeatureName (string) --

      The name of the feature that stores the EventTime of a Record in a FeatureGroup.

      An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.

    • FeatureDefinitions (list) --

      A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

      • (dict) --

        A list of features. You must include FeatureName and FeatureType. Valid feature FeatureType``s are ``Integral, Fractional and String.

        • FeatureName (string) --

          The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

        • FeatureType (string) --

          The value type of a feature. Valid values are Integral, Fractional, or String.

        • CollectionType (string) --

          A grouping of elements where each element within the collection must have the same feature type ( String, Integral, or Fractional).

          • List: An ordered collection of elements.

          • Set: An unordered collection of unique elements.

          • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

        • CollectionConfig (dict) --

          Configuration for your collection.

          • VectorConfig (dict) --

            Configuration for your vector collection type.

            • Dimension: The number of elements in your vector.

            • Dimension (integer) --

              The number of elements in your vector.

    • CreationTime (datetime) --

      A timestamp indicating when SageMaker created the FeatureGroup.

    • LastModifiedTime (datetime) --

      A timestamp indicating when the feature group was last updated.

    • OnlineStoreConfig (dict) --

      The configuration for the OnlineStore.

      • SecurityConfig (dict) --

        Use to specify KMS Key ID ( KMSKeyId) for at-rest encryption of your OnlineStore.

        • KmsKeyId (string) --

          The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

          The caller (either user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

          • "kms:Encrypt"

          • "kms:Decrypt"

          • "kms:DescribeKey"

          • "kms:CreateGrant"

          • "kms:RetireGrant"

          • "kms:ReEncryptFrom"

          • "kms:ReEncryptTo"

          • "kms:GenerateDataKey"

          • "kms:ListAliases"

          • "kms:ListGrants"

          • "kms:RevokeGrant"

          The caller (either user or IAM role) to all DataPlane operations ( PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

          • "kms:Decrypt"

      • EnableOnlineStore (boolean) --

        Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

        The default value is False.

      • TtlDuration (dict) --

        Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

        • Unit (string) --

          TtlDuration time unit.

        • Value (integer) --

          TtlDuration time value.

      • StorageType (string) --

        Option for different tiers of low latency storage for real-time data retrieval.

        • Standard: A managed low latency data store for feature groups.

        • InMemory: A managed data store for feature groups that supports very low latency retrieval.

    • OfflineStoreConfig (dict) --

      The configuration of the offline store. It includes the following configurations:

      • Amazon S3 location of the offline store.

      • Configuration of the Glue data catalog.

      • Table format of the offline store.

      • Option to disable the automatic creation of a Glue table for the offline store.

      • Encryption configuration.

      • S3StorageConfig (dict) --

        The Amazon Simple Storage (Amazon S3) location of OfflineStore.

        • S3Uri (string) --

          The S3 URI, or location in Amazon S3, of OfflineStore.

          S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

        • KmsKeyId (string) --

          The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the OfflineStore S3 location.

          The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

          • "kms:GenerateDataKey"

        • ResolvedOutputS3Uri (string) --

          The S3 path where offline records are written.

      • DisableGlueTableCreation (boolean) --

        Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena's naming recommendations.

        The default value is False.

      • DataCatalogConfig (dict) --

        The meta data of the Glue table that is autogenerated when an OfflineStore is created.

        • TableName (string) --

          The name of the Glue table.

        • Catalog (string) --

          The name of the Glue table catalog.

        • Database (string) --

          The name of the Glue table database.

      • TableFormat (string) --

        Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

    • FeatureGroupStatus (string) --

      The status of the feature group.

    • OfflineStoreStatus (dict) --

      The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

      • Status (string) --

        An OfflineStore status.

      • BlockedReason (string) --

        The justification for why the OfflineStoreStatus is Blocked (if applicable).

    • LastUpdateStatus (dict) --

      A value indicating whether the update made to the feature group was successful.

      • Status (string) --

        A value that indicates whether the update was made successful.

      • FailureReason (string) --

        If the update wasn't successful, indicates the reason why it failed.

    • FailureReason (string) --

      The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:

      • The FeatureGroup could not be created in the OfflineStore.

      • The FeatureGroup could not be deleted from the OfflineStore.

    • Description (string) --

      A free form description of the feature group.

    • NextToken (string) --

      A token to resume pagination of the list of Features ( FeatureDefinitions).

    • OnlineStoreTotalSizeBytes (integer) --

      The size of the OnlineStore in bytes.

UpdateFeatureGroup (updated) Link ¶
Changes (request) 
{'FeatureAdditions': {'CollectionConfig': {'VectorConfig': {'Dimension': 'integer'}},
                      'CollectionType': 'List | Set | Vector'}}

Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.

You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration.

See also: AWS API Documentation

Request Syntax

client.update_feature_group(
    FeatureGroupName='string',
    FeatureAdditions=[
        {
            'FeatureName': 'string',
            'FeatureType': 'Integral'|'Fractional'|'String',
            'CollectionType': 'List'|'Set'|'Vector',
            'CollectionConfig': {
                'VectorConfig': {
                    'Dimension': 123
                }
            }
        },
    ],
    OnlineStoreConfig={
        'TtlDuration': {
            'Unit': 'Seconds'|'Minutes'|'Hours'|'Days'|'Weeks',
            'Value': 123
        }
    }
)
type FeatureGroupName:

string

param FeatureGroupName:

[REQUIRED]

The name or Amazon Resource Name (ARN) of the feature group that you're updating.

type FeatureAdditions:

list

param FeatureAdditions:

Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group.

  • (dict) --

    A list of features. You must include FeatureName and FeatureType. Valid feature FeatureType``s are ``Integral, Fractional and String.

    • FeatureName (string) --

      The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

    • FeatureType (string) --

      The value type of a feature. Valid values are Integral, Fractional, or String.

    • CollectionType (string) --

      A grouping of elements where each element within the collection must have the same feature type ( String, Integral, or Fractional).

      • List: An ordered collection of elements.

      • Set: An unordered collection of unique elements.

      • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

    • CollectionConfig (dict) --

      Configuration for your collection.

      • VectorConfig (dict) --

        Configuration for your vector collection type.

        • Dimension: The number of elements in your vector.

        • Dimension (integer) -- [REQUIRED]

          The number of elements in your vector.

type OnlineStoreConfig:

dict

param OnlineStoreConfig:

Updates the feature group online store configuration.

  • TtlDuration (dict) --

    Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

    • Unit (string) --

      TtlDuration time unit.

    • Value (integer) --

      TtlDuration time value.

rtype:

dict

returns:

Response Syntax

{
    'FeatureGroupArn': 'string'
}

Response Structure

  • (dict) --

    • FeatureGroupArn (string) --

      The Amazon Resource Number (ARN) of the feature group that you're updating.