Skip to content

FeatureGroup

Source code in docs_src/capo_sagemaker/types/feature_group.py
class FeatureGroup(TypedDict, closed=True):
    feature_group_arn: NotRequired[
        "capo_sagemaker.types.feature_group_arn.FeatureGroupArn"
    ]
    """<p>The Amazon Resource Name (ARN) of a <code>FeatureGroup</code>.</p>"""
    feature_group_name: NotRequired[
        "capo_sagemaker.types.feature_group_name.FeatureGroupName"
    ]
    """<p>The 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> whose value uniquely identifies a <code>Record</code> defined in the <code>FeatureGroup</code> <code>FeatureDefinitions</code>.</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>A <code>EventTime</code> is point in time when a new event occurs that corresponds to the creation or update of a <code>Record</code> in <code>FeatureGroup</code>. All <code>Records</code> in the <code>FeatureGroup</code> must have a corresponding <code>EventTime</code>.</p>"""
    feature_definitions: NotRequired[
        "capo_sagemaker.types.feature_definitions.FeatureDefinitions"
    ]
    """<p>A list of <code>Feature</code>s. Each <code>Feature</code> must include a <code>FeatureName</code> and a <code>FeatureType</code>. </p> <p>Valid <code>FeatureType</code>s are <code>Integral</code>, <code>Fractional</code> and <code>String</code>. </p> <p> <code>FeatureName</code>s cannot be any of the following: <code>is_deleted</code>, <code>write_time</code>, <code>api_invocation_time</code>.</p> <p>You can create up to 2,500 <code>FeatureDefinition</code>s per <code>FeatureGroup</code>.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.creation_time.CreationTime"]
    """<p>The time a <code>FeatureGroup</code> was created.</p>"""
    last_modified_time: NotRequired[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ]
    """<p>A timestamp indicating the last time you updated the feature group.</p>"""
    online_store_config: NotRequired[
        "capo_sagemaker.types.online_store_config.OnlineStoreConfig"
    ]
    offline_store_config: NotRequired[
        "capo_sagemaker.types.offline_store_config.OfflineStoreConfig"
    ]
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.</p>"""
    feature_group_status: NotRequired[
        "capo_sagemaker.types.feature_group_status.FeatureGroupStatus"
    ]
    """<p>A <code>FeatureGroup</code> status.</p>"""
    offline_store_status: NotRequired[
        "capo_sagemaker.types.offline_store_status.OfflineStoreStatus"
    ]
    last_update_status: NotRequired[
        "capo_sagemaker.types.last_update_status.LastUpdateStatus"
    ]
    """<p>A value that indicates whether the feature group was updated successfully.</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 may be due to a failure to create a <code>FeatureGroup</code> in or delete a <code>FeatureGroup</code> from the <code>OfflineStore</code>.</p>"""
    description: NotRequired["capo_sagemaker.types.description.Description"]
    """<p>A free form description of a <code>FeatureGroup</code>.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>Tags used to define a <code>FeatureGroup</code>.</p>"""

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

The time a FeatureGroup was created.

description instance-attribute

description: NotRequired[Description]

A free form description of a FeatureGroup.

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.

A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must 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 may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

feature_definitions instance-attribute

feature_definitions: NotRequired[FeatureDefinitions]

A list of Features. Each Feature must include a FeatureName and a FeatureType.

Valid FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

feature_group_arn instance-attribute

feature_group_arn: NotRequired[FeatureGroupArn]

The Amazon Resource Name (ARN) of a FeatureGroup.

feature_group_name instance-attribute

feature_group_name: NotRequired[FeatureGroupName]

The name of the FeatureGroup.

feature_group_status instance-attribute

feature_group_status: NotRequired[FeatureGroupStatus]

A FeatureGroup status.

last_modified_time instance-attribute

last_modified_time: NotRequired[LastModifiedTime]

A timestamp indicating the last time you updated the feature group.

last_update_status instance-attribute

last_update_status: NotRequired[LastUpdateStatus]

A value that indicates whether the feature group was updated successfully.

offline_store_config instance-attribute

offline_store_config: NotRequired[OfflineStoreConfig]

offline_store_status instance-attribute

offline_store_status: NotRequired[OfflineStoreStatus]

online_store_config instance-attribute

online_store_config: NotRequired[OnlineStoreConfig]

record_identifier_feature_name instance-attribute

record_identifier_feature_name: NotRequired[FeatureName]

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

tags instance-attribute

tags: NotRequired[TagList]

Tags used to define a FeatureGroup.