Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Use this operation to describe a <code>FeatureGroup</code>. The response includes information on the creation time, <code>FeatureGroup</code> name, the unique identifier for each <code>FeatureGroup</code>, and more.

post/#X-Amz-Target=SageMaker.DescribeFeatureGroup

Headers

X-Amz-Target'SageMaker.DescribeFeatureGroup' required

Request body

FeatureGroupNamestring required

The name of the <code>FeatureGroup</code> you want described.

NextTokenstring

A token to resume pagination of the list of <code>Features</code> (<code>FeatureDefinitions</code>). 2,500 <code>Features</code> are returned by default.

Response

Success

FeatureGroupArnstring required

The Amazon Resource Name (ARN) of the <code>FeatureGroup</code>.

FeatureGroupNamestring required

he name of the <code>FeatureGroup</code>.

RecordIdentifierFeatureNamestring required

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

EventTimeFeatureNamestring required
<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>
CreationTimestring date-time required

A timestamp indicating when SageMaker created the <code>FeatureGroup</code>.

LastModifiedTimestring date-time

A timestamp indicating when the feature group was last updated.

RoleArnstring

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

FeatureGroupStatus'Creating' | 'Created' | 'CreateFailed' | 'Deleting' | 'DeleteFailed'

The status of the feature group.

FailureReasonstring
<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>
Descriptionstring

A free form description of the feature group.

NextTokenstring required

A token to resume pagination of the list of <code>Features</code> (<code>FeatureDefinitions</code>).

OnlineStoreTotalSizeBytesinteger

The size of the <code>OnlineStore</code> in bytes.