DataZone / Client / start_data_source_run

start_data_source_run

DataZone.Client.start_data_source_run(**kwargs)

Start the run of the specified data source in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.start_data_source_run(
    clientToken='string',
    dataSourceIdentifier='string',
    domainIdentifier='string'
)

Parameters:

• clientToken (string) –

  A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

  This field is autopopulated if not provided.

• dataSourceIdentifier (string) –

  [REQUIRED]

  The identifier of the data source.

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain in which to start a data source run.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'dataSourceConfigurationSnapshot': 'string',
    'dataSourceId': 'string',
    'domainId': 'string',
    'errorMessage': {
        'errorDetail': 'string',
        'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
    },
    'id': 'string',
    'projectId': 'string',
    'runStatisticsForAssets': {
        'added': 123,
        'failed': 123,
        'skipped': 123,
        'unchanged': 123,
        'updated': 123
    },
    'startedAt': datetime(2015, 1, 1),
    'status': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS',
    'stoppedAt': datetime(2015, 1, 1),
    'type': 'PRIORITIZED'|'SCHEDULED',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • createdAt (datetime) –

    The timestamp of when data source run was created.

  • dataSourceConfigurationSnapshot (string) –

    The configuration snapshot of the data source that is being run.

  • dataSourceId (string) –

    The identifier of the data source.

  • domainId (string) –

    The identifier of the Amazon DataZone domain in which to start a data source run.

  • errorMessage (dict) –

    Specifies the error message that is returned if the operation cannot be successfully completed.

    • errorDetail (string) –

      The details of the error message that is returned if the operation cannot be successfully completed.

    • errorType (string) –

      The type of the error message that is returned if the operation cannot be successfully completed.

  • id (string) –

    The identifier of the data source run.

  • projectId (string) –

    The identifier of the project.

  • runStatisticsForAssets (dict) –

    Specifies run statistics for assets.

    • added (integer) –

      The added statistic for the data source run.

    • failed (integer) –

      The failed statistic for the data source run.

    • skipped (integer) –

      The skipped statistic for the data source run.

    • unchanged (integer) –

      The unchanged statistic for the data source run.

    • updated (integer) –

      The updated statistic for the data source run.

  • startedAt (datetime) –

    The timestamp of when the data source run was started.

  • status (string) –

    The status of the data source run.

  • stoppedAt (datetime) –

    The timestamp of when the data source run was stopped.

  • type (string) –

    The type of the data source run.

  • updatedAt (datetime) –

    The timestamp of when the data source run was updated.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ServiceQuotaExceededException

• DataZone.Client.exceptions.ConflictException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException