DataSync / Client / start_discovery_job

start_discovery_job#

DataSync.Client.start_discovery_job(**kwargs)#

Runs a DataSync discovery job on your on-premises storage system. If you haven’t added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.

See also: AWS API Documentation

Request Syntax

response = client.start_discovery_job(
    StorageSystemArn='string',
    CollectionDurationMinutes=123,
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • StorageSystemArn (string) –

    [REQUIRED]

    Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.

  • CollectionDurationMinutes (integer) –

    [REQUIRED]

    Specifies in minutes how long you want the discovery job to run.

    Note

    For more accurate recommendations, we recommend a duration of at least 14 days. Longer durations allow time to collect a sufficient number of data points and provide a realistic representation of storage performance and utilization.

  • ClientToken (string) –

    [REQUIRED]

    Specifies a client token to make sure requests with this API operation are idempotent. If you don’t specify a client token, DataSync generates one for you automatically.

    This field is autopopulated if not provided.

  • Tags (list) –

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.

    • (dict) –

      A key-value pair representing a single tag that’s been applied to an Amazon Web Services resource.

      • Key (string) – [REQUIRED]

        The key for an Amazon Web Services resource tag.

      • Value (string) –

        The value for an Amazon Web Services resource tag.

Return type:

dict

Returns:

Response Syntax

{
    'DiscoveryJobArn': 'string'
}

Response Structure

  • (dict) –

    • DiscoveryJobArn (string) –

      The ARN of the discovery job that you started.

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException