aws-sdk-omics 1.53.0 → 1.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -476,7 +476,11 @@ module Aws::Omics
476
476
 
477
477
  # @!group API Operations
478
478
 
479
- # Stops a multipart upload.
479
+ # Stops a multipart read set upload into a sequence store and returns a
480
+ # response with no body if the operation is successful. To confirm that
481
+ # a multipart read set upload has been stopped, use the
482
+ # `ListMultipartReadSetUploads` API operation to view all active
483
+ # multipart read set uploads.
480
484
  #
481
485
  # @option params [required, String] :sequence_store_id
482
486
  # The sequence store ID for the store involved in the multipart upload.
@@ -530,7 +534,13 @@ module Aws::Omics
530
534
  req.send_request(options)
531
535
  end
532
536
 
533
- # Deletes one or more read sets.
537
+ # Deletes one or more read sets. If the operation is successful, it
538
+ # returns a response with no body. If there is an error with deleting
539
+ # one of the read sets, the operation returns an error list. If the
540
+ # operation successfully deletes only a subset of files, it will return
541
+ # an error list for the remaining files that fail to be deleted. There
542
+ # is a limit of 100 read sets that can be deleted in each
543
+ # `BatchDeleteReadSet` API call.
534
544
  #
535
545
  # @option params [required, Array<String>] :ids
536
546
  # The read sets' IDs.
@@ -633,8 +643,19 @@ module Aws::Omics
633
643
  req.send_request(options)
634
644
  end
635
645
 
636
- # Concludes a multipart upload once you have uploaded all the
637
- # components.
646
+ # Completes a multipart read set upload into a sequence store after you
647
+ # have initiated the upload process with `CreateMultipartReadSetUpload`
648
+ # and uploaded all read set parts using `UploadReadSetPart`. You must
649
+ # specify the parts you uploaded using the parts parameter. If the
650
+ # operation is successful, it returns the read set ID(s) of the uploaded
651
+ # read set(s).
652
+ #
653
+ # For more information, see [Direct upload to a sequence store][1] in
654
+ # the *Amazon Web Services HealthOmics User Guide*.
655
+ #
656
+ #
657
+ #
658
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html
638
659
  #
639
660
  # @option params [required, String] :sequence_store_id
640
661
  # The sequence store ID for the store involved in the multipart upload.
@@ -848,7 +869,35 @@ module Aws::Omics
848
869
  req.send_request(options)
849
870
  end
850
871
 
851
- # Begins a multipart read set upload.
872
+ # Initiates a multipart read set upload for uploading partitioned source
873
+ # files into a sequence store. You can directly import source files from
874
+ # an EC2 instance and other local compute, or from an S3 bucket. To
875
+ # separate these source files into parts, use the `split` operation.
876
+ # Each part cannot be larger than 100 MB. If the operation is
877
+ # successful, it provides an `uploadId` which is required by the
878
+ # `UploadReadSetPart` API operation to upload parts into a sequence
879
+ # store.
880
+ #
881
+ # To continue uploading a multipart read set into your sequence store,
882
+ # you must use the `UploadReadSetPart` API operation to upload each part
883
+ # individually following the steps below:
884
+ #
885
+ # * Specify the `uploadId` obtained from the previous call to
886
+ # `CreateMultipartReadSetUpload`.
887
+ #
888
+ # * Upload parts for that `uploadId`.
889
+ #
890
+ # When you have finished uploading parts, use the
891
+ # `CompleteMultipartReadSetUpload` API to complete the multipart read
892
+ # set upload and to retrieve the final read set IDs in the response.
893
+ #
894
+ # To learn more about creating parts and the `split` operation, see
895
+ # [Direct upload to a sequence store][1] in the *Amazon Web Services
896
+ # HealthOmics User Guide*.
897
+ #
898
+ #
899
+ #
900
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html
852
901
  #
853
902
  # @option params [required, String] :sequence_store_id
854
903
  # The sequence store ID for the store that is the destination of the
@@ -937,7 +986,18 @@ module Aws::Omics
937
986
  req.send_request(options)
938
987
  end
939
988
 
940
- # Creates a reference store.
989
+ # Creates a reference store and returns metadata in JSON format.
990
+ # Reference stores are used to store reference genomes in FASTA format.
991
+ # A reference store is created when the first reference genome is
992
+ # imported. To import additional reference genomes from an Amazon S3
993
+ # bucket, use the `StartReferenceImportJob` API operation.
994
+ #
995
+ # For more information, see [Creating a HealthOmics reference store][1]
996
+ # in the *Amazon Web Services HealthOmics User Guide*.
997
+ #
998
+ #
999
+ #
1000
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html
941
1001
  #
942
1002
  # @option params [required, String] :name
943
1003
  # A name for the store.
@@ -1171,7 +1231,36 @@ module Aws::Omics
1171
1231
  req.send_request(options)
1172
1232
  end
1173
1233
 
1174
- # Creates a sequence store.
1234
+ # Creates a sequence store and returns its metadata. Sequence stores are
1235
+ # used to store sequence data files called read sets that are saved in
1236
+ # FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM),
1237
+ # a sequence store can only use one reference genome. For unaligned
1238
+ # formats (FASTQ and uBAM), a reference genome is not required. You can
1239
+ # create multiple sequence stores per region per account.
1240
+ #
1241
+ # The following are optional parameters you can specify for your
1242
+ # sequence store:
1243
+ #
1244
+ # * Use `s3AccessConfig` to configure your sequence store with S3 access
1245
+ # logs (recommended).
1246
+ #
1247
+ # * Use `sseConfig` to define your own KMS key for encryption.
1248
+ #
1249
+ # * Use `eTagAlgorithmFamily` to define which algorithm to use for the
1250
+ # HealthOmics eTag on objects.
1251
+ #
1252
+ # * Use `fallbackLocation` to define a backup location for storing files
1253
+ # that have failed a direct upload.
1254
+ #
1255
+ # * Use `propagatedSetLevelTags` to configure tags that propagate to all
1256
+ # objects in your store.
1257
+ #
1258
+ # For more information, see [Creating a HealthOmics sequence store][1]
1259
+ # in the *Amazon Web Services HealthOmics User Guide*.
1260
+ #
1261
+ #
1262
+ #
1263
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/create-sequence-store.html
1175
1264
  #
1176
1265
  # @option params [required, String] :name
1177
1266
  # A name for the store.
@@ -1183,28 +1272,39 @@ module Aws::Omics
1183
1272
  # Server-side encryption (SSE) settings for the store.
1184
1273
  #
1185
1274
  # @option params [Hash<String,String>] :tags
1186
- # Tags for the store.
1275
+ # Tags for the store. You can configure up to 50 tags.
1187
1276
  #
1188
1277
  # @option params [String] :client_token
1189
- # To ensure that requests don't run multiple times, specify a unique
1190
- # token for each request.
1278
+ # An idempotency token used to dedupe retry requests so that duplicate
1279
+ # runs are not created.
1191
1280
  #
1192
1281
  # **A suitable default value is auto-generated.** You should normally
1193
1282
  # not need to pass this option.**
1194
1283
  #
1195
1284
  # @option params [String] :fallback_location
1196
1285
  # An S3 location that is used to store files that have failed a direct
1197
- # upload.
1286
+ # upload. You can add or change the `fallbackLocation` after creating a
1287
+ # sequence store. This is not required if you are uploading files from a
1288
+ # different S3 bucket.
1198
1289
  #
1199
1290
  # @option params [String] :e_tag_algorithm_family
1200
- # The ETag algorithm family to use for ingested read sets.
1291
+ # The ETag algorithm family to use for ingested read sets. The default
1292
+ # value is MD5up. For more information on ETags, see [ETags and data
1293
+ # provenance][1] in the *Amazon Web Services HealthOmics User Guide*.
1294
+ #
1295
+ #
1296
+ #
1297
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/etags-and-provenance.html
1201
1298
  #
1202
1299
  # @option params [Array<String>] :propagated_set_level_tags
1203
1300
  # The tags keys to propagate to the S3 objects associated with read sets
1204
- # in the sequence store.
1301
+ # in the sequence store. These tags can be used as input to add metadata
1302
+ # to your read sets.
1205
1303
  #
1206
1304
  # @option params [Types::S3AccessConfig] :s3_access_config
1207
- # S3 access configuration parameters
1305
+ # S3 access configuration parameters. This specifies the parameters
1306
+ # needed to access logs stored in S3 buckets. The S3 bucket must be in
1307
+ # the same region and account as the sequence store.
1208
1308
  #
1209
1309
  # @return [Types::CreateSequenceStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1210
1310
  #
@@ -1394,8 +1494,9 @@ module Aws::Omics
1394
1494
  # file that defines the run parameters, or Amazon Web Services
1395
1495
  # HealthOmics can generate the parameter template for you.
1396
1496
  #
1397
- # * *ECR container images*: Create one or more container images for the
1398
- # workflow. Store the images in a private ECR repository.
1497
+ # * *ECR container images*: Create container images for the workflow in
1498
+ # a private ECR repository, or synchronize images from a supported
1499
+ # upstream registry with your Amazon ECR private repository.
1399
1500
  #
1400
1501
  # * (Optional) *Sentieon licenses*: Request a Sentieon license if using
1401
1502
  # the Sentieon software in a private workflow.
@@ -1492,6 +1593,19 @@ module Aws::Omics
1492
1593
  #
1493
1594
  # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
1494
1595
  #
1596
+ # @option params [Types::ContainerRegistryMap] :container_registry_map
1597
+ # (Optional) Use a container registry map to specify mappings between
1598
+ # the ECR private repository and one or more upstream registries. For
1599
+ # more information, see [Container images][1] in the *Amazon Web
1600
+ # Services HealthOmics User Guide*.
1601
+ #
1602
+ #
1603
+ #
1604
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html
1605
+ #
1606
+ # @option params [String] :container_registry_map_uri
1607
+ # (Optional) URI of the S3 location for the registry mapping file.
1608
+ #
1495
1609
  # @option params [String] :readme_markdown
1496
1610
  # The markdown content for the workflow's README file. This provides
1497
1611
  # documentation and usage information for users of the workflow.
@@ -1559,6 +1673,23 @@ module Aws::Omics
1559
1673
  # request_id: "WorkflowRequestId", # required
1560
1674
  # accelerators: "GPU", # accepts GPU
1561
1675
  # storage_type: "STATIC", # accepts STATIC, DYNAMIC
1676
+ # container_registry_map: {
1677
+ # registry_mappings: [
1678
+ # {
1679
+ # upstream_registry_url: "Uri",
1680
+ # ecr_repository_prefix: "EcrRepositoryPrefix",
1681
+ # upstream_repository_prefix: "UpstreamRepositoryPrefix",
1682
+ # ecr_account_id: "AwsAccountId",
1683
+ # },
1684
+ # ],
1685
+ # image_mappings: [
1686
+ # {
1687
+ # source_image: "Uri",
1688
+ # destination_image: "Uri",
1689
+ # },
1690
+ # ],
1691
+ # },
1692
+ # container_registry_map_uri: "Uri",
1562
1693
  # readme_markdown: "ReadmeMarkdown",
1563
1694
  # parameter_template_path: "ParameterTemplatePath",
1564
1695
  # readme_path: "ReadmePath",
@@ -1603,7 +1734,7 @@ module Aws::Omics
1603
1734
  # Provide a version name that is unique for this workflow. You cannot
1604
1735
  # change the name after HealthOmics creates the version.
1605
1736
  #
1606
- # <note markdown="1"> Dont include any personally identifiable information (PII) in the
1737
+ # <note markdown="1"> Don't include any personally identifiable information (PII) in the
1607
1738
  # version name. Version names appear in the workflow version ARN.
1608
1739
  #
1609
1740
  # </note>
@@ -1616,7 +1747,8 @@ module Aws::Omics
1616
1747
  # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html
1617
1748
  #
1618
1749
  # @option params [required, String] :workflow_id
1619
- # The ID of the workflow where you are creating the new version.
1750
+ # The ID of the workflow where you are creating the new version. The
1751
+ # `workflowId` is not the UUID.
1620
1752
  #
1621
1753
  # @option params [required, String] :version_name
1622
1754
  # A name for the workflow version. Provide a version name that is unique
@@ -1631,12 +1763,15 @@ module Aws::Omics
1631
1763
  # conventions, such as 2.7.0, 2.7.1, 2.7.2.
1632
1764
  #
1633
1765
  # @option params [String, StringIO, File] :definition_zip
1634
- # A zip archive containing the workflow definition for this workflow
1635
- # version.
1766
+ # A ZIP archive containing the main workflow definition file and
1767
+ # dependencies that it imports for this workflow version. You can use a
1768
+ # file with a ://fileb prefix instead of the Base64 string. For more
1769
+ # information, see Workflow definition requirements in the *Amazon Web
1770
+ # Services HealthOmics User Guide*.
1636
1771
  #
1637
1772
  # @option params [String] :definition_uri
1638
- # The URI specifies the location of the workflow definition for this
1639
- # workflow version.
1773
+ # The S3 URI of a definition for this workflow version. The S3 bucket
1774
+ # must be in the same region as this workflow version.
1640
1775
  #
1641
1776
  # @option params [String] :accelerators
1642
1777
  # The computational accelerator for this workflow version.
@@ -1645,46 +1780,82 @@ module Aws::Omics
1645
1780
  # A description for this workflow version.
1646
1781
  #
1647
1782
  # @option params [String] :engine
1648
- # The workflow engine for this workflow version.
1783
+ # The workflow engine for this workflow version. This is only required
1784
+ # if you have workflow definition files from more than one engine in
1785
+ # your zip file. Otherwise, the service can detect the engine
1786
+ # automatically from your workflow definition.
1649
1787
  #
1650
1788
  # @option params [String] :main
1651
- # The path of the main definition file for this workflow version.
1789
+ # The path of the main definition file for this workflow version. This
1790
+ # parameter is not required if the ZIP archive contains only one
1791
+ # workflow definition file, or if the main definition file is named
1792
+ # “main”. An example path is: `workflow-definition/main-file.wdl`.
1652
1793
  #
1653
1794
  # @option params [Hash<String,Types::WorkflowParameter>] :parameter_template
1654
- # The parameter template defines the input parameters for runs that use
1655
- # this workflow version.
1795
+ # A parameter template for this workflow version. If this field is
1796
+ # blank, Amazon Web Services HealthOmics will automatically parse the
1797
+ # parameter template values from your workflow definition file. To
1798
+ # override these service generated default values, provide a parameter
1799
+ # template. To view an example of a parameter template, see [Parameter
1800
+ # template files][1] in the *Amazon Web Services HealthOmics User
1801
+ # Guide*.
1802
+ #
1803
+ #
1804
+ #
1805
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html
1656
1806
  #
1657
1807
  # @option params [required, String] :request_id
1658
- # To ensure that requests don't run multiple times, specify a unique ID
1659
- # for each request.
1808
+ # An idempotency token to ensure that duplicate workflows are not
1809
+ # created when Amazon Web Services HealthOmics submits retry requests.
1660
1810
  #
1661
1811
  # **A suitable default value is auto-generated.** You should normally
1662
1812
  # not need to pass this option.**
1663
1813
  #
1664
1814
  # @option params [String] :storage_type
1665
- # The default storage type for runs that use this workflow. STATIC
1666
- # storage allocates a fixed amount of storage. DYNAMIC storage
1815
+ # The default storage type for runs that use this workflow version. The
1816
+ # `storageType` can be overridden at run time. `DYNAMIC` storage
1667
1817
  # dynamically scales the storage up or down, based on file system
1668
- # utilization. For more information about static and dynamic storage,
1669
- # see [Running workflows][1] in the *Amazon Web Services HealthOmics
1670
- # User Guide*.
1818
+ # utilization. STATIC storage allocates a fixed amount of storage. For
1819
+ # more information about dynamic and static storage types, see [Run
1820
+ # storage types][1] in the *Amazon Web Services HealthOmics User Guide*.
1671
1821
  #
1672
1822
  #
1673
1823
  #
1674
- # [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
1824
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
1675
1825
  #
1676
1826
  # @option params [Integer] :storage_capacity
1677
1827
  # The default static storage capacity (in gibibytes) for runs that use
1678
- # this workflow or workflow version.
1828
+ # this workflow version. The `storageCapacity` can be overwritten at run
1829
+ # time. The storage capacity is not required for runs with a `DYNAMIC`
1830
+ # storage type.
1679
1831
  #
1680
1832
  # @option params [Hash<String,String>] :tags
1681
- # Optional tags to associate with this workflow version.
1833
+ # Tags for this workflow version. You can define up to 50 tags for the
1834
+ # workflow. For more information, see [Adding a tag][1] in the *Amazon
1835
+ # Web Services HealthOmics User Guide*.
1836
+ #
1837
+ #
1838
+ #
1839
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html
1682
1840
  #
1683
1841
  # @option params [String] :workflow_bucket_owner_id
1684
1842
  # Amazon Web Services Id of the owner of the S3 bucket that contains the
1685
1843
  # workflow definition. You need to specify this parameter if your
1686
1844
  # account is not the bucket owner.
1687
1845
  #
1846
+ # @option params [Types::ContainerRegistryMap] :container_registry_map
1847
+ # (Optional) Use a container registry map to specify mappings between
1848
+ # the ECR private repository and one or more upstream registries. For
1849
+ # more information, see [Container images][1] in the *Amazon Web
1850
+ # Services HealthOmics User Guide*.
1851
+ #
1852
+ #
1853
+ #
1854
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html
1855
+ #
1856
+ # @option params [String] :container_registry_map_uri
1857
+ # (Optional) URI of the S3 location for the registry mapping file.
1858
+ #
1688
1859
  # @option params [String] :readme_markdown
1689
1860
  # The markdown content for the workflow version's README file. This
1690
1861
  # provides documentation and usage information for users of this
@@ -1751,6 +1922,23 @@ module Aws::Omics
1751
1922
  # "TagKey" => "TagValue",
1752
1923
  # },
1753
1924
  # workflow_bucket_owner_id: "WorkflowBucketOwnerId",
1925
+ # container_registry_map: {
1926
+ # registry_mappings: [
1927
+ # {
1928
+ # upstream_registry_url: "Uri",
1929
+ # ecr_repository_prefix: "EcrRepositoryPrefix",
1930
+ # upstream_repository_prefix: "UpstreamRepositoryPrefix",
1931
+ # ecr_account_id: "AwsAccountId",
1932
+ # },
1933
+ # ],
1934
+ # image_mappings: [
1935
+ # {
1936
+ # source_image: "Uri",
1937
+ # destination_image: "Uri",
1938
+ # },
1939
+ # ],
1940
+ # },
1941
+ # container_registry_map_uri: "Uri",
1754
1942
  # readme_markdown: "ReadmeMarkdown",
1755
1943
  # parameter_template_path: "ParameterTemplatePath",
1756
1944
  # readme_path: "ReadmePath",
@@ -1857,7 +2045,18 @@ module Aws::Omics
1857
2045
  req.send_request(options)
1858
2046
  end
1859
2047
 
1860
- # Deletes a genome reference.
2048
+ # Deletes a reference genome and returns a response with no body if the
2049
+ # operation is successful. The read set associated with the reference
2050
+ # genome must first be deleted before deleting the reference genome.
2051
+ # After the reference genome is deleted, you can delete the reference
2052
+ # store using the `DeleteReferenceStore` API operation.
2053
+ #
2054
+ # For more information, see [Deleting HealthOmics reference and sequence
2055
+ # stores][1] in the *Amazon Web Services HealthOmics User Guide*.
2056
+ #
2057
+ #
2058
+ #
2059
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/deleting-reference-and-sequence-stores.html
1861
2060
  #
1862
2061
  # @option params [required, String] :id
1863
2062
  # The reference's ID.
@@ -1883,7 +2082,18 @@ module Aws::Omics
1883
2082
  req.send_request(options)
1884
2083
  end
1885
2084
 
1886
- # Deletes a genome reference store.
2085
+ # Deletes a reference store and returns a response with no body if the
2086
+ # operation is successful. You can only delete a reference store when it
2087
+ # does not contain any reference genomes. To empty a reference store,
2088
+ # use `DeleteReference`.
2089
+ #
2090
+ # For more information about your workflow status, see [Deleting
2091
+ # HealthOmics reference and sequence stores][1] in the *Amazon Web
2092
+ # Services HealthOmics User Guide*.
2093
+ #
2094
+ #
2095
+ #
2096
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/deleting-reference-and-sequence-stores.html
1887
2097
  #
1888
2098
  # @option params [required, String] :id
1889
2099
  # The store's ID.
@@ -2025,7 +2235,20 @@ module Aws::Omics
2025
2235
  req.send_request(options)
2026
2236
  end
2027
2237
 
2028
- # Deletes a sequence store.
2238
+ # Deletes a sequence store and returns a response with no body if the
2239
+ # operation is successful. You can only delete a sequence store when it
2240
+ # does not contain any read sets.
2241
+ #
2242
+ # Use the `BatchDeleteReadSet` API operation to ensure that all read
2243
+ # sets in the sequence store are deleted. When a sequence store is
2244
+ # deleted, all tags associated with the store are also deleted.
2245
+ #
2246
+ # For more information, see [Deleting HealthOmics reference and sequence
2247
+ # stores][1] in the *Amazon Web Services HealthOmics User Guide*.
2248
+ #
2249
+ #
2250
+ #
2251
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/deleting-reference-and-sequence-stores.html
2029
2252
  #
2030
2253
  # @option params [required, String] :id
2031
2254
  # The sequence store's ID.
@@ -2109,8 +2332,8 @@ module Aws::Omics
2109
2332
  req.send_request(options)
2110
2333
  end
2111
2334
 
2112
- # Deletes a workflow by specifying its ID. No response is returned if
2113
- # the deletion is successful.
2335
+ # Deletes a workflow by specifying its ID. This operation returns a
2336
+ # response with no body if the deletion is successful.
2114
2337
  #
2115
2338
  # To verify that the workflow is deleted:
2116
2339
  #
@@ -2382,7 +2605,10 @@ module Aws::Omics
2382
2605
  req.send_request(options)
2383
2606
  end
2384
2607
 
2385
- # Gets a file from a read set.
2608
+ # Retrieves detailed information from parts of a read set and returns
2609
+ # the read set in the same format that it was uploaded. You must have
2610
+ # read sets uploaded to your sequence store in order to run this
2611
+ # operation.
2386
2612
  #
2387
2613
  # @option params [required, String] :id
2388
2614
  # The read set's ID.
@@ -2422,7 +2648,8 @@ module Aws::Omics
2422
2648
  req.send_request(options, &block)
2423
2649
  end
2424
2650
 
2425
- # Gets information about a read set activation job.
2651
+ # Returns detailed information about the status of a read set activation
2652
+ # job in JSON format.
2426
2653
  #
2427
2654
  # @option params [required, String] :id
2428
2655
  # The job's ID.
@@ -2474,7 +2701,9 @@ module Aws::Omics
2474
2701
  req.send_request(options)
2475
2702
  end
2476
2703
 
2477
- # Gets information about a read set export job.
2704
+ # Retrieves status information about a read set export job and returns
2705
+ # the data in JSON format. Use this operation to actively monitor the
2706
+ # progress of an export job.
2478
2707
  #
2479
2708
  # @option params [required, String] :sequence_store_id
2480
2709
  # The job's sequence store ID.
@@ -2528,7 +2757,8 @@ module Aws::Omics
2528
2757
  req.send_request(options)
2529
2758
  end
2530
2759
 
2531
- # Gets information about a read set import job.
2760
+ # Gets detailed and status information about a read set import job and
2761
+ # returns the data in JSON format.
2532
2762
  #
2533
2763
  # @option params [required, String] :id
2534
2764
  # The job's ID.
@@ -2593,7 +2823,9 @@ module Aws::Omics
2593
2823
  req.send_request(options)
2594
2824
  end
2595
2825
 
2596
- # Gets details about a read set.
2826
+ # Retrieves the metadata for a read set from a sequence store in JSON
2827
+ # format. This operation does not return tags. To retrieve the list of
2828
+ # tags for a read set, use the `ListTagsForResource` API operation.
2597
2829
  #
2598
2830
  # @option params [required, String] :id
2599
2831
  # The read set's ID.
@@ -2673,7 +2905,15 @@ module Aws::Omics
2673
2905
  req.send_request(options)
2674
2906
  end
2675
2907
 
2676
- # Gets a reference file.
2908
+ # Downloads parts of data from a reference genome and returns the
2909
+ # reference file in the same format that it was uploaded.
2910
+ #
2911
+ # For more information, see [Creating a HealthOmics reference store][1]
2912
+ # in the *Amazon Web Services HealthOmics User Guide*.
2913
+ #
2914
+ #
2915
+ #
2916
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html
2677
2917
  #
2678
2918
  # @option params [required, String] :id
2679
2919
  # The reference's ID.
@@ -2717,7 +2957,8 @@ module Aws::Omics
2717
2957
  req.send_request(options, &block)
2718
2958
  end
2719
2959
 
2720
- # Gets information about a reference import job.
2960
+ # Monitors the status of a reference import job. This operation can be
2961
+ # called after calling the `StartReferenceImportJob` operation.
2721
2962
  #
2722
2963
  # @option params [required, String] :id
2723
2964
  # The job's ID.
@@ -2776,7 +3017,10 @@ module Aws::Omics
2776
3017
  req.send_request(options)
2777
3018
  end
2778
3019
 
2779
- # Gets information about a genome reference's metadata.
3020
+ # Retrieves metadata for a reference genome. This operation returns the
3021
+ # number of parts, part size, and MD5 of an entire file. This operation
3022
+ # does not return tags. To retrieve the list of tags for a read set, use
3023
+ # the `ListTagsForResource` API operation.
2780
3024
  #
2781
3025
  # @option params [required, String] :id
2782
3026
  # The reference's ID.
@@ -3123,6 +3367,7 @@ module Aws::Omics
3123
3367
  # * {Types::GetRunTaskResponse#gpus #gpus} => Integer
3124
3368
  # * {Types::GetRunTaskResponse#instance_type #instance_type} => String
3125
3369
  # * {Types::GetRunTaskResponse#failure_reason #failure_reason} => String
3370
+ # * {Types::GetRunTaskResponse#image_details #image_details} => Types::ImageDetails
3126
3371
  #
3127
3372
  # @example Request syntax with placeholder values
3128
3373
  #
@@ -3148,6 +3393,9 @@ module Aws::Omics
3148
3393
  # resp.gpus #=> Integer
3149
3394
  # resp.instance_type #=> String
3150
3395
  # resp.failure_reason #=> String
3396
+ # resp.image_details.image #=> String
3397
+ # resp.image_details.image_digest #=> String
3398
+ # resp.image_details.source_image #=> String
3151
3399
  #
3152
3400
  #
3153
3401
  # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -3200,7 +3448,8 @@ module Aws::Omics
3200
3448
  req.send_request(options)
3201
3449
  end
3202
3450
 
3203
- # Gets information about a sequence store.
3451
+ # Retrieves metadata for a sequence store using its ID and returns it in
3452
+ # JSON format.
3204
3453
  #
3205
3454
  # @option params [required, String] :id
3206
3455
  # The store's ID.
@@ -3453,6 +3702,7 @@ module Aws::Omics
3453
3702
  # * {Types::GetWorkflowResponse#accelerators #accelerators} => String
3454
3703
  # * {Types::GetWorkflowResponse#storage_type #storage_type} => String
3455
3704
  # * {Types::GetWorkflowResponse#uuid #uuid} => String
3705
+ # * {Types::GetWorkflowResponse#container_registry_map #container_registry_map} => Types::ContainerRegistryMap
3456
3706
  # * {Types::GetWorkflowResponse#readme #readme} => String
3457
3707
  # * {Types::GetWorkflowResponse#definition_repository_details #definition_repository_details} => Types::DefinitionRepositoryDetails
3458
3708
  # * {Types::GetWorkflowResponse#readme_path #readme_path} => String
@@ -3491,6 +3741,14 @@ module Aws::Omics
3491
3741
  # resp.accelerators #=> String, one of "GPU"
3492
3742
  # resp.storage_type #=> String, one of "STATIC", "DYNAMIC"
3493
3743
  # resp.uuid #=> String
3744
+ # resp.container_registry_map.registry_mappings #=> Array
3745
+ # resp.container_registry_map.registry_mappings[0].upstream_registry_url #=> String
3746
+ # resp.container_registry_map.registry_mappings[0].ecr_repository_prefix #=> String
3747
+ # resp.container_registry_map.registry_mappings[0].upstream_repository_prefix #=> String
3748
+ # resp.container_registry_map.registry_mappings[0].ecr_account_id #=> String
3749
+ # resp.container_registry_map.image_mappings #=> Array
3750
+ # resp.container_registry_map.image_mappings[0].source_image #=> String
3751
+ # resp.container_registry_map.image_mappings[0].destination_image #=> String
3494
3752
  # resp.readme #=> String
3495
3753
  # resp.definition_repository_details.connection_arn #=> String
3496
3754
  # resp.definition_repository_details.full_repository_id #=> String
@@ -3523,7 +3781,7 @@ module Aws::Omics
3523
3781
  # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html
3524
3782
  #
3525
3783
  # @option params [required, String] :workflow_id
3526
- # The workflow's ID.
3784
+ # The workflow's ID. The `workflowId` is not the UUID.
3527
3785
  #
3528
3786
  # @option params [required, String] :version_name
3529
3787
  # The workflow version name.
@@ -3535,7 +3793,9 @@ module Aws::Omics
3535
3793
  # The export format for the workflow.
3536
3794
  #
3537
3795
  # @option params [String] :workflow_owner_id
3538
- # Amazon Web Services Id of the owner of the workflow.
3796
+ # The 12-digit account ID of the workflow owner. The workflow owner ID
3797
+ # can be retrieved using the `GetShare` API operation. If you are the
3798
+ # workflow owner, you do not need to include this ID.
3539
3799
  #
3540
3800
  # @return [Types::GetWorkflowVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3541
3801
  #
@@ -3559,6 +3819,7 @@ module Aws::Omics
3559
3819
  # * {Types::GetWorkflowVersionResponse#tags #tags} => Hash&lt;String,String&gt;
3560
3820
  # * {Types::GetWorkflowVersionResponse#uuid #uuid} => String
3561
3821
  # * {Types::GetWorkflowVersionResponse#workflow_bucket_owner_id #workflow_bucket_owner_id} => String
3822
+ # * {Types::GetWorkflowVersionResponse#container_registry_map #container_registry_map} => Types::ContainerRegistryMap
3562
3823
  # * {Types::GetWorkflowVersionResponse#readme #readme} => String
3563
3824
  # * {Types::GetWorkflowVersionResponse#definition_repository_details #definition_repository_details} => Types::DefinitionRepositoryDetails
3564
3825
  # * {Types::GetWorkflowVersionResponse#readme_path #readme_path} => String
@@ -3599,6 +3860,14 @@ module Aws::Omics
3599
3860
  # resp.tags["TagKey"] #=> String
3600
3861
  # resp.uuid #=> String
3601
3862
  # resp.workflow_bucket_owner_id #=> String
3863
+ # resp.container_registry_map.registry_mappings #=> Array
3864
+ # resp.container_registry_map.registry_mappings[0].upstream_registry_url #=> String
3865
+ # resp.container_registry_map.registry_mappings[0].ecr_repository_prefix #=> String
3866
+ # resp.container_registry_map.registry_mappings[0].upstream_repository_prefix #=> String
3867
+ # resp.container_registry_map.registry_mappings[0].ecr_account_id #=> String
3868
+ # resp.container_registry_map.image_mappings #=> Array
3869
+ # resp.container_registry_map.image_mappings[0].source_image #=> String
3870
+ # resp.container_registry_map.image_mappings[0].destination_image #=> String
3602
3871
  # resp.readme #=> String
3603
3872
  # resp.definition_repository_details.connection_arn #=> String
3604
3873
  # resp.definition_repository_details.full_repository_id #=> String
@@ -3800,9 +4069,10 @@ module Aws::Omics
3800
4069
  req.send_request(options)
3801
4070
  end
3802
4071
 
3803
- # Lists multipart read set uploads and for in progress uploads. Once the
3804
- # upload is completed, a read set is created and the upload will no
3805
- # longer be returned in the response.
4072
+ # Lists in-progress multipart read set uploads for a sequence store and
4073
+ # returns it in a JSON formatted output. Multipart read set uploads are
4074
+ # initiated by the `CreateMultipartReadSetUploads` API operation. This
4075
+ # operation returns a response with no body when the upload is complete.
3806
4076
  #
3807
4077
  # @option params [required, String] :sequence_store_id
3808
4078
  # The Sequence Store ID used for the multipart uploads.
@@ -3856,7 +4126,9 @@ module Aws::Omics
3856
4126
  req.send_request(options)
3857
4127
  end
3858
4128
 
3859
- # Retrieves a list of read set activation jobs.
4129
+ # Retrieves a list of read set activation jobs and returns the metadata
4130
+ # in a JSON formatted output. To extract metadata from a read set
4131
+ # activation job, use the `GetReadSetActivationJob` API operation.
3860
4132
  #
3861
4133
  # @option params [required, String] :sequence_store_id
3862
4134
  # The read set's sequence store ID.
@@ -3911,7 +4183,9 @@ module Aws::Omics
3911
4183
  req.send_request(options)
3912
4184
  end
3913
4185
 
3914
- # Retrieves a list of read set export jobs.
4186
+ # Retrieves a list of read set export jobs in a JSON formatted response.
4187
+ # This API operation is used to check the status of a read set export
4188
+ # job initiated by the `StartReadSetExportJob` API operation.
3915
4189
  #
3916
4190
  # @option params [required, String] :sequence_store_id
3917
4191
  # The jobs' sequence store ID.
@@ -3966,7 +4240,8 @@ module Aws::Omics
3966
4240
  req.send_request(options)
3967
4241
  end
3968
4242
 
3969
- # Retrieves a list of read set import jobs.
4243
+ # Retrieves a list of read set import jobs and returns the data in JSON
4244
+ # format.
3970
4245
  #
3971
4246
  # @option params [Integer] :max_results
3972
4247
  # The maximum number of jobs to return in one page of results.
@@ -4021,8 +4296,8 @@ module Aws::Omics
4021
4296
  req.send_request(options)
4022
4297
  end
4023
4298
 
4024
- # This operation will list all parts in a requested multipart upload for
4025
- # a sequence store.
4299
+ # Lists all parts in a multipart read set upload for a sequence store
4300
+ # and returns the metadata in a JSON formatted output.
4026
4301
  #
4027
4302
  # @option params [required, String] :sequence_store_id
4028
4303
  # The Sequence Store ID used for the multipart uploads.
@@ -4086,7 +4361,8 @@ module Aws::Omics
4086
4361
  req.send_request(options)
4087
4362
  end
4088
4363
 
4089
- # Retrieves a list of read sets.
4364
+ # Retrieves a list of read sets from a sequence store ID and returns the
4365
+ # metadata in JSON format.
4090
4366
  #
4091
4367
  # @option params [required, String] :sequence_store_id
4092
4368
  # The jobs' sequence store ID.
@@ -4161,7 +4437,8 @@ module Aws::Omics
4161
4437
  req.send_request(options)
4162
4438
  end
4163
4439
 
4164
- # Retrieves a list of reference import jobs.
4440
+ # Retrieves the metadata of one or more reference import jobs for a
4441
+ # reference store.
4165
4442
  #
4166
4443
  # @option params [Integer] :max_results
4167
4444
  # The maximum number of jobs to return in one page of results.
@@ -4216,7 +4493,15 @@ module Aws::Omics
4216
4493
  req.send_request(options)
4217
4494
  end
4218
4495
 
4219
- # Retrieves a list of reference stores.
4496
+ # Retrieves a list of reference stores linked to your account and
4497
+ # returns their metadata in JSON format.
4498
+ #
4499
+ # For more information, see [Creating a reference store][1] in the
4500
+ # *Amazon Web Services HealthOmics User Guide*.
4501
+ #
4502
+ #
4503
+ #
4504
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html
4220
4505
  #
4221
4506
  # @option params [Integer] :max_results
4222
4507
  # The maximum number of stores to return in one page of results.
@@ -4268,7 +4553,15 @@ module Aws::Omics
4268
4553
  req.send_request(options)
4269
4554
  end
4270
4555
 
4271
- # Retrieves a list of references.
4556
+ # Retrieves the metadata of one or more reference genomes in a reference
4557
+ # store.
4558
+ #
4559
+ # For more information, see [Creating a reference store][1] in the
4560
+ # *Amazon Web Services HealthOmics User Guide*.
4561
+ #
4562
+ #
4563
+ #
4564
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html
4272
4565
  #
4273
4566
  # @option params [required, String] :reference_store_id
4274
4567
  # The references' reference store ID.
@@ -4552,7 +4845,15 @@ module Aws::Omics
4552
4845
  req.send_request(options)
4553
4846
  end
4554
4847
 
4555
- # Retrieves a list of sequence stores.
4848
+ # Retrieves a list of sequence stores and returns each sequence store's
4849
+ # metadata.
4850
+ #
4851
+ # For more information, see [Creating a HealthOmics sequence store][1]
4852
+ # in the *Amazon Web Services HealthOmics User Guide*.
4853
+ #
4854
+ #
4855
+ #
4856
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/create-sequence-store.html
4556
4857
  #
4557
4858
  # @option params [Integer] :max_results
4558
4859
  # The maximum number of stores to return in one page of results.
@@ -4829,13 +5130,15 @@ module Aws::Omics
4829
5130
  # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html
4830
5131
  #
4831
5132
  # @option params [required, String] :workflow_id
4832
- # The workflow's ID.
5133
+ # The workflow's ID. The `workflowId` is not the UUID.
4833
5134
  #
4834
5135
  # @option params [String] :type
4835
5136
  # The workflow type.
4836
5137
  #
4837
5138
  # @option params [String] :workflow_owner_id
4838
- # Amazon Web Services Id of the owner of the workflow.
5139
+ # The 12-digit account ID of the workflow owner. The workflow owner ID
5140
+ # can be retrieved using the `GetShare` API operation. If you are the
5141
+ # workflow owner, you do not need to include this ID.
4839
5142
  #
4840
5143
  # @option params [String] :starting_token
4841
5144
  # Specify the pagination token from a previous request to retrieve the
@@ -5060,8 +5363,17 @@ module Aws::Omics
5060
5363
  req.send_request(options)
5061
5364
  end
5062
5365
 
5063
- # Activates an archived read set. To reduce storage charges, Amazon
5064
- # Omics archives unused read sets after 30 days.
5366
+ # Activates an archived read set and returns its metadata in a JSON
5367
+ # formatted output. AWS HealthOmics automatically archives unused read
5368
+ # sets after 30 days. To monitor the status of your read set activation
5369
+ # job, use the `GetReadSetActivationJob` operation.
5370
+ #
5371
+ # To learn more, see [Activating read sets][1] in the *Amazon Web
5372
+ # Services HealthOmics User Guide*.
5373
+ #
5374
+ #
5375
+ #
5376
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/activating-read-sets.html
5065
5377
  #
5066
5378
  # @option params [required, String] :sequence_store_id
5067
5379
  # The read set's sequence store ID.
@@ -5108,7 +5420,12 @@ module Aws::Omics
5108
5420
  req.send_request(options)
5109
5421
  end
5110
5422
 
5111
- # Exports a read set to Amazon S3.
5423
+ # Starts a read set export job. When the export job is finished, the
5424
+ # read set is exported to an Amazon S3 bucket which can be retrieved
5425
+ # using the `GetReadSetExportJob` API operation.
5426
+ #
5427
+ # To monitor the status of the export job, use the
5428
+ # `ListReadSetExportJobs` API operation.
5112
5429
  #
5113
5430
  # @option params [required, String] :sequence_store_id
5114
5431
  # The read set's sequence store ID.
@@ -5165,7 +5482,10 @@ module Aws::Omics
5165
5482
  req.send_request(options)
5166
5483
  end
5167
5484
 
5168
- # Starts a read set import job.
5485
+ # Imports a read set from the sequence store. Read set import jobs
5486
+ # support a maximum of 100 read sets of different types. Monitor the
5487
+ # progress of your read set import job by calling the
5488
+ # `GetReadSetImportJob` API operation.
5169
5489
  #
5170
5490
  # @option params [required, String] :sequence_store_id
5171
5491
  # The read set's sequence store ID.
@@ -5231,7 +5551,11 @@ module Aws::Omics
5231
5551
  req.send_request(options)
5232
5552
  end
5233
5553
 
5234
- # Starts a reference import job.
5554
+ # Imports a reference genome from Amazon S3 into a specified reference
5555
+ # store. You can have multiple reference genomes in a reference store.
5556
+ # You can only import reference genomes one at a time into each
5557
+ # reference store. Monitor the status of your reference import job by
5558
+ # using the `GetReferenceImportJob` API operation.
5235
5559
  #
5236
5560
  # @option params [required, String] :reference_store_id
5237
5561
  # The job's reference store ID.
@@ -5424,7 +5748,7 @@ module Aws::Omics
5424
5748
  # multiple. This field is not required if the storage type is `DYNAMIC`
5425
5749
  # (the system ignores any value that you enter).
5426
5750
  #
5427
- # @option params [String] :output_uri
5751
+ # @option params [required, String] :output_uri
5428
5752
  # An output S3 URI for the run. The S3 bucket must be in the same region
5429
5753
  # as the workflow. The role ARN must have permission to write to this S3
5430
5754
  # bucket.
@@ -5522,7 +5846,7 @@ module Aws::Omics
5522
5846
  # parameters: {
5523
5847
  # },
5524
5848
  # storage_capacity: 1,
5525
- # output_uri: "RunOutputUri",
5849
+ # output_uri: "RunOutputUri", # required
5526
5850
  # log_level: "OFF", # accepts OFF, FATAL, ERROR, ALL
5527
5851
  # tags: {
5528
5852
  # "TagKey" => "TagValue",
@@ -6080,7 +6404,7 @@ module Aws::Omics
6080
6404
  # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html
6081
6405
  #
6082
6406
  # @option params [required, String] :workflow_id
6083
- # The workflow's ID.
6407
+ # The workflow's ID. The `workflowId` is not the UUID.
6084
6408
  #
6085
6409
  # @option params [required, String] :version_name
6086
6410
  # The name of the workflow version.
@@ -6089,20 +6413,23 @@ module Aws::Omics
6089
6413
  # Description of the workflow version.
6090
6414
  #
6091
6415
  # @option params [String] :storage_type
6092
- # The default storage type for runs that use this workflow. STATIC
6093
- # storage allocates a fixed amount of storage. DYNAMIC storage
6416
+ # The default storage type for runs that use this workflow version. The
6417
+ # `storageType` can be overridden at run time. `DYNAMIC` storage
6094
6418
  # dynamically scales the storage up or down, based on file system
6095
- # utilization. For more information about static and dynamic storage,
6096
- # see [Running workflows][1] in the *Amazon Web Services HealthOmics
6097
- # User Guide*.
6419
+ # utilization. STATIC storage allocates a fixed amount of storage. For
6420
+ # more information about dynamic and static storage types, see [Run
6421
+ # storage types][1] in the <i>in the <i>Amazon Web Services HealthOmics
6422
+ # User Guide</i> </i>.
6098
6423
  #
6099
6424
  #
6100
6425
  #
6101
- # [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
6426
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
6102
6427
  #
6103
6428
  # @option params [Integer] :storage_capacity
6104
6429
  # The default static storage capacity (in gibibytes) for runs that use
6105
- # this workflow or workflow version.
6430
+ # this workflow version. The `storageCapacity` can be overwritten at run
6431
+ # time. The storage capacity is not required for runs with a `DYNAMIC`
6432
+ # storage type.
6106
6433
  #
6107
6434
  # @option params [String] :readme_markdown
6108
6435
  # The markdown content for the workflow version's README file. This
@@ -6131,9 +6458,18 @@ module Aws::Omics
6131
6458
  req.send_request(options)
6132
6459
  end
6133
6460
 
6134
- # This operation uploads a specific part of a read set. If you upload a
6135
- # new part using a previously used part number, the previously uploaded
6136
- # part will be overwritten.
6461
+ # Uploads a specific part of a read set into a sequence store. When you
6462
+ # a upload a read set part with a part number that already exists, the
6463
+ # new part replaces the existing one. This operation returns a JSON
6464
+ # formatted response containing a string identifier that is used to
6465
+ # confirm that parts are being added to the intended upload.
6466
+ #
6467
+ # For more information, see [Direct upload to a sequence store][1] in
6468
+ # the *Amazon Web Services HealthOmics User Guide*.
6469
+ #
6470
+ #
6471
+ #
6472
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html
6137
6473
  #
6138
6474
  # @option params [required, String] :sequence_store_id
6139
6475
  # The Sequence Store ID used for the multipart upload.
@@ -6195,7 +6531,7 @@ module Aws::Omics
6195
6531
  tracer: tracer
6196
6532
  )
6197
6533
  context[:gem_name] = 'aws-sdk-omics'
6198
- context[:gem_version] = '1.53.0'
6534
+ context[:gem_version] = '1.55.0'
6199
6535
  Seahorse::Client::Request.new(handlers, context)
6200
6536
  end
6201
6537