Skip to content

describe_batch_load_task

describe_batch_load_task(
    task_id: BatchLoadTaskId,
    *,
    config_overrides: Optional[TimestreamWriteClientConfig] = None,
) -> DescribeBatchLoadTaskResponse

Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.

Parameters:

Raises:

Source code in docs_src/capo_timestream_write/_services/timestream_write.py
def describe_batch_load_task(
    self,
    task_id: "capo_timestream_write.types.batch_load_task_id.BatchLoadTaskId",
    *,
    config_overrides: Optional[TimestreamWriteClientConfig] = None,
) -> "capo_timestream_write.types.describe_batch_load_task_response.DescribeBatchLoadTaskResponse":
    """<p>Returns information about the batch load task, including configurations, mappings, progress, and other details. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html">code sample</a> for details.</p>

    Args:
        task_id: <p>The ID 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.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.</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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_timestream_write.types.describe_batch_load_task_request.DescribeBatchLoadTaskRequest]",
    ) -> OperationResponse[
        "capo_timestream_write.types.describe_batch_load_task_response.DescribeBatchLoadTaskResponse"
    ]:
        import capo_timestream_write._operations.timestream_20181101.describe_batch_load_task

        output, http_response = (
            capo_timestream_write._operations.timestream_20181101.describe_batch_load_task.describe_batch_load_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeBatchLoadTask")
    )
    input_: capo_timestream_write.types.describe_batch_load_task_request.DescribeBatchLoadTaskRequest = {
        "task_id": task_id
    }

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