AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . dms ]

describe-data-migrations

Description

Returns information about data migrations.

See also: AWS API Documentation

describe-data-migrations 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: DataMigrations

Synopsis

  describe-data-migrations
[--filters <value>]
[--without-settings | --no-without-settings]
[--without-statistics | --no-without-statistics]
[--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>]

Options

--filters (list)

Filters applied to the data migrations.

(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", ...]
  }
  ...
]

--without-settings | --no-without-settings (boolean)

An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose true ; otherwise, choose false (the default).

--without-statistics | --no-without-statistics (boolean)

An option to set to avoid returning information about statistics. Use this to reduce overhead when statistics information is too large. To use this option, choose true ; otherwise, choose false (the default).

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

Output

DataMigrations -> (list)

Returns information about the data migrations used in the project.

(structure)

This object provides information about a DMS data migration.

DataMigrationName -> (string)

The user-friendly name for the data migration.

DataMigrationArn -> (string)

The Amazon Resource Name (ARN) that identifies this replication.

DataMigrationCreateTime -> (timestamp)

The UTC time when DMS created the data migration.

DataMigrationStartTime -> (timestamp)

The UTC time when DMS started the data migration.

DataMigrationEndTime -> (timestamp)

The UTC time when data migration ended.

ServiceAccessRoleArn -> (string)

The IAM role that the data migration uses to access Amazon Web Services resources.

MigrationProjectArn -> (string)

The Amazon Resource Name (ARN) of the data migration's associated migration project.

DataMigrationType -> (string)

Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

DataMigrationSettings -> (structure)

Specifies CloudWatch settings and selection rules for the data migration.

NumberOfJobs -> (integer)

The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

CloudwatchLogsEnabled -> (boolean)

Whether to enable CloudWatch logging for the data migration.

SelectionRules -> (string)

A JSON-formatted string that defines what objects to include and exclude from the migration.

SourceDataSettings -> (list)

Specifies information about the data migration's source data provider.

(structure)

Defines settings for a source data provider for a data migration.

CDCStartPosition -> (string)

The change data capture (CDC) start position for the source data provider.

CDCStartTime -> (timestamp)

The change data capture (CDC) start time for the source data provider.

CDCStopTime -> (timestamp)

The change data capture (CDC) stop time for the source data provider.

SlotName -> (string)

The name of the replication slot on the source data provider. This attribute is only valid for a PostgreSQL or Aurora PostgreSQL source.

DataMigrationStatistics -> (structure)

Provides information about the data migration's run, including start and stop time, latency, and data migration progress.

TablesLoaded -> (integer)

The number of tables loaded in the current data migration run.

ElapsedTimeMillis -> (long)

The elapsed duration of the data migration run.

TablesLoading -> (integer)

The data migration's table loading progress.

FullLoadPercentage -> (integer)

The data migration's progress in the full-load migration phase.

CDCLatency -> (integer)

The current latency of the change data capture (CDC) operation.

TablesQueued -> (integer)

The number of tables that are waiting for processing.

TablesErrored -> (integer)

The number of tables that DMS failed to process.

StartTime -> (timestamp)

The time when the migration started.

StopTime -> (timestamp)

The time when the migration stopped or failed.

DataMigrationStatus -> (string)

The current status of the data migration.

PublicIpAddresses -> (list)

The IP addresses of the endpoints for the data migration.

(string)

DataMigrationCidrBlocks -> (list)

The CIDR blocks of the endpoints for the data migration.

(string)

LastFailureMessage -> (string)

Information about the data migration's most recent error or failure.

StopReason -> (string)

The reason the data migration last stopped.

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 .