listBulkImportJobs method

Future<ListBulkImportJobsResponse> listBulkImportJobs({
  1. ListBulkImportJobsFilter? filter,
  2. int? maxResults,
  3. String? nextToken,
  4. String? workspaceName,
})

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

May throw InternalFailureException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

Parameter filter : You can use a filter to select the bulk import jobs that you want to retrieve.

Parameter maxResults : The maximum number of results to return for each paginated request.

Parameter nextToken : The token to be used for the next set of paginated results.

Parameter workspaceName : The name of the workspace.

Implementation

Future<ListBulkImportJobsResponse> listBulkImportJobs({
  ListBulkImportJobsFilter? filter,
  int? maxResults,
  String? nextToken,
  String? workspaceName,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    250,
  );
  final $query = <String, List<String>>{
    if (filter != null) 'filter': [filter.value],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
    if (workspaceName != null) 'workspaceName': [workspaceName],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/jobs',
    queryParams: $query,
    hostPrefix: 'data.',
    exceptionFnMap: _exceptionFns,
  );
  return ListBulkImportJobsResponse.fromJson(response);
}