describe_dataset_group

Personalize.Client.describe_dataset_group(**kwargs)

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

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 to describe.

Return type

dict

Returns

Response Syntax

{
    'datasetGroup': {
        'name': 'string',
        'datasetGroupArn': 'string',
        'status': 'string',
        'roleArn': 'string',
        'kmsKeyArn': 'string',
        'creationDateTime': datetime(2015, 1, 1),
        'lastUpdatedDateTime': datetime(2015, 1, 1),
        'failureReason': 'string',
        'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
    }
}

Response Structure

• (dict) --
  • datasetGroup (dict) --

    A listing of the dataset group's properties.

    • name (string) --

      The name of the dataset group.

    • datasetGroupArn (string) --

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

    • status (string) --

      The current 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
    • roleArn (string) --

      The ARN of the IAM role that has permissions to create the dataset group.

    • kmsKeyArn (string) --

      The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

    • creationDateTime (datetime) --

      The creation date and time (in Unix time) of the dataset group.

    • lastUpdatedDateTime (datetime) --

      The last update date and time (in Unix time) of the dataset group.

    • failureReason (string) --

      If creating a dataset group fails, provides the reason why.

    • domain (string) --

      The domain of a Domain dataset group.

Exceptions

• Personalize.Client.exceptions.InvalidInputException
• Personalize.Client.exceptions.ResourceNotFoundException