DataSync / Client / list_discovery_jobs

list_discovery_jobs#

DataSync.Client.list_discovery_jobs(**kwargs)#

Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you’re using DataSync Discovery.

See also: AWS API Documentation

Request Syntax

response = client.list_discovery_jobs(
    StorageSystemArn='string',
    MaxResults=123,
    NextToken='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.

  • MaxResults (integer) – Specifies how many results you want in the response.

  • NextToken (string) – Specifies an opaque string that indicates the position to begin the next list of results in the response.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      The opaque string that indicates the position to begin the next list of results in the response.

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException