Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See code sample for details.
Parameters:
-
next_token
(Optional[String], default:
None
)
–
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
-
max_results
(Optional[PageLimit], default:
None
)
–
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
-
task_status
(Optional[BatchLoadStatus], default:
None
)
–
Status of the batch load task.
Raises:
Source code in docs_src/capo_timestream_write/_services/timestream_write.py
| def list_batch_load_tasks(
self,
*,
config_overrides: Optional[TimestreamWriteClientConfig] = None,
next_token: Optional["capo_timestream_write.types.string.String"] = None,
max_results: Optional[
"capo_timestream_write.types.page_limit.PageLimit"
] = None,
task_status: Optional[
"capo_timestream_write.types.batch_load_status.BatchLoadStatus"
] = None,
) -> "capo_timestream_write.types.list_batch_load_tasks_response.ListBatchLoadTasksResponse":
"""<p>Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html">code sample</a> for details.</p>
Args:
next_token: <p>A token to specify where to start paginating. This is the NextToken from a previously truncated response.</p>
max_results: <p>The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</p>
task_status: <p>Status of the batch load task.</p>
Raises:
capo_timestream_write.errors.access_denied_exception.AccessDeniedException: <p>You are not authorized to perform this action.</p>
capo_timestream_write.errors.internal_server_exception.InternalServerException: <p> Timestream was unable to fully process this request because of an internal server error.</p>
capo_timestream_write.errors.invalid_endpoint_exception.InvalidEndpointException: <p>The requested endpoint was not valid.</p>
capo_timestream_write.errors.throttling_exception.ThrottlingException: <p> Too many requests were made by a user and they exceeded the service quotas. The request was throttled.</p>
capo_timestream_write.errors.validation_exception.ValidationException: <p> An invalid or malformed request.</p>
capo_timestream_write.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_timestream_write.types.list_batch_load_tasks_request.ListBatchLoadTasksRequest]",
) -> OperationResponse[
"capo_timestream_write.types.list_batch_load_tasks_response.ListBatchLoadTasksResponse"
]:
import capo_timestream_write._operations.timestream_20181101.list_batch_load_tasks
output, http_response = (
capo_timestream_write._operations.timestream_20181101.list_batch_load_tasks.list_batch_load_tasks(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListBatchLoadTasks")
)
input_: capo_timestream_write.types.list_batch_load_tasks_request.ListBatchLoadTasksRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if task_status is not None:
input_["task_status"] = task_status
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|