Amazon Personalize

Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.

See also: AWS API Documentation

Request Syntax

client.update_dataset(
    datasetArn='string',
    schemaArn='string'
)

type datasetArn:

string

param datasetArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the dataset that you want to update.

type schemaArn:

string

param schemaArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the new schema you want use.

rtype:

dict

returns:

Response Syntax

{
    'datasetArn': 'string'
}

Response Structure

• (dict) --

  • datasetArn (string) --

    The Amazon Resource Name (ARN) of the dataset you updated.

{'dataset': {'latestDatasetUpdate': {'creationDateTime': 'timestamp',
                                     'failureReason': 'string',
                                     'lastUpdatedDateTime': 'timestamp',
                                     'schemaArn': 'string',
                                     'status': 'string'}}}

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

See also: AWS API Documentation

Request Syntax

client.describe_dataset(
    datasetArn='string'
)

type datasetArn:

string

param datasetArn:

[REQUIRED]

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

rtype:

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),
        'latestDatasetUpdate': {
            'schemaArn': 'string',
            'status': 'string',
            'failureReason': '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.

    • latestDatasetUpdate (dict) --

      Describes the latest update to the dataset.

      • schemaArn (string) --

        The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.

      • status (string) --

        The status of the dataset update.

      • failureReason (string) --

        If updating a dataset fails, provides the reason why.

      • creationDateTime (datetime) --

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

      • lastUpdatedDateTime (datetime) --

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