amazonka-omics-2.0: Amazon Omics SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Omics.Lens

Contents

Description

 
Synopsis

Operations

BatchDeleteReadSet

CancelAnnotationImportJob

CancelRun

CancelVariantImportJob

CreateAnnotationStore

createAnnotationStore_reference :: Lens' CreateAnnotationStore (Maybe ReferenceItem) Source #

The genome reference for the store's annotations.

createAnnotationStore_sseConfig :: Lens' CreateAnnotationStore (Maybe SseConfig) Source #

Server-side encryption (SSE) settings for the store.

createAnnotationStore_storeOptions :: Lens' CreateAnnotationStore (Maybe StoreOptions) Source #

File parsing options for the annotation store.

CreateReferenceStore

createReferenceStore_clientToken :: Lens' CreateReferenceStore (Maybe Text) Source #

To ensure that requests don't run multiple times, specify a unique token for each request.

createReferenceStore_sseConfig :: Lens' CreateReferenceStore (Maybe SseConfig) Source #

Server-side encryption (SSE) settings for the store.

CreateRunGroup

createRunGroup_maxCpus :: Lens' CreateRunGroup (Maybe Natural) Source #

The maximum number of CPUs to use in the group.

createRunGroup_maxRuns :: Lens' CreateRunGroup (Maybe Natural) Source #

The maximum number of concurrent runs for the group.

CreateSequenceStore

createSequenceStore_clientToken :: Lens' CreateSequenceStore (Maybe Text) Source #

To ensure that requests don't run multiple times, specify a unique token for each request.

createSequenceStore_sseConfig :: Lens' CreateSequenceStore (Maybe SseConfig) Source #

Server-side encryption (SSE) settings for the store.

CreateVariantStore

createVariantStore_sseConfig :: Lens' CreateVariantStore (Maybe SseConfig) Source #

Server-side encryption (SSE) settings for the store.

createVariantStore_reference :: Lens' CreateVariantStore ReferenceItem Source #

The genome reference for the store's variants.

CreateWorkflow

createWorkflow_definitionUri :: Lens' CreateWorkflow (Maybe Text) Source #

The URI of a definition for the workflow.

createWorkflow_definitionZip :: Lens' CreateWorkflow (Maybe ByteString) Source #

A ZIP archive for the workflow.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

createWorkflow_description :: Lens' CreateWorkflow (Maybe Text) Source #

A description for the workflow.

createWorkflow_main :: Lens' CreateWorkflow (Maybe Text) Source #

The path of the main definition file for the workflow.

createWorkflow_storageCapacity :: Lens' CreateWorkflow (Maybe Natural) Source #

A storage capacity for the workflow.

createWorkflow_requestId :: Lens' CreateWorkflow Text Source #

A request ID for the workflow.

DeleteAnnotationStore

DeleteReference

DeleteReferenceStore

DeleteRun

DeleteRunGroup

DeleteSequenceStore

DeleteVariantStore

DeleteWorkflow

GetAnnotationImportJob

GetAnnotationStore

getAnnotationStoreResponse_sseConfig :: Lens' GetAnnotationStoreResponse SseConfig Source #

The store's server-side encryption (SSE) settings.

GetReadSet

getReadSet_id :: Lens' GetReadSet Text Source #

The read set's ID.

getReadSet_partNumber :: Lens' GetReadSet Natural Source #

The part number to retrieve.

getReadSet_sequenceStoreId :: Lens' GetReadSet Text Source #

The read set's sequence store ID.

GetReadSetActivationJob

GetReadSetExportJob

GetReadSetImportJob

GetReadSetMetadata

GetReference

getReference_partNumber :: Lens' GetReference Natural Source #

The part number to retrieve.

GetReferenceImportJob

GetReferenceMetadata

GetReferenceStore

getReferenceStoreResponse_sseConfig :: Lens' GetReferenceStoreResponse (Maybe SseConfig) Source #

The store's server-side encryption (SSE) settings.

GetRun

getRun_export :: Lens' GetRun (Maybe [RunExport]) Source #

The run's export format.

getRun_id :: Lens' GetRun Text Source #

The run's ID.

getRunResponse_roleArn :: Lens' GetRunResponse (Maybe Text) Source #

The run's service role ARN.

getRunResponse_httpStatus :: Lens' GetRunResponse Int Source #

The response's http status code.

GetRunGroup

getRunGroupResponse_maxCpus :: Lens' GetRunGroupResponse (Maybe Natural) Source #

The group's maximum number of CPUs to use.

getRunGroupResponse_maxRuns :: Lens' GetRunGroupResponse (Maybe Natural) Source #

The maximum number of concurrent runs for the group.

GetRunTask

GetSequenceStore

getSequenceStoreResponse_sseConfig :: Lens' GetSequenceStoreResponse (Maybe SseConfig) Source #

The store's server-side encryption (SSE) settings.

GetVariantImportJob

GetVariantStore

getVariantStoreResponse_sseConfig :: Lens' GetVariantStoreResponse SseConfig Source #

The store's server-side encryption (SSE) settings.

GetWorkflow

getWorkflow_export :: Lens' GetWorkflow (Maybe [WorkflowExport]) Source #

The export format for the workflow.

getWorkflowResponse_main :: Lens' GetWorkflowResponse (Maybe Text) Source #

The path of the main definition file for the workflow.

ListAnnotationImportJobs

listAnnotationImportJobs_ids :: Lens' ListAnnotationImportJobs (Maybe (NonEmpty Text)) Source #

IDs of annotation import jobs to retrieve.

listAnnotationImportJobs_maxResults :: Lens' ListAnnotationImportJobs (Maybe Natural) Source #

The maximum number of jobs to return in one page of results.

listAnnotationImportJobs_nextToken :: Lens' ListAnnotationImportJobs (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listAnnotationImportJobsResponse_nextToken :: Lens' ListAnnotationImportJobsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListAnnotationStores

listAnnotationStores_maxResults :: Lens' ListAnnotationStores (Maybe Natural) Source #

The maximum number of stores to return in one page of results.

listAnnotationStores_nextToken :: Lens' ListAnnotationStores (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listAnnotationStoresResponse_nextToken :: Lens' ListAnnotationStoresResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListReadSetActivationJobs

listReadSetActivationJobs_maxResults :: Lens' ListReadSetActivationJobs (Maybe Natural) Source #

The maximum number of read set activation jobs to return in one page of results.

listReadSetActivationJobs_nextToken :: Lens' ListReadSetActivationJobs (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listReadSetActivationJobsResponse_nextToken :: Lens' ListReadSetActivationJobsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListReadSetExportJobs

listReadSetExportJobs_maxResults :: Lens' ListReadSetExportJobs (Maybe Natural) Source #

The maximum number of jobs to return in one page of results.

listReadSetExportJobs_nextToken :: Lens' ListReadSetExportJobs (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listReadSetExportJobsResponse_nextToken :: Lens' ListReadSetExportJobsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListReadSetImportJobs

listReadSetImportJobs_maxResults :: Lens' ListReadSetImportJobs (Maybe Natural) Source #

The maximum number of jobs to return in one page of results.

listReadSetImportJobs_nextToken :: Lens' ListReadSetImportJobs (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listReadSetImportJobsResponse_nextToken :: Lens' ListReadSetImportJobsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListReadSets

listReadSets_filter :: Lens' ListReadSets (Maybe ReadSetFilter) Source #

A filter to apply to the list.

listReadSets_maxResults :: Lens' ListReadSets (Maybe Natural) Source #

The maximum number of read sets to return in one page of results.

listReadSets_nextToken :: Lens' ListReadSets (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listReadSetsResponse_nextToken :: Lens' ListReadSetsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListReferenceImportJobs

listReferenceImportJobs_maxResults :: Lens' ListReferenceImportJobs (Maybe Natural) Source #

The maximum number of jobs to return in one page of results.

listReferenceImportJobs_nextToken :: Lens' ListReferenceImportJobs (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listReferenceImportJobsResponse_nextToken :: Lens' ListReferenceImportJobsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListReferenceStores

listReferenceStores_maxResults :: Lens' ListReferenceStores (Maybe Natural) Source #

The maximum number of stores to return in one page of results.

listReferenceStores_nextToken :: Lens' ListReferenceStores (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listReferenceStoresResponse_nextToken :: Lens' ListReferenceStoresResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListReferences

listReferences_maxResults :: Lens' ListReferences (Maybe Natural) Source #

The maximum number of references to return in one page of results.

listReferences_nextToken :: Lens' ListReferences (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listReferences_referenceStoreId :: Lens' ListReferences Text Source #

The references' reference store ID.

listReferencesResponse_nextToken :: Lens' ListReferencesResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListRunGroups

listRunGroups_maxResults :: Lens' ListRunGroups (Maybe Natural) Source #

The maximum number of run groups to return in one page of results.

listRunGroups_startingToken :: Lens' ListRunGroups (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listRunGroupsResponse_nextToken :: Lens' ListRunGroupsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListRunTasks

listRunTasks_maxResults :: Lens' ListRunTasks (Maybe Natural) Source #

The maximum number of run tasks to return in one page of results.

listRunTasks_startingToken :: Lens' ListRunTasks (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listRunTasksResponse_nextToken :: Lens' ListRunTasksResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListRuns

listRuns_maxResults :: Lens' ListRuns (Maybe Natural) Source #

The maximum number of runs to return in one page of results.

listRuns_name :: Lens' ListRuns (Maybe Text) Source #

Filter the list by run name.

listRuns_runGroupId :: Lens' ListRuns (Maybe Text) Source #

Filter the list by run group ID.

listRuns_startingToken :: Lens' ListRuns (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listRunsResponse_nextToken :: Lens' ListRunsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

listRunsResponse_httpStatus :: Lens' ListRunsResponse Int Source #

The response's http status code.

ListSequenceStores

listSequenceStores_maxResults :: Lens' ListSequenceStores (Maybe Natural) Source #

The maximum number of stores to return in one page of results.

listSequenceStores_nextToken :: Lens' ListSequenceStores (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listSequenceStoresResponse_nextToken :: Lens' ListSequenceStoresResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListTagsForResource

ListVariantImportJobs

listVariantImportJobs_maxResults :: Lens' ListVariantImportJobs (Maybe Natural) Source #

The maximum number of import jobs to return in one page of results.

listVariantImportJobs_nextToken :: Lens' ListVariantImportJobs (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listVariantImportJobsResponse_nextToken :: Lens' ListVariantImportJobsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListVariantStores

listVariantStores_maxResults :: Lens' ListVariantStores (Maybe Natural) Source #

The maximum number of stores to return in one page of results.

listVariantStores_nextToken :: Lens' ListVariantStores (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listVariantStoresResponse_nextToken :: Lens' ListVariantStoresResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListWorkflows

listWorkflows_maxResults :: Lens' ListWorkflows (Maybe Natural) Source #

The maximum number of workflows to return in one page of results.

listWorkflows_startingToken :: Lens' ListWorkflows (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listWorkflowsResponse_nextToken :: Lens' ListWorkflowsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

StartAnnotationImportJob

StartReadSetActivationJob

startReadSetActivationJob_clientToken :: Lens' StartReadSetActivationJob (Maybe Text) Source #

To ensure that jobs don't run multiple times, specify a unique token for each job.

StartReadSetExportJob

startReadSetExportJob_clientToken :: Lens' StartReadSetExportJob (Maybe Text) Source #

To ensure that jobs don't run multiple times, specify a unique token for each job.

startReadSetExportJob_destination :: Lens' StartReadSetExportJob Text Source #

A location for exported files in Amazon S3.

StartReadSetImportJob

startReadSetImportJob_clientToken :: Lens' StartReadSetImportJob (Maybe Text) Source #

To ensure that jobs don't run multiple times, specify a unique token for each job.

StartReferenceImportJob

startReferenceImportJob_clientToken :: Lens' StartReferenceImportJob (Maybe Text) Source #

To ensure that jobs don't run multiple times, specify a unique token for each job.

StartRun

startRun_name :: Lens' StartRun (Maybe Text) Source #

A name for the run.

startRun_outputUri :: Lens' StartRun (Maybe Text) Source #

An output URI for the run.

startRun_priority :: Lens' StartRun (Maybe Natural) Source #

A priority for the run.

startRun_storageCapacity :: Lens' StartRun (Maybe Natural) Source #

A storage capacity for the run.

startRun_workflowId :: Lens' StartRun (Maybe Text) Source #

The run's workflow ID.

startRun_requestId :: Lens' StartRun Text Source #

A request ID for the run.

startRun_roleArn :: Lens' StartRun Text Source #

A service role for the run.

startRunResponse_httpStatus :: Lens' StartRunResponse Int Source #

The response's http status code.

StartVariantImportJob

startVariantImportJob_destinationName :: Lens' StartVariantImportJob Text Source #

The destination variant store for the job.

TagResource

UntagResource

UpdateAnnotationStore

UpdateRunGroup

updateRunGroup_maxCpus :: Lens' UpdateRunGroup (Maybe Natural) Source #

The maximum number of CPUs to use.

updateRunGroup_maxDuration :: Lens' UpdateRunGroup (Maybe Natural) Source #

The maximum amount of time to run.

updateRunGroup_maxRuns :: Lens' UpdateRunGroup (Maybe Natural) Source #

The maximum number of concurrent runs for the group.

UpdateVariantStore

UpdateWorkflow

updateWorkflow_description :: Lens' UpdateWorkflow (Maybe Text) Source #

A description for the workflow.

Types

ActivateReadSetFilter

ActivateReadSetJobItem

ActivateReadSetSourceItem

AnnotationImportItemDetail

AnnotationImportItemSource

AnnotationImportJobItem

AnnotationStoreItem

annotationStoreItem_sseConfig :: Lens' AnnotationStoreItem SseConfig Source #

The store's server-side encryption (SSE) settings.

ExportReadSet

ExportReadSetDetail

ExportReadSetFilter

ExportReadSetJobDetail

FileInformation

FormatOptions

ImportReadSetFilter

ImportReadSetJobItem

ImportReadSetSourceItem

ImportReferenceFilter

ImportReferenceJobItem

ImportReferenceSourceItem

ListAnnotationImportJobsFilter

ListAnnotationStoresFilter

ListVariantImportJobsFilter

ListVariantStoresFilter

ReadOptions

readOptions_comment :: Lens' ReadOptions (Maybe Text) Source #

The file's comment character.

readOptions_escape :: Lens' ReadOptions (Maybe Text) Source #

A character for escaping quotes in the file.

readOptions_escapeQuotes :: Lens' ReadOptions (Maybe Bool) Source #

Whether quotes need to be escaped in the file.

readOptions_header :: Lens' ReadOptions (Maybe Bool) Source #

Whether the file has a header row.

readOptions_lineSep :: Lens' ReadOptions (Maybe Text) Source #

A line separator for the file.

readOptions_quote :: Lens' ReadOptions (Maybe Text) Source #

The file's quote character.

readOptions_quoteAll :: Lens' ReadOptions (Maybe Bool) Source #

Whether all values need to be quoted, or just those that contain quotes.

readOptions_sep :: Lens' ReadOptions (Maybe Text) Source #

The file's field separator.

ReadSetBatchError

ReadSetFiles

readSetFiles_source1 :: Lens' ReadSetFiles (Maybe FileInformation) Source #

The location of the first file in Amazon S3.

readSetFiles_source2 :: Lens' ReadSetFiles (Maybe FileInformation) Source #

The location of the second file in Amazon S3.

ReadSetFilter

readSetFilter_referenceArn :: Lens' ReadSetFilter (Maybe Text) Source #

A genome reference ARN to filter on.

ReadSetListItem

readSetListItem_referenceArn :: Lens' ReadSetListItem (Maybe Text) Source #

The read set's genome reference ARN.

ReferenceFiles

referenceFiles_source :: Lens' ReferenceFiles (Maybe FileInformation) Source #

The source file's location in Amazon S3.

ReferenceFilter

referenceFilter_md5 :: Lens' ReferenceFilter (Maybe Text) Source #

An MD5 checksum to filter on.

ReferenceItem

ReferenceListItem

referenceListItem_md5 :: Lens' ReferenceListItem Text Source #

The reference's MD5 checksum.

ReferenceStoreDetail

referenceStoreDetail_sseConfig :: Lens' ReferenceStoreDetail (Maybe SseConfig) Source #

The store's server-side encryption (SSE) settings.

ReferenceStoreFilter

RunGroupListItem

runGroupListItem_maxCpus :: Lens' RunGroupListItem (Maybe Natural) Source #

The group's maximum CPU count setting.

runGroupListItem_maxDuration :: Lens' RunGroupListItem (Maybe Natural) Source #

The group's maximum duration setting.

runGroupListItem_maxRuns :: Lens' RunGroupListItem (Maybe Natural) Source #

The group's maximum concurrent run setting.

RunListItem

RunParameters

SequenceInformation

SequenceStoreDetail

sequenceStoreDetail_sseConfig :: Lens' SequenceStoreDetail (Maybe SseConfig) Source #

The store's server-side encryption (SSE) settings.

SequenceStoreFilter

SourceFiles

sourceFiles_source2 :: Lens' SourceFiles (Maybe Text) Source #

The location of the second file in Amazon S3.

sourceFiles_source1 :: Lens' SourceFiles Text Source #

The location of the first file in Amazon S3.

SseConfig

sseConfig_keyArn :: Lens' SseConfig (Maybe Text) Source #

An encryption key ARN.

StartReadSetActivationJobSourceItem

StartReadSetImportJobSourceItem

StartReferenceImportJobSourceItem

StoreOptions

TaskListItem

TsvOptions

TsvStoreOptions

tsvStoreOptions_formatToHeader :: Lens' TsvStoreOptions (Maybe (HashMap FormatToHeaderKey Text)) Source #

The store's header key to column name mapping.

VariantImportItemDetail

variantImportItemDetail_source :: Lens' VariantImportItemDetail Text Source #

The source file's location in Amazon S3.

VariantImportItemSource

variantImportItemSource_source :: Lens' VariantImportItemSource Text Source #

The source file's location in Amazon S3.

VariantImportJobItem

VariantStoreItem

variantStoreItem_sseConfig :: Lens' VariantStoreItem SseConfig Source #

The store's server-side encryption (SSE) settings.

VcfOptions

vcfOptions_ignoreFilterField :: Lens' VcfOptions (Maybe Bool) Source #

The file's ignore filter field setting.

vcfOptions_ignoreQualField :: Lens' VcfOptions (Maybe Bool) Source #

The file's ignore qual field setting.

WorkflowListItem

WorkflowParameter

workflowParameter_optional :: Lens' WorkflowParameter (Maybe Bool) Source #

Whether the parameter is optional.