/AWS1/CL_SGMFEATUREGROUP¶
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.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_featuregrouparn TYPE /AWS1/SGMFEATUREGROUPARN /AWS1/SGMFEATUREGROUPARN¶
The Amazon Resource Name (ARN) of a
FeatureGroup.
iv_featuregroupname TYPE /AWS1/SGMFEATUREGROUPNAME /AWS1/SGMFEATUREGROUPNAME¶
The name of the
FeatureGroup.
iv_recordidfeaturename TYPE /AWS1/SGMFEATURENAME /AWS1/SGMFEATURENAME¶
The name of the
Featurewhose value uniquely identifies aRecorddefined in theFeatureGroupFeatureDefinitions.
iv_eventtimefeaturename TYPE /AWS1/SGMFEATURENAME /AWS1/SGMFEATURENAME¶
The name of the feature that stores the
EventTimeof a Record in aFeatureGroup.A
EventTimeis point in time when a new event occurs that corresponds to the creation or update of aRecordinFeatureGroup. AllRecordsin theFeatureGroupmust have a correspondingEventTime.
it_featuredefinitions TYPE /AWS1/CL_SGMFEATUREDEFINITION=>TT_FEATUREDEFINITIONS TT_FEATUREDEFINITIONS¶
A list of
Features. EachFeaturemust include aFeatureNameand aFeatureType.Valid
FeatureTypes areIntegral,FractionalandString.
FeatureNames cannot be any of the following:is_deleted,write_time,api_invocation_time.You can create up to 2,500
FeatureDefinitions perFeatureGroup.
iv_creationtime TYPE /AWS1/SGMCREATIONTIME /AWS1/SGMCREATIONTIME¶
The time a
FeatureGroupwas created.
iv_lastmodifiedtime TYPE /AWS1/SGMLASTMODIFIEDTIME /AWS1/SGMLASTMODIFIEDTIME¶
A timestamp indicating the last time you updated the feature group.
io_onlinestoreconfig TYPE REF TO /AWS1/CL_SGMONLINESTORECONFIG /AWS1/CL_SGMONLINESTORECONFIG¶
Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or
KMSKeyId, for at rest data encryption. You can turnOnlineStoreon or off by specifying theEnableOnlineStoreflag at General Assembly.The default value is
False.
io_offlinestoreconfig TYPE REF TO /AWS1/CL_SGMOFFLINESTORECONFIG /AWS1/CL_SGMOFFLINESTORECONFIG¶
The configuration of an
OfflineStore.Provide an
OfflineStoreConfigin a request toCreateFeatureGroupto create anOfflineStore.To encrypt an
OfflineStoreusing at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, orKMSKeyId, inS3StorageConfig.
iv_rolearn TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN¶
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
iv_featuregroupstatus TYPE /AWS1/SGMFEATUREGROUPSTATUS /AWS1/SGMFEATUREGROUPSTATUS¶
A
FeatureGroupstatus.
io_offlinestorestatus TYPE REF TO /AWS1/CL_SGMOFFLINESTORESTATUS /AWS1/CL_SGMOFFLINESTORESTATUS¶
The status of
OfflineStore.
io_lastupdatestatus TYPE REF TO /AWS1/CL_SGMLASTUPDATESTATUS /AWS1/CL_SGMLASTUPDATESTATUS¶
A value that indicates whether the feature group was updated successfully.
iv_failurereason TYPE /AWS1/SGMFAILUREREASON /AWS1/SGMFAILUREREASON¶
The reason that the
FeatureGroupfailed to be replicated in theOfflineStore. This is failure may be due to a failure to create aFeatureGroupin or delete aFeatureGroupfrom theOfflineStore.
iv_description TYPE /AWS1/SGMDESCRIPTION /AWS1/SGMDESCRIPTION¶
A free form description of a
FeatureGroup.
it_tags TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST¶
Tags used to define a
FeatureGroup.
Queryable Attributes¶
FeatureGroupArn¶
The Amazon Resource Name (ARN) of a
FeatureGroup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FEATUREGROUPARN() |
Getter for FEATUREGROUPARN, with configurable default |
ASK_FEATUREGROUPARN() |
Getter for FEATUREGROUPARN w/ exceptions if field has no val |
HAS_FEATUREGROUPARN() |
Determine if FEATUREGROUPARN has a value |
FeatureGroupName¶
The name of the
FeatureGroup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FEATUREGROUPNAME() |
Getter for FEATUREGROUPNAME, with configurable default |
ASK_FEATUREGROUPNAME() |
Getter for FEATUREGROUPNAME w/ exceptions if field has no va |
HAS_FEATUREGROUPNAME() |
Determine if FEATUREGROUPNAME has a value |
RecordIdentifierFeatureName¶
The name of the
Featurewhose value uniquely identifies aRecorddefined in theFeatureGroupFeatureDefinitions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RECORDIDFEATURENAME() |
Getter for RECORDIDENTIFIERFEATURENAME, with configurable de |
ASK_RECORDIDFEATURENAME() |
Getter for RECORDIDENTIFIERFEATURENAME w/ exceptions if fiel |
HAS_RECORDIDFEATURENAME() |
Determine if RECORDIDENTIFIERFEATURENAME has a value |
EventTimeFeatureName¶
The name of the feature that stores the
EventTimeof a Record in aFeatureGroup.A
EventTimeis point in time when a new event occurs that corresponds to the creation or update of aRecordinFeatureGroup. AllRecordsin theFeatureGroupmust have a correspondingEventTime.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EVENTTIMEFEATURENAME() |
Getter for EVENTTIMEFEATURENAME, with configurable default |
ASK_EVENTTIMEFEATURENAME() |
Getter for EVENTTIMEFEATURENAME w/ exceptions if field has n |
HAS_EVENTTIMEFEATURENAME() |
Determine if EVENTTIMEFEATURENAME has a value |
FeatureDefinitions¶
A list of
Features. EachFeaturemust include aFeatureNameand aFeatureType.Valid
FeatureTypes areIntegral,FractionalandString.
FeatureNames cannot be any of the following:is_deleted,write_time,api_invocation_time.You can create up to 2,500
FeatureDefinitions perFeatureGroup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FEATUREDEFINITIONS() |
Getter for FEATUREDEFINITIONS, with configurable default |
ASK_FEATUREDEFINITIONS() |
Getter for FEATUREDEFINITIONS w/ exceptions if field has no |
HAS_FEATUREDEFINITIONS() |
Determine if FEATUREDEFINITIONS has a value |
CreationTime¶
The time a
FeatureGroupwas created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
LastModifiedTime¶
A timestamp indicating the last time you updated the feature group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDTIME() |
Getter for LASTMODIFIEDTIME, with configurable default |
ASK_LASTMODIFIEDTIME() |
Getter for LASTMODIFIEDTIME w/ exceptions if field has no va |
HAS_LASTMODIFIEDTIME() |
Determine if LASTMODIFIEDTIME has a value |
OnlineStoreConfig¶
Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or
KMSKeyId, for at rest data encryption. You can turnOnlineStoreon or off by specifying theEnableOnlineStoreflag at General Assembly.The default value is
False.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ONLINESTORECONFIG() |
Getter for ONLINESTORECONFIG |
OfflineStoreConfig¶
The configuration of an
OfflineStore.Provide an
OfflineStoreConfigin a request toCreateFeatureGroupto create anOfflineStore.To encrypt an
OfflineStoreusing at rest data encryption, specify Amazon Web Services Key Management Service (KMS) key ID, orKMSKeyId, inS3StorageConfig.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OFFLINESTORECONFIG() |
Getter for OFFLINESTORECONFIG |
RoleArn¶
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
FeatureGroupStatus¶
A
FeatureGroupstatus.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FEATUREGROUPSTATUS() |
Getter for FEATUREGROUPSTATUS, with configurable default |
ASK_FEATUREGROUPSTATUS() |
Getter for FEATUREGROUPSTATUS w/ exceptions if field has no |
HAS_FEATUREGROUPSTATUS() |
Determine if FEATUREGROUPSTATUS has a value |
OfflineStoreStatus¶
The status of
OfflineStore.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OFFLINESTORESTATUS() |
Getter for OFFLINESTORESTATUS |
LastUpdateStatus¶
A value that indicates whether the feature group was updated successfully.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATESTATUS() |
Getter for LASTUPDATESTATUS |
FailureReason¶
The reason that the
FeatureGroupfailed to be replicated in theOfflineStore. This is failure may be due to a failure to create aFeatureGroupin or delete aFeatureGroupfrom theOfflineStore.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREREASON() |
Getter for FAILUREREASON, with configurable default |
ASK_FAILUREREASON() |
Getter for FAILUREREASON w/ exceptions if field has no value |
HAS_FAILUREREASON() |
Determine if FAILUREREASON has a value |
Description¶
A free form description of a
FeatureGroup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
Tags¶
Tags used to define a
FeatureGroup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |