Skip to content

create_reference_store async

create_reference_store(
    name: ReferenceStoreName,
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    description: Optional[ReferenceStoreDescription] = None,
    sse_config: Optional[SseConfig] = None,
    tags: Optional[TagMap] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateReferenceStoreResponse

Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation.

For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

Parameters:

Raises:

Source code in docs_src/capo_omics/_services/async_omics.py
async def create_reference_store(
    self,
    name: "capo_omics.types.reference_store_name.ReferenceStoreName",
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    description: Optional[
        "capo_omics.types.reference_store_description.ReferenceStoreDescription"
    ] = None,
    sse_config: Optional["capo_omics.types.sse_config.SseConfig"] = None,
    tags: Optional["capo_omics.types.tag_map.TagMap"] = None,
    client_token: Optional["capo_omics.types.client_token.ClientToken"] = None,
) -> (
    "capo_omics.types.create_reference_store_response.CreateReferenceStoreResponse"
):
    """<p>Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the <code>StartReferenceImportJob</code> API operation. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html">Creating a HealthOmics reference store</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>

    Args:
        name: <p>A name for the store.</p>
        description: <p>A description for the store.</p>
        sse_config: <p>Server-side encryption (SSE) settings for the store.</p>
        tags: <p>Tags for the store.</p>
        client_token: <p>To ensure that requests don't run multiple times, specify a unique token for each request.</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.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.create_reference_store_request.CreateReferenceStoreRequest]",
    ) -> AsyncOperationResponse[
        "capo_omics.types.create_reference_store_response.CreateReferenceStoreResponse"
    ]:
        import capo_omics._operations.omics.create_reference_store

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateReferenceStore")
    )
    input_: capo_omics.types.create_reference_store_request.CreateReferenceStoreRequest = {
        "name": name
    }
    if description is not None:
        input_["description"] = description
    if sse_config is not None:
        input_["sse_config"] = sse_config
    if tags is not None:
        input_["tags"] = tags
    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