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#

Accept a resource share request.

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. boto3 documentation

# create_annotation_store method definition

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

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

parent.create_annotation_store(**kwargs)
  1. See CreateAnnotationStoreRequestRequestTypeDef

create_annotation_store_version#

Creates a new version of an annotation store.

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

# create_annotation_store_version method definition

def create_annotation_store_version(
    self,
    *,
    name: str,
    versionName: str,
    description: str = ...,
    versionOptions: VersionOptionsTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateAnnotationStoreVersionResponseTypeDef:  # (2)
    ...
  1. See VersionOptionsTypeDef
  2. See CreateAnnotationStoreVersionResponseTypeDef 
# create_annotation_store_version method usage example with argument unpacking

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

parent.create_annotation_store_version(**kwargs)
  1. See CreateAnnotationStoreVersionRequestRequestTypeDef

create_multipart_read_set_upload#

Begins a multipart read set upload.

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

# create_multipart_read_set_upload method definition

def create_multipart_read_set_upload(
    self,
    *,
    sequenceStoreId: str,
    sourceFileType: FileTypeType,  # (1)
    subjectId: str,
    sampleId: str,
    name: str,
    clientToken: str = ...,
    generatedFrom: str = ...,
    referenceArn: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateMultipartReadSetUploadResponseTypeDef:  # (2)
    ...
  1. See FileTypeType
  2. See CreateMultipartReadSetUploadResponseTypeDef 
# create_multipart_read_set_upload method usage example with argument unpacking

kwargs: CreateMultipartReadSetUploadRequestRequestTypeDef = {  # (1)
    "sequenceStoreId": ...,
    "sourceFileType": ...,
    "subjectId": ...,
    "sampleId": ...,
    "name": ...,
}

parent.create_multipart_read_set_upload(**kwargs)
  1. See CreateMultipartReadSetUploadRequestRequestTypeDef

create_reference_store#

Creates a reference store.

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

# create_reference_store method definition

def create_reference_store(
    self,
    *,
    name: str,
    description: str = ...,
    sseConfig: SseConfigTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateReferenceStoreResponseTypeDef:  # (2)
    ...
  1. See SseConfigTypeDef
  2. See CreateReferenceStoreResponseTypeDef 
# create_reference_store method usage example with argument unpacking

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

parent.create_reference_store(**kwargs)
  1. See CreateReferenceStoreRequestRequestTypeDef

create_run_cache#

You can create a run cache to save the task outputs from completed tasks in a run for a private workflow.

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

# create_run_cache method definition

def create_run_cache(
    self,
    *,
    cacheS3Location: str,
    requestId: str,
    cacheBehavior: CacheBehaviorType = ...,  # (1)
    description: str = ...,
    name: str = ...,
    tags: Mapping[str, str] = ...,
    cacheBucketOwnerId: str = ...,
) -> CreateRunCacheResponseTypeDef:  # (2)
    ...
  1. See CacheBehaviorType
  2. See CreateRunCacheResponseTypeDef 
# create_run_cache method usage example with argument unpacking

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

parent.create_run_cache(**kwargs)
  1. See CreateRunCacheRequestRequestTypeDef

create_run_group#

You can optionally create a run group to limit the compute resources for the runs that you add to the group.

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

# create_run_group method definition

def create_run_group(
    self,
    *,
    requestId: str,
    name: str = ...,
    maxCpus: int = ...,
    maxRuns: int = ...,
    maxDuration: int = ...,
    tags: Mapping[str, str] = ...,
    maxGpus: int = ...,
) -> CreateRunGroupResponseTypeDef:  # (1)
    ...
  1. See CreateRunGroupResponseTypeDef 
# create_run_group method usage example with argument unpacking

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

# create_sequence_store method definition

def create_sequence_store(
    self,
    *,
    name: str,
    description: str = ...,
    sseConfig: SseConfigTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
    fallbackLocation: str = ...,
    eTagAlgorithmFamily: ETagAlgorithmFamilyType = ...,  # (2)
) -> CreateSequenceStoreResponseTypeDef:  # (3)
    ...
  1. See SseConfigTypeDef
  2. See ETagAlgorithmFamilyType
  3. See CreateSequenceStoreResponseTypeDef 
# create_sequence_store method usage example with argument unpacking

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

parent.create_sequence_store(**kwargs)
  1. See CreateSequenceStoreRequestRequestTypeDef

create_share#

Creates a cross-account shared resource.

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

# create_share method definition

def create_share(
    self,
    *,
    resourceArn: str,
    principalSubscriber: str,
    shareName: str = ...,
) -> CreateShareResponseTypeDef:  # (1)
    ...
  1. See CreateShareResponseTypeDef 
# create_share method usage example with argument unpacking

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

parent.create_share(**kwargs)
  1. See CreateShareRequestRequestTypeDef

create_variant_store#

Creates a variant store.

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

# create_variant_store method definition

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

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

# create_workflow method definition

def create_workflow(
    self,
    *,
    requestId: str,
    name: str = ...,
    description: str = ...,
    engine: WorkflowEngineType = ...,  # (1)
    definitionZip: BlobTypeDef = ...,
    definitionUri: str = ...,
    main: str = ...,
    parameterTemplate: Mapping[str, WorkflowParameterTypeDef] = ...,  # (2)
    storageCapacity: int = ...,
    tags: Mapping[str, str] = ...,
    accelerators: AcceleratorsType = ...,  # (3)
) -> CreateWorkflowResponseTypeDef:  # (4)
    ...
  1. See WorkflowEngineType
  2. See WorkflowParameterTypeDef
  3. See AcceleratorsType
  4. See CreateWorkflowResponseTypeDef 
# create_workflow method usage example with argument unpacking

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

# delete_annotation_store method definition

def delete_annotation_store(
    self,
    *,
    name: str,
    force: bool = ...,
) -> DeleteAnnotationStoreResponseTypeDef:  # (1)
    ...
  1. See DeleteAnnotationStoreResponseTypeDef 
# delete_annotation_store method usage example with argument unpacking

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

parent.delete_annotation_store(**kwargs)
  1. See DeleteAnnotationStoreRequestRequestTypeDef

delete_annotation_store_versions#

Deletes one or multiple versions of an annotation store.

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

# delete_annotation_store_versions method definition

def delete_annotation_store_versions(
    self,
    *,
    name: str,
    versions: Sequence[str],
    force: bool = ...,
) -> DeleteAnnotationStoreVersionsResponseTypeDef:  # (1)
    ...
  1. See DeleteAnnotationStoreVersionsResponseTypeDef 
# delete_annotation_store_versions method usage example with argument unpacking

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

parent.delete_annotation_store_versions(**kwargs)
  1. See DeleteAnnotationStoreVersionsRequestRequestTypeDef

delete_reference#

Deletes a genome reference.

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

# delete_reference method definition

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

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

# delete_reference_store method definition

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

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

# delete_run method definition

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

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

parent.delete_run(**kwargs)
  1. See DeleteRunRequestRequestTypeDef

delete_run_cache#

Delete a run cache.

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

# delete_run_cache method definition

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

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

parent.delete_run_cache(**kwargs)
  1. See DeleteRunCacheRequestRequestTypeDef

delete_run_group#

Deletes a workflow run group.

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

# delete_run_group method definition

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

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

# delete_sequence_store method definition

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

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

parent.delete_sequence_store(**kwargs)
  1. See DeleteSequenceStoreRequestRequestTypeDef

delete_share#

Deletes a resource share.

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

# delete_share method definition

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

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

parent.delete_share(**kwargs)
  1. See DeleteShareRequestRequestTypeDef

delete_variant_store#

Deletes a variant store.

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

# delete_variant_store method definition

def delete_variant_store(
    self,
    *,
    name: str,
    force: bool = ...,
) -> DeleteVariantStoreResponseTypeDef:  # (1)
    ...
  1. See DeleteVariantStoreResponseTypeDef 
# delete_variant_store method usage example with argument unpacking

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

# delete_workflow method definition

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

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

# generate_presigned_url 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

# get_annotation_import_job method definition

def get_annotation_import_job(
    self,
    *,
    jobId: str,
) -> GetAnnotationImportResponseTypeDef:  # (1)
    ...
  1. See GetAnnotationImportResponseTypeDef 
# get_annotation_import_job method usage example with argument unpacking

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

# get_annotation_store method definition

def get_annotation_store(
    self,
    *,
    name: str,
) -> GetAnnotationStoreResponseTypeDef:  # (1)
    ...
  1. See GetAnnotationStoreResponseTypeDef 
# get_annotation_store method usage example with argument unpacking

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

parent.get_annotation_store(**kwargs)
  1. See GetAnnotationStoreRequestRequestTypeDef

get_annotation_store_version#

Retrieves the metadata for an annotation store version.

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

# get_annotation_store_version method definition

def get_annotation_store_version(
    self,
    *,
    name: str,
    versionName: str,
) -> GetAnnotationStoreVersionResponseTypeDef:  # (1)
    ...
  1. See GetAnnotationStoreVersionResponseTypeDef 
# get_annotation_store_version method usage example with argument unpacking

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

parent.get_annotation_store_version(**kwargs)
  1. See GetAnnotationStoreVersionRequestRequestTypeDef

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

# get_read_set method definition

def get_read_set(
    self,
    *,
    id: str,
    sequenceStoreId: str,
    partNumber: int,
    file: ReadSetFileType = ...,  # (1)
) -> GetReadSetResponseTypeDef:  # (2)
    ...
  1. See ReadSetFileType
  2. See GetReadSetResponseTypeDef 
# get_read_set method usage example with argument unpacking

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

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

# get_read_set_activation_job method definition

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

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

# get_read_set_export_job method definition

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

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

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

# get_read_set_import_job method definition

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

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

# get_read_set_metadata method definition

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

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

# get_reference method definition

def get_reference(
    self,
    *,
    id: str,
    referenceStoreId: str,
    partNumber: int,
    range: str = ...,
    file: ReferenceFileType = ...,  # (1)
) -> GetReferenceResponseTypeDef:  # (2)
    ...
  1. See ReferenceFileType
  2. See GetReferenceResponseTypeDef 
# get_reference method usage example with argument unpacking

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

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

# get_reference_import_job method definition

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

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

# get_reference_metadata method definition

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

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

# get_reference_store method definition

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

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

# get_run method definition

def get_run(
    self,
    *,
    id: str,
    export: Sequence[RunExportType] = ...,  # (1)
) -> GetRunResponseTypeDef:  # (2)
    ...
  1. See RunExportType
  2. See GetRunResponseTypeDef 
# get_run method usage example with argument unpacking

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

parent.get_run(**kwargs)
  1. See GetRunRequestRequestTypeDef

get_run_cache#

Retrieve the details for the specified run cache.

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

# get_run_cache method definition

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

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

parent.get_run_cache(**kwargs)
  1. See GetRunCacheRequestRequestTypeDef

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

# get_run_group method definition

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

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

# get_run_task method definition

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

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

# get_sequence_store method definition

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

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

parent.get_sequence_store(**kwargs)
  1. See GetSequenceStoreRequestRequestTypeDef

get_share#

Retrieves the metadata for the specified resource share.

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

# get_share method definition

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

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

parent.get_share(**kwargs)
  1. See GetShareRequestRequestTypeDef

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

# get_variant_import_job method definition

def get_variant_import_job(
    self,
    *,
    jobId: str,
) -> GetVariantImportResponseTypeDef:  # (1)
    ...
  1. See GetVariantImportResponseTypeDef 
# get_variant_import_job method usage example with argument unpacking

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

# get_variant_store method definition

def get_variant_store(
    self,
    *,
    name: str,
) -> GetVariantStoreResponseTypeDef:  # (1)
    ...
  1. See GetVariantStoreResponseTypeDef 
# get_variant_store method usage example with argument unpacking

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

# get_workflow method definition

def get_workflow(
    self,
    *,
    id: str,
    type: WorkflowTypeType = ...,  # (1)
    export: Sequence[WorkflowExportType] = ...,  # (2)
    workflowOwnerId: str = ...,
) -> GetWorkflowResponseTypeDef:  # (3)
    ...
  1. See WorkflowTypeType
  2. See WorkflowExportType
  3. See GetWorkflowResponseTypeDef 
# get_workflow method usage example with argument unpacking

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

# list_annotation_import_jobs method definition

def list_annotation_import_jobs(
    self,
    *,
    maxResults: int = ...,
    ids: Sequence[str] = ...,
    nextToken: str = ...,
    filter: ListAnnotationImportJobsFilterTypeDef = ...,  # (1)
) -> ListAnnotationImportJobsResponseTypeDef:  # (2)
    ...
  1. See ListAnnotationImportJobsFilterTypeDef
  2. See ListAnnotationImportJobsResponseTypeDef 
# list_annotation_import_jobs method usage example with argument unpacking

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

parent.list_annotation_import_jobs(**kwargs)
  1. See ListAnnotationImportJobsRequestRequestTypeDef

list_annotation_store_versions#

Lists the versions of an annotation store.

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

# list_annotation_store_versions method definition

def list_annotation_store_versions(
    self,
    *,
    name: str,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ListAnnotationStoreVersionsFilterTypeDef = ...,  # (1)
) -> ListAnnotationStoreVersionsResponseTypeDef:  # (2)
    ...
  1. See ListAnnotationStoreVersionsFilterTypeDef
  2. See ListAnnotationStoreVersionsResponseTypeDef 
# list_annotation_store_versions method usage example with argument unpacking

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

parent.list_annotation_store_versions(**kwargs)
  1. See ListAnnotationStoreVersionsRequestRequestTypeDef

list_annotation_stores#

Retrieves a list of annotation stores.

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

# list_annotation_stores method definition

def list_annotation_stores(
    self,
    *,
    ids: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ListAnnotationStoresFilterTypeDef = ...,  # (1)
) -> ListAnnotationStoresResponseTypeDef:  # (2)
    ...
  1. See ListAnnotationStoresFilterTypeDef
  2. See ListAnnotationStoresResponseTypeDef 
# list_annotation_stores method usage example with argument unpacking

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

parent.list_annotation_stores(**kwargs)
  1. See ListAnnotationStoresRequestRequestTypeDef

list_multipart_read_set_uploads#

Lists multipart read set uploads and for in progress uploads.

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

# list_multipart_read_set_uploads method definition

def list_multipart_read_set_uploads(
    self,
    *,
    sequenceStoreId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMultipartReadSetUploadsResponseTypeDef:  # (1)
    ...
  1. See ListMultipartReadSetUploadsResponseTypeDef 
# list_multipart_read_set_uploads method usage example with argument unpacking

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

parent.list_multipart_read_set_uploads(**kwargs)
  1. See ListMultipartReadSetUploadsRequestRequestTypeDef

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

# list_read_set_activation_jobs method definition

def list_read_set_activation_jobs(
    self,
    *,
    sequenceStoreId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ActivateReadSetFilterTypeDef = ...,  # (1)
) -> ListReadSetActivationJobsResponseTypeDef:  # (2)
    ...
  1. See ActivateReadSetFilterTypeDef
  2. See ListReadSetActivationJobsResponseTypeDef 
# list_read_set_activation_jobs method usage example with argument unpacking

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

# list_read_set_export_jobs method definition

def list_read_set_export_jobs(
    self,
    *,
    sequenceStoreId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ExportReadSetFilterTypeDef = ...,  # (1)
) -> ListReadSetExportJobsResponseTypeDef:  # (2)
    ...
  1. See ExportReadSetFilterTypeDef
  2. See ListReadSetExportJobsResponseTypeDef 
# list_read_set_export_jobs method usage example with argument unpacking

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

# list_read_set_import_jobs method definition

def list_read_set_import_jobs(
    self,
    *,
    sequenceStoreId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ImportReadSetFilterTypeDef = ...,  # (1)
) -> ListReadSetImportJobsResponseTypeDef:  # (2)
    ...
  1. See ImportReadSetFilterTypeDef
  2. See ListReadSetImportJobsResponseTypeDef 
# list_read_set_import_jobs method usage example with argument unpacking

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

parent.list_read_set_import_jobs(**kwargs)
  1. See ListReadSetImportJobsRequestRequestTypeDef

list_read_set_upload_parts#

This operation will list all parts in a requested multipart upload for a sequence store.

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

# list_read_set_upload_parts method definition

def list_read_set_upload_parts(
    self,
    *,
    sequenceStoreId: str,
    uploadId: str,
    partSource: ReadSetPartSourceType,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ReadSetUploadPartListFilterTypeDef = ...,  # (2)
) -> ListReadSetUploadPartsResponseTypeDef:  # (3)
    ...
  1. See ReadSetPartSourceType
  2. See ReadSetUploadPartListFilterTypeDef
  3. See ListReadSetUploadPartsResponseTypeDef 
# list_read_set_upload_parts method usage example with argument unpacking

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

parent.list_read_set_upload_parts(**kwargs)
  1. See ListReadSetUploadPartsRequestRequestTypeDef

list_read_sets#

Retrieves a list of read sets.

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

# list_read_sets method definition

def list_read_sets(
    self,
    *,
    sequenceStoreId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ReadSetFilterTypeDef = ...,  # (1)
) -> ListReadSetsResponseTypeDef:  # (2)
    ...
  1. See ReadSetFilterTypeDef
  2. See ListReadSetsResponseTypeDef 
# list_read_sets method usage example with argument unpacking

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

# list_reference_import_jobs method definition

def list_reference_import_jobs(
    self,
    *,
    referenceStoreId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ImportReferenceFilterTypeDef = ...,  # (1)
) -> ListReferenceImportJobsResponseTypeDef:  # (2)
    ...
  1. See ImportReferenceFilterTypeDef
  2. See ListReferenceImportJobsResponseTypeDef 
# list_reference_import_jobs method usage example with argument unpacking

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

# list_reference_stores method definition

def list_reference_stores(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ReferenceStoreFilterTypeDef = ...,  # (1)
) -> ListReferenceStoresResponseTypeDef:  # (2)
    ...
  1. See ReferenceStoreFilterTypeDef
  2. See ListReferenceStoresResponseTypeDef 
# list_reference_stores method usage example with argument unpacking

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

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

# list_references method definition

def list_references(
    self,
    *,
    referenceStoreId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: ReferenceFilterTypeDef = ...,  # (1)
) -> ListReferencesResponseTypeDef:  # (2)
    ...
  1. See ReferenceFilterTypeDef
  2. See ListReferencesResponseTypeDef 
# list_references method usage example with argument unpacking

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

parent.list_references(**kwargs)
  1. See ListReferencesRequestRequestTypeDef

list_run_caches#

Retrieves a list of your run caches.

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

# list_run_caches method definition

def list_run_caches(
    self,
    *,
    maxResults: int = ...,
    startingToken: str = ...,
) -> ListRunCachesResponseTypeDef:  # (1)
    ...
  1. See ListRunCachesResponseTypeDef 
# list_run_caches method usage example with argument unpacking

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

parent.list_run_caches(**kwargs)
  1. See ListRunCachesRequestRequestTypeDef

list_run_groups#

Retrieves a list of run groups.

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

# list_run_groups method definition

def list_run_groups(
    self,
    *,
    name: str = ...,
    startingToken: str = ...,
    maxResults: int = ...,
) -> ListRunGroupsResponseTypeDef:  # (1)
    ...
  1. See ListRunGroupsResponseTypeDef 
# list_run_groups method usage example with argument unpacking

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

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

# list_run_tasks method definition

def list_run_tasks(
    self,
    *,
    id: str,
    status: TaskStatusType = ...,  # (1)
    startingToken: str = ...,
    maxResults: int = ...,
) -> ListRunTasksResponseTypeDef:  # (2)
    ...
  1. See TaskStatusType
  2. See ListRunTasksResponseTypeDef 
# list_run_tasks method usage example with argument unpacking

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

# list_runs method definition

def list_runs(
    self,
    *,
    name: str = ...,
    runGroupId: str = ...,
    startingToken: str = ...,
    maxResults: int = ...,
    status: RunStatusType = ...,  # (1)
) -> ListRunsResponseTypeDef:  # (2)
    ...
  1. See RunStatusType
  2. See ListRunsResponseTypeDef 
# list_runs method usage example with argument unpacking

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

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

# list_sequence_stores method definition

def list_sequence_stores(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    filter: SequenceStoreFilterTypeDef = ...,  # (1)
) -> ListSequenceStoresResponseTypeDef:  # (2)
    ...
  1. See SequenceStoreFilterTypeDef
  2. See ListSequenceStoresResponseTypeDef 
# list_sequence_stores method usage example with argument unpacking

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

parent.list_sequence_stores(**kwargs)
  1. See ListSequenceStoresRequestRequestTypeDef

list_shares#

Retrieves the resource shares associated with an account.

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

# list_shares method definition

def list_shares(
    self,
    *,
    resourceOwner: ResourceOwnerType,  # (1)
    filter: FilterTypeDef = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSharesResponseTypeDef:  # (3)
    ...
  1. See ResourceOwnerType
  2. See FilterTypeDef
  3. See ListSharesResponseTypeDef 
# list_shares method usage example with argument unpacking

kwargs: ListSharesRequestRequestTypeDef = {  # (1)
    "resourceOwner": ...,
}

parent.list_shares(**kwargs)
  1. See ListSharesRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

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

# list_variant_import_jobs method definition

def list_variant_import_jobs(
    self,
    *,
    maxResults: int = ...,
    ids: Sequence[str] = ...,
    nextToken: str = ...,
    filter: ListVariantImportJobsFilterTypeDef = ...,  # (1)
) -> ListVariantImportJobsResponseTypeDef:  # (2)
    ...
  1. See ListVariantImportJobsFilterTypeDef
  2. See ListVariantImportJobsResponseTypeDef 
# list_variant_import_jobs method usage example with argument unpacking

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

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

# list_variant_stores method definition

def list_variant_stores(
    self,
    *,
    maxResults: int = ...,
    ids: Sequence[str] = ...,
    nextToken: str = ...,
    filter: ListVariantStoresFilterTypeDef = ...,  # (1)
) -> ListVariantStoresResponseTypeDef:  # (2)
    ...
  1. See ListVariantStoresFilterTypeDef
  2. See ListVariantStoresResponseTypeDef 
# list_variant_stores method usage example with argument unpacking

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

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

# list_workflows method definition

def list_workflows(
    self,
    *,
    type: WorkflowTypeType = ...,  # (1)
    name: str = ...,
    startingToken: str = ...,
    maxResults: int = ...,
) -> ListWorkflowsResponseTypeDef:  # (2)
    ...
  1. See WorkflowTypeType
  2. See ListWorkflowsResponseTypeDef 
# list_workflows method usage example with argument unpacking

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

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

# start_annotation_import_job method definition

def start_annotation_import_job(
    self,
    *,
    destinationName: str,
    roleArn: str,
    items: Sequence[AnnotationImportItemSourceTypeDef],  # (1)
    versionName: str = ...,
    formatOptions: FormatOptionsTypeDef = ...,  # (2)
    runLeftNormalization: bool = ...,
    annotationFields: Mapping[str, str] = ...,
) -> StartAnnotationImportResponseTypeDef:  # (3)
    ...
  1. See AnnotationImportItemSourceTypeDef
  2. See FormatOptionsTypeDef
  3. See StartAnnotationImportResponseTypeDef 
# start_annotation_import_job method usage example with argument unpacking

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

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

# start_read_set_activation_job 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 
# start_read_set_activation_job method usage example with argument unpacking

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

# start_read_set_export_job method definition

def start_read_set_export_job(
    self,
    *,
    sequenceStoreId: str,
    destination: str,
    roleArn: str,
    sources: Sequence[ExportReadSetTypeDef],  # (1)
    clientToken: str = ...,
) -> StartReadSetExportJobResponseTypeDef:  # (2)
    ...
  1. See ExportReadSetTypeDef
  2. See StartReadSetExportJobResponseTypeDef 
# start_read_set_export_job method usage example with argument unpacking

kwargs: StartReadSetExportJobRequestRequestTypeDef = {  # (1)
    "sequenceStoreId": ...,
    "destination": ...,
    "roleArn": ...,
    "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

# start_read_set_import_job method definition

def start_read_set_import_job(
    self,
    *,
    sequenceStoreId: str,
    roleArn: str,
    sources: Sequence[StartReadSetImportJobSourceItemTypeDef],  # (1)
    clientToken: str = ...,
) -> StartReadSetImportJobResponseTypeDef:  # (2)
    ...
  1. See StartReadSetImportJobSourceItemTypeDef
  2. See StartReadSetImportJobResponseTypeDef 
# start_read_set_import_job method usage example with argument unpacking

kwargs: StartReadSetImportJobRequestRequestTypeDef = {  # (1)
    "sequenceStoreId": ...,
    "roleArn": ...,
    "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

# start_reference_import_job 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 
# start_reference_import_job method usage example with argument unpacking

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

parent.start_reference_import_job(**kwargs)
  1. See StartReferenceImportJobRequestRequestTypeDef

start_run#

Starts a workflow run.

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

# start_run method definition

def start_run(
    self,
    *,
    roleArn: str,
    requestId: str,
    workflowId: str = ...,
    workflowType: WorkflowTypeType = ...,  # (1)
    runId: str = ...,
    name: str = ...,
    cacheId: str = ...,
    cacheBehavior: CacheBehaviorType = ...,  # (2)
    runGroupId: str = ...,
    priority: int = ...,
    parameters: Mapping[str, Any] = ...,
    storageCapacity: int = ...,
    outputUri: str = ...,
    logLevel: RunLogLevelType = ...,  # (3)
    tags: Mapping[str, str] = ...,
    retentionMode: RunRetentionModeType = ...,  # (4)
    storageType: StorageTypeType = ...,  # (5)
    workflowOwnerId: str = ...,
) -> StartRunResponseTypeDef:  # (6)
    ...
  1. See WorkflowTypeType
  2. See CacheBehaviorType
  3. See RunLogLevelType
  4. See RunRetentionModeType
  5. See StorageTypeType
  6. See StartRunResponseTypeDef 
# start_run method usage example with argument unpacking

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

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

# start_variant_import_job method definition

def start_variant_import_job(
    self,
    *,
    destinationName: str,
    roleArn: str,
    items: Sequence[VariantImportItemSourceTypeDef],  # (1)
    runLeftNormalization: bool = ...,
    annotationFields: Mapping[str, str] = ...,
) -> StartVariantImportResponseTypeDef:  # (2)
    ...
  1. See VariantImportItemSourceTypeDef
  2. See StartVariantImportResponseTypeDef 
# start_variant_import_job method usage example with argument unpacking

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

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

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

# update_annotation_store method definition

def update_annotation_store(
    self,
    *,
    name: str,
    description: str = ...,
) -> UpdateAnnotationStoreResponseTypeDef:  # (1)
    ...
  1. See UpdateAnnotationStoreResponseTypeDef 
# update_annotation_store method usage example with argument unpacking

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

parent.update_annotation_store(**kwargs)
  1. See UpdateAnnotationStoreRequestRequestTypeDef

update_annotation_store_version#

Updates the description of an annotation store version.

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

# update_annotation_store_version method definition

def update_annotation_store_version(
    self,
    *,
    name: str,
    versionName: str,
    description: str = ...,
) -> UpdateAnnotationStoreVersionResponseTypeDef:  # (1)
    ...
  1. See UpdateAnnotationStoreVersionResponseTypeDef 
# update_annotation_store_version method usage example with argument unpacking

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

parent.update_annotation_store_version(**kwargs)
  1. See UpdateAnnotationStoreVersionRequestRequestTypeDef

update_run_cache#

Update a run cache.

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

# update_run_cache method definition

def update_run_cache(
    self,
    *,
    id: str,
    cacheBehavior: CacheBehaviorType = ...,  # (1)
    description: str = ...,
    name: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See CacheBehaviorType
  2. See EmptyResponseMetadataTypeDef 
# update_run_cache method usage example with argument unpacking

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

parent.update_run_cache(**kwargs)
  1. See UpdateRunCacheRequestRequestTypeDef

update_run_group#

Updates a run group.

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

# update_run_group method definition

def update_run_group(
    self,
    *,
    id: str,
    name: str = ...,
    maxCpus: int = ...,
    maxRuns: int = ...,
    maxDuration: int = ...,
    maxGpus: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# update_run_group method usage example with argument unpacking

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

# update_variant_store method definition

def update_variant_store(
    self,
    *,
    name: str,
    description: str = ...,
) -> UpdateVariantStoreResponseTypeDef:  # (1)
    ...
  1. See UpdateVariantStoreResponseTypeDef 
# update_variant_store method usage example with argument unpacking

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

# update_workflow method definition

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

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

parent.update_workflow(**kwargs)
  1. See UpdateWorkflowRequestRequestTypeDef

upload_read_set_part#

This operation uploads a specific part of a read set.

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

# upload_read_set_part method definition

def upload_read_set_part(
    self,
    *,
    sequenceStoreId: str,
    uploadId: str,
    partSource: ReadSetPartSourceType,  # (1)
    partNumber: int,
    payload: BlobTypeDef,
) -> UploadReadSetPartResponseTypeDef:  # (2)
    ...
  1. See ReadSetPartSourceType
  2. See UploadReadSetPartResponseTypeDef 
# upload_read_set_part method usage example with argument unpacking

kwargs: UploadReadSetPartRequestRequestTypeDef = {  # (1)
    "sequenceStoreId": ...,
    "uploadId": ...,
    "partSource": ...,
    "partNumber": ...,
    "payload": ...,
}

parent.upload_read_set_part(**kwargs)
  1. See UploadReadSetPartRequestRequestTypeDef

get_paginator#

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

get_waiter#

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