list_runs ¶

def list_runs(
    self,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    name: Optional["capo_omics.types.run_name.RunName"] = None,
    run_group_id: Optional["capo_omics.types.run_group_id.RunGroupId"] = None,
    batch_id: Optional["capo_omics.types.batch_id.BatchId"] = None,
    starting_token: Optional["capo_omics.types.run_list_token.RunListToken"] = None,
    max_results: Optional[int] = None,
    status: Optional["capo_omics.types.run_status.RunStatus"] = None,
) -> "capo_omics.types.list_runs_response.ListRunsResponse":
    """<p>Retrieves a list of runs and returns each run's metadata and status.</p> <p>Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the <code>ListRuns</code> response doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see <a href="https://docs.aws.amazon.com/omics/latest/dev/monitoring-cloudwatch-logs.html">CloudWatch logs</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>

    Args:
        name: <p>Filter the list by run name.</p>
        run_group_id: <p>Filter the list by run group ID.</p>
        batch_id: <p>Filter by batch ID.</p>
        starting_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        max_results: <p>The maximum number of runs to return in one page of results.</p>
        status: <p>The status of a run.</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_request.ListRunsRequest]",
    ) -> OperationResponse["capo_omics.types.list_runs_response.ListRunsResponse"]:
        import capo_omics._operations.omics.list_runs

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRuns")
    )
    input_: capo_omics.types.list_runs_request.ListRunsRequest = {}
    if name is not None:
        input_["name"] = name
    if run_group_id is not None:
        input_["run_group_id"] = run_group_id
    if batch_id is not None:
        input_["batch_id"] = batch_id
    if starting_token is not None:
        input_["starting_token"] = starting_token
    if max_results is not None:
        input_["max_results"] = max_results
    if status is not None:
        input_["status"] = status

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