Skip to content

start_annotation_import_job async

start_annotation_import_job(
    destination_name: StoreName,
    role_arn: Arn,
    items: AnnotationImportItemSources,
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    version_name: Optional[VersionName] = None,
    format_options: Optional[FormatOptions] = None,
    run_left_normalization: Optional[RunLeftNormalization] = None,
    annotation_fields: Optional[AnnotationFieldMap] = None,
) -> StartAnnotationImportResponse

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.

Starts an annotation import job.

Parameters:

Raises:

Source code in docs_src/capo_omics/_services/async_omics.py
async def start_annotation_import_job(
    self,
    destination_name: "capo_omics.types.store_name.StoreName",
    role_arn: "capo_omics.types.arn.Arn",
    items: "capo_omics.types.annotation_import_item_sources.AnnotationImportItemSources",
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    version_name: Optional["capo_omics.types.version_name.VersionName"] = None,
    format_options: Optional[
        "capo_omics.types.format_options.FormatOptions"
    ] = None,
    run_left_normalization: Optional[
        "capo_omics.types.run_left_normalization.RunLeftNormalization"
    ] = None,
    annotation_fields: Optional[
        "capo_omics.types.annotation_field_map.AnnotationFieldMap"
    ] = None,
) -> "capo_omics.types.start_annotation_import_response.StartAnnotationImportResponse":
    """<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>Starts an annotation import job.</p>

    Args:
        destination_name: <p>A destination annotation store for the job.</p>
        role_arn: <p>A service role for the job.</p>
        items: <p>Items to import.</p>
        version_name: <p> The name of the annotation store version. </p>
        format_options: <p>Formatting options for the annotation file.</p>
        run_left_normalization: <p>The job's left normalization setting.</p>
        annotation_fields: <p>The annotation schema generated by the parsed annotation data.</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.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_annotation_import_request.StartAnnotationImportRequest]",
    ) -> AsyncOperationResponse[
        "capo_omics.types.start_annotation_import_response.StartAnnotationImportResponse"
    ]:
        import capo_omics._operations.omics.start_annotation_import_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartAnnotationImportJob")
    )
    input_: capo_omics.types.start_annotation_import_request.StartAnnotationImportRequest = {
        "destination_name": destination_name,
        "role_arn": role_arn,
        "items": items,
    }
    if version_name is not None:
        input_["version_name"] = version_name
    if format_options is not None:
        input_["format_options"] = format_options
    if run_left_normalization is not None:
        input_["run_left_normalization"] = run_left_normalization
    if annotation_fields is not None:
        input_["annotation_fields"] = annotation_fields

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