SageMaker / Client / describe_feature_group

describe_feature_group#

SageMaker.Client.describe_feature_group(**kwargs)#

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.

Request Syntax

response = client.describe_feature_group(
    FeatureGroupName='string',
    NextToken='string'
)

Parameters:

FeatureGroupName (string) –
[REQUIRED]

The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.
NextToken (string) – A token to resume pagination of the list of Features ( FeatureDefinitions). 2,500 Features are returned by default.

Return type:

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.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: VectorConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - 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.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound