MigrationHub / Paginator / ListSourceResources

ListSourceResources

class MigrationHub.Paginator.ListSourceResources

paginator = client.get_paginator('list_source_resources')

paginate(**kwargs)

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

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 progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

• MigrationTaskName (string) –

  [REQUIRED]

  A unique identifier that references the migration task. Do not store confidential 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

{
    'SourceResourceList': [
        {
            'Name': 'string',
            'Description': 'string',
            'StatusDetail': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • SourceResourceList (list) –

    The list of source resources.

    • (dict) –

      A source resource can be a source server, a migration wave, an application, or any other resource that you track.

      • Name (string) –

        This is the name that you want to use to identify the resource. If the resource is an AWS resource, we recommend that you set this parameter to the ARN of the resource.

      • Description (string) –

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

      • StatusDetail (string) –

        A free-form description of the status of the resource.