list_runs_in_batch ¶

def list_runs_in_batch(
    self,
    batch_id: "capo_omics.types.batch_id.BatchId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    max_items: Optional[int] = None,
    starting_token: Optional["capo_omics.types.list_token.ListToken"] = None,
    submission_status: Optional[
        "capo_omics.types.submission_status.SubmissionStatus"
    ] = None,
    run_setting_id: Optional[str] = None,
    run_id: Optional[str] = None,
) -> "capo_omics.types.list_runs_in_batch_response.ListRunsInBatchResponse":
    """<p>Returns a paginated list of individual workflow runs within a specific batch. Use this operation to map each <code>runSettingId</code> to its HealthOmics-generated <code>runId</code>, and to check the submission status of each run. Only one filter per call is supported.</p>

    Args:
        batch_id: <p>The identifier portion of the run batch ARN.</p>
        max_items: <p>The maximum number of runs to return.</p>
        starting_token: <p>A pagination token returned from a prior <code>ListRunsInBatch</code> call.</p>
        submission_status: <p>Filter runs by submission status.</p>
        run_setting_id: <p>Filter runs by the customer-provided run setting ID.</p>
        run_id: <p>Filter runs by the HealthOmics-generated run 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.conflict_exception.ConflictException: <p>The request cannot be applied to the target resource in its current state.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</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_runs_in_batch_request.ListRunsInBatchRequest]",
    ) -> OperationResponse[
        "capo_omics.types.list_runs_in_batch_response.ListRunsInBatchResponse"
    ]:
        import capo_omics._operations.omics.list_runs_in_batch

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRunsInBatch")
    )
    input_: capo_omics.types.list_runs_in_batch_request.ListRunsInBatchRequest = {
        "batch_id": batch_id
    }
    if max_items is not None:
        input_["max_items"] = max_items
    if starting_token is not None:
        input_["starting_token"] = starting_token
    if submission_status is not None:
        input_["submission_status"] = submission_status
    if run_setting_id is not None:
        input_["run_setting_id"] = run_setting_id
    if run_id is not None:
        input_["run_id"] = run_id

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