Personalize / Client / list_dataset_groups

list_dataset_groups#

Personalize.Client.list_dataset_groups(**kwargs)#

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

See also: AWS API Documentation

Request Syntax

response = client.list_dataset_groups(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).

  • maxResults (integer) – The maximum number of dataset groups to return.

Return type:

dict

Returns:

Response Syntax

{
    'datasetGroups': [
        {
            'name': 'string',
            'datasetGroupArn': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'failureReason': 'string',
            'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • datasetGroups (list) –

      The list of your dataset groups.

      • (dict) –

        Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.

        • name (string) –

          The name of the dataset group.

        • datasetGroupArn (string) –

          The Amazon Resource Name (ARN) of the dataset group.

        • status (string) –

          The status of the dataset group.

          A dataset group can be in one of the following states:

          • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

          • DELETE PENDING

        • creationDateTime (datetime) –

          The date and time (in Unix time) that the dataset group was created.

        • lastUpdatedDateTime (datetime) –

          The date and time (in Unix time) that the dataset group was last updated.

        • failureReason (string) –

          If creating a dataset group fails, the reason behind the failure.

        • domain (string) –

          The domain of a Domain dataset group.

    • nextToken (string) –

      A token for getting the next set of dataset groups (if they exist).

Exceptions

  • Personalize.Client.exceptions.InvalidNextTokenException