DatabaseMigrationService / Client / describe_metadata_model_exports_as_script

describe_metadata_model_exports_as_script#

DatabaseMigrationService.Client.describe_metadata_model_exports_as_script(**kwargs)#

Returns a paginated list of metadata model exports.

See also: AWS API Documentation

Request Syntax

response = client.describe_metadata_model_exports_as_script(
    MigrationProjectIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123
)
Parameters:

  • MigrationProjectIdentifier (string) –

    [REQUIRED]

    The migration project name or Amazon Resource Name (ARN).

  • Filters (list) –

    Filters applied to the metadata model exports described in the form of key-value pairs.

    • (dict) –

      Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

      • Name (string) – [REQUIRED]

        The name of the filter as specified for a Describe* or similar operation.

      • Values (list) – [REQUIRED]

        The filter value, which can specify one or more values used to narrow the returned results.

        • (string) –

  • Marker (string) –

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

  • MaxRecords (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'Requests': [
        {
            'Status': 'string',
            'RequestIdentifier': 'string',
            'MigrationProjectArn': 'string',
            'Error': {
                'defaultErrorDetails': {
                    'Message': 'string'
                }
            },
            'ExportSqlDetails': {
                'S3ObjectKey': 'string',
                'ObjectURL': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • Requests (list) –

      A paginated list of metadata model exports.

      • (dict) –

        Provides information about a schema conversion action.

        • Status (string) –

          The schema conversion action status.

        • RequestIdentifier (string) –

          The identifier for the schema conversion action.

        • MigrationProjectArn (string) –

          The migration project ARN.

        • Error (dict) –

          Provides error information about a project.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: defaultErrorDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • defaultErrorDetails (dict) –

            Error information about a project.

            • Message (string) –

              The error message.

        • ExportSqlDetails (dict) –

          Provides information about a metadata model assessment exported to SQL.

          • S3ObjectKey (string) –

            The Amazon S3 object key for the object containing the exported metadata model assessment.

          • ObjectURL (string) –

            The URL for the object containing the exported metadata model assessment.

Exceptions