ForecastService / Client / describe_dataset_group

describe_dataset_group#

ForecastService.Client.describe_dataset_group(**kwargs)#

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties:

  • DatasetArns - The datasets belonging to the group.

  • CreationTime

  • LastModificationTime

  • Status

See also: AWS API Documentation

Request Syntax

response = client.describe_dataset_group(
    DatasetGroupArn='string'
)
Parameters:

DatasetGroupArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'DatasetGroupName': 'string',
    'DatasetGroupArn': 'string',
    'DatasetArns': [
        'string',
    ],
    'Domain': 'RETAIL'|'CUSTOM'|'INVENTORY_PLANNING'|'EC2_CAPACITY'|'WORK_FORCE'|'WEB_TRAFFIC'|'METRICS',
    'Status': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModificationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • DatasetGroupName (string) –

      The name of the dataset group.

    • DatasetGroupArn (string) –

      The ARN of the dataset group.

    • DatasetArns (list) –

      An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

      • (string) –

    • Domain (string) –

      The domain associated with the dataset group.

    • Status (string) –

      The status of the dataset group. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

      • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

      The UPDATE states apply when you call the UpdateDatasetGroup operation.

      Note

      The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.

    • 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 DescribeDatasetGroup call.

Exceptions

  • ForecastService.Client.exceptions.InvalidInputException

  • ForecastService.Client.exceptions.ResourceNotFoundException