ListFeatureGroups - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ListFeatureGroups

List FeatureGroups based on given filter and order.

Request Syntax

{ "CreationTimeAfter": number, "CreationTimeBefore": number, "FeatureGroupStatusEquals": "string", "MaxResults": number, "NameContains": "string", "NextToken": "string", "OfflineStoreStatusEquals": "string", "SortBy": "string", "SortOrder": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreationTimeAfter

Use this parameter to search for FeatureGroupss created after a specific date and time.

Type: Timestamp

Required: No

CreationTimeBefore

Use this parameter to search for FeatureGroupss created before a specific date and time.

Type: Timestamp

Required: No

FeatureGroupStatusEquals

A FeatureGroup status. Filters by FeatureGroup status.

Type: String

Valid Values: Creating | Created | CreateFailed | Deleting | DeleteFailed

Required: No

MaxResults

The maximum number of results returned by ListFeatureGroups.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

NextToken

A token to resume pagination of ListFeatureGroups results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

OfflineStoreStatusEquals

An OfflineStore status. Filters by OfflineStore status.

Type: String

Valid Values: Active | Blocked | Disabled

Required: No

SortBy

The value on which the feature group list is sorted.

Type: String

Valid Values: Name | FeatureGroupStatus | OfflineStoreStatus | CreationTime

Required: No

SortOrder

The order in which feature groups are listed.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax

{ "FeatureGroupSummaries": [ { "CreationTime": number, "FeatureGroupArn": "string", "FeatureGroupName": "string", "FeatureGroupStatus": "string", "OfflineStoreStatus": { "BlockedReason": "string", "Status": "string" } } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FeatureGroupSummaries

A summary of feature groups.

Type: Array of FeatureGroupSummary objects

NextToken

A token to resume pagination of ListFeatureGroups results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: