AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . dms ]

describe-metadata-model-creations

Description

Returns a paginated list of metadata model creation requests for a migration project, initiated by StartMetadataModelCreation .

To cancel a queued or in-progress request, call CancelMetadataModelCreation .

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

See also: AWS API Documentation

describe-metadata-model-creations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Requests

Synopsis

  describe-metadata-model-creations
[--filters <value>]
--migration-project-identifier <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--filters (list)

The filters to apply to the metadata model creation requests.

The following filter names are supported:

  • request-id – The request identifier.
  • status – The request status. Valid values: RECEIVED , IN_PROGRESS , SUCCESS , FAILED , CANCELING , CANCELED .

(structure)

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)

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

Values -> (list)

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

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--migration-project-identifier (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe metadata model creations

The following describe-metadata-model-creations example retrieves the status of metadata model creation operations identified by their request IDs.

aws dms describe-metadata-model-creations \
    --migration-project-identifier arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS \
    --filters Name=request-id,Values=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,a1b2c3d4-5678-90ab-cdef-EXAMPLE22222,a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

Output:

{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:123456789012:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "No objects were found according to the specified selection rules. Please review your selection rules and try again."
                }
            }
        }
    ]
}

For more information, see Creating statement metadata models in the AWS Database Migration Service User Guide.

Output

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 creation requests.

Note

DMS never populates the ExportSqlDetails field for this operation.

(structure)

Provides information about a schema conversion action.

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 -> (tagged union structure)

Provides error information about a project.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: defaultErrorDetails.

defaultErrorDetails -> (structure)

Error information about a project.

Message -> (string)

The error message.

ExportSqlDetails -> (structure)

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 -> (structure)

Provides information about the progress of the schema conversion operation.

ProgressPercent -> (double)

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

TotalObjects -> (long)

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 -> (structure)

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" .