DatabaseMigrationService / Client / cancel_metadata_model_conversion

cancel_metadata_model_conversion

DatabaseMigrationService.Client.cancel_metadata_model_conversion(**kwargs)

Cancels a single metadata model conversion operation that was started with StartMetadataModelConversion.

Required permissions: dms:CancelMetadataModelConversion. For more information, see Actions, resources, and condition keys for Database Migration Service.

See also: AWS API Documentation

Request Syntax

response = client.cancel_metadata_model_conversion(
    MigrationProjectIdentifier='string',
    RequestIdentifier='string'
)
Parameters:

  • MigrationProjectIdentifier (string) –

    [REQUIRED]

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

  • RequestIdentifier (string) –

    [REQUIRED]

    The identifier for the metadata model conversion operation to cancel. This operation was initiated by StartMetadataModelConversion.

Return type:

dict

Returns:

Response Syntax

{
    'Request': {
        'Status': 'string',
        'RequestIdentifier': 'string',
        'MigrationProjectArn': 'string',
        'Error': {
            'defaultErrorDetails': {
                'Message': 'string'
            }
        },
        'ExportSqlDetails': {
            'S3ObjectKey': 'string',
            'ObjectURL': 'string'
        },
        'Progress': {
            'ProgressPercent': 123.0,
            'TotalObjects': 123,
            'ProgressStep': 'string',
            'ProcessedObject': {
                'Name': 'string',
                'Type': 'string',
                'EndpointType': 'string'
            }
        }
    }
}

Response Structure

  • (dict) –

    • Request (dict) –

      The metadata model conversion request.

      Note

      DMS never populates the ExportSqlDetails field for this operation.

      • Status (string) –

        The schema conversion operation status. Possible values:

        • RECEIVED – The operation is received but not yet queued for processing.

        • IN_PROGRESS – The operation is queued or actively running.

        • SUCCESS – The operation completed successfully.

        • FAILED – The operation did not complete.

        • CANCELING – The operation is being canceled. The operation might still succeed or fail before cancellation takes effect.

        • CANCELED – The operation was canceled before completion.

      • 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) –

        The Amazon S3 location of the ZIP archive that contains the exported data definition language (DDL) scripts.

        Note

        DMS populates this field only for the DescribeMetadataModelExportsAsScript operation.

        • S3ObjectKey (string) –

          The Amazon S3 URI of the object that contains the ZIP archive with exported DDL scripts.

        • ObjectURL (string) –

          The URL of the Amazon S3 object that contains the ZIP archive with exported DDL scripts.

      • Progress (dict) –

        Provides information about the progress of the schema conversion operation.

        • ProgressPercent (float) –

          The percent complete for the current step of the schema conversion operation.

        • TotalObjects (integer) –

          The number of objects in this schema conversion operation.

        • ProgressStep (string) –

          The step of the schema conversion operation. This parameter can store one of the following values:

          • IN_PROGRESS – The operation is running.

          • LOADING_METADATA – Loads metadata from the source database.

          • COUNTING_OBJECTS – Determines the number of objects involved in the operation.

          • ANALYZING – Analyzes the source database objects.

          • CONVERTING – Converts the source database objects to a format compatible with the target database.

          • APPLYING – Applies the converted code to the target database.

          • FINISHED – The operation completed successfully.

        • ProcessedObject (dict) –

          The name of the database object that the schema conversion operation currently uses.

          • Name (string) –

            The name of the database object.

          • Type (string) –

            The type of the database object. For example, a table, view, procedure, and so on.

          • EndpointType (string) –

            The type of the data provider. This parameter can store one of the following values: "SOURCE" or "TARGET".

Exceptions