DataSync / Client / describe_discovery_job

describe_discovery_job

DataSync.Client.describe_discovery_job(**kwargs)

Returns information about a DataSync discovery job.

See also: AWS API Documentation

Request Syntax

response = client.describe_discovery_job(
    DiscoveryJobArn='string'
)

Parameters:

DiscoveryJobArn (string) –

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the discovery job that you want information about.

Return type:

dict

Returns:

Response Syntax

{
    'StorageSystemArn': 'string',
    'DiscoveryJobArn': 'string',
    'CollectionDurationMinutes': 123,
    'Status': 'RUNNING'|'WARNING'|'TERMINATED'|'FAILED'|'STOPPED'|'COMPLETED'|'COMPLETED_WITH_ISSUES',
    'JobStartTime': datetime(2015, 1, 1),
    'JobEndTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • StorageSystemArn (string) –

    The ARN of the on-premises storage system you’re running the discovery job on.

  • DiscoveryJobArn (string) –

    The ARN of the discovery job.

  • CollectionDurationMinutes (integer) –

    The number of minutes that the discovery job runs.

  • Status (string) –

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

  • JobStartTime (datetime) –

    The time when the discovery job started.

  • JobEndTime (datetime) –

    The time when the discovery job ended.

Exceptions

• DataSync.Client.exceptions.InvalidRequestException

• DataSync.Client.exceptions.InternalException