Skip to content

get_read_set_export_job

get_read_set_export_job(
    sequence_store_id: SequenceStoreId,
    id: ExportJobId,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> GetReadSetExportJobResponse

Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.

Parameters:

Raises:

Source code in docs_src/capo_omics/_services/omics.py
def get_read_set_export_job(
    self,
    sequence_store_id: "capo_omics.types.sequence_store_id.SequenceStoreId",
    id: "capo_omics.types.export_job_id.ExportJobId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> (
    "capo_omics.types.get_read_set_export_job_response.GetReadSetExportJobResponse"
):
    """<p>Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.</p>

    Args:
        sequence_store_id: <p>The job's sequence store ID.</p>
        id: <p>The job's 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.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_read_set_export_job_request.GetReadSetExportJobRequest]",
    ) -> OperationResponse[
        "capo_omics.types.get_read_set_export_job_response.GetReadSetExportJobResponse"
    ]:
        import capo_omics._operations.omics.get_read_set_export_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetReadSetExportJob")
    )
    input_: capo_omics.types.get_read_set_export_job_request.GetReadSetExportJobRequest = {
        "sequence_store_id": sequence_store_id,
        "id": id,
    }

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