[ aws . dms ]

describe-replications

Description

Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.

See also: AWS API Documentation

Synopsis

  describe-replications
[--filters <value>]
[--max-records <value>]
[--marker <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--filters (list)

Filters applied to the replications.

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

--max-records (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.

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

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 .

Replications -> (list)

The replication descriptions.

(structure)

Provides information that describes a serverless replication created by the CreateReplication operation.

ReplicationConfigIdentifier -> (string)

The identifier for the ReplicationConfig associated with the replication.

ReplicationConfigArn -> (string)

The Amazon Resource Name for the ReplicationConfig associated with the replication.

SourceEndpointArn -> (string)

The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.

TargetEndpointArn -> (string)

The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.

ReplicationType -> (string)

The type of the serverless replication.

Status -> (string)

The current status of the serverless replication.

ProvisionData -> (structure)

Information about provisioning resources for an DMS serverless replication.

ProvisionState -> (string)

The current provisioning state

ProvisionedCapacityUnits -> (integer)

The number of capacity units the replication is using.

DateProvisioned -> (timestamp)

The timestamp when DMS provisioned replication resources.

IsNewProvisioningAvailable -> (boolean)

Whether the new provisioning is available to the replication.

DateNewProvisioningDataAvailable -> (timestamp)

The timestamp when provisioning became available.

ReasonForNewProvisioningData -> (string)

A message describing the reason that DMS provisioned new resources for the serverless replication.

StopReason -> (string)

The reason the replication task was stopped. This response parameter can return one of the following values:

• "Stop Reason NORMAL"
• "Stop Reason RECOVERABLE_ERROR"
• "Stop Reason FATAL_ERROR"
• "Stop Reason FULL_LOAD_ONLY_FINISHED"
• "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied
• "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied
• "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
• "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied
• "Stop Reason STOPPED_DUE_TO_LOW_MEMORY"
• "Stop Reason STOPPED_DUE_TO_LOW_DISK"
• "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task
• "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task
• "Stop Reason RECONFIGURATION_RESTART"
• "Stop Reason RECYCLE_TASK"

FailureMessages -> (list)

Error and other information about why a serverless replication failed.

(string)

ReplicationStats -> (structure)

This object provides a collection of statistics about a serverless replication.

FullLoadProgressPercent -> (integer)

The percent complete for the full load serverless replication.

ElapsedTimeMillis -> (long)

The elapsed time of the replication, in milliseconds.

TablesLoaded -> (integer)

The number of tables loaded for this replication.

TablesLoading -> (integer)

The number of tables currently loading for this replication.

TablesQueued -> (integer)

The number of tables queued for this replication.

TablesErrored -> (integer)

The number of errors that have occured for this replication.

FreshStartDate -> (timestamp)

The date the replication was started either with a fresh start or a target reload.

StartDate -> (timestamp)

The date the replication is scheduled to start.

StopDate -> (timestamp)

The date the replication was stopped.

FullLoadStartDate -> (timestamp)

The date the replication full load was started.

FullLoadFinishDate -> (timestamp)

The date the replication full load was finished.

StartReplicationType -> (string)

The type of replication to start.

CdcStartTime -> (timestamp)

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

CdcStartPosition -> (string)

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

CdcStopPosition -> (string)

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

RecoveryCheckpoint -> (string)

Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

ReplicationCreateTime -> (timestamp)

The time the serverless replication was created.

ReplicationUpdateTime -> (timestamp)

The time the serverless replication was updated.

ReplicationLastStopTime -> (timestamp)

The timestamp when replication was last stopped.

ReplicationDeprovisionTime -> (timestamp)

The timestamp when DMS will deprovision the replication.