Skip to content

create_annotation_store async

create_annotation_store(
    store_format: StoreFormat,
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    reference: Optional[ReferenceItem] = None,
    name: Optional[StoreName] = None,
    description: Optional[Description] = None,
    tags: Optional[TagMap] = None,
    version_name: Optional[VersionName] = None,
    sse_config: Optional[SseConfig] = None,
    store_options: Optional[StoreOptions] = None,
) -> CreateAnnotationStoreResponse

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change.

Creates an annotation store.

Parameters:

  • reference (Optional[ReferenceItem], default: None ) –

    The genome reference for the store's annotations.

  • name (Optional[StoreName], default: None ) –

    A name for the store.

  • description (Optional[Description], default: None ) –

    A description for the store.

  • tags (Optional[TagMap], default: None ) –

    Tags for the store.

  • version_name (Optional[VersionName], default: None ) –

    The name given to an annotation store version to distinguish it from other versions.

  • sse_config (Optional[SseConfig], default: None ) –

    Server-side encryption (SSE) settings for the store.

  • store_format (StoreFormat) –

    The annotation file format of the store.

  • store_options (Optional[StoreOptions], default: None ) –

    File parsing options for the annotation store.

Raises:

Source code in docs_src/capo_omics/_services/async_omics.py
async def create_annotation_store(
    self,
    store_format: "capo_omics.types.store_format.StoreFormat",
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    reference: Optional["capo_omics.types.reference_item.ReferenceItem"] = None,
    name: Optional["capo_omics.types.store_name.StoreName"] = None,
    description: Optional["capo_omics.types.description.Description"] = None,
    tags: Optional["capo_omics.types.tag_map.TagMap"] = None,
    version_name: Optional["capo_omics.types.version_name.VersionName"] = None,
    sse_config: Optional["capo_omics.types.sse_config.SseConfig"] = None,
    store_options: Optional["capo_omics.types.store_options.StoreOptions"] = None,
) -> "capo_omics.types.create_annotation_store_response.CreateAnnotationStoreResponse":
    """<important> <p>Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html"> Amazon Web Services HealthOmics variant store and annotation store availability change</a>.</p> </important> <p>Creates an annotation store.</p>

    Args:
        reference: <p>The genome reference for the store's annotations.</p>
        name: <p>A name for the store.</p>
        description: <p>A description for the store.</p>
        tags: <p>Tags for the store.</p>
        version_name: <p> The name given to an annotation store version to distinguish it from other versions. </p>
        sse_config: <p>Server-side encryption (SSE) settings for the store.</p>
        store_format: <p>The annotation file format of the store.</p>
        store_options: <p>File parsing options for the annotation store.</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.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.create_annotation_store_request.CreateAnnotationStoreRequest]",
    ) -> AsyncOperationResponse[
        "capo_omics.types.create_annotation_store_response.CreateAnnotationStoreResponse"
    ]:
        import capo_omics._operations.omics.create_annotation_store

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateAnnotationStore")
    )
    input_: capo_omics.types.create_annotation_store_request.CreateAnnotationStoreRequest = {
        "store_format": store_format
    }
    if reference is not None:
        input_["reference"] = reference
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags
    if version_name is not None:
        input_["version_name"] = version_name
    if sse_config is not None:
        input_["sse_config"] = sse_config
    if store_options is not None:
        input_["store_options"] = store_options

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