aws-sdk-omics 1.49.0 → 1.50.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.
@@ -912,8 +912,8 @@ module Aws::Omics
912
912
  # CACHE\_ON\_FAILURE. When you start a run that uses this cache, you
913
913
  # can override the default cache behavior.
914
914
  #
915
- # For more information, see [Run cache behavior][1] in the Amazon Web
916
- # Services HealthOmics User Guide.
915
+ # For more information, see [Run cache behavior][1] in the *Amazon Web
916
+ # Services HealthOmics User Guide*.
917
917
  #
918
918
  #
919
919
  #
@@ -1301,7 +1301,9 @@ module Aws::Omics
1301
1301
  end
1302
1302
 
1303
1303
  # @!attribute [rw] name
1304
- # A name for the workflow.
1304
+ # Name (optional but highly recommended) for the workflow to locate
1305
+ # relevant information in the CloudWatch logs and Amazon Web Services
1306
+ # HealthOmics console.
1305
1307
  # @return [String]
1306
1308
  #
1307
1309
  # @!attribute [rw] description
@@ -1309,37 +1311,70 @@ module Aws::Omics
1309
1311
  # @return [String]
1310
1312
  #
1311
1313
  # @!attribute [rw] engine
1312
- # The workflow engine for the workflow.
1314
+ # The workflow engine for the workflow. This is only required if you
1315
+ # have workflow definition files from more than one engine in your zip
1316
+ # file. Otherwise, the service can detect the engine automatically
1317
+ # from your workflow definition.
1313
1318
  # @return [String]
1314
1319
  #
1315
1320
  # @!attribute [rw] definition_zip
1316
- # A ZIP archive for the workflow.
1321
+ # A ZIP archive containing the main workflow definition file and
1322
+ # dependencies that it imports for the workflow. You can use a file
1323
+ # with a ://fileb prefix instead of the Base64 string. For more
1324
+ # information, see [Workflow definition requirements][1] in the
1325
+ # *Amazon Web Services HealthOmics User Guide*.
1326
+ #
1327
+ #
1328
+ #
1329
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-defn-requirements.html
1317
1330
  # @return [String]
1318
1331
  #
1319
1332
  # @!attribute [rw] definition_uri
1320
- # The URI of a definition for the workflow.
1333
+ # The S3 URI of a definition for the workflow. The S3 bucket must be
1334
+ # in the same region as the workflow.
1321
1335
  # @return [String]
1322
1336
  #
1323
1337
  # @!attribute [rw] main
1324
- # The path of the main definition file for the workflow.
1338
+ # The path of the main definition file for the workflow. This
1339
+ # parameter is not required if the ZIP archive contains only one
1340
+ # workflow definition file, or if the main definition file is named
1341
+ # “main”. An example path is: `workflow-definition/main-file.wdl`.
1325
1342
  # @return [String]
1326
1343
  #
1327
1344
  # @!attribute [rw] parameter_template
1328
- # A parameter template for the workflow.
1345
+ # A parameter template for the workflow. If this field is blank,
1346
+ # Amazon Web Services HealthOmics will automatically parse the
1347
+ # parameter template values from your workflow definition file. To
1348
+ # override these service generated default values, provide a parameter
1349
+ # template. To view an example of a parameter template, see [Parameter
1350
+ # template files][1] in the *Amazon Web Services HealthOmics User
1351
+ # Guide*.
1352
+ #
1353
+ #
1354
+ #
1355
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html
1329
1356
  # @return [Hash<String,Types::WorkflowParameter>]
1330
1357
  #
1331
1358
  # @!attribute [rw] storage_capacity
1332
1359
  # The default static storage capacity (in gibibytes) for runs that use
1333
- # this workflow or workflow version.
1360
+ # this workflow or workflow version. The `storageCapacity` can be
1361
+ # overwritten at run time. The storage capacity is not required for
1362
+ # runs with a `DYNAMIC` storage type.
1334
1363
  # @return [Integer]
1335
1364
  #
1336
1365
  # @!attribute [rw] tags
1337
- # Tags for the workflow.
1366
+ # Tags for the workflow. You can define up to 50 tags for the
1367
+ # workflow. For more information, see [Adding a tag][1] in the *Amazon
1368
+ # Web Services HealthOmics User Guide*.
1369
+ #
1370
+ #
1371
+ #
1372
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html
1338
1373
  # @return [Hash<String,String>]
1339
1374
  #
1340
1375
  # @!attribute [rw] request_id
1341
- # To ensure that requests don't run multiple times, specify a unique
1342
- # ID for each request.
1376
+ # An idempotency token to ensure that duplicate workflows are not
1377
+ # created when Amazon Web Services HealthOmics submits retry requests.
1343
1378
  #
1344
1379
  # **A suitable default value is auto-generated.** You should normally
1345
1380
  # not need to pass this option.
@@ -1350,16 +1385,60 @@ module Aws::Omics
1350
1385
  # @return [String]
1351
1386
  #
1352
1387
  # @!attribute [rw] storage_type
1353
- # The default storage type for runs that use this workflow. STATIC
1354
- # storage allocates a fixed amount of storage. DYNAMIC storage
1388
+ # The default storage type for runs that use this workflow. The
1389
+ # `storageType` can be overridden at run time. `DYNAMIC` storage
1355
1390
  # dynamically scales the storage up or down, based on file system
1356
- # utilization. For more information about static and dynamic storage,
1357
- # see [Running workflows][1] in the *Amazon Web Services HealthOmics
1358
- # User Guide*.
1391
+ # utilization. `STATIC` storage allocates a fixed amount of storage.
1392
+ # For more information about dynamic and static storage types, see
1393
+ # [Run storage types][1] in the *Amazon Web Services HealthOmics User
1394
+ # Guide*.
1359
1395
  #
1360
1396
  #
1361
1397
  #
1362
- # [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
1398
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
1399
+ # @return [String]
1400
+ #
1401
+ # @!attribute [rw] readme_markdown
1402
+ # The markdown content for the workflow's README file. This provides
1403
+ # documentation and usage information for users of the workflow.
1404
+ # @return [String]
1405
+ #
1406
+ # @!attribute [rw] parameter_template_path
1407
+ # The path to the workflow parameter template JSON file within the
1408
+ # repository. This file defines the input parameters for runs that use
1409
+ # this workflow. If not specified, the workflow will be created
1410
+ # without a parameter template.
1411
+ # @return [String]
1412
+ #
1413
+ # @!attribute [rw] readme_path
1414
+ # The path to the workflow README markdown file within the repository.
1415
+ # This file provides documentation and usage information for the
1416
+ # workflow. If not specified, the `README.md` file from the root
1417
+ # directory of the repository will be used.
1418
+ # @return [String]
1419
+ #
1420
+ # @!attribute [rw] definition_repository
1421
+ # The repository information for the workflow definition. This allows
1422
+ # you to source your workflow definition directly from a code
1423
+ # repository.
1424
+ # @return [Types::DefinitionRepository]
1425
+ #
1426
+ # @!attribute [rw] workflow_bucket_owner_id
1427
+ # The Amazon Web Services account ID of the expected owner of the S3
1428
+ # bucket that contains the workflow definition. If not specified, the
1429
+ # service skips the validation.
1430
+ # @return [String]
1431
+ #
1432
+ # @!attribute [rw] readme_uri
1433
+ # The S3 URI of the README file for the workflow. This file provides
1434
+ # documentation and usage information for the workflow. Requirements
1435
+ # include:
1436
+ #
1437
+ # * The S3 URI must begin with `s3://USER-OWNED-BUCKET/`
1438
+ #
1439
+ # * The requester must have access to the S3 bucket and object.
1440
+ #
1441
+ # * The max README content length is 500 KiB.
1363
1442
  # @return [String]
1364
1443
  #
1365
1444
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateWorkflowRequest AWS API Documentation
@@ -1376,7 +1455,13 @@ module Aws::Omics
1376
1455
  :tags,
1377
1456
  :request_id,
1378
1457
  :accelerators,
1379
- :storage_type)
1458
+ :storage_type,
1459
+ :readme_markdown,
1460
+ :parameter_template_path,
1461
+ :readme_path,
1462
+ :definition_repository,
1463
+ :workflow_bucket_owner_id,
1464
+ :readme_uri)
1380
1465
  SENSITIVE = []
1381
1466
  include Aws::Structure
1382
1467
  end
@@ -1497,6 +1582,44 @@ module Aws::Omics
1497
1582
  # account is not the bucket owner.
1498
1583
  # @return [String]
1499
1584
  #
1585
+ # @!attribute [rw] readme_markdown
1586
+ # The markdown content for the workflow version's README file. This
1587
+ # provides documentation and usage information for users of this
1588
+ # specific workflow version.
1589
+ # @return [String]
1590
+ #
1591
+ # @!attribute [rw] parameter_template_path
1592
+ # The path to the workflow version parameter template JSON file within
1593
+ # the repository. This file defines the input parameters for runs that
1594
+ # use this workflow version. If not specified, the workflow version
1595
+ # will be created without a parameter template.
1596
+ # @return [String]
1597
+ #
1598
+ # @!attribute [rw] readme_path
1599
+ # The path to the workflow version README markdown file within the
1600
+ # repository. This file provides documentation and usage information
1601
+ # for the workflow. If not specified, the `README.md` file from the
1602
+ # root directory of the repository will be used.
1603
+ # @return [String]
1604
+ #
1605
+ # @!attribute [rw] definition_repository
1606
+ # The repository information for the workflow version definition. This
1607
+ # allows you to source your workflow version definition directly from
1608
+ # a code repository.
1609
+ # @return [Types::DefinitionRepository]
1610
+ #
1611
+ # @!attribute [rw] readme_uri
1612
+ # The S3 URI of the README file for the workflow version. This file
1613
+ # provides documentation and usage information for the workflow
1614
+ # version. Requirements include:
1615
+ #
1616
+ # * The S3 URI must begin with `s3://USER-OWNED-BUCKET/`
1617
+ #
1618
+ # * The requester must have access to the S3 bucket and object.
1619
+ #
1620
+ # * The max README content length is 500 KiB.
1621
+ # @return [String]
1622
+ #
1500
1623
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateWorkflowVersionRequest AWS API Documentation
1501
1624
  #
1502
1625
  class CreateWorkflowVersionRequest < Struct.new(
@@ -1513,7 +1636,12 @@ module Aws::Omics
1513
1636
  :storage_type,
1514
1637
  :storage_capacity,
1515
1638
  :tags,
1516
- :workflow_bucket_owner_id)
1639
+ :workflow_bucket_owner_id,
1640
+ :readme_markdown,
1641
+ :parameter_template_path,
1642
+ :readme_path,
1643
+ :definition_repository,
1644
+ :readme_uri)
1517
1645
  SENSITIVE = []
1518
1646
  include Aws::Structure
1519
1647
  end
@@ -1556,6 +1684,79 @@ module Aws::Omics
1556
1684
  include Aws::Structure
1557
1685
  end
1558
1686
 
1687
+ # Contains information about a source code repository that hosts the
1688
+ # workflow definition files.
1689
+ #
1690
+ # @!attribute [rw] connection_arn
1691
+ # The Amazon Resource Name (ARN) of the connection to the source code
1692
+ # repository.
1693
+ # @return [String]
1694
+ #
1695
+ # @!attribute [rw] full_repository_id
1696
+ # The full repository identifier, including the repository owner and
1697
+ # name. For example, 'repository-owner/repository-name'.
1698
+ # @return [String]
1699
+ #
1700
+ # @!attribute [rw] source_reference
1701
+ # The source reference for the repository, such as a branch name, tag,
1702
+ # or commit ID.
1703
+ # @return [Types::SourceReference]
1704
+ #
1705
+ # @!attribute [rw] exclude_file_patterns
1706
+ # A list of file patterns to exclude when retrieving the workflow
1707
+ # definition from the repository.
1708
+ # @return [Array<String>]
1709
+ #
1710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DefinitionRepository AWS API Documentation
1711
+ #
1712
+ class DefinitionRepository < Struct.new(
1713
+ :connection_arn,
1714
+ :full_repository_id,
1715
+ :source_reference,
1716
+ :exclude_file_patterns)
1717
+ SENSITIVE = []
1718
+ include Aws::Structure
1719
+ end
1720
+
1721
+ # Contains detailed information about the source code repository that
1722
+ # hosts the workflow definition files.
1723
+ #
1724
+ # @!attribute [rw] connection_arn
1725
+ # The Amazon Resource Name (ARN) of the connection to the source code
1726
+ # repository.
1727
+ # @return [String]
1728
+ #
1729
+ # @!attribute [rw] full_repository_id
1730
+ # The full repository identifier, including the repository owner and
1731
+ # name. For example, 'repository-owner/repository-name'.
1732
+ # @return [String]
1733
+ #
1734
+ # @!attribute [rw] source_reference
1735
+ # The source reference for the repository, such as a branch name, tag,
1736
+ # or commit ID.
1737
+ # @return [Types::SourceReference]
1738
+ #
1739
+ # @!attribute [rw] provider_type
1740
+ # The provider type of the source code repository, such as Bitbucket,
1741
+ # GitHub, GitHubEnterpriseServer, GitLab, and GitLabSelfManaged.
1742
+ # @return [String]
1743
+ #
1744
+ # @!attribute [rw] provider_endpoint
1745
+ # The endpoint URL of the source code repository provider.
1746
+ # @return [String]
1747
+ #
1748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DefinitionRepositoryDetails AWS API Documentation
1749
+ #
1750
+ class DefinitionRepositoryDetails < Struct.new(
1751
+ :connection_arn,
1752
+ :full_repository_id,
1753
+ :source_reference,
1754
+ :provider_type,
1755
+ :provider_endpoint)
1756
+ SENSITIVE = []
1757
+ include Aws::Structure
1758
+ end
1759
+
1559
1760
  # @!attribute [rw] name
1560
1761
  # The store's name.
1561
1762
  # @return [String]
@@ -3725,6 +3926,23 @@ module Aws::Omics
3725
3926
  # The universally unique identifier (UUID) value for this workflow.
3726
3927
  # @return [String]
3727
3928
  #
3929
+ # @!attribute [rw] readme
3930
+ # The README content for the workflow, providing documentation and
3931
+ # usage information.
3932
+ # @return [String]
3933
+ #
3934
+ # @!attribute [rw] definition_repository_details
3935
+ # Details about the source code repository that hosts the workflow
3936
+ # definition files.
3937
+ # @return [Types::DefinitionRepositoryDetails]
3938
+ #
3939
+ # @!attribute [rw] readme_path
3940
+ # The path to the workflow README markdown file within the repository.
3941
+ # This file provides documentation and usage information for the
3942
+ # workflow. If not specified, the `README.md` file from the root
3943
+ # directory of the repository will be used.
3944
+ # @return [String]
3945
+ #
3728
3946
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetWorkflowResponse AWS API Documentation
3729
3947
  #
3730
3948
  class GetWorkflowResponse < Struct.new(
@@ -3746,7 +3964,10 @@ module Aws::Omics
3746
3964
  :metadata,
3747
3965
  :accelerators,
3748
3966
  :storage_type,
3749
- :uuid)
3967
+ :uuid,
3968
+ :readme,
3969
+ :definition_repository_details,
3970
+ :readme_path)
3750
3971
  SENSITIVE = []
3751
3972
  include Aws::Structure
3752
3973
  end
@@ -3864,6 +4085,23 @@ module Aws::Omics
3864
4085
  # Amazon Web Services Id of the owner of the bucket.
3865
4086
  # @return [String]
3866
4087
  #
4088
+ # @!attribute [rw] readme
4089
+ # The README content for the workflow version, providing documentation
4090
+ # and usage information specific to this version.
4091
+ # @return [String]
4092
+ #
4093
+ # @!attribute [rw] definition_repository_details
4094
+ # Details about the source code repository that hosts the workflow
4095
+ # version definition files.
4096
+ # @return [Types::DefinitionRepositoryDetails]
4097
+ #
4098
+ # @!attribute [rw] readme_path
4099
+ # The path to the workflow version README markdown file within the
4100
+ # repository. This file provides documentation and usage information
4101
+ # for the workflow. If not specified, the `README.md` file from the
4102
+ # root directory of the repository will be used.
4103
+ # @return [String]
4104
+ #
3867
4105
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetWorkflowVersionResponse AWS API Documentation
3868
4106
  #
3869
4107
  class GetWorkflowVersionResponse < Struct.new(
@@ -3886,7 +4124,10 @@ module Aws::Omics
3886
4124
  :type,
3887
4125
  :tags,
3888
4126
  :uuid,
3889
- :workflow_bucket_owner_id)
4127
+ :workflow_bucket_owner_id,
4128
+ :readme,
4129
+ :definition_repository_details,
4130
+ :readme_path)
3890
4131
  SENSITIVE = []
3891
4132
  include Aws::Structure
3892
4133
  end
@@ -6357,6 +6598,27 @@ module Aws::Omics
6357
6598
  include Aws::Structure
6358
6599
  end
6359
6600
 
6601
+ # Contains information about the source reference in a code repository,
6602
+ # such as a branch, tag, or commit.
6603
+ #
6604
+ # @!attribute [rw] type
6605
+ # The type of source reference, such as branch, tag, or commit.
6606
+ # @return [String]
6607
+ #
6608
+ # @!attribute [rw] value
6609
+ # The value of the source reference, such as the branch name, tag
6610
+ # name, or commit ID.
6611
+ # @return [String]
6612
+ #
6613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/SourceReference AWS API Documentation
6614
+ #
6615
+ class SourceReference < Struct.new(
6616
+ :type,
6617
+ :value)
6618
+ SENSITIVE = []
6619
+ include Aws::Structure
6620
+ end
6621
+
6360
6622
  # Server-side encryption (SSE) settings for a store.
6361
6623
  #
6362
6624
  # @!attribute [rw] type
@@ -6763,11 +7025,14 @@ module Aws::Omics
6763
7025
  end
6764
7026
 
6765
7027
  # @!attribute [rw] workflow_id
6766
- # The run's workflow ID.
7028
+ # The run's workflow ID. The `workflowId` is not the UUID.
6767
7029
  # @return [String]
6768
7030
  #
6769
7031
  # @!attribute [rw] workflow_type
6770
- # The run's workflow type.
7032
+ # The run's workflow type. The `workflowType` must be specified if
7033
+ # you are running a `READY2RUN` workflow. If you are running a
7034
+ # `PRIVATE` workflow (default), you do not need to include the
7035
+ # workflow type.
6771
7036
  # @return [String]
6772
7037
  #
6773
7038
  # @!attribute [rw] run_id
@@ -6775,11 +7040,17 @@ module Aws::Omics
6775
7040
  # @return [String]
6776
7041
  #
6777
7042
  # @!attribute [rw] role_arn
6778
- # A service role for the run.
7043
+ # A service role for the run. The `roleArn` requires access to Amazon
7044
+ # Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example
7045
+ # `roleArn` is
7046
+ # `arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ`.
7047
+ # In this example, the AWS account ID is `123456789012` and the role
7048
+ # name is `omics-service-role-serviceRole-W8O1XMPL7QZ`.
6779
7049
  # @return [String]
6780
7050
  #
6781
7051
  # @!attribute [rw] name
6782
- # A name for the run.
7052
+ # A name for the run. This is recommended to view and organize runs in
7053
+ # the Amazon Web Services HealthOmics console and CloudWatch logs.
6783
7054
  # @return [String]
6784
7055
  #
6785
7056
  # @!attribute [rw] cache_id
@@ -6791,8 +7062,8 @@ module Aws::Omics
6791
7062
  # The cache behavior for the run. You specify this value if you want
6792
7063
  # to override the default behavior for the cache. You had set the
6793
7064
  # default value when you created the cache. For more information, see
6794
- # [Run cache behavior][1] in the Amazon Web Services HealthOmics User
6795
- # Guide.
7065
+ # [Run cache behavior][1] in the *Amazon Web Services HealthOmics User
7066
+ # Guide*.
6796
7067
  #
6797
7068
  #
6798
7069
  #
@@ -6800,25 +7071,46 @@ module Aws::Omics
6800
7071
  # @return [String]
6801
7072
  #
6802
7073
  # @!attribute [rw] run_group_id
6803
- # The run's group ID.
7074
+ # The run's group ID. Use a run group to cap the compute resources
7075
+ # (and number of concurrent runs) for the runs that you add to the run
7076
+ # group.
6804
7077
  # @return [String]
6805
7078
  #
6806
7079
  # @!attribute [rw] priority
6807
- # A priority for the run.
7080
+ # Use the run priority (highest: 1) to establish the order of runs in
7081
+ # a run group when you start a run. If multiple runs share the same
7082
+ # priority, the run that was initiated first will have the higher
7083
+ # priority. Runs that do not belong to a run group can be assigned a
7084
+ # priority. The priorities of these runs are ranked among other runs
7085
+ # that are not in a run group. For more information, see [Run
7086
+ # priority][1] in the *Amazon Web Services HealthOmics User Guide*.
7087
+ #
7088
+ #
7089
+ #
7090
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html#run-priority
6808
7091
  # @return [Integer]
6809
7092
  #
6810
7093
  # @!attribute [rw] parameters
6811
- # Parameters for the run.
7094
+ # Parameters for the run. The run needs all required parameters and
7095
+ # can include optional parameters. The run cannot include any
7096
+ # parameters that are not defined in the parameter template. To
7097
+ # retrieve parameters from the run, use the GetRun API operation.
6812
7098
  # @return [Hash,Array,String,Numeric,Boolean]
6813
7099
  #
6814
7100
  # @!attribute [rw] storage_capacity
6815
- # The static storage capacity (in gibibytes) for this run. This field
6816
- # is not required if the storage type is dynamic (the system ignores
6817
- # any value that you enter).
7101
+ # The `STATIC` storage capacity (in gibibytes, GiB) for this run. The
7102
+ # default run storage capacity is 1200 GiB. If your requested storage
7103
+ # capacity is unavailable, the system rounds up the value to the
7104
+ # nearest 1200 GiB multiple. If the requested storage capacity is
7105
+ # still unavailable, the system rounds up the value to the nearest
7106
+ # 2400 GiB multiple. This field is not required if the storage type is
7107
+ # `DYNAMIC` (the system ignores any value that you enter).
6818
7108
  # @return [Integer]
6819
7109
  #
6820
7110
  # @!attribute [rw] output_uri
6821
- # An output URI for the run.
7111
+ # An output S3 URI for the run. The S3 bucket must be in the same
7112
+ # region as the workflow. The role ARN must have permission to write
7113
+ # to this S3 bucket.
6822
7114
  # @return [String]
6823
7115
  #
6824
7116
  # @!attribute [rw] log_level
@@ -6826,28 +7118,34 @@ module Aws::Omics
6826
7118
  # @return [String]
6827
7119
  #
6828
7120
  # @!attribute [rw] tags
6829
- # Tags for the run.
7121
+ # Tags for the run. You can add up to 50 tags per run. For more
7122
+ # information, see [Adding a tag][1] in the *Amazon Web Services
7123
+ # HealthOmics User Guide*.
7124
+ #
7125
+ #
7126
+ #
7127
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html
6830
7128
  # @return [Hash<String,String>]
6831
7129
  #
6832
7130
  # @!attribute [rw] request_id
6833
- # To ensure that requests don't run multiple times, specify a unique
6834
- # ID for each request.
7131
+ # An idempotency token used to dedupe retry requests so that duplicate
7132
+ # runs are not created.
6835
7133
  #
6836
7134
  # **A suitable default value is auto-generated.** You should normally
6837
7135
  # not need to pass this option.
6838
7136
  # @return [String]
6839
7137
  #
6840
7138
  # @!attribute [rw] retention_mode
6841
- # The retention mode for the run. The default value is RETAIN.
7139
+ # The retention mode for the run. The default value is `RETAIN`.
6842
7140
  #
6843
7141
  # Amazon Web Services HealthOmics stores a fixed number of runs that
6844
- # are available to the console and API. In the default mode (RETAIN),
6845
- # you need to remove runs manually when the number of run exceeds the
6846
- # maximum. If you set the retention mode to `REMOVE`, Amazon Web
6847
- # Services HealthOmics automatically removes runs (that have mode set
6848
- # to REMOVE) when the number of run exceeds the maximum. All run logs
6849
- # are available in CloudWatch logs, if you need information about a
6850
- # run that is no longer available to the API.
7142
+ # are available to the console and API. In the default mode
7143
+ # (`RETAIN`), you need to remove runs manually when the number of run
7144
+ # exceeds the maximum. If you set the retention mode to `REMOVE`,
7145
+ # Amazon Web Services HealthOmics automatically removes runs (that
7146
+ # have mode set to `REMOVE`) when the number of run exceeds the
7147
+ # maximum. All run logs are available in CloudWatch logs, if you need
7148
+ # information about a run that is no longer available to the API.
6851
7149
  #
6852
7150
  # For more information about retention mode, see [Specifying run
6853
7151
  # retention mode][1] in the *Amazon Web Services HealthOmics User
@@ -6859,25 +7157,36 @@ module Aws::Omics
6859
7157
  # @return [String]
6860
7158
  #
6861
7159
  # @!attribute [rw] storage_type
6862
- # The storage type for the run. By default, the run uses STATIC
6863
- # storage type, which allocates a fixed amount of storage. If you set
6864
- # the storage type to DYNAMIC, Amazon Web Services HealthOmics
6865
- # dynamically scales the storage up or down, based on file system
6866
- # utilization. For more information about static and dynamic storage,
6867
- # see [Running workflows][1] in the *Amazon Web Services HealthOmics
6868
- # User Guide*.
7160
+ # The storage type for the run. If you set the storage type to
7161
+ # `DYNAMIC`, Amazon Web Services HealthOmics dynamically scales the
7162
+ # storage up or down, based on file system utilization. By default,
7163
+ # the run uses `STATIC` storage type, which allocates a fixed amount
7164
+ # of storage. For more information about `DYNAMIC` and `STATIC`
7165
+ # storage, see [Run storage types][1] in the *Amazon Web Services
7166
+ # HealthOmics User Guide*.
6869
7167
  #
6870
7168
  #
6871
7169
  #
6872
- # [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
7170
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html
6873
7171
  # @return [String]
6874
7172
  #
6875
7173
  # @!attribute [rw] workflow_owner_id
6876
- # The ID of the workflow owner.
7174
+ # The 12-digit account ID of the workflow owner that is used for
7175
+ # running a shared workflow. The workflow owner ID can be retrieved
7176
+ # using the `GetShare` API operation. If you are the workflow owner,
7177
+ # you do not need to include this ID.
6877
7178
  # @return [String]
6878
7179
  #
6879
7180
  # @!attribute [rw] workflow_version_name
6880
- # The name of the workflow version.
7181
+ # The name of the workflow version. Use workflow versions to track and
7182
+ # organize changes to the workflow. If your workflow has multiple
7183
+ # versions, the run uses the default version unless you specify a
7184
+ # version name. To learn more, see [Workflow versioning][1] in the
7185
+ # *Amazon Web Services HealthOmics User Guide*.
7186
+ #
7187
+ #
7188
+ #
7189
+ # [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html
6881
7190
  # @return [String]
6882
7191
  #
6883
7192
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartRunRequest AWS API Documentation
@@ -7611,6 +7920,11 @@ module Aws::Omics
7611
7920
  # this workflow or workflow version.
7612
7921
  # @return [Integer]
7613
7922
  #
7923
+ # @!attribute [rw] readme_markdown
7924
+ # The markdown content for the workflow's README file. This provides
7925
+ # documentation and usage information for users of the workflow.
7926
+ # @return [String]
7927
+ #
7614
7928
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateWorkflowRequest AWS API Documentation
7615
7929
  #
7616
7930
  class UpdateWorkflowRequest < Struct.new(
@@ -7618,7 +7932,8 @@ module Aws::Omics
7618
7932
  :name,
7619
7933
  :description,
7620
7934
  :storage_type,
7621
- :storage_capacity)
7935
+ :storage_capacity,
7936
+ :readme_markdown)
7622
7937
  SENSITIVE = []
7623
7938
  include Aws::Structure
7624
7939
  end
@@ -7653,6 +7968,12 @@ module Aws::Omics
7653
7968
  # this workflow or workflow version.
7654
7969
  # @return [Integer]
7655
7970
  #
7971
+ # @!attribute [rw] readme_markdown
7972
+ # The markdown content for the workflow version's README file. This
7973
+ # provides documentation and usage information for users of this
7974
+ # specific workflow version.
7975
+ # @return [String]
7976
+ #
7656
7977
  # @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateWorkflowVersionRequest AWS API Documentation
7657
7978
  #
7658
7979
  class UpdateWorkflowVersionRequest < Struct.new(
@@ -7660,7 +7981,8 @@ module Aws::Omics
7660
7981
  :version_name,
7661
7982
  :description,
7662
7983
  :storage_type,
7663
- :storage_capacity)
7984
+ :storage_capacity,
7985
+ :readme_markdown)
7664
7986
  SENSITIVE = []
7665
7987
  include Aws::Structure
7666
7988
  end
data/lib/aws-sdk-omics.rb CHANGED
@@ -55,7 +55,7 @@ module Aws::Omics
55
55
  autoload :EndpointProvider, 'aws-sdk-omics/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-omics/endpoints'
57
57
 
58
- GEM_VERSION = '1.49.0'
58
+ GEM_VERSION = '1.50.0'
59
59
 
60
60
  end
61
61