Personalize / Client / list_schemas

list_schemas#

Personalize.Client.list_schemas(**kwargs)#

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

See also: AWS API Documentation

Request Syntax

response = client.list_schemas(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).

  • maxResults (integer) – The maximum number of schemas to return.

Return type:

dict

Returns:

Response Syntax

{
    'schemas': [
        {
            'name': 'string',
            'schemaArn': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • schemas (list) –

      A list of schemas.

      • (dict) –

        Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.

        • name (string) –

          The name of the schema.

        • schemaArn (string) –

          The Amazon Resource Name (ARN) of 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.

    • nextToken (string) –

      A token used to get the next set of schemas (if they exist).

Exceptions

  • Personalize.Client.exceptions.InvalidNextTokenException