list_bulk_import_jobs

IoTSiteWise.Client.list_bulk_import_jobs(**kwargs)

Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_bulk_import_jobs(
    nextToken='string',
    maxResults=123,
    filter='ALL'|'PENDING'|'RUNNING'|'CANCELLED'|'FAILED'|'COMPLETED_WITH_FAILURES'|'COMPLETED'
)

Parameters

• nextToken (string) -- The token to be used for the next set of paginated results.
• maxResults (integer) -- The maximum number of results to return for each paginated request.
• filter (string) -- You can use a filter to select the bulk import jobs that you want to retrieve.

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) --

    The token for the next set of results, or null if there are no additional results.

Exceptions

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