MigrationHub / Client / associate_created_artifact

associate_created_artifact#

MigrationHub.Client.associate_created_artifact(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.associate_created_artifact(
    ProgressUpdateStream='string',
    MigrationTaskName='string',
    CreatedArtifact={
        'Name': 'string',
        'Description': 'string'
    },
    DryRun=True|False
)
Parameters:

  • ProgressUpdateStream (string) –

    [REQUIRED]

    The name of the ProgressUpdateStream.

  • MigrationTaskName (string) –

    [REQUIRED]

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

  • CreatedArtifact (dict) –

    [REQUIRED]

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

    • Name (string) – [REQUIRED]

      An ARN that uniquely identifies the result of a migration task.

    • Description (string) –

      A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions