Skip to content

start_variant_import_job

start_variant_import_job(
    destination_name: StoreName,
    role_arn: Arn,
    items: VariantImportItemSources,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    run_left_normalization: Optional[RunLeftNormalization] = None,
    annotation_fields: Optional[AnnotationFieldMap] = None,
) -> StartVariantImportResponse

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 a variant import job.

Parameters:

Raises:

Source code in docs_src/capo_omics/_services/omics.py
def start_variant_import_job(
    self,
    destination_name: "capo_omics.types.store_name.StoreName",
    role_arn: "capo_omics.types.arn.Arn",
    items: "capo_omics.types.variant_import_item_sources.VariantImportItemSources",
    *,
    config_overrides: Optional[OmicsClientConfig] = 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_variant_import_response.StartVariantImportResponse":
    """<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 a variant import job.</p>

    Args:
        destination_name: <p>The destination variant store for the job.</p>
        role_arn: <p>A service role for the job.</p>
        items: <p>Items to import.</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.
    """

    def _handler(
        req: "OperationRequest[capo_omics.types.start_variant_import_request.StartVariantImportRequest]",
    ) -> OperationResponse[
        "capo_omics.types.start_variant_import_response.StartVariantImportResponse"
    ]:
        import capo_omics._operations.omics.start_variant_import_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartVariantImportJob")
    )
    input_: capo_omics.types.start_variant_import_request.StartVariantImportRequest = {
        "destination_name": destination_name,
        "role_arn": role_arn,
        "items": items,
    }
    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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output