Omics ***** Client ====== class Omics.Client A low-level client representing Amazon Omics Amazon Web Services HealthOmics is a service that helps users such as bioinformaticians, researchers, and scientists to store, query, analyze, and generate insights from genomics and other biological data. It simplifies and accelerates the process of storing and analyzing genomic information for Amazon Web Services. For an introduction to the service, see What is Amazon Web Services HealthOmics? in the *Amazon Web Services HealthOmics User Guide*. import boto3 client = boto3.client('omics') These are the available methods: * abort_multipart_read_set_upload * accept_share * batch_delete_read_set * can_paginate * cancel_annotation_import_job * cancel_run * cancel_variant_import_job * close * complete_multipart_read_set_upload * create_annotation_store * create_annotation_store_version * create_multipart_read_set_upload * create_reference_store * create_run_cache * create_run_group * create_sequence_store * create_share * create_variant_store * create_workflow * create_workflow_version * delete_annotation_store * delete_annotation_store_versions * delete_reference * delete_reference_store * delete_run * delete_run_cache * delete_run_group * delete_s3_access_policy * delete_sequence_store * delete_share * delete_variant_store * delete_workflow * delete_workflow_version * get_annotation_import_job * get_annotation_store * get_annotation_store_version * get_paginator * get_read_set * get_read_set_activation_job * get_read_set_export_job * get_read_set_import_job * get_read_set_metadata * get_reference * get_reference_import_job * get_reference_metadata * get_reference_store * get_run * get_run_cache * get_run_group * get_run_task * get_s3_access_policy * get_sequence_store * get_share * get_variant_import_job * get_variant_store * get_waiter * get_workflow * get_workflow_version * list_annotation_import_jobs * list_annotation_store_versions * list_annotation_stores * list_multipart_read_set_uploads * list_read_set_activation_jobs * list_read_set_export_jobs * list_read_set_import_jobs * list_read_set_upload_parts * list_read_sets * list_reference_import_jobs * list_reference_stores * list_references * list_run_caches * list_run_groups * list_run_tasks * list_runs * list_sequence_stores * list_shares * list_tags_for_resource * list_variant_import_jobs * list_variant_stores * list_workflow_versions * list_workflows * put_s3_access_policy * start_annotation_import_job * start_read_set_activation_job * start_read_set_export_job * start_read_set_import_job * start_reference_import_job * start_run * start_variant_import_job * tag_resource * untag_resource * update_annotation_store * update_annotation_store_version * update_run_cache * update_run_group * update_sequence_store * update_variant_store * update_workflow * update_workflow_version * upload_read_set_part Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAnnotationImportJobs * ListAnnotationStoreVersions * ListAnnotationStores * ListMultipartReadSetUploads * ListReadSetActivationJobs * ListReadSetExportJobs * ListReadSetImportJobs * ListReadSetUploadParts * ListReadSets * ListReferenceImportJobs * ListReferenceStores * ListReferences * ListRunCaches * ListRunGroups * ListRunTasks * ListRuns * ListSequenceStores * ListShares * ListVariantImportJobs * ListVariantStores * ListWorkflowVersions * ListWorkflows Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * AnnotationImportJobCreated * AnnotationStoreCreated * AnnotationStoreDeleted * AnnotationStoreVersionCreated * AnnotationStoreVersionDeleted * ReadSetActivationJobCompleted * ReadSetExportJobCompleted * ReadSetImportJobCompleted * ReferenceImportJobCompleted * RunCompleted * RunRunning * TaskCompleted * TaskRunning * VariantImportJobCreated * VariantStoreCreated * VariantStoreDeleted * WorkflowActive * WorkflowVersionActive Omics / Waiter / VariantImportJobCreated VariantImportJobCreated *********************** class Omics.Waiter.VariantImportJobCreated waiter = client.get_waiter('variant_import_job_created') wait(**kwargs) Polls "Omics.Client.get_variant_import_job()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( jobId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **jobId** (*string*) -- **[REQUIRED]** The job's ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / ReadSetExportJobCompleted ReadSetExportJobCompleted ************************* class Omics.Waiter.ReadSetExportJobCompleted waiter = client.get_waiter('read_set_export_job_completed') wait(**kwargs) Polls "Omics.Client.get_read_set_export_job()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( sequenceStoreId='string', id='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **sequenceStoreId** (*string*) -- **[REQUIRED]** The job's sequence store ID. * **id** (*string*) -- **[REQUIRED]** The job's ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / ReadSetActivationJobCompleted ReadSetActivationJobCompleted ***************************** class Omics.Waiter.ReadSetActivationJobCompleted waiter = client.get_waiter('read_set_activation_job_completed') wait(**kwargs) Polls "Omics.Client.get_read_set_activation_job()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( id='string', sequenceStoreId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The job's ID. * **sequenceStoreId** (*string*) -- **[REQUIRED]** The job's sequence store ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / AnnotationStoreVersionCreated AnnotationStoreVersionCreated ***************************** class Omics.Waiter.AnnotationStoreVersionCreated waiter = client.get_waiter('annotation_store_version_created') wait(**kwargs) Polls "Omics.Client.get_annotation_store_version()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( name='string', versionName='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name given to an annotation store version to distinguish it from others. * **versionName** (*string*) -- **[REQUIRED]** The name given to an annotation store version to distinguish it from others. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / AnnotationStoreDeleted AnnotationStoreDeleted ********************** class Omics.Waiter.AnnotationStoreDeleted waiter = client.get_waiter('annotation_store_deleted') wait(**kwargs) Polls "Omics.Client.get_annotation_store()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( name='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The store's name. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / TaskCompleted TaskCompleted ************* class Omics.Waiter.TaskCompleted waiter = client.get_waiter('task_completed') wait(**kwargs) Polls "Omics.Client.get_run_task()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( id='string', taskId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The workflow run ID. * **taskId** (*string*) -- **[REQUIRED]** The task's ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / VariantStoreDeleted VariantStoreDeleted ******************* class Omics.Waiter.VariantStoreDeleted waiter = client.get_waiter('variant_store_deleted') wait(**kwargs) Polls "Omics.Client.get_variant_store()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( name='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The store's name. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / RunRunning RunRunning ********** class Omics.Waiter.RunRunning waiter = client.get_waiter('run_running') wait(**kwargs) Polls "Omics.Client.get_run()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( id='string', export=[ 'DEFINITION', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The run's ID. * **export** (*list*) -- The run's export format. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / WorkflowVersionActive WorkflowVersionActive ********************* class Omics.Waiter.WorkflowVersionActive waiter = client.get_waiter('workflow_version_active') wait(**kwargs) Polls "Omics.Client.get_workflow_version()" every 3 seconds until a successful state is reached. An error is raised after 10 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( workflowId='string', versionName='string', type='PRIVATE'|'READY2RUN', export=[ 'DEFINITION'|'README', ], workflowOwnerId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **workflowId** (*string*) -- **[REQUIRED]** The workflow's ID. * **versionName** (*string*) -- **[REQUIRED]** The workflow version name. * **type** (*string*) -- The workflow's type. * **export** (*list*) -- The export format for the workflow. * *(string) --* * **workflowOwnerId** (*string*) -- Amazon Web Services Id of the owner of the workflow. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 3 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 10 Returns: None Omics / Waiter / AnnotationImportJobCreated AnnotationImportJobCreated ************************** class Omics.Waiter.AnnotationImportJobCreated waiter = client.get_waiter('annotation_import_job_created') wait(**kwargs) Polls "Omics.Client.get_annotation_import_job()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( jobId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **jobId** (*string*) -- **[REQUIRED]** The job's ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / RunCompleted RunCompleted ************ class Omics.Waiter.RunCompleted waiter = client.get_waiter('run_completed') wait(**kwargs) Polls "Omics.Client.get_run()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( id='string', export=[ 'DEFINITION', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The run's ID. * **export** (*list*) -- The run's export format. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / TaskRunning TaskRunning *********** class Omics.Waiter.TaskRunning waiter = client.get_waiter('task_running') wait(**kwargs) Polls "Omics.Client.get_run_task()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( id='string', taskId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The workflow run ID. * **taskId** (*string*) -- **[REQUIRED]** The task's ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / AnnotationStoreVersionDeleted AnnotationStoreVersionDeleted ***************************** class Omics.Waiter.AnnotationStoreVersionDeleted waiter = client.get_waiter('annotation_store_version_deleted') wait(**kwargs) Polls "Omics.Client.get_annotation_store_version()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( name='string', versionName='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name given to an annotation store version to distinguish it from others. * **versionName** (*string*) -- **[REQUIRED]** The name given to an annotation store version to distinguish it from others. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / AnnotationStoreCreated AnnotationStoreCreated ********************** class Omics.Waiter.AnnotationStoreCreated waiter = client.get_waiter('annotation_store_created') wait(**kwargs) Polls "Omics.Client.get_annotation_store()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( name='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The store's name. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / ReferenceImportJobCompleted ReferenceImportJobCompleted *************************** class Omics.Waiter.ReferenceImportJobCompleted waiter = client.get_waiter('reference_import_job_completed') wait(**kwargs) Polls "Omics.Client.get_reference_import_job()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( id='string', referenceStoreId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The job's ID. * **referenceStoreId** (*string*) -- **[REQUIRED]** The job's reference store ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / WorkflowActive WorkflowActive ************** class Omics.Waiter.WorkflowActive waiter = client.get_waiter('workflow_active') wait(**kwargs) Polls "Omics.Client.get_workflow()" every 3 seconds until a successful state is reached. An error is raised after 10 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( id='string', type='PRIVATE'|'READY2RUN', export=[ 'DEFINITION'|'README', ], workflowOwnerId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The workflow's ID. * **type** (*string*) -- The workflow's type. * **export** (*list*) -- The export format for the workflow. * *(string) --* * **workflowOwnerId** (*string*) -- The ID of the workflow owner. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 3 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 10 Returns: None Omics / Waiter / ReadSetImportJobCompleted ReadSetImportJobCompleted ************************* class Omics.Waiter.ReadSetImportJobCompleted waiter = client.get_waiter('read_set_import_job_completed') wait(**kwargs) Polls "Omics.Client.get_read_set_import_job()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( id='string', sequenceStoreId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The job's ID. * **sequenceStoreId** (*string*) -- **[REQUIRED]** The job's sequence store ID. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Waiter / VariantStoreCreated VariantStoreCreated ******************* class Omics.Waiter.VariantStoreCreated waiter = client.get_waiter('variant_store_created') wait(**kwargs) Polls "Omics.Client.get_variant_store()" every 30 seconds until a successful state is reached. An error is raised after 20 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( name='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The store's name. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 20 Returns: None Omics / Paginator / ListShares ListShares ********** class Omics.Paginator.ListShares paginator = client.get_paginator('list_shares') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_shares()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( resourceOwner='SELF'|'OTHER', filter={ 'resourceArns': [ 'string', ], 'status': [ 'PENDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED', ], 'type': [ 'VARIANT_STORE'|'ANNOTATION_STORE'|'WORKFLOW', ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **resourceOwner** (*string*) -- **[REQUIRED]** The account that owns the resource shares. * **filter** (*dict*) -- Attributes that you use to filter for a specific subset of resource shares. * **resourceArns** *(list) --* Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values. * *(string) --* * **status** *(list) --* Filter based on the resource status. You can specify up to 10 values. * *(string) --* * **type** *(list) --* The type of resources to be filtered. You can specify one or more of the resource types. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'shares': [ { 'shareId': 'string', 'resourceArn': 'string', 'resourceId': 'string', 'principalSubscriber': 'string', 'ownerId': 'string', 'status': 'PENDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED', 'statusMessage': 'string', 'shareName': 'string', 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **shares** *(list) --* The shares available and their metadata details. * *(dict) --* The details of a resource share. * **shareId** *(string) --* The ID of the resource share. * **resourceArn** *(string) --* The Arn of the shared resource. * **resourceId** *(string) --* The ID of the shared resource. * **principalSubscriber** *(string) --* The principal subscriber is the account that is sharing the resource. * **ownerId** *(string) --* The account ID for the data owner. The owner creates the resource share. * **status** *(string) --* The status of the share. * **statusMessage** *(string) --* The status message for a resource share. It provides additional details about the share status. * **shareName** *(string) --* The name of the resource share. * **creationTime** *(datetime) --* The timestamp of when the resource share was created. * **updateTime** *(datetime) --* The timestamp of the resource share update. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListVariantImportJobs ListVariantImportJobs ********************* class Omics.Paginator.ListVariantImportJobs paginator = client.get_paginator('list_variant_import_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_variant_import_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ids=[ 'string', ], filter={ 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES', 'storeName': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ids** (*list*) -- A list of job IDs. * *(string) --* * **filter** (*dict*) -- A filter to apply to the list. * **status** *(string) --* A status to filter on. * **storeName** *(string) --* A store name to filter on. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'variantImportJobs': [ { 'id': 'string', 'destinationName': 'string', 'roleArn': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES', 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1), 'completionTime': datetime(2015, 1, 1), 'runLeftNormalization': True|False, 'annotationFields': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **variantImportJobs** *(list) --* A list of jobs. * *(dict) --* A variant import job. * **id** *(string) --* The job's ID. * **destinationName** *(string) --* The job's destination variant store. * **roleArn** *(string) --* The job's service role ARN. * **status** *(string) --* The job's status. * **creationTime** *(datetime) --* When the job was created. * **updateTime** *(datetime) --* When the job was updated. * **completionTime** *(datetime) --* When the job completed. * **runLeftNormalization** *(boolean) --* The job's left normalization setting. * **annotationFields** *(dict) --* The annotation schema generated by the parsed annotation data. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListReferences ListReferences ************** class Omics.Paginator.ListReferences paginator = client.get_paginator('list_references') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_references()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( referenceStoreId='string', filter={ 'name': 'string', 'md5': 'string', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1) }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **referenceStoreId** (*string*) -- **[REQUIRED]** The references' reference store ID. * **filter** (*dict*) -- A filter to apply to the list. * **name** *(string) --* A name to filter on. * **md5** *(string) --* An MD5 checksum to filter on. * **createdAfter** *(datetime) --* The filter's start date. * **createdBefore** *(datetime) --* The filter's end date. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'references': [ { 'id': 'string', 'arn': 'string', 'referenceStoreId': 'string', 'md5': 'string', 'status': 'ACTIVE'|'DELETING'|'DELETED', 'name': 'string', 'description': 'string', 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **references** *(list) --* A list of references. * *(dict) --* A genome reference. * **id** *(string) --* The reference's ID. * **arn** *(string) --* The reference's ARN. * **referenceStoreId** *(string) --* The reference's store ID. * **md5** *(string) --* The reference's MD5 checksum. * **status** *(string) --* The reference's status. * **name** *(string) --* The reference's name. * **description** *(string) --* The reference's description. * **creationTime** *(datetime) --* When the reference was created. * **updateTime** *(datetime) --* When the reference was updated. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListWorkflows ListWorkflows ************* class Omics.Paginator.ListWorkflows paginator = client.get_paginator('list_workflows') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_workflows()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( type='PRIVATE'|'READY2RUN', name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **type** (*string*) -- Filter the list by workflow type. * **name** (*string*) -- Filter the list by workflow name. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'id': 'string', 'name': 'string', 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETED'|'FAILED'|'INACTIVE', 'type': 'PRIVATE'|'READY2RUN', 'digest': 'string', 'creationTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* A list of workflow items. * *(dict) --* A workflow. * **arn** *(string) --* The workflow's ARN. * **id** *(string) --* The workflow's ID. * **name** *(string) --* The workflow's name. * **status** *(string) --* The workflow's status. * **type** *(string) --* The workflow's type. * **digest** *(string) --* The workflow's digest. * **creationTime** *(datetime) --* When the workflow was created. * **metadata** *(dict) --* Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListReadSetUploadParts ListReadSetUploadParts ********************** class Omics.Paginator.ListReadSetUploadParts paginator = client.get_paginator('list_read_set_upload_parts') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_read_set_upload_parts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( sequenceStoreId='string', uploadId='string', partSource='SOURCE1'|'SOURCE2', filter={ 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1) }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **sequenceStoreId** (*string*) -- **[REQUIRED]** The Sequence Store ID used for the multipart uploads. * **uploadId** (*string*) -- **[REQUIRED]** The ID for the initiated multipart upload. * **partSource** (*string*) -- **[REQUIRED]** The source file for the upload part. * **filter** (*dict*) -- Attributes used to filter for a specific subset of read set part uploads. * **createdAfter** *(datetime) --* Filters for read set uploads after a specified time. * **createdBefore** *(datetime) --* Filters for read set part uploads before a specified time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'parts': [ { 'partNumber': 123, 'partSize': 123, 'partSource': 'SOURCE1'|'SOURCE2', 'checksum': 'string', 'creationTime': datetime(2015, 1, 1), 'lastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **parts** *(list) --* An array of upload parts. * *(dict) --* The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API. * **partNumber** *(integer) --* The number identifying the part in an upload. * **partSize** *(integer) --* The size of the the part in an upload. * **partSource** *(string) --* The origin of the part being direct uploaded. * **checksum** *(string) --* A unique identifier used to confirm that parts are being added to the correct upload. * **creationTime** *(datetime) --* The time stamp for when a direct upload was created. * **lastUpdatedTime** *(datetime) --* The time stamp for the most recent update to an uploaded part. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListAnnotationImportJobs ListAnnotationImportJobs ************************ class Omics.Paginator.ListAnnotationImportJobs paginator = client.get_paginator('list_annotation_import_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_annotation_import_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ids=[ 'string', ], filter={ 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES', 'storeName': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ids** (*list*) -- IDs of annotation import jobs to retrieve. * *(string) --* * **filter** (*dict*) -- A filter to apply to the list. * **status** *(string) --* A status to filter on. * **storeName** *(string) --* A store name to filter on. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'annotationImportJobs': [ { 'id': 'string', 'destinationName': 'string', 'versionName': 'string', 'roleArn': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES', 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1), 'completionTime': datetime(2015, 1, 1), 'runLeftNormalization': True|False, 'annotationFields': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **annotationImportJobs** *(list) --* A list of jobs. * *(dict) --* An annotation import job. * **id** *(string) --* The job's ID. * **destinationName** *(string) --* The job's destination annotation store. * **versionName** *(string) --* The name of the annotation store version. * **roleArn** *(string) --* The job's service role ARN. * **status** *(string) --* The job's status. * **creationTime** *(datetime) --* When the job was created. * **updateTime** *(datetime) --* When the job was updated. * **completionTime** *(datetime) --* When the job completed. * **runLeftNormalization** *(boolean) --* The job's left normalization setting. * **annotationFields** *(dict) --* The annotation schema generated by the parsed annotation data. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListReferenceImportJobs ListReferenceImportJobs *********************** class Omics.Paginator.ListReferenceImportJobs paginator = client.get_paginator('list_reference_import_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_reference_import_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( referenceStoreId='string', filter={ 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1) }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **referenceStoreId** (*string*) -- **[REQUIRED]** The job's reference store ID. * **filter** (*dict*) -- A filter to apply to the list. * **status** *(string) --* A status to filter on. * **createdAfter** *(datetime) --* The filter's start date. * **createdBefore** *(datetime) --* The filter's end date. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'importJobs': [ { 'id': 'string', 'referenceStoreId': 'string', 'roleArn': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'creationTime': datetime(2015, 1, 1), 'completionTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **importJobs** *(list) --* A lis of jobs. * *(dict) --* An import reference job. * **id** *(string) --* The job's ID. * **referenceStoreId** *(string) --* The job's reference store ID. * **roleArn** *(string) --* The job's service role ARN. * **status** *(string) --* The job's status. * **creationTime** *(datetime) --* When the job was created. * **completionTime** *(datetime) --* When the job completed. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListWorkflowVersions ListWorkflowVersions ******************** class Omics.Paginator.ListWorkflowVersions paginator = client.get_paginator('list_workflow_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_workflow_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( workflowId='string', type='PRIVATE'|'READY2RUN', workflowOwnerId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **workflowId** (*string*) -- **[REQUIRED]** The workflow's ID. * **type** (*string*) -- The workflow type. * **workflowOwnerId** (*string*) -- Amazon Web Services Id of the owner of the workflow. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'workflowId': 'string', 'versionName': 'string', 'description': 'string', 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETED'|'FAILED'|'INACTIVE', 'type': 'PRIVATE'|'READY2RUN', 'digest': 'string', 'creationTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* A list of workflow version items. * *(dict) --* A list of workflow version items. * **arn** *(string) --* ARN of the workflow version. * **workflowId** *(string) --* The workflow's ID. * **versionName** *(string) --* The name of the workflow version. * **description** *(string) --* The description of the workflow version. * **status** *(string) --* The status of the workflow version. * **type** *(string) --* The type of the workflow version. * **digest** *(string) --* The digist of the workflow version. * **creationTime** *(datetime) --* The creation time of the workflow version. * **metadata** *(dict) --* Metadata for the workflow version. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListReadSets ListReadSets ************ class Omics.Paginator.ListReadSets paginator = client.get_paginator('list_read_sets') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_read_sets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( sequenceStoreId='string', filter={ 'name': 'string', 'status': 'ARCHIVED'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'PROCESSING_UPLOAD'|'UPLOAD_FAILED', 'referenceArn': 'string', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1), 'sampleId': 'string', 'subjectId': 'string', 'generatedFrom': 'string', 'creationType': 'IMPORT'|'UPLOAD' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **sequenceStoreId** (*string*) -- **[REQUIRED]** The jobs' sequence store ID. * **filter** (*dict*) -- A filter to apply to the list. * **name** *(string) --* A name to filter on. * **status** *(string) --* A status to filter on. * **referenceArn** *(string) --* A genome reference ARN to filter on. * **createdAfter** *(datetime) --* The filter's start date. * **createdBefore** *(datetime) --* The filter's end date. * **sampleId** *(string) --* The read set source's sample ID. * **subjectId** *(string) --* The read set source's subject ID. * **generatedFrom** *(string) --* Where the source originated. * **creationType** *(string) --* The creation type of the read set. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'readSets': [ { 'id': 'string', 'arn': 'string', 'sequenceStoreId': 'string', 'subjectId': 'string', 'sampleId': 'string', 'status': 'ARCHIVED'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'PROCESSING_UPLOAD'|'UPLOAD_FAILED', 'name': 'string', 'description': 'string', 'referenceArn': 'string', 'fileType': 'FASTQ'|'BAM'|'CRAM'|'UBAM', 'sequenceInformation': { 'totalReadCount': 123, 'totalBaseCount': 123, 'generatedFrom': 'string', 'alignment': 'string' }, 'creationTime': datetime(2015, 1, 1), 'statusMessage': 'string', 'creationType': 'IMPORT'|'UPLOAD', 'etag': { 'algorithm': 'FASTQ_MD5up'|'BAM_MD5up'|'CRAM_MD5up'|'FASTQ_SHA256up'|'BAM_SHA256up'|'CRAM_SHA256up'|'FASTQ_SHA512up'|'BAM_SHA512up'|'CRAM_SHA512up', 'source1': 'string', 'source2': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **readSets** *(list) --* A list of read sets. * *(dict) --* A read set. * **id** *(string) --* The read set's ID. * **arn** *(string) --* The read set's ARN. * **sequenceStoreId** *(string) --* The read set's sequence store ID. * **subjectId** *(string) --* The read set's subject ID. * **sampleId** *(string) --* The read set's sample ID. * **status** *(string) --* The read set's status. * **name** *(string) --* The read set's name. * **description** *(string) --* The read set's description. * **referenceArn** *(string) --* The read set's genome reference ARN. * **fileType** *(string) --* The read set's file type. * **sequenceInformation** *(dict) --* Details about a sequence. * **totalReadCount** *(integer) --* The sequence's total read count. * **totalBaseCount** *(integer) --* The sequence's total base count. * **generatedFrom** *(string) --* Where the sequence originated. * **alignment** *(string) --* The sequence's alignment setting. * **creationTime** *(datetime) --* When the read set was created. * **statusMessage** *(string) --* The status for a read set. It provides more detail as to why the read set has a status. * **creationType** *(string) --* The creation type of the read set. * **etag** *(dict) --* The entity tag (ETag) is a hash of the object representing its semantic content. * **algorithm** *(string) --* The algorithm used to calculate the read set’s ETag(s). * **source1** *(string) --* The ETag hash calculated on Source1 of the read set. * **source2** *(string) --* The ETag hash calculated on Source2 of the read set. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListReadSetImportJobs ListReadSetImportJobs ********************* class Omics.Paginator.ListReadSetImportJobs paginator = client.get_paginator('list_read_set_import_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_read_set_import_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( sequenceStoreId='string', filter={ 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1) }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **sequenceStoreId** (*string*) -- **[REQUIRED]** The jobs' sequence store ID. * **filter** (*dict*) -- A filter to apply to the list. * **status** *(string) --* A status to filter on. * **createdAfter** *(datetime) --* The filter's start date. * **createdBefore** *(datetime) --* The filter's end date. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'importJobs': [ { 'id': 'string', 'sequenceStoreId': 'string', 'roleArn': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'creationTime': datetime(2015, 1, 1), 'completionTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **importJobs** *(list) --* A list of jobs. * *(dict) --* An import read set job. * **id** *(string) --* The job's ID. * **sequenceStoreId** *(string) --* The job's sequence store ID. * **roleArn** *(string) --* The job's service role ARN. * **status** *(string) --* The job's status. * **creationTime** *(datetime) --* When the job was created. * **completionTime** *(datetime) --* When the job completed. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListReadSetExportJobs ListReadSetExportJobs ********************* class Omics.Paginator.ListReadSetExportJobs paginator = client.get_paginator('list_read_set_export_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_read_set_export_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( sequenceStoreId='string', filter={ 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1) }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **sequenceStoreId** (*string*) -- **[REQUIRED]** The jobs' sequence store ID. * **filter** (*dict*) -- A filter to apply to the list. * **status** *(string) --* A status to filter on. * **createdAfter** *(datetime) --* The filter's start date. * **createdBefore** *(datetime) --* The filter's end date. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'exportJobs': [ { 'id': 'string', 'sequenceStoreId': 'string', 'destination': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'creationTime': datetime(2015, 1, 1), 'completionTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **exportJobs** *(list) --* A list of jobs. * *(dict) --* Details about a read set export job. * **id** *(string) --* The job's ID. * **sequenceStoreId** *(string) --* The job's sequence store ID. * **destination** *(string) --* The job's destination in Amazon S3. * **status** *(string) --* The job's status. * **creationTime** *(datetime) --* When the job was created. * **completionTime** *(datetime) --* When the job completed. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListRunCaches ListRunCaches ************* class Omics.Paginator.ListRunCaches paginator = client.get_paginator('list_run_caches') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_run_caches()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS', 'cacheS3Uri': 'string', 'creationTime': datetime(2015, 1, 1), 'id': 'string', 'name': 'string', 'status': 'ACTIVE'|'DELETED'|'FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Details about each run cache in the response. * *(dict) --* List entry for one run cache. * **arn** *(string) --* Unique resource identifier for the run cache. * **cacheBehavior** *(string) --* Default cache behavior for the run cache. * **cacheS3Uri** *(string) --* The S3 uri for the run cache data. * **creationTime** *(datetime) --* The time that this run cache was created (an ISO 8601 formatted string). * **id** *(string) --* The identifier for this run cache. * **name** *(string) --* The name of the run cache. * **status** *(string) --* The run cache status. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListSequenceStores ListSequenceStores ****************** class Omics.Paginator.ListSequenceStores paginator = client.get_paginator('list_sequence_stores') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_sequence_stores()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filter={ 'name': 'string', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED', 'updatedAfter': datetime(2015, 1, 1), 'updatedBefore': datetime(2015, 1, 1) }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filter** (*dict*) -- A filter to apply to the list. * **name** *(string) --* A name to filter on. * **createdAfter** *(datetime) --* The filter's start date. * **createdBefore** *(datetime) --* The filter's end date. * **status** *(string) --* Filter results based on status. * **updatedAfter** *(datetime) --* Filter results based on stores updated after the specified time. * **updatedBefore** *(datetime) --* Filter results based on stores updated before the specified time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'sequenceStores': [ { 'arn': 'string', 'id': 'string', 'name': 'string', 'description': 'string', 'sseConfig': { 'type': 'KMS', 'keyArn': 'string' }, 'creationTime': datetime(2015, 1, 1), 'fallbackLocation': 'string', 'eTagAlgorithmFamily': 'MD5up'|'SHA256up'|'SHA512up', 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED', 'statusMessage': 'string', 'updateTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **sequenceStores** *(list) --* A list of sequence stores. * *(dict) --* Details about a sequence store. * **arn** *(string) --* The store's ARN. * **id** *(string) --* The store's ID. * **name** *(string) --* The store's name. * **description** *(string) --* The store's description. * **sseConfig** *(dict) --* The store's server-side encryption (SSE) settings. * **type** *(string) --* The encryption type. * **keyArn** *(string) --* An encryption key ARN. * **creationTime** *(datetime) --* When the store was created. * **fallbackLocation** *(string) --* An S3 location that is used to store files that have failed a direct upload. * **eTagAlgorithmFamily** *(string) --* The algorithm family of the ETag. * **status** *(string) --* Status of the sequence store. * **statusMessage** *(string) --* The status message of the sequence store. * **updateTime** *(datetime) --* The last-updated time of the Sequence Store. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListVariantStores ListVariantStores ***************** class Omics.Paginator.ListVariantStores paginator = client.get_paginator('list_variant_stores') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_variant_stores()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ids=[ 'string', ], filter={ 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ids** (*list*) -- A list of store IDs. * *(string) --* * **filter** (*dict*) -- A filter to apply to the list. * **status** *(string) --* A status to filter on. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'variantStores': [ { 'id': 'string', 'reference': { 'referenceArn': 'string' }, 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED', 'storeArn': 'string', 'name': 'string', 'description': 'string', 'sseConfig': { 'type': 'KMS', 'keyArn': 'string' }, 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1), 'statusMessage': 'string', 'storeSizeBytes': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **variantStores** *(list) --* A list of variant stores. * *(dict) --* A variant store. * **id** *(string) --* The store's ID. * **reference** *(dict) --* The store's genome reference. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "referenceArn". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **referenceArn** *(string) --* The reference's ARN. * **status** *(string) --* The store's status. * **storeArn** *(string) --* The store's ARN. * **name** *(string) --* The store's name. * **description** *(string) --* The store's description. * **sseConfig** *(dict) --* The store's server-side encryption (SSE) settings. * **type** *(string) --* The encryption type. * **keyArn** *(string) --* An encryption key ARN. * **creationTime** *(datetime) --* When the store was created. * **updateTime** *(datetime) --* When the store was updated. * **statusMessage** *(string) --* The store's status message. * **storeSizeBytes** *(integer) --* The store's size in bytes. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListAnnotationStores ListAnnotationStores ******************** class Omics.Paginator.ListAnnotationStores paginator = client.get_paginator('list_annotation_stores') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_annotation_stores()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ids=[ 'string', ], filter={ 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ids** (*list*) -- IDs of stores to list. * *(string) --* * **filter** (*dict*) -- A filter to apply to the list. * **status** *(string) --* A status to filter on. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'annotationStores': [ { 'id': 'string', 'reference': { 'referenceArn': 'string' }, 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED', 'storeArn': 'string', 'name': 'string', 'storeFormat': 'GFF'|'TSV'|'VCF', 'description': 'string', 'sseConfig': { 'type': 'KMS', 'keyArn': 'string' }, 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1), 'statusMessage': 'string', 'storeSizeBytes': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **annotationStores** *(list) --* A list of stores. * *(dict) --* An annotation store. * **id** *(string) --* The store's ID. * **reference** *(dict) --* The store's genome reference. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "referenceArn". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **referenceArn** *(string) --* The reference's ARN. * **status** *(string) --* The store's status. * **storeArn** *(string) --* The store's ARN. * **name** *(string) --* The store's name. * **storeFormat** *(string) --* The store's file format. * **description** *(string) --* The store's description. * **sseConfig** *(dict) --* The store's server-side encryption (SSE) settings. * **type** *(string) --* The encryption type. * **keyArn** *(string) --* An encryption key ARN. * **creationTime** *(datetime) --* The store's creation time. * **updateTime** *(datetime) --* When the store was updated. * **statusMessage** *(string) --* The store's status message. * **storeSizeBytes** *(integer) --* The store's size in bytes. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListAnnotationStoreVersions ListAnnotationStoreVersions *************************** class Omics.Paginator.ListAnnotationStoreVersions paginator = client.get_paginator('list_annotation_store_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_annotation_store_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( name='string', filter={ 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of an annotation store. * **filter** (*dict*) -- A filter to apply to the list of annotation store versions. * **status** *(string) --* The status of an annotation store version. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'annotationStoreVersions': [ { 'storeId': 'string', 'id': 'string', 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED', 'versionArn': 'string', 'name': 'string', 'versionName': 'string', 'description': 'string', 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1), 'statusMessage': 'string', 'versionSizeBytes': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **annotationStoreVersions** *(list) --* Lists all versions of an annotation store. * *(dict) --* Annotation store versions. * **storeId** *(string) --* The store ID for an annotation store version. * **id** *(string) --* The annotation store version ID. * **status** *(string) --* The status of an annotation store version. * **versionArn** *(string) --* The Arn for an annotation store version. * **name** *(string) --* A name given to an annotation store version to distinguish it from others. * **versionName** *(string) --* The name of an annotation store version. * **description** *(string) --* The description of an annotation store version. * **creationTime** *(datetime) --* The time stamp for when an annotation store version was created. * **updateTime** *(datetime) --* The time stamp for when an annotation store version was updated. * **statusMessage** *(string) --* The status of an annotation store version. * **versionSizeBytes** *(integer) --* The size of an annotation store version in Bytes. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListReferenceStores ListReferenceStores ******************* class Omics.Paginator.ListReferenceStores paginator = client.get_paginator('list_reference_stores') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_reference_stores()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filter={ 'name': 'string', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1) }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filter** (*dict*) -- A filter to apply to the list. * **name** *(string) --* The name to filter on. * **createdAfter** *(datetime) --* The filter's start date. * **createdBefore** *(datetime) --* The filter's end date. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'referenceStores': [ { 'arn': 'string', 'id': 'string', 'name': 'string', 'description': 'string', 'sseConfig': { 'type': 'KMS', 'keyArn': 'string' }, 'creationTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **referenceStores** *(list) --* A list of reference stores. * *(dict) --* Details about a reference store. * **arn** *(string) --* The store's ARN. * **id** *(string) --* The store's ID. * **name** *(string) --* The store's name. * **description** *(string) --* The store's description. * **sseConfig** *(dict) --* The store's server-side encryption (SSE) settings. * **type** *(string) --* The encryption type. * **keyArn** *(string) --* An encryption key ARN. * **creationTime** *(datetime) --* When the store was created. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListRunTasks ListRunTasks ************ class Omics.Paginator.ListRunTasks paginator = client.get_paginator('list_run_tasks') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_run_tasks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( id='string', status='PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'CANCELLED'|'FAILED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **id** (*string*) -- **[REQUIRED]** The run's ID. * **status** (*string*) -- Filter the list by status. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'taskId': 'string', 'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'CANCELLED'|'FAILED', 'name': 'string', 'cpus': 123, 'cacheHit': True|False, 'cacheS3Uri': 'string', 'memory': 123, 'creationTime': datetime(2015, 1, 1), 'startTime': datetime(2015, 1, 1), 'stopTime': datetime(2015, 1, 1), 'gpus': 123, 'instanceType': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* A list of tasks. * *(dict) --* A workflow run task. * **taskId** *(string) --* The task's ID. * **status** *(string) --* The task's status. * **name** *(string) --* The task's name. * **cpus** *(integer) --* The task's CPU count. * **cacheHit** *(boolean) --* Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task. * **cacheS3Uri** *(string) --* The S3 URI of the cache location. * **memory** *(integer) --* The task's memory use in gigabyes. * **creationTime** *(datetime) --* When the task was created. * **startTime** *(datetime) --* When the task started. * **stopTime** *(datetime) --* When the task stopped. * **gpus** *(integer) --* The number of Graphics Processing Units (GPU) specified for the task. * **instanceType** *(string) --* The instance type for a task. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListReadSetActivationJobs ListReadSetActivationJobs ************************* class Omics.Paginator.ListReadSetActivationJobs paginator = client.get_paginator('list_read_set_activation_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_read_set_activation_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( sequenceStoreId='string', filter={ 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1) }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **sequenceStoreId** (*string*) -- **[REQUIRED]** The read set's sequence store ID. * **filter** (*dict*) -- A filter to apply to the list. * **status** *(string) --* The filter's status. * **createdAfter** *(datetime) --* The filter's start date. * **createdBefore** *(datetime) --* The filter's end date. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'activationJobs': [ { 'id': 'string', 'sequenceStoreId': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'creationTime': datetime(2015, 1, 1), 'completionTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **activationJobs** *(list) --* A list of jobs. * *(dict) --* A read set activation job. * **id** *(string) --* The job's ID. * **sequenceStoreId** *(string) --* The job's sequence store ID. * **status** *(string) --* The job's status. * **creationTime** *(datetime) --* When the job was created. * **completionTime** *(datetime) --* When the job completed. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListRuns ListRuns ******** class Omics.Paginator.ListRuns paginator = client.get_paginator('list_runs') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_runs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( name='string', runGroupId='string', status='PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **name** (*string*) -- Filter the list by run name. * **runGroupId** (*string*) -- Filter the list by run group ID. * **status** (*string*) -- The status of a run. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'id': 'string', 'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED', 'workflowId': 'string', 'name': 'string', 'priority': 123, 'storageCapacity': 123, 'creationTime': datetime(2015, 1, 1), 'startTime': datetime(2015, 1, 1), 'stopTime': datetime(2015, 1, 1), 'storageType': 'STATIC'|'DYNAMIC', 'workflowVersionName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* A list of runs. * *(dict) --* A workflow run. * **arn** *(string) --* The run's ARN. * **id** *(string) --* The run's ID. * **status** *(string) --* The run's status. * **workflowId** *(string) --* The run's workflow ID. * **name** *(string) --* The run's name. * **priority** *(integer) --* The run's priority. * **storageCapacity** *(integer) --* The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run. * **creationTime** *(datetime) --* When the run was created. * **startTime** *(datetime) --* When the run started. * **stopTime** *(datetime) --* When the run stopped. * **storageType** *(string) --* The run's storage type. * **workflowVersionName** *(string) --* The name of the workflow version. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListMultipartReadSetUploads ListMultipartReadSetUploads *************************** class Omics.Paginator.ListMultipartReadSetUploads paginator = client.get_paginator('list_multipart_read_set_uploads') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_multipart_read_set_uploads()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( sequenceStoreId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **sequenceStoreId** (*string*) -- **[REQUIRED]** The Sequence Store ID used for the multipart uploads. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'uploads': [ { 'sequenceStoreId': 'string', 'uploadId': 'string', 'sourceFileType': 'FASTQ'|'BAM'|'CRAM'|'UBAM', 'subjectId': 'string', 'sampleId': 'string', 'generatedFrom': 'string', 'referenceArn': 'string', 'name': 'string', 'description': 'string', 'tags': { 'string': 'string' }, 'creationTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **uploads** *(list) --* An array of multipart uploads. * *(dict) --* Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads. * **sequenceStoreId** *(string) --* The sequence store ID used for the multipart upload. * **uploadId** *(string) --* The ID for the initiated multipart upload. * **sourceFileType** *(string) --* The type of file the read set originated from. * **subjectId** *(string) --* The read set source's subject ID. * **sampleId** *(string) --* The read set source's sample ID. * **generatedFrom** *(string) --* The source of an uploaded part. * **referenceArn** *(string) --* The source's reference ARN. * **name** *(string) --* The name of a read set. * **description** *(string) --* The description of a read set. * **tags** *(dict) --* Any tags you wish to add to a read set. * *(string) --* * *(string) --* * **creationTime** *(datetime) --* The time stamp for when a direct upload was created. * **NextToken** *(string) --* A token to resume pagination. Omics / Paginator / ListRunGroups ListRunGroups ************* class Omics.Paginator.ListRunGroups paginator = client.get_paginator('list_run_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "Omics.Client.list_run_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **name** (*string*) -- The run groups' name. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'id': 'string', 'name': 'string', 'maxCpus': 123, 'maxRuns': 123, 'maxDuration': 123, 'creationTime': datetime(2015, 1, 1), 'maxGpus': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* A list of groups. * *(dict) --* A run group. * **arn** *(string) --* The group's ARN. * **id** *(string) --* The group's ID. * **name** *(string) --* The group's name. * **maxCpus** *(integer) --* The group's maximum CPU count setting. * **maxRuns** *(integer) --* The group's maximum concurrent run setting. * **maxDuration** *(integer) --* The group's maximum duration setting in minutes. * **creationTime** *(datetime) --* When the group was created. * **maxGpus** *(integer) --* The maximum GPUs that can be used by a run group. * **NextToken** *(string) --* A token to resume pagination. Omics / Client / list_run_caches list_run_caches *************** Omics.Client.list_run_caches(**kwargs) Retrieves a list of your run caches and the metadata for each cache. See also: AWS API Documentation **Request Syntax** response = client.list_run_caches( maxResults=123, startingToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return. * **startingToken** (*string*) -- Optional pagination token returned from a prior call to the "ListRunCaches" API operation. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS', 'cacheS3Uri': 'string', 'creationTime': datetime(2015, 1, 1), 'id': 'string', 'name': 'string', 'status': 'ACTIVE'|'DELETED'|'FAILED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Details about each run cache in the response. * *(dict) --* List entry for one run cache. * **arn** *(string) --* Unique resource identifier for the run cache. * **cacheBehavior** *(string) --* Default cache behavior for the run cache. * **cacheS3Uri** *(string) --* The S3 uri for the run cache data. * **creationTime** *(datetime) --* The time that this run cache was created (an ISO 8601 formatted string). * **id** *(string) --* The identifier for this run cache. * **name** *(string) --* The name of the run cache. * **status** *(string) --* The run cache status. * **nextToken** *(string) --* Pagination token to retrieve additional run caches. If the response does not have a >>``<