Skip to content

DescribeFeatureGroupResponse

Source code in docs_src/capo_sagemaker/types/describe_feature_group_response.py
class DescribeFeatureGroupResponse(TypedDict, closed=True):
    feature_group_arn: NotRequired[
        "capo_sagemaker.types.feature_group_arn.FeatureGroupArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the <code>FeatureGroup</code>. </p>"""
    feature_group_name: NotRequired[
        "capo_sagemaker.types.feature_group_name.FeatureGroupName"
    ]
    """<p>he name of the <code>FeatureGroup</code>.</p>"""
    record_identifier_feature_name: NotRequired[
        "capo_sagemaker.types.feature_name.FeatureName"
    ]
    """<p>The name of the <code>Feature</code> used for <code>RecordIdentifier</code>, whose value uniquely identifies a record stored in the feature store.</p>"""
    event_time_feature_name: NotRequired[
        "capo_sagemaker.types.feature_name.FeatureName"
    ]
    """<p>The name of the feature that stores the <code>EventTime</code> of a Record in a <code>FeatureGroup</code>.</p> <p> An <code>EventTime</code> is a point in time when a new event occurs that corresponds to the creation or update of a <code>Record</code> in a <code>FeatureGroup</code>. All <code>Records</code> in the <code>FeatureGroup</code> have a corresponding <code>EventTime</code>.</p>"""
    feature_definitions: NotRequired[
        "capo_sagemaker.types.feature_definitions.FeatureDefinitions"
    ]
    """<p>A list of the <code>Features</code> in the <code>FeatureGroup</code>. Each feature is defined by a <code>FeatureName</code> and <code>FeatureType</code>.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.creation_time.CreationTime"]
    """<p>A timestamp indicating when SageMaker created the <code>FeatureGroup</code>.</p>"""
    last_modified_time: NotRequired[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ]
    """<p>A timestamp indicating when the feature group was last updated.</p>"""
    online_store_config: NotRequired[
        "capo_sagemaker.types.online_store_config.OnlineStoreConfig"
    ]
    """<p>The configuration for the <code>OnlineStore</code>.</p>"""
    offline_store_config: NotRequired[
        "capo_sagemaker.types.offline_store_config.OfflineStoreConfig"
    ]
    """<p>The configuration of the offline store. It includes the following configurations:</p> <ul> <li> <p>Amazon S3 location of the offline store.</p> </li> <li> <p>Configuration of the Glue data catalog.</p> </li> <li> <p>Table format of the offline store.</p> </li> <li> <p>Option to disable the automatic creation of a Glue table for the offline store.</p> </li> <li> <p>Encryption configuration.</p> </li> </ul>"""
    throughput_config: NotRequired[
        "capo_sagemaker.types.throughput_config_description.ThroughputConfigDescription"
    ]
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.</p>"""
    feature_group_status: NotRequired[
        "capo_sagemaker.types.feature_group_status.FeatureGroupStatus"
    ]
    """<p>The status of the feature group.</p>"""
    offline_store_status: NotRequired[
        "capo_sagemaker.types.offline_store_status.OfflineStoreStatus"
    ]
    """<p>The status of the <code>OfflineStore</code>. Notifies you if replicating data into the <code>OfflineStore</code> has failed. Returns either: <code>Active</code> or <code>Blocked</code> </p>"""
    last_update_status: NotRequired[
        "capo_sagemaker.types.last_update_status.LastUpdateStatus"
    ]
    """<p>A value indicating whether the update made to the feature group was successful.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>The reason that the <code>FeatureGroup</code> failed to be replicated in the <code>OfflineStore</code>. This is failure can occur because:</p> <ul> <li> <p>The <code>FeatureGroup</code> could not be created in the <code>OfflineStore</code>.</p> </li> <li> <p>The <code>FeatureGroup</code> could not be deleted from the <code>OfflineStore</code>.</p> </li> </ul>"""
    description: NotRequired["capo_sagemaker.types.description.Description"]
    """<p>A free form description of the feature group.</p>"""
    next_token: NotRequired["capo_sagemaker.types.next_token.NextToken"]
    """<p>A token to resume pagination of the list of <code>Features</code> (<code>FeatureDefinitions</code>).</p>"""
    online_store_total_size_bytes: NotRequired[
        "capo_sagemaker.types.online_store_total_size_bytes.OnlineStoreTotalSizeBytes"
    ]
    """<p>The size of the <code>OnlineStore</code> in bytes.</p>"""

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

A timestamp indicating when SageMaker created the FeatureGroup.

description instance-attribute

description: NotRequired[Description]

A free form description of the feature group.

event_time_feature_name instance-attribute

event_time_feature_name: NotRequired[FeatureName]

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.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

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.

feature_definitions instance-attribute

feature_definitions: NotRequired[FeatureDefinitions]

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

feature_group_arn instance-attribute

feature_group_arn: NotRequired[FeatureGroupArn]

The Amazon Resource Name (ARN) of the FeatureGroup.

feature_group_name instance-attribute

feature_group_name: NotRequired[FeatureGroupName]

he name of the FeatureGroup.

feature_group_status instance-attribute

feature_group_status: NotRequired[FeatureGroupStatus]

The status of the feature group.

last_modified_time instance-attribute

last_modified_time: NotRequired[LastModifiedTime]

A timestamp indicating when the feature group was last updated.

last_update_status instance-attribute

last_update_status: NotRequired[LastUpdateStatus]

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

next_token instance-attribute

next_token: NotRequired[NextToken]

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

offline_store_config instance-attribute

offline_store_config: NotRequired[OfflineStoreConfig]

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.

offline_store_status instance-attribute

offline_store_status: NotRequired[OfflineStoreStatus]

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

online_store_config instance-attribute

online_store_config: NotRequired[OnlineStoreConfig]

The configuration for the OnlineStore.

online_store_total_size_bytes instance-attribute

online_store_total_size_bytes: NotRequired[OnlineStoreTotalSizeBytes]

The size of the OnlineStore in bytes.

record_identifier_feature_name instance-attribute

record_identifier_feature_name: NotRequired[FeatureName]

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

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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

throughput_config instance-attribute

throughput_config: NotRequired[ThroughputConfigDescription]