Skip to content

OmicsClient#

Index > Omics > OmicsClient

Auto-generated documentation for Omics type annotations stubs module mypy-boto3-omics.

OmicsClient#

Type annotations and code completion for boto3.client("omics"). boto3 documentation

# OmicsClient usage example

from boto3.session import Session
from mypy_boto3_omics.client import OmicsClient

def get_omics_client() -> OmicsClient:
    return Session().client("omics")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("omics").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("omics")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.NotSupportedOperationException,
    client.exceptions.RangeNotSatisfiableException,
    client.exceptions.RequestTimeoutException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_omics.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

abort_multipart_read_set_upload#

Stops a multipart upload.

Type annotations and code completion for boto3.client("omics").abort_multipart_read_set_upload method. boto3 documentation

# abort_multipart_read_set_upload method definition

def abort_multipart_read_set_upload(
    self,
    *,
    sequenceStoreId: str,
    uploadId: str,
) -> Dict[str, Any]:
    ...
# abort_multipart_read_set_upload method usage example with argument unpacking

kwargs: AbortMultipartReadSetUploadRequestRequestTypeDef = {  # (1)
    "sequenceStoreId": ...,
    "uploadId": ...,
}

parent.abort_multipart_read_set_upload(**kwargs)
  1. See AbortMultipartReadSetUploadRequestRequestTypeDef

accept_share#

Accepts a share for an analytics store.

Type annotations and code completion for boto3.client("omics").accept_share method. boto3 documentation

# accept_share method definition

def accept_share(
    self,
    *,
    shareId: str,
) -> AcceptShareResponseTypeDef:  # (1)
    ...
  1. See AcceptShareResponseTypeDef
# accept_share method usage example with argument unpacking

kwargs: AcceptShareRequestRequestTypeDef = {  # (1)
    "shareId": ...,
}

parent.accept_share(**kwargs)
  1. See AcceptShareRequestRequestTypeDef

batch_delete_read_set#

Deletes one or more read sets.

Type annotations and code completion for boto3.client("omics").batch_delete_read_set method. boto3 documentation

# batch_delete_read_set method definition

def batch_delete_read_set(
    self,
    *,
    ids: Sequence[str],
    sequenceStoreId: str,
) -> BatchDeleteReadSetResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteReadSetResponseTypeDef
# batch_delete_read_set method usage example with argument unpacking

kwargs: BatchDeleteReadSetRequestRequestTypeDef = {  # (1)
    "ids": ...,
    "sequenceStoreId": ...,
}

parent.batch_delete_read_set(**kwargs)
  1. See BatchDeleteReadSetRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("omics").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_annotation_import_job#

Cancels an annotation import job.

Type annotations and code completion for boto3.client("omics").cancel_annotation_import_job method. boto3 documentation

# cancel_annotation_import_job method definition

def cancel_annotation_import_job(
    self,
    *,
    jobId: str,
) -> Dict[str, Any]:
    ...
# cancel_annotation_import_job method usage example with argument unpacking

kwargs: CancelAnnotationImportRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.cancel_annotation_import_job(**kwargs)
  1. See CancelAnnotationImportRequestRequestTypeDef

cancel_run#

Cancels a run.

Type annotations and code completion for boto3.client("omics").cancel_run method. boto3 documentation

# cancel_run method definition

def cancel_run(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# cancel_run method usage example with argument unpacking

kwargs: CancelRunRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.cancel_run(**kwargs)
  1. See CancelRunRequestRequestTypeDef

cancel_variant_import_job#

Cancels a variant import job.

Type annotations and code completion for boto3.client("omics").cancel_variant_import_job method. boto3 documentation

# cancel_variant_import_job method definition

def cancel_variant_import_job(
    self,
    *,
    jobId: str,
) -> Dict[str, Any]:
    ...
# cancel_variant_import_job method usage example with argument unpacking

kwargs: CancelVariantImportRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.cancel_variant_import_job(**kwargs)
  1. See CancelVariantImportRequestRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("omics").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

complete_multipart_read_set_upload#

Concludes a multipart upload once you have uploaded all the components.

Type annotations and code completion for boto3.client("omics").complete_multipart_read_set_upload method. boto3 documentation

# complete_multipart_read_set_upload method definition

def complete_multipart_read_set_upload(
    self,
    *,
    sequenceStoreId: str,
    uploadId: str,
    parts: Sequence[CompleteReadSetUploadPartListItemTypeDef],  # (1)
) -> CompleteMultipartReadSetUploadResponseTypeDef:  # (2)
    ...
  1. See CompleteReadSetUploadPartListItemTypeDef
  2. See CompleteMultipartReadSetUploadResponseTypeDef
# complete_multipart_read_set_upload method usage example with argument unpacking

kwargs: CompleteMultipartReadSetUploadRequestRequestTypeDef = {  # (1)
    "sequenceStoreId": ...,
    "uploadId": ...,
    "parts": ...,
}

parent.complete_multipart_read_set_upload(**kwargs)
  1. See CompleteMultipartReadSetUploadRequestRequestTypeDef

create_annotation_store#

Creates an annotation store.

Type annotations and code completion for boto3.client("omics").create_annotation_store method.