stop-replication
Description
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn’t deprovision the stopped replications.
See also: AWS API Documentation
Synopsis
stop-replication
--replication-config-arn <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
--replication-config-arn (string)
--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
Replication -> (structure)
The replication that DMS stopped.
ReplicationConfigIdentifier -> (string)
ReplicationConfig associated with the replication.ReplicationConfigArn -> (string)
ReplicationConfig associated with the replication.SourceEndpointArn -> (string)
Endpoint the serverless replication uses for its data source.TargetEndpointArn -> (string)
Endpoint the serverless replication uses for its data target.ReplicationType -> (string)
Status -> (string)
ProvisionData -> (structure)
Information about provisioning resources for an DMS serverless replication.
ProvisionState -> (string)
ProvisionedCapacityUnits -> (integer)
DateProvisioned -> (timestamp)
IsNewProvisioningAvailable -> (boolean)
DateNewProvisioningDataAvailable -> (timestamp)
ReasonForNewProvisioningData -> (string)
PremigrationAssessmentStatuses -> (list)
The status output of premigration assessment in describe-replications.
(structure)
The results returned in describe-replications to display the results of the premigration assessment from the replication configuration.
PremigrationAssessmentRunArn -> (string)
FailOnAssessmentFailure -> (boolean)
true (the defualt setting) or false . Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.Status -> (string)
This describes the assessment run status. The status can be one of the following values:
-
cancelling: The assessment run was canceled. -
deleting: The assessment run was deleted. -
failed: At least one individual assessment completed with a failed status. -
error-provisioning: An internal error occurred while resources were provisioned (during theprovisioningstatus). -
error-executingAn internal error occurred while individual assessments ran (during therunningstatus). -
invalid state: The assessment run is in an unknown state. -
passed: All individual assessments have completed and none have a failed status. -
provisioning: The resources required to run individual assessments are being provisioned. -
running: Individual assessments are being run. -
starting: The assessment run is starting, but resources are not yet being provisioned for individual assessments. -
warning: At least one individual assessment completed with a warning status.
PremigrationAssessmentRunCreationDate -> (timestamp)
AssessmentProgress -> (structure)
The progress values reported by the AssessmentProgress response element.
IndividualAssessmentCount -> (integer)
IndividualAssessmentCompletedCount -> (integer)
LastFailureMessage -> (string)
ResultLocationBucket -> (string)
ResultLocationFolder -> (string)
ResultEncryptionMode -> (string)
SSE_KMS and SSE_S3 . If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects .ResultKmsKeyArn -> (string)
ResultEncryptionMode to SSE_KMS .ResultStatistic -> (structure)
The object containing the result statistics for a completed assessment run.
Passed -> (integer)
Failed -> (integer)
Error -> (integer)
Warning -> (integer)
Cancelled -> (integer)
Skipped -> (integer)
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)
ElapsedTimeMillis -> (long)
TablesLoaded -> (integer)
TablesLoading -> (integer)
TablesQueued -> (integer)
TablesErrored -> (integer)
FreshStartDate -> (timestamp)
StartDate -> (timestamp)
StopDate -> (timestamp)
FullLoadStartDate -> (timestamp)
FullLoadFinishDate -> (timestamp)
StartReplicationType -> (string)
CdcStartTime -> (timestamp)
CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.CdcStartPosition -> (string)
CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.CdcStopPosition -> (string)
RecoveryCheckpoint -> (string)
CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.ReplicationCreateTime -> (timestamp)
ReplicationUpdateTime -> (timestamp)
ReplicationLastStopTime -> (timestamp)
ReplicationDeprovisionTime -> (timestamp)
© Copyright 2025, Amazon Web Services. Created using Sphinx.