MigrationHub / Client / list_created_artifacts

list_created_artifacts#

MigrationHub.Client.list_created_artifacts(**kwargs)#

Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:

  • Gets the list of the created artifacts while migration is taking place.

  • Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API.

  • Lists created artifacts in a paginated interface.

See also: AWS API Documentation

Request Syntax

response = client.list_created_artifacts(
    ProgressUpdateStream='string',
    MigrationTaskName='string',
    NextToken='string',
    MaxResults=123
)
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.

  • NextToken (string) – If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

  • MaxResults (integer) – Maximum number of results to be returned per page.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'CreatedArtifactList': [
        {
            'Name': 'string',
            'Description': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

    • CreatedArtifactList (list) –

      List of created artifacts up to the maximum number of results specified in the request.

      • (dict) –

        An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).

        • Name (string) –

          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.

Exceptions