ForecastService / Client / list_dataset_groups

list_dataset_groups#

ForecastService.Client.list_dataset_groups(**kwargs)#

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.

See also: AWS API Documentation

Request Syntax

response = client.list_dataset_groups(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

  • MaxResults (integer) – The number of items to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'DatasetGroups': [
        {
            'DatasetGroupArn': 'string',
            'DatasetGroupName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModificationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DatasetGroups (list) –

      An array of objects that summarize each dataset group’s properties.

      • (dict) –

        Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To get the complete set of properties, call the DescribeDatasetGroup operation, and provide the DatasetGroupArn.

        • DatasetGroupArn (string) –

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

        • DatasetGroupName (string) –

          The name of the dataset group.

        • CreationTime (datetime) –

          When the dataset group was created.

        • LastModificationTime (datetime) –

          When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the ListDatasetGroups call.

    • NextToken (string) –

      If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

Exceptions