DataZone / Client / list_data_source_runs

list_data_source_runs#

DataZone.Client.list_data_source_runs(**kwargs)#

Lists data source runs in Amazon DataZone.

Request Syntax

response = client.list_data_source_runs(
    dataSourceIdentifier='string',
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    status='REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS'
)

Parameters:

dataSourceIdentifier (string) –
[REQUIRED]

The identifier of the data source.
domainIdentifier (string) –
[REQUIRED]

The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.
maxResults (integer) – The maximum number of runs to return in a single call to ListDataSourceRuns. When the number of runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSourceRuns to list the next set of runs.
nextToken (string) – When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.
status (string) – The status of the data source.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'dataSourceId': '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)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The results of the ListDataSourceRuns action.
  - (dict) –
    
    The details of a data source run.
    - createdAt (datetime) –
      
      The timestamp of when a data source run was created.
    - dataSourceId (string) –
      
      The identifier of the data source of the data source run.
    - errorMessage (dict) –
      
      The details of 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 project ID of the data source run.
    - runStatisticsForAssets (dict) –
      
      The asset statistics from the data source run.
      - 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 a data source run was started.
    - status (string) –
      
      The status of the data source run.
    - stoppedAt (datetime) –
      
      The timestamp of when a data source run was stopped.
    - type (string) –
      
      The type of the data source run.
    - updatedAt (datetime) –
      
      The timestamp of when a data source run was updated.
- nextToken (string) –
  
  When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.

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