Skip to content

/AWS1/CL_SGMDESCRFEATGROUPRSP

DescribeFeatureGroupResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_featuregrouparn TYPE /AWS1/SGMFEATUREGROUPARN /AWS1/SGMFEATUREGROUPARN

The Amazon Resource Name (ARN) of the FeatureGroup.

iv_featuregroupname TYPE /AWS1/SGMFEATUREGROUPNAME /AWS1/SGMFEATUREGROUPNAME

he name of the FeatureGroup.

iv_recordidfeaturename TYPE /AWS1/SGMFEATURENAME /AWS1/SGMFEATURENAME

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

iv_eventtimefeaturename TYPE /AWS1/SGMFEATURENAME /AWS1/SGMFEATURENAME

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.

it_featuredefinitions TYPE /AWS1/CL_SGMFEATUREDEFINITION=>TT_FEATUREDEFINITIONS TT_FEATUREDEFINITIONS

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

iv_creationtime TYPE /AWS1/SGMCREATIONTIME /AWS1/SGMCREATIONTIME

A timestamp indicating when SageMaker created the FeatureGroup.

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

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

Optional arguments:

iv_lastmodifiedtime TYPE /AWS1/SGMLASTMODIFIEDTIME /AWS1/SGMLASTMODIFIEDTIME

A timestamp indicating when the feature group was last updated.

io_onlinestoreconfig TYPE REF TO /AWS1/CL_SGMONLINESTORECONFIG /AWS1/CL_SGMONLINESTORECONFIG

The configuration for the OnlineStore.

io_offlinestoreconfig TYPE REF TO /AWS1/CL_SGMOFFLINESTORECONFIG /AWS1/CL_SGMOFFLINESTORECONFIG

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.

io_throughputconfig TYPE REF TO /AWS1/CL_SGMTHRUPUTCONFIGDESC /AWS1/CL_SGMTHRUPUTCONFIGDESC

Active throughput configuration of the feature group. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

iv_rolearn TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN

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

iv_featuregroupstatus TYPE /AWS1/SGMFEATUREGROUPSTATUS /AWS1/SGMFEATUREGROUPSTATUS

The status of the feature group.

io_offlinestorestatus TYPE REF TO /AWS1/CL_SGMOFFLINESTORESTATUS /AWS1/CL_SGMOFFLINESTORESTATUS

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

io_lastupdatestatus TYPE REF TO /AWS1/CL_SGMLASTUPDATESTATUS /AWS1/CL_SGMLASTUPDATESTATUS

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

iv_failurereason TYPE /AWS1/SGMFAILUREREASON /AWS1/SGMFAILUREREASON

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.

iv_description TYPE /AWS1/SGMDESCRIPTION /AWS1/SGMDESCRIPTION

A free form description of the feature group.

iv_onlinestoretotalsizebytes TYPE /AWS1/SGMONLINESTORETOTALSIZ00 /AWS1/SGMONLINESTORETOTALSIZ00

The size of the OnlineStore in bytes.

Queryable Attributes

FeatureGroupArn

The Amazon Resource Name (ARN) of the 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

he 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 Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

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 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.

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 the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

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

A timestamp indicating when SageMaker created the FeatureGroup.

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 when the feature group was last updated.

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

The configuration for the OnlineStore.

Accessible with the following methods

Method Description
GET_ONLINESTORECONFIG() Getter for ONLINESTORECONFIG

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.

Accessible with the following methods

Method Description
GET_OFFLINESTORECONFIG() Getter for OFFLINESTORECONFIG

ThroughputConfig

Active throughput configuration of the feature group. There are two modes: ON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.

Note: PROVISIONED throughput mode is supported only for feature groups that are offline-only, or use the Standard tier online store.

Accessible with the following methods

Method Description
GET_THROUGHPUTCONFIG() Getter for THROUGHPUTCONFIG

RoleArn

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

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

The status of the feature group.

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 the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

Accessible with the following methods

Method Description
GET_OFFLINESTORESTATUS() Getter for OFFLINESTORESTATUS

LastUpdateStatus

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

Accessible with the following methods

Method Description
GET_LASTUPDATESTATUS() Getter for LASTUPDATESTATUS

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.

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 the feature group.

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

NextToken

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

Accessible with the following methods

Method Description
GET_NEXTTOKEN() Getter for NEXTTOKEN, with configurable default
ASK_NEXTTOKEN() Getter for NEXTTOKEN w/ exceptions if field has no value
HAS_NEXTTOKEN() Determine if NEXTTOKEN has a value

OnlineStoreTotalSizeBytes

The size of the OnlineStore in bytes.

Accessible with the following methods

Method Description
GET_ONLINESTORETOTALSIZEBY00() Getter for ONLINESTORETOTALSIZEBYTES, with configurable defa
ASK_ONLINESTORETOTALSIZEBY00() Getter for ONLINESTORETOTALSIZEBYTES w/ exceptions if field
HAS_ONLINESTORETOTALSIZEBY00() Determine if ONLINESTORETOTALSIZEBYTES has a value