Personalize / Client / describe_dataset

describe_dataset#

Personalize.Client.describe_dataset(**kwargs)#

Describes the given dataset. For more information on datasets, see CreateDataset.

See also: AWS API Documentation

Request Syntax

response = client.describe_dataset(
    datasetArn='string'
)
Parameters:

datasetArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the dataset to describe.

Return type:

dict

Returns:

Response Syntax

{
    'dataset': {
        'name': 'string',
        'datasetArn': 'string',
        'datasetGroupArn': 'string',
        'datasetType': 'string',
        'schemaArn': 'string',
        'status': 'string',
        'creationDateTime': datetime(2015, 1, 1),
        'lastUpdatedDateTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • dataset (dict) –

      A listing of the dataset’s properties.

      • name (string) –

        The name of the dataset.

      • datasetArn (string) –

        The Amazon Resource Name (ARN) of the dataset that you want metadata for.

      • datasetGroupArn (string) –

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

      • datasetType (string) –

        One of the following values:

        • Interactions

        • Items

        • Users

      • schemaArn (string) –

        The ARN of the associated schema.

      • status (string) –

        The status of the dataset.

        A dataset can be in one of the following states:

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

        • DELETE PENDING > DELETE IN_PROGRESS

      • creationDateTime (datetime) –

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

      • lastUpdatedDateTime (datetime) –

        A time stamp that shows when the dataset was updated.

Exceptions

  • Personalize.Client.exceptions.InvalidInputException

  • Personalize.Client.exceptions.ResourceNotFoundException