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 ]

cancel-replication-task-assessment-run

Description

Cancels a single premigration assessment run.

This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.

See also: AWS API Documentation

Synopsis

  cancel-replication-task-assessment-run
--replication-task-assessment-run-arn <value>
[--cli-input-json <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

--replication-task-assessment-run-arn (string)

Amazon Resource Name (ARN) of the premigration assessment run to be canceled.

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

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

ReplicationTaskAssessmentRun -> (structure)

The ReplicationTaskAssessmentRun object for the canceled assessment run.

ReplicationTaskAssessmentRunArn -> (string)

Amazon Resource Name (ARN) of this assessment run.

ReplicationTaskArn -> (string)

ARN of the migration task associated with this premigration assessment run.

Status -> (string)

Assessment run status.

This status can have one of the following values:

  • "cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.
  • "deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.
  • "failed" – At least one individual assessment completed with a failed status.
  • "error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).
  • "error-executing" – An internal error occurred while individual assessments ran (during running status).
  • "invalid state" – The assessment run is in an unknown state.
  • "passed" – All individual assessments have completed, and none has a failed status.
  • "provisioning" – 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.

ReplicationTaskAssessmentRunCreationDate -> (timestamp)

Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.

AssessmentProgress -> (structure)

Indication of the completion progress for the individual assessments specified to run.

IndividualAssessmentCount -> (integer)

The number of individual assessments that are specified to run.

IndividualAssessmentCompletedCount -> (integer)

The number of individual assessments that have completed, successfully or not.

LastFailureMessage -> (string)

Last message generated by an individual assessment failure.

ServiceAccessRoleArn -> (string)

ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.

ResultLocationBucket -> (string)

Amazon S3 bucket where DMS stores the results of this assessment run.

ResultLocationFolder -> (string)

Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.

ResultEncryptionMode -> (string)

Encryption mode used to encrypt the assessment run results.

ResultKmsKeyArn -> (string)

ARN of the KMS encryption key used to encrypt the assessment run results.

AssessmentRunName -> (string)

Unique name of the assessment run.

IsLatestTaskAssessmentRun -> (boolean)

Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.

ResultStatistic -> (structure)

Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.

Passed -> (integer)

The number of individual assessments that successfully passed all checks in the assessment run.

Failed -> (integer)

The number of individual assessments that failed to meet the criteria defined in the assessment run.

Error -> (integer)

The number of individual assessments that encountered a critical error and could not complete properly.

Warning -> (integer)

Indicates that the recent completed AssessmentRun triggered a warning.

Cancelled -> (integer)

The number of individual assessments that were cancelled during the assessment run.