list_feature_groups

SageMaker.Client.list_feature_groups(**kwargs)

List FeatureGroup s based on given filter and order.

See also: AWS API Documentation

Request Syntax

response = client.list_feature_groups(
    NameContains='string',
    FeatureGroupStatusEquals='Creating'|'Created'|'CreateFailed'|'Deleting'|'DeleteFailed',
    OfflineStoreStatusEquals='Active'|'Blocked'|'Disabled',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    SortOrder='Ascending'|'Descending',
    SortBy='Name'|'FeatureGroupStatus'|'OfflineStoreStatus'|'CreationTime',
    MaxResults=123,
    NextToken='string'
)

Parameters

• NameContains (string) -- A string that partially matches one or more FeatureGroup s names. Filters FeatureGroup s by name.
• FeatureGroupStatusEquals (string) -- A FeatureGroup status. Filters by FeatureGroup status.
• OfflineStoreStatusEquals (string) -- An OfflineStore status. Filters by OfflineStore status.
• CreationTimeAfter (datetime) -- Use this parameter to search for FeatureGroups s created after a specific date and time.
• CreationTimeBefore (datetime) -- Use this parameter to search for FeatureGroups s created before a specific date and time.
• SortOrder (string) -- The order in which feature groups are listed.
• SortBy (string) -- The value on which the feature group list is sorted.
• MaxResults (integer) -- The maximum number of results returned by ListFeatureGroups .
• NextToken (string) -- A token to resume pagination of ListFeatureGroups results.

Return type

dict

Returns

Response Syntax

{
    'FeatureGroupSummaries': [
        {
            'FeatureGroupName': 'string',
            'FeatureGroupArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'FeatureGroupStatus': 'Creating'|'Created'|'CreateFailed'|'Deleting'|'DeleteFailed',
            'OfflineStoreStatus': {
                'Status': 'Active'|'Blocked'|'Disabled',
                'BlockedReason': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • FeatureGroupSummaries (list) --

    A summary of feature groups.

    • (dict) --

      The name, Arn, CreationTime , FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup .

      • FeatureGroupName (string) --

        The name of FeatureGroup .

      • FeatureGroupArn (string) --

        Unique identifier for the FeatureGroup .

      • CreationTime (datetime) --

        A timestamp indicating the time of creation time of the FeatureGroup .

      • FeatureGroupStatus (string) --

        The status of a FeatureGroup. The status can be any of the following: Creating , Created , CreateFail , Deleting or DetailFail .

      • OfflineStoreStatus (dict) --

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

        • Status (string) --

          An OfflineStore status.

        • BlockedReason (string) --

          The justification for why the OfflineStoreStatus is Blocked (if applicable).

  • NextToken (string) --

    A token to resume pagination of ListFeatureGroups results.