IoTSiteWise / Paginator / ListDatasetExportJobs

ListDatasetExportJobs

class IoTSiteWise.Paginator.ListDatasetExportJobs

paginator = client.get_paginator('list_dataset_export_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_dataset_export_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    workspaceName='string',
    filter='ALL'|'SUBMITTED'|'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) – <p>Contains summary information about a dataset export job.</p>

      • jobId (string) – <p>The unique identifier for the dataset export job.</p>

      • status (string) – <p>The current status of the dataset export job.</p>

      • startedAt (datetime) – <p>The timestamp when the job started processing.</p>

      • completedAt (datetime) – <p>The timestamp when the job completed, or null if the job is still running.</p>

      • destinationS3Uri (string) – <p>The S3 URI where output clips are written.</p>

  • NextToken (string) –

    A token to resume pagination.