[ 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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  cancel-replication-task-assessment-run
--replication-task-assessment-run-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

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

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

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

See ‘aws help’ for descriptions of global parameters.

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.

ResultLocationBucket -> (string)

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

ResultLocationFolder -> (string)

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

ResultEncryptionMode -> (string)

Encryption mode used to encrypt the assessment run results.

ResultKmsKeyArn -> (string)

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

AssessmentRunName -> (string)

Unique name of the assessment run.