list_bulk_import_jobs ¶

list_bulk_import_jobs(
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    filter: Optional[ListBulkImportJobsFilter] = None,
    workspace_name: Optional[WorkspaceName] = None,
) -> ListBulkImportJobsResponse

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

Parameters:

next_token (Optional[NextToken], default: None ) –

The token to be used for the next set of paginated results.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return for each paginated request.
filter (Optional[ListBulkImportJobsFilter], default: None ) –

You can use a filter to select the bulk import jobs that you want to retrieve.
workspace_name (Optional[WorkspaceName], default: None ) –

The name of the workspace.

Raises:

InternalFailureException –

IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotsitewise/_services/io_t_site_wise.py

def list_bulk_import_jobs(
    self,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iotsitewise.types.max_results.MaxResults"] = None,
    filter: Optional[
        "capo_iotsitewise.types.list_bulk_import_jobs_filter.ListBulkImportJobsFilter"
    ] = None,
    workspace_name: Optional[
        "capo_iotsitewise.types.workspace_name.WorkspaceName"
    ] = None,
) -> "capo_iotsitewise.types.list_bulk_import_jobs_response.ListBulkImportJobsResponse":
    """<p>Retrieves a paginated list of bulk import job requests. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html">List bulk import jobs (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>

    Args:
        next_token: <p>The token to be used for the next set of paginated results.</p>
        max_results: <p>The maximum number of results to return for each paginated request.</p>
        filter: <p>You can use a filter to select the bulk import jobs that you want to retrieve.</p>
        workspace_name: <p>The name of the workspace.</p>

    Raises:
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.list_bulk_import_jobs_request.ListBulkImportJobsRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.list_bulk_import_jobs_response.ListBulkImportJobsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_bulk_import_jobs

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.list_bulk_import_jobs.list_bulk_import_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBulkImportJobs")
    )
    input_: capo_iotsitewise.types.list_bulk_import_jobs_request.ListBulkImportJobsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filter is not None:
        input_["filter"] = filter
    if workspace_name is not None:
        input_["workspace_name"] = workspace_name

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output