describe_schema

Personalize.Client.describe_schema(**kwargs)

Describes a schema. For more information on schemas, see CreateSchema.

See also: AWS API Documentation

Request Syntax

response = client.describe_schema(
    schemaArn='string'
)

Parameters

schemaArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the schema to retrieve.

Return type

dict

Returns

Response Syntax

{
    'schema': {
        'name': 'string',
        'schemaArn': 'string',
        'schema': 'string',
        'creationDateTime': datetime(2015, 1, 1),
        'lastUpdatedDateTime': datetime(2015, 1, 1),
        'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
    }
}

Response Structure

• (dict) --
  • schema (dict) --

    The requested schema.

    • name (string) --

      The name of the schema.

    • schemaArn (string) --

      The Amazon Resource Name (ARN) of the schema.

    • schema (string) --

      The schema.

    • creationDateTime (datetime) --

      The date and time (in Unix time) that the schema was created.

    • lastUpdatedDateTime (datetime) --

      The date and time (in Unix time) that the schema was last updated.

    • domain (string) --

      The domain of a schema that you created for a dataset in a Domain dataset group.

Exceptions

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