list_batch ¶

def list_batch(
    self,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    max_items: Optional[int] = None,
    starting_token: Optional["capo_omics.types.list_token.ListToken"] = None,
    status: Optional["capo_omics.types.batch_status.BatchStatus"] = None,
    name: Optional["capo_omics.types.batch_name.BatchName"] = None,
    run_group_id: Optional["capo_omics.types.run_group_id.RunGroupId"] = None,
) -> "capo_omics.types.list_batch_response.ListBatchResponse":
    """<p>Returns a list of run batches in your account, with optional filtering by status, name, or run group. Results are paginated. Only one filter per call is supported.</p>

    Args:
        max_items: <p>The maximum number of batches to return. If not specified, defaults to 100.</p>
        starting_token: <p>A pagination token returned from a prior <code>ListBatch</code> call.</p>
        status: <p>Filter batches by status.</p>
        name: <p>Filter batches by name.</p>
        run_group_id: <p>Filter batches by run group ID.</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.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.list_batch_request.ListBatchRequest]",
    ) -> OperationResponse[
        "capo_omics.types.list_batch_response.ListBatchResponse"
    ]:
        import capo_omics._operations.omics.list_batch

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBatch")
    )
    input_: capo_omics.types.list_batch_request.ListBatchRequest = {}
    if max_items is not None:
        input_["max_items"] = max_items
    if starting_token is not None:
        input_["starting_token"] = starting_token
    if status is not None:
        input_["status"] = status
    if name is not None:
        input_["name"] = name
    if run_group_id is not None:
        input_["run_group_id"] = run_group_id

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