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.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
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:
...
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)
description: str = ...,
name: str = ...,
reference: ReferenceItemTypeDef = ..., # (2)
sseConfig: SseConfigTypeDef = ..., # (3)
storeOptions: StoreOptionsTypeDef = ..., # (4)
tags: Mapping[str, str] = ...,
) -> 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_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,
clientToken: str = ...,
description: str = ...,
sseConfig: SseConfigTypeDef = ..., # (1)
tags: Mapping[str, 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,
maxCpus: int = ...,
maxDuration: int = ...,
maxRuns: int = ...,
name: str = ...,
tags: Mapping[str, str] = ...,
) -> 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,
clientToken: str = ...,
description: str = ...,
sseConfig: SseConfigTypeDef = ..., # (1)
tags: Mapping[str, str] = ...,
) -> CreateSequenceStoreResponseTypeDef: # (2)
...
# create_sequence_store method usage example with argument unpacking
kwargs: CreateSequenceStoreRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_sequence_store(**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)
description: str = ...,
name: str = ...,
sseConfig: SseConfigTypeDef = ..., # (2)
tags: Mapping[str, str] = ...,
) -> 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,
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)
...
# 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_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_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)
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)
...
# delete_workflow method usage example with argument unpacking
kwargs: DeleteWorkflowRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_workflow(**kwargs)
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)
...
# get_annotation_import_job method usage example with argument unpacking
kwargs: GetAnnotationImportRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.get_annotation_import_job(**kwargs)
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)
...
# get_annotation_store method usage example with argument unpacking
kwargs: GetAnnotationStoreRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_annotation_store(**kwargs)
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,
partNumber: int,
sequenceStoreId: str,
file: ReadSetFileType = ..., # (1)
) -> GetReadSetResponseTypeDef: # (2)
...
# get_read_set method usage example with argument unpacking
kwargs: GetReadSetRequestRequestTypeDef = { # (1)
"id": ...,
"partNumber": ...,
"sequenceStoreId": ...,
}
parent.get_read_set(**kwargs)
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)
...
# get_read_set_activation_job method usage example with argument unpacking
kwargs: GetReadSetActivationJobRequestRequestTypeDef = { # (1)
"id": ...,
"sequenceStoreId": ...,
}
parent.get_read_set_activation_job(**kwargs)
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,
*,
id: str,
sequenceStoreId: str,
) -> GetReadSetExportJobResponseTypeDef: # (1)
...
# get_read_set_export_job method usage example with argument unpacking
kwargs: GetReadSetExportJobRequestRequestTypeDef = { # (1)
"id": ...,
"sequenceStoreId": ...,
}
parent.get_read_set_export_job(**kwargs)
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)
...
# get_read_set_import_job method usage example with argument unpacking
kwargs: GetReadSetImportJobRequestRequestTypeDef = { # (1)
"id": ...,
"sequenceStoreId": ...,
}
parent.get_read_set_import_job(**kwargs)
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)
...
# get_read_set_metadata method usage example with argument unpacking
kwargs: GetReadSetMetadataRequestRequestTypeDef = { # (1)
"id": ...,
"sequenceStoreId": ...,
}
parent.get_read_set_metadata(**kwargs)
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,
partNumber: int,
referenceStoreId: str,
file: ReferenceFileType = ..., # (1)
range: str = ...,
) -> GetReferenceResponseTypeDef: # (2)
...
# get_reference method usage example with argument unpacking
kwargs: GetReferenceRequestRequestTypeDef = { # (1)
"id": ...,
"partNumber": ...,
"referenceStoreId": ...,
}
parent.get_reference(**kwargs)
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)
...
# get_reference_import_job method usage example with argument unpacking
kwargs: GetReferenceImportJobRequestRequestTypeDef = { # (1)
"id": ...,
"referenceStoreId": ...,
}
parent.get_reference_import_job(**kwargs)
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)
...
# get_reference_metadata method usage example with argument unpacking
kwargs: GetReferenceMetadataRequestRequestTypeDef = { # (1)
"id": ...,
"referenceStoreId": ...,
}
parent.get_reference_metadata(**kwargs)
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)
...
# get_reference_store method usage example with argument unpacking
kwargs: GetReferenceStoreRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_reference_store(**kwargs)
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)
...
- See RunExportType
- See GetRunResponseTypeDef
# get_run method usage example with argument unpacking
kwargs: GetRunRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_run(**kwargs)
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)
...
# get_run_group method usage example with argument unpacking
kwargs: GetRunGroupRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_run_group(**kwargs)
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)
...
# get_run_task method usage example with argument unpacking
kwargs: GetRunTaskRequestRequestTypeDef = { # (1)
"id": ...,
"taskId": ...,
}
parent.get_run_task(**kwargs)
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)
...
# get_sequence_store method usage example with argument unpacking
kwargs: GetSequenceStoreRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_sequence_store(**kwargs)
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)
...
# get_variant_import_job method usage example with argument unpacking
kwargs: GetVariantImportRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.get_variant_import_job(**kwargs)
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)
...
# get_variant_store method usage example with argument unpacking
kwargs: GetVariantStoreRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_variant_store(**kwargs)
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,
export: Sequence[WorkflowExportType] = ..., # (1)
type: WorkflowTypeType = ..., # (2)
) -> GetWorkflowResponseTypeDef: # (3)
...
# get_workflow method usage example with argument unpacking
kwargs: GetWorkflowRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_workflow(**kwargs)
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,
*,
filter: ListAnnotationImportJobsFilterTypeDef = ..., # (1)
ids: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListAnnotationImportJobsResponseTypeDef: # (2)
...
# list_annotation_import_jobs method usage example with argument unpacking
kwargs: ListAnnotationImportJobsRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.list_annotation_import_jobs(**kwargs)
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,
*,
filter: ListAnnotationStoresFilterTypeDef = ..., # (1)
ids: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListAnnotationStoresResponseTypeDef: # (2)
...
# list_annotation_stores method usage example with argument unpacking
kwargs: ListAnnotationStoresRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.list_annotation_stores(**kwargs)
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,
filter: ActivateReadSetFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListReadSetActivationJobsResponseTypeDef: # (2)
...
# list_read_set_activation_jobs method usage example with argument unpacking
kwargs: ListReadSetActivationJobsRequestRequestTypeDef = { # (1)
"sequenceStoreId": ...,
}
parent.list_read_set_activation_jobs(**kwargs)
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,
filter: ExportReadSetFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListReadSetExportJobsResponseTypeDef: # (2)
...
# list_read_set_export_jobs method usage example with argument unpacking
kwargs: ListReadSetExportJobsRequestRequestTypeDef = { # (1)
"sequenceStoreId": ...,
}
parent.list_read_set_export_jobs(**kwargs)
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,
filter: ImportReadSetFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListReadSetImportJobsResponseTypeDef: # (2)
...
# list_read_set_import_jobs method usage example with argument unpacking
kwargs: ListReadSetImportJobsRequestRequestTypeDef = { # (1)
"sequenceStoreId": ...,
}
parent.list_read_set_import_jobs(**kwargs)
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,
filter: ReadSetFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListReadSetsResponseTypeDef: # (2)
...
# list_read_sets method usage example with argument unpacking
kwargs: ListReadSetsRequestRequestTypeDef = { # (1)
"sequenceStoreId": ...,
}
parent.list_read_sets(**kwargs)
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,
filter: ImportReferenceFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListReferenceImportJobsResponseTypeDef: # (2)
...
# list_reference_import_jobs method usage example with argument unpacking
kwargs: ListReferenceImportJobsRequestRequestTypeDef = { # (1)
"referenceStoreId": ...,
}
parent.list_reference_import_jobs(**kwargs)
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,
*,
filter: ReferenceStoreFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListReferenceStoresResponseTypeDef: # (2)
...
# list_reference_stores method usage example with argument unpacking
kwargs: ListReferenceStoresRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.list_reference_stores(**kwargs)
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,
filter: ReferenceFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListReferencesResponseTypeDef: # (2)
...
# list_references method usage example with argument unpacking
kwargs: ListReferencesRequestRequestTypeDef = { # (1)
"referenceStoreId": ...,
}
parent.list_references(**kwargs)
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,
*,
maxResults: int = ...,
name: str = ...,
startingToken: str = ...,
) -> ListRunGroupsResponseTypeDef: # (1)
...
# list_run_groups method usage example with argument unpacking
kwargs: ListRunGroupsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_run_groups(**kwargs)
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,
maxResults: int = ...,
startingToken: str = ...,
status: TaskStatusType = ..., # (1)
) -> ListRunTasksResponseTypeDef: # (2)
...
# list_run_tasks method usage example with argument unpacking
kwargs: ListRunTasksRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.list_run_tasks(**kwargs)
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,
*,
maxResults: int = ...,
name: str = ...,
runGroupId: str = ...,
startingToken: str = ...,
) -> ListRunsResponseTypeDef: # (1)
...
# list_runs method usage example with argument unpacking
kwargs: ListRunsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_runs(**kwargs)
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,
*,
filter: SequenceStoreFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListSequenceStoresResponseTypeDef: # (2)
...
# list_sequence_stores method usage example with argument unpacking
kwargs: ListSequenceStoresRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.list_sequence_stores(**kwargs)
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)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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,
*,
filter: ListVariantImportJobsFilterTypeDef = ..., # (1)
ids: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListVariantImportJobsResponseTypeDef: # (2)
...
# list_variant_import_jobs method usage example with argument unpacking
kwargs: ListVariantImportJobsRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.list_variant_import_jobs(**kwargs)
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,
*,
filter: ListVariantStoresFilterTypeDef = ..., # (1)
ids: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListVariantStoresResponseTypeDef: # (2)
...
# list_variant_stores method usage example with argument unpacking
kwargs: ListVariantStoresRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.list_variant_stores(**kwargs)
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,
*,
maxResults: int = ...,
name: str = ...,
startingToken: str = ...,
type: WorkflowTypeType = ..., # (1)
) -> ListWorkflowsResponseTypeDef: # (2)
...
# list_workflows method usage example with argument unpacking
kwargs: ListWorkflowsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_workflows(**kwargs)
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,
items: Sequence[AnnotationImportItemSourceTypeDef], # (1)
roleArn: str,
formatOptions: FormatOptionsTypeDef = ..., # (2)
runLeftNormalization: bool = ...,
) -> StartAnnotationImportResponseTypeDef: # (3)
...
- See AnnotationImportItemSourceTypeDef
- See FormatOptionsTypeDef
- See StartAnnotationImportResponseTypeDef
# start_annotation_import_job method usage example with argument unpacking
kwargs: StartAnnotationImportRequestRequestTypeDef = { # (1)
"destinationName": ...,
"items": ...,
"roleArn": ...,
}
parent.start_annotation_import_job(**kwargs)
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)
...
# start_read_set_activation_job method usage example with argument unpacking
kwargs: StartReadSetActivationJobRequestRequestTypeDef = { # (1)
"sequenceStoreId": ...,
"sources": ...,
}
parent.start_read_set_activation_job(**kwargs)
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,
*,
destination: str,
roleArn: str,
sequenceStoreId: str,
sources: Sequence[ExportReadSetTypeDef], # (1)
clientToken: str = ...,
) -> StartReadSetExportJobResponseTypeDef: # (2)
...
# start_read_set_export_job method usage example with argument unpacking
kwargs: StartReadSetExportJobRequestRequestTypeDef = { # (1)
"destination": ...,
"roleArn": ...,
"sequenceStoreId": ...,
"sources": ...,
}
parent.start_read_set_export_job(**kwargs)
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,
*,
roleArn: str,
sequenceStoreId: str,
sources: Sequence[StartReadSetImportJobSourceItemTypeDef], # (1)
clientToken: str = ...,
) -> StartReadSetImportJobResponseTypeDef: # (2)
...
# start_read_set_import_job method usage example with argument unpacking
kwargs: StartReadSetImportJobRequestRequestTypeDef = { # (1)
"roleArn": ...,
"sequenceStoreId": ...,
"sources": ...,
}
parent.start_read_set_import_job(**kwargs)
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)
...
# start_reference_import_job method usage example with argument unpacking
kwargs: StartReferenceImportJobRequestRequestTypeDef = { # (1)
"referenceStoreId": ...,
"roleArn": ...,
"sources": ...,
}
parent.start_reference_import_job(**kwargs)
start_run
Starts a run.
Type annotations and code completion for boto3.client("omics").start_run
method.
boto3 documentation
# start_run 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)
...
- See RunLogLevelType
- See WorkflowTypeType
- See StartRunResponseTypeDef
# start_run method usage example with argument unpacking
kwargs: StartRunRequestRequestTypeDef = { # (1)
"requestId": ...,
"roleArn": ...,
}
parent.start_run(**kwargs)
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,
items: Sequence[VariantImportItemSourceTypeDef], # (1)
roleArn: str,
runLeftNormalization: bool = ...,
) -> StartVariantImportResponseTypeDef: # (2)
...
# start_variant_import_job method usage example with argument unpacking
kwargs: StartVariantImportRequestRequestTypeDef = { # (1)
"destinationName": ...,
"items": ...,
"roleArn": ...,
}
parent.start_variant_import_job(**kwargs)
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)
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)
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)
...
# update_annotation_store method usage example with argument unpacking
kwargs: UpdateAnnotationStoreRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.update_annotation_store(**kwargs)
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,
maxCpus: int = ...,
maxDuration: int = ...,
maxRuns: int = ...,
name: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# update_run_group method usage example with argument unpacking
kwargs: UpdateRunGroupRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.update_run_group(**kwargs)
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)
...
# update_variant_store method usage example with argument unpacking
kwargs: UpdateVariantStoreRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.update_variant_store(**kwargs)
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,
description: str = ...,
name: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...