Skip to content

get_run

get_run(
    id: RunId,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    export: Optional[RunExportList] = None,
) -> GetRunResponse

Gets detailed information about a specific run using its ID.

Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If GetRun does not return the requested run, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

Parameters:

Raises:

Source code in docs_src/capo_omics/_services/omics.py
def get_run(
    self,
    id: "capo_omics.types.run_id.RunId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    export: Optional["capo_omics.types.run_export_list.RunExportList"] = None,
) -> "capo_omics.types.get_run_response.GetRunResponse":
    """<p>Gets detailed information about a specific run using its ID.</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 <code>GetRun</code> does not return the requested run, 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:
        id: <p>The run's ID.</p>
        export: <p>The run's export format.</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.get_run_request.GetRunRequest]",
    ) -> OperationResponse["capo_omics.types.get_run_response.GetRunResponse"]:
        import capo_omics._operations.omics.get_run

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRun")
    )
    input_: capo_omics.types.get_run_request.GetRunRequest = {"id": id}
    if export is not None:
        input_["export"] = export

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