Skip to content

start_read_set_export_job async

start_read_set_export_job(
    sequence_store_id: SequenceStoreId,
    destination: S3Destination,
    role_arn: RoleArn,
    sources: ExportReadSetList,
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> StartReadSetExportJobResponse

Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the GetReadSetExportJob API operation.

To monitor the status of the export job, use the ListReadSetExportJobs API operation.

Parameters:

  • sequence_store_id (SequenceStoreId) –

    The read set's sequence store ID.

  • destination (S3Destination) –

    A location for exported files in Amazon S3.

  • role_arn (RoleArn) –

    A service role for the job.

  • client_token (Optional[ClientToken], default: None ) –

    To ensure that jobs don't run multiple times, specify a unique token for each job.

  • sources (ExportReadSetList) –

    The job's source files.

Raises:

Source code in docs_src/capo_omics/_services/async_omics.py
async def start_read_set_export_job(
    self,
    sequence_store_id: "capo_omics.types.sequence_store_id.SequenceStoreId",
    destination: "capo_omics.types.s3_destination.S3Destination",
    role_arn: "capo_omics.types.role_arn.RoleArn",
    sources: "capo_omics.types.export_read_set_list.ExportReadSetList",
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    client_token: Optional["capo_omics.types.client_token.ClientToken"] = None,
) -> "capo_omics.types.start_read_set_export_job_response.StartReadSetExportJobResponse":
    """<p>Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the <code>GetReadSetExportJob</code> API operation.</p> <p>To monitor the status of the export job, use the <code>ListReadSetExportJobs</code> API operation. </p>

    Args:
        sequence_store_id: <p>The read set's sequence store ID.</p>
        destination: <p>A location for exported files in Amazon S3.</p>
        role_arn: <p>A service role for the job.</p>
        client_token: <p>To ensure that jobs don't run multiple times, specify a unique token for each job.</p>
        sources: <p>The job's source files.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_omics.types.start_read_set_export_job_request.StartReadSetExportJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_omics.types.start_read_set_export_job_response.StartReadSetExportJobResponse"
    ]:
        import capo_omics._operations.omics.start_read_set_export_job

        (
            output,
            http_response,
        ) = await capo_omics._operations.omics.start_read_set_export_job.async_start_read_set_export_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartReadSetExportJob")
    )
    input_: capo_omics.types.start_read_set_export_job_request.StartReadSetExportJobRequest = {
        "sequence_store_id": sequence_store_id,
        "destination": destination,
        "role_arn": role_arn,
        "sources": sources,
    }
    if client_token is not None:
        input_["client_token"] = client_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output