Skip to content

get_batch

get_batch(
    batch_id: BatchId, *, config_overrides: Optional[OmicsClientConfig] = None
) -> GetBatchResponse

Retrieves details and current status for a specific run batch, including submission progress and run execution counts.

Parameters:

  • batch_id (BatchId) –

    The identifier portion of the run batch ARN.

Raises:

Source code in docs_src/capo_omics/_services/omics.py
def get_batch(
    self,
    batch_id: "capo_omics.types.batch_id.BatchId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> "capo_omics.types.get_batch_response.GetBatchResponse":
    """<p>Retrieves details and current status for a specific run batch, including submission progress and run execution counts.</p>

    Args:
        batch_id: <p>The identifier portion of the run batch ARN.</p>

    Raises:
        capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
        capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
        capo_omics.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found in the current Region.</p>
        capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_omics.types.get_batch_request.GetBatchRequest]",
    ) -> OperationResponse["capo_omics.types.get_batch_response.GetBatchResponse"]:
        import capo_omics._operations.omics.get_batch

        output, http_response = capo_omics._operations.omics.get_batch.get_batch(
            req.options, req.input
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBatch")
    )
    input_: capo_omics.types.get_batch_request.GetBatchRequest = {
        "batch_id": batch_id
    }

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