Request Syntax Request Parameters Response Elements Errors Examples See Also

DisassociateCreatedArtifact

Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:

A migration user can call the DisassociateCreatedArtifacts operation to disassociate a created AWS Artifact from a migration task.
The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.
Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc.

Request Syntax


{
   "CreatedArtifactName": "string",
   "DryRun": boolean,
   "MigrationTaskName": "string",
   "ProgressUpdateStream": "string"
}

Request Parameters

The request accepts the following data in JSON format.

CreatedArtifactName

An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: arn:[a-z-]+:[a-z0-9-]+:(?:[a-z0-9-]+|):(?:[0-9]{12}|):.*

Required: Yes

DryRun

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Type: Boolean

Required: No

MigrationTaskName

Unique identifier that references the migration task to be disassociated with the artifact. Do not store personal data in this field.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^:|]+

Required: Yes

ProgressUpdateStream

The name of the ProgressUpdateStream.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: [^/:|\000-\037]+

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

DryRunOperation

Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

HTTP Status Code: 400

HomeRegionNotSetException

The home region is not set. Set the home region to continue.

HTTP Status Code: 400

InternalServerError

Exception raised when an internal, configuration, or dependency error is encountered.

HTTP Status Code: 500

InvalidInputException

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

HTTP Status Code: 400

ResourceNotFoundException

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HTTP Status Code: 400

ServiceUnavailableException

Exception raised when there is an internal, configuration, or dependency error encountered.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

Message: A message that provides information about the exception.
RetryAfterSeconds: The number of seconds the caller should wait before retrying.

HTTP Status Code: 400

UnauthorizedOperation

Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".

HTTP Status Code: 400

Examples

Disassociate a created artifact

The following example disassociates an AWS resource from the migration task d-server-0025db43a885966c8 using its ARN formatted name geaws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.

Sample Request



{
   "CreatedArtifactName": "arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b",
   "MigrationTaskName": "sms-12de3cf1a",
   "ProgressUpdateStream": "SMS"
}