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)
accept_share#
Accepts a share for an analytics store.
Type annotations and code completion for boto3.client("omics").accept_share
method.
boto3 documentation
# accept_share method definition
def accept_share(
self,
*,
shareId: str,
) -> AcceptShareResponseTypeDef: # (1)
...
# accept_share method usage example with argument unpacking
kwargs: AcceptShareRequestRequestTypeDef = { # (1)
"shareId": ...,
}
parent.accept_share(**kwargs)
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)
...
# batch_delete_read_set method usage example with argument unpacking
kwargs: BatchDeleteReadSetRequestRequestTypeDef = { # (1)
"ids": ...,
"sequenceStoreId": ...,
}
parent.batch_delete_read_set(**kwargs)
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)
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)
...
# cancel_run method usage example with argument unpacking
kwargs: CancelRunRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.cancel_run(**kwargs)
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)
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)
...
# complete_multipart_read_set_upload method usage example with argument unpacking
kwargs: CompleteMultipartReadSetUploadRequestRequestTypeDef = { # (1)
"sequenceStoreId": ...,
"uploadId": ...,
"parts": ...,
}
parent.complete_multipart_read_set_upload(**kwargs)
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)
...
- See StoreFormatType
- See ReferenceItemTypeDef
- See SseConfigTypeDef
- See StoreOptionsTypeDef
- See CreateAnnotationStoreResponseTypeDef
# create_annotation_store method usage example with argument unpacking
kwargs: CreateAnnotationStoreRequestRequestTypeDef = { # (1)
"storeFormat": ...,
}
parent.create_annotation_store(**kwargs)
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)
...
# create_annotation_store_version method usage example with argument unpacking
kwargs: CreateAnnotationStoreVersionRequestRequestTypeDef = { # (1)
"name": ...,
"versionName": ...,
}
parent.create_annotation_store_version(**kwargs)
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,
referenceArn: str,
name: str,
clientToken: str = ...,
generatedFrom: str = ...,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateMultipartReadSetUploadResponseTypeDef: # (2)
...
# create_multipart_read_set_upload method usage example with argument unpacking
kwargs: CreateMultipartReadSetUploadRequestRequestTypeDef = { # (1)
"sequenceStoreId": ...,
"sourceFileType": ...,
"subjectId": ...,
"sampleId": ...,
"referenceArn": ...,
"name": ...,
}
parent.create_multipart_read_set_upload(**kwargs)
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)
...
# create_reference_store method usage example with argument unpacking
kwargs: CreateReferenceStoreRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_reference_store(**kwargs)
create_run_group#
Creates a run 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)
...
# create_run_group method usage example with argument unpacking
kwargs: CreateRunGroupRequestRequestTypeDef = { # (1)
"requestId": ...,
}
parent.create_run_group(**kwargs)
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 = ...,
) -> CreateSequenceStoreResponseTypeDef: # (2)
...
# create_sequence_store method usage example with argument unpacking
kwargs: CreateSequenceStoreRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_sequence_store(**kwargs)
create_share#
Creates a share offer that can be accepted outside the account by a subscriber.
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)
...
# create_share method usage example with argument unpacking
kwargs: CreateShareRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"principalSubscriber": ...,
}
parent.create_share(**kwargs)
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)
...
# create_variant_store method usage example with argument unpacking
kwargs: CreateVariantStoreRequestRequestTypeDef = { # (1)
"reference": ...,
}
parent.create_variant_store(**kwargs)
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: Union[str, bytes, IO[Any], StreamingBody] = ...,
definitionUri: str = ...,
main: str = ...,
parameterTemplate: Mapping[str, WorkflowParameterTypeDef] = ..., # (2)
storageCapacity: int = ...,
tags: Mapping[str, str] = ...,
accelerators: AcceleratorsType = ..., # (3)
) -> CreateWorkflowResponseTypeDef: # (4)
...
- See WorkflowEngineType
- See WorkflowParameterTypeDef
- See AcceleratorsType
- See CreateWorkflowResponseTypeDef
# create_workflow method usage example with argument unpacking
kwargs: CreateWorkflowRequestRequestTypeDef = { # (1)
"requestId": ...,
}
parent.create_workflow(**kwargs)
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)
...
# delete_annotation_store method usage example with argument unpacking
kwargs: DeleteAnnotationStoreRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_annotation_store(**kwargs)
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)
...
# delete_annotation_store_versions method usage example with argument unpacking
kwargs: DeleteAnnotationStoreVersionsRequestRequestTypeDef = { # (1)
"name": ...,
"versions": ...,
}
parent.delete_annotation_store_versions(**kwargs)
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)
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)
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)
...
# delete_run method usage example with argument unpacking
kwargs: DeleteRunRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_run(**kwargs)
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)
...
# delete_run_group method usage example with argument unpacking
kwargs: DeleteRunGroupRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_run_group(**kwargs)
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)
delete_share#
Deletes a share of an analytics store.
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)
...
# delete_share method usage example with argument unpacking
kwargs: DeleteShareRequestRequestTypeDef = { # (1)
"shareId": ...,
}
parent.delete_share(**kwargs)
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)
...
# delete_variant_store method usage example with argument unpacking
kwargs: DeleteVariantStoreRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_variant_store(**kwargs)