DataSync / Paginator / ListDiscoveryJobs

ListDiscoveryJobs

class DataSync.Paginator.ListDiscoveryJobs

paginator = client.get_paginator('list_discovery_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataSync.Client.list_discovery_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    StorageSystemArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• StorageSystemArn (string) – Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this parameter if you only want to list the discovery jobs that are associated with a specific storage system.

• 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

{
    'DiscoveryJobs': [
        {
            'DiscoveryJobArn': 'string',
            'Status': 'RUNNING'|'WARNING'|'TERMINATED'|'FAILED'|'STOPPED'|'COMPLETED'|'COMPLETED_WITH_ISSUES'
        },
    ],

}

Response Structure

• (dict) –

  • DiscoveryJobs (list) –

    The discovery jobs that you’ve run.

    • (dict) –

      The details about a specific DataSync discovery job.

      • DiscoveryJobArn (string) –

        The Amazon Resource Name (ARN) of a discovery job.

      • Status (string) –

        The status of a discovery job. For more information, see Discovery job statuses.