[ aws . dms ]

start-replication-task-assessment-run

Description

Starts a new premigration assessment run for one or more individual assessments of a migration task.

The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.

See also: AWS API Documentation

Synopsis

  start-replication-task-assessment-run
--replication-task-arn <value>
--service-access-role-arn <value>
--result-location-bucket <value>
[--result-location-folder <value>]
[--result-encryption-mode <value>]
[--result-kms-key-arn <value>]
--assessment-run-name <value>
[--include-only <value>]
[--exclude <value>]
[--tags <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-task-arn (string)

Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

--service-access-role-arn (string)

ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.

--result-location-bucket (string)

Amazon S3 bucket where you want DMS to store the results of this assessment run.

--result-location-folder (string)

Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

--result-encryption-mode (string)

Encryption mode that you can specify to encrypt the results of this assessment run. If you don’t specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:

• "SSE_S3" – The server-side encryption provided as a default by Amazon S3.
• "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.

--result-kms-key-arn (string)

ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS “.

--assessment-run-name (string)

Unique name to identify the assessment run.

--include-only (list)

Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn .

Note

You can’t set a value for IncludeOnly if you also set a value for Exclude in the API operation.

To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

(string)

Syntax:

"string" "string" ...

--exclude (list)

Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn .

Note

You can’t set a value for Exclude if you also set a value for IncludeOnly in the API operation.

To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

(string)

Syntax:

"string" "string" ...

--tags (list)

One or more tags to be assigned to the premigration assessment run that you want to start.

(structure)

A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:

• AddTagsToResource
• ListTagsForResource
• RemoveTagsFromResource

Key -> (string)

A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can’t be prefixed with “aws:” or “dms:”. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regular expressions: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).

Value -> (string)

A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can’t be prefixed with “aws:” or “dms:”. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regular expressions: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).

ResourceArn -> (string)

The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.

Shorthand Syntax:

Key=string,Value=string,ResourceArn=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string",
    "ResourceArn": "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

ReplicationTaskAssessmentRun -> (structure)

The premigration assessment run that was started.

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.