MigrationHub / Paginator / ListCreatedArtifacts

ListCreatedArtifacts#

class MigrationHub.Paginator.ListCreatedArtifacts#
paginator = client.get_paginator('list_created_artifacts')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from MigrationHub.Client.list_created_artifacts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ProgressUpdateStream='string',
    MigrationTaskName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • 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.