DatabaseMigrationService / Client / describe_schemas

describe_schemas#

DatabaseMigrationService.Client.describe_schemas(**kwargs)#

Returns information about the schema for the specified endpoint.

See also: AWS API Documentation

Request Syntax

response = client.describe_schemas(
    EndpointArn='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:
  • EndpointArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

  • MaxRecords (integer) –

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • Marker (string) – An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'Schemas': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • Schemas (list) –

      The described schema.

      • (string) –

Exceptions

  • DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault

  • DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault

Examples

Returns information about the schema for the specified endpoint.

response = client.describe_schemas(
    EndpointArn='',
    Marker='',
    MaxRecords=123,
)

print(response)

Expected Output:

{
    'Marker': '',
    'Schemas': [
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}