IoTSiteWise / Client / list_dataset_export_jobs

list_dataset_export_jobs¶

IoTSiteWise.Client.list_dataset_export_jobs(**kwargs)¶

Retrieves a paginated list of dataset export jobs for a workspace.

Request Syntax

response = client.list_dataset_export_jobs(
    workspaceName='string',
    filter='ALL'|'SUBMITTED'|'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
    maxResults=123,
    nextToken='string'
)

Parameters:

workspaceName (string) –
[REQUIRED]

The name of the workspace whose dataset export jobs should be listed.
filter (string) – The optional filter that returns only jobs matching the given filter value. Defaults to ALL.
maxResults (integer) – The maximum number of results to return for each paginated request.
nextToken (string) – The token to be used for the next set of paginated results.

Return type:

dict

Returns:

Response Syntax

{
    'jobs': [
        {
            'jobId': 'string',
            'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
            'startedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1),
            'destinationS3Uri': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Response for list dataset export jobs request.
- jobs (list) –
 
 A list of dataset export job summaries.
 - (dict) – Contains summary information about a dataset export job.
 - jobId (string) – The unique identifier for the dataset export job.
 - status (string) – The current status of the dataset export job.
 - startedAt (datetime) – The timestamp when the job started processing.
 - completedAt (datetime) – The timestamp when the job completed, or null if the job is still running.
 - destinationS3Uri (string) – The S3 URI where output clips are written.
- nextToken (string) –
 
 The token for the next set of results, or null if there are no additional results.

Exceptions

IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.AccessDeniedException
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.ThrottlingException