EntityResolution / Client / list_schema_mappings

list_schema_mappings#

EntityResolution.Client.list_schema_mappings(**kwargs)#

Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

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

  • maxResults (integer) – The maximum number of objects returned per page.

  • nextToken (string) – The pagination token from the previous API call.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'schemaList': [
        {
            'createdAt': datetime(2015, 1, 1),
            'hasWorkflows': True|False,
            'schemaArn': 'string',
            'schemaName': 'string',
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The pagination token from the previous API call.

    • schemaList (list) –

      A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt, UpdatedAt.

      • (dict) –

        An object containing SchemaName, SchemaArn, CreatedAt, and UpdatedAt.

        • createdAt (datetime) –

          The timestamp of when the SchemaMapping was created.

        • hasWorkflows (boolean) –

          Specifies whether the schema mapping has been applied to a workflow.

        • schemaArn (string) –

          The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.

        • schemaName (string) –

          The name of the schema.

        • updatedAt (datetime) –

          The timestamp of when the SchemaMapping was last updated.

Exceptions