FeatureGroup
Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.
Contents
- CreationTime
-
The time a
FeatureGroup
was created.Type: Timestamp
Required: No
- Description
-
A free form description of a
FeatureGroup
.Type: String
Length Constraints: Maximum length of 128.
Required: No
- EventTimeFeatureName
-
The name of the feature that stores the
EventTime
of a Record in aFeatureGroup
.A
EventTime
is point in time when a new event occurs that corresponds to the creation or update of aRecord
inFeatureGroup
. AllRecords
in theFeatureGroup
must have a correspondingEventTime
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}
Required: No
- FailureReason
-
The reason that the
FeatureGroup
failed to be replicated in theOfflineStore
. This is failure may be due to a failure to create aFeatureGroup
in or delete aFeatureGroup
from theOfflineStore
.Type: String
Length Constraints: Maximum length of 1024.
Required: No
- FeatureDefinitions
-
A list of
Feature
s. EachFeature
must include aFeatureName
and aFeatureType
.Valid
FeatureType
s areIntegral
,Fractional
andString
.FeatureName
s cannot be any of the following:is_deleted
,write_time
,api_invocation_time
.You can create up to 2,500
FeatureDefinition
s perFeatureGroup
.Type: Array of FeatureDefinition objects
Array Members: Minimum number of 1 item. Maximum number of 2500 items.
Required: No
- FeatureGroupArn
-
The Amazon Resource Name (ARN) of a
FeatureGroup
.Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/.*
Required: No
- FeatureGroupName
-
The name of the
FeatureGroup
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}
Required: No
- FeatureGroupStatus
-
A
FeatureGroup
status.Type: String
Valid Values:
Creating | Created | CreateFailed | Deleting | DeleteFailed
Required: No
- LastModifiedTime
-
A timestamp indicating the last time you updated the feature group.
Type: Timestamp
Required: No
- LastUpdateStatus
-
A value that indicates whether the feature group was updated successfully.
Type: LastUpdateStatus object
Required: No
- OfflineStoreConfig
-
The configuration of an
OfflineStore
.Provide an
OfflineStoreConfig
in a request toCreateFeatureGroup
to create anOfflineStore
.To encrypt an
OfflineStore
using at rest data encryption, specify Amazon Key Management Service (KMS) key ID, orKMSKeyId
, inS3StorageConfig
.Type: OfflineStoreConfig object
Required: No
- OfflineStoreStatus
-
The status of
OfflineStore
.Type: OfflineStoreStatus object
Required: No
- OnlineStoreConfig
-
Use this to specify the Amazon Key Management Service (KMS) Key ID, or
KMSKeyId
, for at rest data encryption. You can turnOnlineStore
on or off by specifying theEnableOnlineStore
flag at General Assembly.The default value is
False
.Type: OnlineStoreConfig object
Required: No
- RecordIdentifierFeatureName
-
The name of the
Feature
whose value uniquely identifies aRecord
defined in theFeatureGroup
FeatureDefinitions
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}
Required: No
- RoleArn
-
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
Required: No
- Tags
-
Tags used to define a
FeatureGroup
.Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: