AssociateCreatedArtifact - AWS Migration Hub


Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:

  • Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with 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 DMS endpoint, etc.

Request Syntax

{ "CreatedArtifact": { "Description": "string", "Name": "string" }, "DryRun": boolean, "MigrationTaskName": "string", "ProgressUpdateStream": "string" }

Request Parameters

The request accepts the following data in JSON format.


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

Type: CreatedArtifact object

Required: Yes


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


Unique identifier that references the migration task. Do not store personal data in this field.

Type: String

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

Pattern: [^:|]+

Required: Yes


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.



You do not have sufficient access to perform this action.

HTTP Status Code: 400


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

HTTP Status Code: 400


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

HTTP Status Code: 400


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

HTTP Status Code: 500


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

HTTP Status Code: 400


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


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

HTTP Status Code: 500


The request was denied due to request throttling.

HTTP Status Code: 400


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

HTTP Status Code: 400


Associate a created artifact

The following example associates an AWS resource to the migration task identified by the values passed to the required parameters of MigrationTaskName and ProgressUpdateStream in the request.

Sample Request

{ "CreatedArtifact": [ { "Description": "Using SMS to migrate server to EC2", "Name": "arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b" } ], "DryRun": false, "MigrationTaskName": "sms-12de3cf1a", "ProgressUpdateStream": "SMS" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: