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

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.

Usage example

client = boto3.client("omics")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.RangeNotSatisfiableException,
    client.RequestTimeoutException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_omics.client import Exceptions

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

Methods

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

Method definition

def batch_delete_read_set(
    self,
    *,
    ids: Sequence[str],
    sequenceStoreId: str,
) -> BatchDeleteReadSetResponseTypeDef:  # (1)
    ...

1. See BatchDeleteReadSetResponseTypeDef

Usage example with kwargs

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

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

Method definition

def cancel_annotation_import_job(
    self,
    *,
    jobId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def cancel_run(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

Method definition

def cancel_variant_import_job(
    self,
    *,
    jobId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

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

create_annotation_store

Creates an annotation store.

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

Method definition

def create_annotation_store(
    self,
    *,
    storeFormat: StoreFormatType,  # (1)
    description: str = ...,
    name: str = ...,
    reference: ReferenceItemTypeDef = ...,  # (2)
    sseConfig: SseConfigTypeDef = ...,  # (3)
    storeOptions: StoreOptionsTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateAnnotationStoreResponseTypeDef:  # (5)
    ...

1. See StoreFormatType
2. See ReferenceItemTypeDef
3. See SseConfigTypeDef
4. See StoreOptionsTypeDef
5. See CreateAnnotationStoreResponseTypeDef

Usage example with kwargs

kwargs: CreateAnnotationStoreRequestRequestTypeDef = {  # (1)
    "storeFormat": ...,
}

parent.create_annotation_store(**kwargs)

1. See CreateAnnotationStoreRequestRequestTypeDef

create_reference_store

Creates a reference store.

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

Method definition

def create_reference_store(
    self,
    *,
    name: str,
    clientToken: str = ...,
    description: str = ...,
    sseConfig: SseConfigTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateReferenceStoreResponseTypeDef:  # (2)
    ...

1. See SseConfigTypeDef
2. See CreateReferenceStoreResponseTypeDef

Usage example with kwargs

kwargs: CreateReferenceStoreRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_reference_store(**kwargs)

1. See CreateReferenceStoreRequestRequestTypeDef

create_run_group

Creates a run group.

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

Method definition

def create_run_group(
    self,
    *,
    requestId: str,
    maxCpus: int = ...,
    maxDuration: int = ...,
    maxRuns: int = ...,
    name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRunGroupResponseTypeDef:  # (1)
    ...

1. See CreateRunGroupResponseTypeDef

Usage example with kwargs

kwargs: CreateRunGroupRequestRequestTypeDef = {  # (1)
    "requestId": ...,
}

parent.create_run_group(**kwargs)

1. See CreateRunGroupRequestRequestTypeDef

create_sequence_store

Creates a sequence store.

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

Method definition

def create_sequence_store(
    self,
    *,
    name: str,
    clientToken: str = ...,
    description: str = ...,
    sseConfig: SseConfigTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateSequenceStoreResponseTypeDef:  # (2)
    ...

1. See SseConfigTypeDef
2. See CreateSequenceStoreResponseTypeDef

Usage example with kwargs

kwargs: CreateSequenceStoreRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_sequence_store(**kwargs)

1. See CreateSequenceStoreRequestRequestTypeDef

create_variant_store

Creates a variant store.

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

Method definition

def create_variant_store(
    self,
    *,
    reference: ReferenceItemTypeDef,  # (1)
    description: str = ...,
    name: str = ...,
    sseConfig: SseConfigTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateVariantStoreResponseTypeDef:  # (3)
    ...

1. See ReferenceItemTypeDef
2. See SseConfigTypeDef
3. See CreateVariantStoreResponseTypeDef

Usage example with kwargs

kwargs: CreateVariantStoreRequestRequestTypeDef = {  # (1)
    "reference": ...,
}

parent.create_variant_store(**kwargs)

1. See CreateVariantStoreRequestRequestTypeDef

create_workflow

Creates a workflow.

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

Method definition

def create_workflow(
    self,
    *,
    requestId: str,
    definitionUri: str = ...,
    definitionZip: Union[str, bytes, IO[Any], StreamingBody] = ...,
    description: str = ...,
    engine: WorkflowEngineType = ...,  # (1)
    main: str = ...,
    name: str = ...,
    parameterTemplate: Mapping[str, WorkflowParameterTypeDef] = ...,  # (2)
    storageCapacity: int = ...,
    tags: Mapping[str, str] = ...,
) -> CreateWorkflowResponseTypeDef:  # (3)
    ...

1. See WorkflowEngineType
2. See WorkflowParameterTypeDef
3. See CreateWorkflowResponseTypeDef

Usage example with kwargs

kwargs: CreateWorkflowRequestRequestTypeDef = {  # (1)
    "requestId": ...,
}

parent.create_workflow(**kwargs)

1. See CreateWorkflowRequestRequestTypeDef

delete_annotation_store

Deletes an annotation store.

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

Method definition

def delete_annotation_store(
    self,
    *,
    name: str,
    force: bool = ...,
) -> DeleteAnnotationStoreResponseTypeDef:  # (1)
    ...

1. See DeleteAnnotationStoreResponseTypeDef

Usage example with kwargs

kwargs: DeleteAnnotationStoreRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_annotation_store(**kwargs)

1. See DeleteAnnotationStoreRequestRequestTypeDef

delete_reference

Deletes a genome reference.

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

Method definition

def delete_reference(
    self,
    *,
    id: str,
    referenceStoreId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_reference(**kwargs)

1. See DeleteReferenceRequestRequestTypeDef

delete_reference_store

Deletes a genome reference store.

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

Method definition

def delete_reference_store(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_reference_store(**kwargs)

1. See DeleteReferenceStoreRequestRequestTypeDef

delete_run

Deletes a workflow run.

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

Method definition

def delete_run(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_run(**kwargs)

1. See DeleteRunRequestRequestTypeDef

delete_run_group

Deletes a workflow run group.

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

Method definition

def delete_run_group(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_run_group(**kwargs)

1. See DeleteRunGroupRequestRequestTypeDef

delete_sequence_store

Deletes a sequence store.

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

Method definition

def delete_sequence_store(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_sequence_store(**kwargs)

1. See DeleteSequenceStoreRequestRequestTypeDef

delete_variant_store

Deletes a variant store.

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

Method definition

def delete_variant_store(
    self,
    *,
    name: str,
    force: bool = ...,
) -> DeleteVariantStoreResponseTypeDef:  # (1)
    ...

1. See DeleteVariantStoreResponseTypeDef

Usage example with kwargs

kwargs: DeleteVariantStoreRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_variant_store(**kwargs)

1. See DeleteVariantStoreRequestRequestTypeDef

delete_workflow

Deletes a workflow.

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

Method definition

def delete_workflow(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_workflow(**kwargs)

1. See DeleteWorkflowRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_annotation_import_job

Gets information about an annotation import job.

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

Method definition

def get_annotation_import_job(
    self,
    *,
    jobId: str,
) -> GetAnnotationImportResponseTypeDef:  # (1)
    ...

1. See GetAnnotationImportResponseTypeDef

Usage example with kwargs

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

parent.get_annotation_import_job(**kwargs)

1. See GetAnnotationImportRequestRequestTypeDef

get_annotation_store

Gets information about an annotation store.

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

Method definition

def get_annotation_store(
    self,
    *,
    name: str,
) -> GetAnnotationStoreResponseTypeDef:  # (1)
    ...

1. See GetAnnotationStoreResponseTypeDef

Usage example with kwargs

kwargs: GetAnnotationStoreRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_annotation_store(**kwargs)

1. See GetAnnotationStoreRequestRequestTypeDef

get_read_set

Gets a file from a read set.

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

Method definition

def get_read_set(
    self,
    *,
    id: str,
    partNumber: int,
    sequenceStoreId: str,
    file: ReadSetFileType = ...,  # (1)
) -> GetReadSetResponseTypeDef:  # (2)
    ...

1. See ReadSetFileType
2. See GetReadSetResponseTypeDef

Usage example with kwargs

kwargs: GetReadSetRequestRequestTypeDef = {  # (1)
    "id": ...,
    "partNumber": ...,
    "sequenceStoreId": ...,
}

parent.get_read_set(**kwargs)

1. See GetReadSetRequestRequestTypeDef

get_read_set_activation_job

Gets information about a read set activation job.

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

Method definition

def get_read_set_activation_job(
    self,
    *,
    id: str,
    sequenceStoreId: str,
) -> GetReadSetActivationJobResponseTypeDef:  # (1)
    ...

1. See GetReadSetActivationJobResponseTypeDef

Usage example with kwargs

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

parent.get_read_set_activation_job(**kwargs)

1. See GetReadSetActivationJobRequestRequestTypeDef

get_read_set_export_job

Gets information about a read set export job.

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

Method definition

def get_read_set_export_job(
    self,
    *,
    id: str,
    sequenceStoreId: str,
) -> GetReadSetExportJobResponseTypeDef:  # (1)
    ...

1. See GetReadSetExportJobResponseTypeDef

Usage example with kwargs

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

parent.get_read_set_export_job(**kwargs)

1. See GetReadSetExportJobRequestRequestTypeDef

get_read_set_import_job

Gets information about a read set import job.

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

Method definition

def get_read_set_import_job(
    self,
    *,
    id: str,
    sequenceStoreId: str,
) -> GetReadSetImportJobResponseTypeDef:  # (1)
    ...

1. See GetReadSetImportJobResponseTypeDef

Usage example with kwargs

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

parent.get_read_set_import_job(**kwargs)

1. See GetReadSetImportJobRequestRequestTypeDef

get_read_set_metadata

Gets details about a read set.

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

Method definition

def get_read_set_metadata(
    self,
    *,
    id: str,
    sequenceStoreId: str,
) -> GetReadSetMetadataResponseTypeDef:  # (1)
    ...

1. See GetReadSetMetadataResponseTypeDef

Usage example with kwargs

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

parent.get_read_set_metadata(**kwargs)

1. See GetReadSetMetadataRequestRequestTypeDef

get_reference

Gets a reference file.

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

Method definition

def get_reference(
    self,
    *,
    id: str,
    partNumber: int,
    referenceStoreId: str,
    file: ReferenceFileType = ...,  # (1)
    range: str = ...,
) -> GetReferenceResponseTypeDef:  # (2)
    ...

1. See ReferenceFileType
2. See GetReferenceResponseTypeDef

Usage example with kwargs

kwargs: GetReferenceRequestRequestTypeDef = {  # (1)
    "id": ...,
    "partNumber": ...,
    "referenceStoreId": ...,
}

parent.get_reference(**kwargs)

1. See GetReferenceRequestRequestTypeDef

get_reference_import_job

Gets information about a reference import job.

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

Method definition

def get_reference_import_job(
    self,
    *,
    id: str,
    referenceStoreId: str,
) -> GetReferenceImportJobResponseTypeDef:  # (1)
    ...

1. See GetReferenceImportJobResponseTypeDef

Usage example with kwargs

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

parent.get_reference_import_job(**kwargs)

1. See GetReferenceImportJobRequestRequestTypeDef

get_reference_metadata

Gets information about a genome reference's metadata.

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

Method definition

def get_reference_metadata(
    self,
    *,
    id: str,
    referenceStoreId: str,
) -> GetReferenceMetadataResponseTypeDef:  # (1)
    ...

1. See GetReferenceMetadataResponseTypeDef

Usage example with kwargs

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

parent.get_reference_metadata(**kwargs)

1. See GetReferenceMetadataRequestRequestTypeDef

get_reference_store

Gets information about a reference store.

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

Method definition

def get_reference_store(
    self,
    *,
    id: str,
) -> GetReferenceStoreResponseTypeDef:  # (1)
    ...

1. See GetReferenceStoreResponseTypeDef

Usage example with kwargs

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

parent.get_reference_store(**kwargs)

1. See GetReferenceStoreRequestRequestTypeDef

get_run

Gets information about a workflow run.

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

Method definition

def get_run(
    self,
    *,
    id: str,
    export: Sequence[RunExportType] = ...,  # (1)
) -> GetRunResponseTypeDef:  # (2)
    ...

1. See RunExportType
2. See GetRunResponseTypeDef

Usage example with kwargs

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

parent.get_run(**kwargs)

1. See GetRunRequestRequestTypeDef

get_run_group

Gets information about a workflow run group.

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

Method definition

def get_run_group(
    self,
    *,
    id: str,
) -> GetRunGroupResponseTypeDef:  # (1)
    ...

1. See GetRunGroupResponseTypeDef

Usage example with kwargs

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

parent.get_run_group(**kwargs)

1. See GetRunGroupRequestRequestTypeDef

get_run_task

Gets information about a workflow run task.

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

Method definition

def get_run_task(
    self,
    *,
    id: str,
    taskId: str,
) -> GetRunTaskResponseTypeDef:  # (1)
    ...

1. See GetRunTaskResponseTypeDef

Usage example with kwargs

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

parent.get_run_task(**kwargs)

1. See GetRunTaskRequestRequestTypeDef

get_sequence_store

Gets information about a sequence store.

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

Method definition

def get_sequence_store(
    self,
    *,
    id: str,
) -> GetSequenceStoreResponseTypeDef:  # (1)
    ...

1. See GetSequenceStoreResponseTypeDef

Usage example with kwargs

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

parent.get_sequence_store(**kwargs)

1. See GetSequenceStoreRequestRequestTypeDef

get_variant_import_job

Gets information about a variant import job.

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

Method definition

def get_variant_import_job(
    self,
    *,
    jobId: str,
) -> GetVariantImportResponseTypeDef:  # (1)
    ...

1. See GetVariantImportResponseTypeDef

Usage example with kwargs

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

parent.get_variant_import_job(**kwargs)

1. See GetVariantImportRequestRequestTypeDef

get_variant_store

Gets information about a variant store.

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

Method definition

def get_variant_store(
    self,
    *,
    name: str,
) -> GetVariantStoreResponseTypeDef:  # (1)
    ...

1. See GetVariantStoreResponseTypeDef

Usage example with kwargs

kwargs: GetVariantStoreRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_variant_store(**kwargs)

1. See GetVariantStoreRequestRequestTypeDef

get_workflow

Gets information about a workflow.

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

Method definition

def get_workflow(
    self,
    *,
    id: str,
    export: Sequence[WorkflowExportType] = ...,  # (1)
    type: WorkflowTypeType = ...,  # (2)
) -> GetWorkflowResponseTypeDef:  # (3)
    ...

1. See WorkflowExportType
2. See WorkflowTypeType
3. See GetWorkflowResponseTypeDef

Usage example with kwargs

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

parent.get_workflow(**kwargs)

1. See GetWorkflowRequestRequestTypeDef

list_annotation_import_jobs

Retrieves a list of annotation import jobs.

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

Method definition

def list_annotation_import_jobs(
    self,
    *,
    filter: ListAnnotationImportJobsFilterTypeDef = ...,  # (1)
    ids: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAnnotationImportJobsResponseTypeDef:  # (2)
    ...

1. See ListAnnotationImportJobsFilterTypeDef
2. See ListAnnotationImportJobsResponseTypeDef

Usage example with kwargs

kwargs: ListAnnotationImportJobsRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_annotation_import_jobs(**kwargs)

1. See ListAnnotationImportJobsRequestRequestTypeDef

list_annotation_stores

Retrieves a list of annotation stores.

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

Method definition

def list_annotation_stores(
    self,
    *,
    filter: ListAnnotationStoresFilterTypeDef = ...,  # (1)
    ids: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAnnotationStoresResponseTypeDef:  # (2)
    ...

1. See ListAnnotationStoresFilterTypeDef
2. See ListAnnotationStoresResponseTypeDef

Usage example with kwargs

kwargs: ListAnnotationStoresRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_annotation_stores(**kwargs)

1. See ListAnnotationStoresRequestRequestTypeDef

list_read_set_activation_jobs

Retrieves a list of read set activation jobs.

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

Method definition

def list_read_set_activation_jobs(
    self,
    *,
    sequenceStoreId: str,
    filter: ActivateReadSetFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReadSetActivationJobsResponseTypeDef:  # (2)
    ...

1. See ActivateReadSetFilterTypeDef
2. See ListReadSetActivationJobsResponseTypeDef

Usage example with kwargs

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

parent.list_read_set_activation_jobs(**kwargs)

1. See ListReadSetActivationJobsRequestRequestTypeDef

list_read_set_export_jobs

Retrieves a list of read set export jobs.

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

Method definition

def list_read_set_export_jobs(
    self,
    *,
    sequenceStoreId: str,
    filter: ExportReadSetFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReadSetExportJobsResponseTypeDef:  # (2)
    ...

1. See ExportReadSetFilterTypeDef
2. See ListReadSetExportJobsResponseTypeDef

Usage example with kwargs

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

parent.list_read_set_export_jobs(**kwargs)

1. See ListReadSetExportJobsRequestRequestTypeDef

list_read_set_import_jobs

Retrieves a list of read set import jobs.

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

Method definition

def list_read_set_import_jobs(
    self,
    *,
    sequenceStoreId: str,
    filter: ImportReadSetFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReadSetImportJobsResponseTypeDef:  # (2)
    ...

1. See ImportReadSetFilterTypeDef
2. See ListReadSetImportJobsResponseTypeDef

Usage example with kwargs

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

parent.list_read_set_import_jobs(**kwargs)

1. See ListReadSetImportJobsRequestRequestTypeDef

list_read_sets

Retrieves a list of read sets.

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

Method definition

def list_read_sets(
    self,
    *,
    sequenceStoreId: str,
    filter: ReadSetFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReadSetsResponseTypeDef:  # (2)
    ...

1. See ReadSetFilterTypeDef
2. See ListReadSetsResponseTypeDef

Usage example with kwargs

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

parent.list_read_sets(**kwargs)

1. See ListReadSetsRequestRequestTypeDef

list_reference_import_jobs

Retrieves a list of reference import jobs.

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

Method definition

def list_reference_import_jobs(
    self,
    *,
    referenceStoreId: str,
    filter: ImportReferenceFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReferenceImportJobsResponseTypeDef:  # (2)
    ...

1. See ImportReferenceFilterTypeDef
2. See ListReferenceImportJobsResponseTypeDef

Usage example with kwargs

kwargs: ListReferenceImportJobsRequestRequestTypeDef = {  # (1)
    "referenceStoreId": ...,
}

parent.list_reference_import_jobs(**kwargs)

1. See ListReferenceImportJobsRequestRequestTypeDef

list_reference_stores

Retrieves a list of reference stores.

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

Method definition

def list_reference_stores(
    self,
    *,
    filter: ReferenceStoreFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReferenceStoresResponseTypeDef:  # (2)
    ...

1. See ReferenceStoreFilterTypeDef
2. See ListReferenceStoresResponseTypeDef

Usage example with kwargs

kwargs: ListReferenceStoresRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_reference_stores(**kwargs)

1. See ListReferenceStoresRequestRequestTypeDef

list_references

Retrieves a list of references.

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

Method definition

def list_references(
    self,
    *,
    referenceStoreId: str,
    filter: ReferenceFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReferencesResponseTypeDef:  # (2)
    ...

1. See ReferenceFilterTypeDef
2. See ListReferencesResponseTypeDef

Usage example with kwargs

kwargs: ListReferencesRequestRequestTypeDef = {  # (1)
    "referenceStoreId": ...,
}

parent.list_references(**kwargs)

1. See ListReferencesRequestRequestTypeDef

list_run_groups

Retrieves a list of run groups.

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

Method definition

def list_run_groups(
    self,
    *,
    maxResults: int = ...,
    name: str = ...,
    startingToken: str = ...,
) -> ListRunGroupsResponseTypeDef:  # (1)
    ...

1. See ListRunGroupsResponseTypeDef

Usage example with kwargs

kwargs: ListRunGroupsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_run_groups(**kwargs)

1. See ListRunGroupsRequestRequestTypeDef

list_run_tasks

Retrieves a list of tasks for a run.

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

Method definition

def list_run_tasks(
    self,
    *,
    id: str,
    maxResults: int = ...,
    startingToken: str = ...,
    status: TaskStatusType = ...,  # (1)
) -> ListRunTasksResponseTypeDef:  # (2)
    ...

1. See TaskStatusType
2. See ListRunTasksResponseTypeDef

Usage example with kwargs

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

parent.list_run_tasks(**kwargs)

1. See ListRunTasksRequestRequestTypeDef

list_runs

Retrieves a list of runs.

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

Method definition

def list_runs(
    self,
    *,
    maxResults: int = ...,
    name: str = ...,
    runGroupId: str = ...,
    startingToken: str = ...,
) -> ListRunsResponseTypeDef:  # (1)
    ...

1. See ListRunsResponseTypeDef

Usage example with kwargs

kwargs: ListRunsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_runs(**kwargs)

1. See ListRunsRequestRequestTypeDef

list_sequence_stores

Retrieves a list of sequence stores.

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

Method definition

def list_sequence_stores(
    self,
    *,
    filter: SequenceStoreFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSequenceStoresResponseTypeDef:  # (2)
    ...

1. See SequenceStoreFilterTypeDef
2. See ListSequenceStoresResponseTypeDef

Usage example with kwargs

kwargs: ListSequenceStoresRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_sequence_stores(**kwargs)

1. See ListSequenceStoresRequestRequestTypeDef

list_tags_for_resource

Retrieves a list of tags for a resource.

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

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_variant_import_jobs

Retrieves a list of variant import jobs.

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

Method definition

def list_variant_import_jobs(
    self,
    *,
    filter: ListVariantImportJobsFilterTypeDef = ...,  # (1)
    ids: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListVariantImportJobsResponseTypeDef:  # (2)
    ...

1. See ListVariantImportJobsFilterTypeDef
2. See ListVariantImportJobsResponseTypeDef

Usage example with kwargs

kwargs: ListVariantImportJobsRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_variant_import_jobs(**kwargs)

1. See ListVariantImportJobsRequestRequestTypeDef

list_variant_stores

Retrieves a list of variant stores.

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

Method definition

def list_variant_stores(
    self,
    *,
    filter: ListVariantStoresFilterTypeDef = ...,  # (1)
    ids: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListVariantStoresResponseTypeDef:  # (2)
    ...

1. See ListVariantStoresFilterTypeDef
2. See ListVariantStoresResponseTypeDef

Usage example with kwargs

kwargs: ListVariantStoresRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_variant_stores(**kwargs)

1. See ListVariantStoresRequestRequestTypeDef

list_workflows

Retrieves a list of workflows.

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

Method definition

def list_workflows(
    self,
    *,
    maxResults: int = ...,
    name: str = ...,
    startingToken: str = ...,
    type: WorkflowTypeType = ...,  # (1)
) -> ListWorkflowsResponseTypeDef:  # (2)
    ...

1. See WorkflowTypeType
2. See ListWorkflowsResponseTypeDef

Usage example with kwargs

kwargs: ListWorkflowsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_workflows(**kwargs)

1. See ListWorkflowsRequestRequestTypeDef

start_annotation_import_job

Starts an annotation import job.

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

Method definition

def start_annotation_import_job(
    self,
    *,
    destinationName: str,
    items: Sequence[AnnotationImportItemSourceTypeDef],  # (1)
    roleArn: str,
    formatOptions: FormatOptionsTypeDef = ...,  # (2)
    runLeftNormalization: bool = ...,
) -> StartAnnotationImportResponseTypeDef:  # (3)
    ...

1. See AnnotationImportItemSourceTypeDef
2. See FormatOptionsTypeDef
3. See StartAnnotationImportResponseTypeDef

Usage example with kwargs

kwargs: StartAnnotationImportRequestRequestTypeDef = {  # (1)
    "destinationName": ...,
    "items": ...,
    "roleArn": ...,
}

parent.start_annotation_import_job(**kwargs)

1. See StartAnnotationImportRequestRequestTypeDef

start_read_set_activation_job

Activates an archived read set.

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

Method definition

def start_read_set_activation_job(
    self,
    *,
    sequenceStoreId: str,
    sources: Sequence[StartReadSetActivationJobSourceItemTypeDef],  # (1)
    clientToken: str = ...,
) -> StartReadSetActivationJobResponseTypeDef:  # (2)
    ...

1. See StartReadSetActivationJobSourceItemTypeDef
2. See StartReadSetActivationJobResponseTypeDef

Usage example with kwargs

kwargs: StartReadSetActivationJobRequestRequestTypeDef = {  # (1)
    "sequenceStoreId": ...,
    "sources": ...,
}

parent.start_read_set_activation_job(**kwargs)

1. See StartReadSetActivationJobRequestRequestTypeDef

start_read_set_export_job

Exports a read set to Amazon S3.

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

Method definition

def start_read_set_export_job(
    self,
    *,
    destination: str,
    roleArn: str,
    sequenceStoreId: str,
    sources: Sequence[ExportReadSetTypeDef],  # (1)
    clientToken: str = ...,
) -> StartReadSetExportJobResponseTypeDef:  # (2)
    ...

1. See ExportReadSetTypeDef
2. See StartReadSetExportJobResponseTypeDef

Usage example with kwargs

kwargs: StartReadSetExportJobRequestRequestTypeDef = {  # (1)
    "destination": ...,
    "roleArn": ...,
    "sequenceStoreId": ...,
    "sources": ...,
}

parent.start_read_set_export_job(**kwargs)

1. See StartReadSetExportJobRequestRequestTypeDef

start_read_set_import_job

Starts a read set import job.

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

Method definition

def start_read_set_import_job(
    self,
    *,
    roleArn: str,
    sequenceStoreId: str,
    sources: Sequence[StartReadSetImportJobSourceItemTypeDef],  # (1)
    clientToken: str = ...,
) -> StartReadSetImportJobResponseTypeDef:  # (2)
    ...

1. See StartReadSetImportJobSourceItemTypeDef
2. See StartReadSetImportJobResponseTypeDef

Usage example with kwargs

kwargs: StartReadSetImportJobRequestRequestTypeDef = {  # (1)
    "roleArn": ...,
    "sequenceStoreId": ...,
    "sources": ...,
}

parent.start_read_set_import_job(**kwargs)

1. See StartReadSetImportJobRequestRequestTypeDef

start_reference_import_job

Starts a reference import job.

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

Method definition

def start_reference_import_job(
    self,
    *,
    referenceStoreId: str,
    roleArn: str,
    sources: Sequence[StartReferenceImportJobSourceItemTypeDef],  # (1)
    clientToken: str = ...,
) -> StartReferenceImportJobResponseTypeDef:  # (2)
    ...

1. See StartReferenceImportJobSourceItemTypeDef
2. See StartReferenceImportJobResponseTypeDef

Usage example with kwargs

kwargs: StartReferenceImportJobRequestRequestTypeDef = {  # (1)
    "referenceStoreId": ...,
    "roleArn": ...,
    "sources": ...,
}

parent.start_reference_import_job(**kwargs)

1. See StartReferenceImportJobRequestRequestTypeDef

start_run

Starts a run.

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

Method definition

def start_run(
    self,
    *,
    requestId: str,
    roleArn: str,
    logLevel: RunLogLevelType = ...,  # (1)
    name: str = ...,
    outputUri: str = ...,
    parameters: Mapping[str, Any] = ...,
    priority: int = ...,
    runGroupId: str = ...,
    runId: str = ...,
    storageCapacity: int = ...,
    tags: Mapping[str, str] = ...,
    workflowId: str = ...,
    workflowType: WorkflowTypeType = ...,  # (2)
) -> StartRunResponseTypeDef:  # (3)
    ...

1. See RunLogLevelType
2. See WorkflowTypeType
3. See StartRunResponseTypeDef

Usage example with kwargs

kwargs: StartRunRequestRequestTypeDef = {  # (1)
    "requestId": ...,
    "roleArn": ...,
}

parent.start_run(**kwargs)

1. See StartRunRequestRequestTypeDef

start_variant_import_job

Starts a variant import job.

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

Method definition

def start_variant_import_job(
    self,
    *,
    destinationName: str,
    items: Sequence[VariantImportItemSourceTypeDef],  # (1)
    roleArn: str,
    runLeftNormalization: bool = ...,
) -> StartVariantImportResponseTypeDef:  # (2)
    ...

1. See VariantImportItemSourceTypeDef
2. See StartVariantImportResponseTypeDef

Usage example with kwargs

kwargs: StartVariantImportRequestRequestTypeDef = {  # (1)
    "destinationName": ...,
    "items": ...,
    "roleArn": ...,
}

parent.start_variant_import_job(**kwargs)

1. See StartVariantImportRequestRequestTypeDef

tag_resource

Tags a resource.

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

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from a resource.

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

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_annotation_store

Updates an annotation store.

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

Method definition

def update_annotation_store(
    self,
    *,
    name: str,
    description: str = ...,
) -> UpdateAnnotationStoreResponseTypeDef:  # (1)
    ...

1. See UpdateAnnotationStoreResponseTypeDef

Usage example with kwargs

kwargs: UpdateAnnotationStoreRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.update_annotation_store(**kwargs)

1. See UpdateAnnotationStoreRequestRequestTypeDef

update_run_group

Updates a run group.

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

Method definition

def update_run_group(
    self,
    *,
    id: str,
    maxCpus: int = ...,
    maxDuration: int = ...,
    maxRuns: int = ...,
    name: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.update_run_group(**kwargs)

1. See UpdateRunGroupRequestRequestTypeDef

update_variant_store

Updates a variant store.

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

Method definition

def update_variant_store(
    self,
    *,
    name: str,
    description: str = ...,
) -> UpdateVariantStoreResponseTypeDef:  # (1)
    ...

1. See UpdateVariantStoreResponseTypeDef

Usage example with kwargs

kwargs: UpdateVariantStoreRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.update_variant_store(**kwargs)

1. See UpdateVariantStoreRequestRequestTypeDef

update_workflow

Updates a workflow.

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

Method definition

def update_workflow(
    self,
    *,
    id: str,
    description: str = ...,
    name: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.update_workflow(**kwargs)

1. See UpdateWorkflowRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("omics").get_paginator method with overloads.

• client.get_paginator("list_annotation_import_jobs") -> ListAnnotationImportJobsPaginator
• client.get_paginator("list_annotation_stores") -> ListAnnotationStoresPaginator
• client.get_paginator("list_read_set_activation_jobs") -> ListReadSetActivationJobsPaginator
• client.get_paginator("list_read_set_export_jobs") -> ListReadSetExportJobsPaginator
• client.get_paginator("list_read_set_import_jobs") -> ListReadSetImportJobsPaginator
• client.get_paginator("list_read_sets") -> ListReadSetsPaginator
• client.get_paginator("list_reference_import_jobs") -> ListReferenceImportJobsPaginator
• client.get_paginator("list_reference_stores") -> ListReferenceStoresPaginator
• client.get_paginator("list_references") -> ListReferencesPaginator
• client.get_paginator("list_run_groups") -> ListRunGroupsPaginator
• client.get_paginator("list_run_tasks") -> ListRunTasksPaginator
• client.get_paginator("list_runs") -> ListRunsPaginator
• client.get_paginator("list_sequence_stores") -> ListSequenceStoresPaginator
• client.get_paginator("list_variant_import_jobs") -> ListVariantImportJobsPaginator
• client.get_paginator("list_variant_stores") -> ListVariantStoresPaginator
• client.get_paginator("list_workflows") -> ListWorkflowsPaginator

get_waiter

Type annotations and code completion for boto3.client("omics").get_waiter method with overloads.

• client.get_waiter("annotation_import_job_created") -> AnnotationImportJobCreatedWaiter
• client.get_waiter("annotation_store_created") -> AnnotationStoreCreatedWaiter
• client.get_waiter("annotation_store_deleted") -> AnnotationStoreDeletedWaiter
• client.get_waiter("read_set_activation_job_completed") -> ReadSetActivationJobCompletedWaiter
• client.get_waiter("read_set_export_job_completed") -> ReadSetExportJobCompletedWaiter
• client.get_waiter("read_set_import_job_completed") -> ReadSetImportJobCompletedWaiter
• client.get_waiter("reference_import_job_completed") -> ReferenceImportJobCompletedWaiter
• client.get_waiter("run_completed") -> RunCompletedWaiter
• client.get_waiter("run_running") -> RunRunningWaiter
• client.get_waiter("task_completed") -> TaskCompletedWaiter
• client.get_waiter("task_running") -> TaskRunningWaiter
• client.get_waiter("variant_import_job_created") -> VariantImportJobCreatedWaiter
• client.get_waiter("variant_store_created") -> VariantStoreCreatedWaiter
• client.get_waiter("variant_store_deleted") -> VariantStoreDeletedWaiter
• client.get_waiter("workflow_active") -> WorkflowActiveWaiter