IoTSiteWise / Paginator / ListBulkImportJobs

ListBulkImportJobs#

class IoTSiteWise.Paginator.ListBulkImportJobs#
paginator = client.get_paginator('list_bulk_import_jobs')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter='ALL'|'PENDING'|'RUNNING'|'CANCELLED'|'FAILED'|'COMPLETED_WITH_FAILURES'|'COMPLETED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • filter (string) – You can use a filter to select the bulk import jobs that you want to retrieve.

  • 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

{
    'jobSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'status': 'PENDING'|'CANCELLED'|'RUNNING'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • jobSummaries (list) –

      One or more job summaries to list.

      • (dict) –

        Contains a job summary information.

        • id (string) –

          The ID of the job.

        • name (string) –

          The unique name that helps identify the job request.

        • status (string) –

          The status of the bulk import job can be one of following values.

          • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

          • CANCELLED – The bulk import job has been canceled.

          • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

          • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

          • FAILED – IoT SiteWise couldn’t process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

          • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

    • NextToken (string) –

      A token to resume pagination.