aws-sdk-omics 1.44.0 → 1.45.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-omics/client.rb +551 -68
- data/lib/aws-sdk-omics/client_api.rb +230 -9
- data/lib/aws-sdk-omics/types.rb +572 -41
- data/lib/aws-sdk-omics/waiters.rb +58 -0
- data/lib/aws-sdk-omics.rb +1 -1
- data/sig/client.rbs +116 -3
- data/sig/types.rbs +114 -0
- data/sig/waiters.rbs +14 -0
- metadata +2 -2
data/lib/aws-sdk-omics/types.rb
CHANGED
@@ -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
|
916
|
-
# 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
|
#
|
@@ -935,8 +935,8 @@ module Aws::Omics
|
|
935
935
|
#
|
936
936
|
# @!attribute [rw] request_id
|
937
937
|
# A unique request token, to ensure idempotency. If you don't specify
|
938
|
-
# a token, HealthOmics automatically generates a
|
939
|
-
# identifier (UUID) for the request.
|
938
|
+
# a token, Amazon Web Services HealthOmics automatically generates a
|
939
|
+
# universally unique identifier (UUID) for the request.
|
940
940
|
#
|
941
941
|
# **A suitable default value is auto-generated.** You should normally
|
942
942
|
# not need to pass this option.
|
@@ -947,9 +947,9 @@ module Aws::Omics
|
|
947
947
|
# @return [Hash<String,String>]
|
948
948
|
#
|
949
949
|
# @!attribute [rw] cache_bucket_owner_id
|
950
|
-
# The
|
951
|
-
# run cache. If not provided, your account ID is set as
|
952
|
-
# the bucket.
|
950
|
+
# The Amazon Web Services account ID of the expected owner of the S3
|
951
|
+
# bucket for the run cache. If not provided, your account ID is set as
|
952
|
+
# the owner of the bucket.
|
953
953
|
# @return [String]
|
954
954
|
#
|
955
955
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateRunCacheRequest AWS API Documentation
|
@@ -1309,7 +1309,7 @@ module Aws::Omics
|
|
1309
1309
|
# @return [String]
|
1310
1310
|
#
|
1311
1311
|
# @!attribute [rw] engine
|
1312
|
-
#
|
1312
|
+
# The workflow engine for the workflow.
|
1313
1313
|
# @return [String]
|
1314
1314
|
#
|
1315
1315
|
# @!attribute [rw] definition_zip
|
@@ -1329,7 +1329,8 @@ module Aws::Omics
|
|
1329
1329
|
# @return [Hash<String,Types::WorkflowParameter>]
|
1330
1330
|
#
|
1331
1331
|
# @!attribute [rw] storage_capacity
|
1332
|
-
# The default storage capacity
|
1332
|
+
# The default static storage capacity (in gibibytes) for runs that use
|
1333
|
+
# this workflow or workflow version.
|
1333
1334
|
# @return [Integer]
|
1334
1335
|
#
|
1335
1336
|
# @!attribute [rw] tags
|
@@ -1348,6 +1349,19 @@ module Aws::Omics
|
|
1348
1349
|
# The computational accelerator specified to run the workflow.
|
1349
1350
|
# @return [String]
|
1350
1351
|
#
|
1352
|
+
# @!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
|
1355
|
+
# 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*.
|
1359
|
+
#
|
1360
|
+
#
|
1361
|
+
#
|
1362
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
|
1363
|
+
# @return [String]
|
1364
|
+
#
|
1351
1365
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateWorkflowRequest AWS API Documentation
|
1352
1366
|
#
|
1353
1367
|
class CreateWorkflowRequest < Struct.new(
|
@@ -1361,7 +1375,8 @@ module Aws::Omics
|
|
1361
1375
|
:storage_capacity,
|
1362
1376
|
:tags,
|
1363
1377
|
:request_id,
|
1364
|
-
:accelerators
|
1378
|
+
:accelerators,
|
1379
|
+
:storage_type)
|
1365
1380
|
SENSITIVE = []
|
1366
1381
|
include Aws::Structure
|
1367
1382
|
end
|
@@ -1382,13 +1397,161 @@ module Aws::Omics
|
|
1382
1397
|
# The workflow's tags.
|
1383
1398
|
# @return [Hash<String,String>]
|
1384
1399
|
#
|
1400
|
+
# @!attribute [rw] uuid
|
1401
|
+
# The universally unique identifier (UUID) value for this workflow.
|
1402
|
+
# @return [String]
|
1403
|
+
#
|
1385
1404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateWorkflowResponse AWS API Documentation
|
1386
1405
|
#
|
1387
1406
|
class CreateWorkflowResponse < Struct.new(
|
1388
1407
|
:arn,
|
1389
1408
|
:id,
|
1390
1409
|
:status,
|
1391
|
-
:tags
|
1410
|
+
:tags,
|
1411
|
+
:uuid)
|
1412
|
+
SENSITIVE = []
|
1413
|
+
include Aws::Structure
|
1414
|
+
end
|
1415
|
+
|
1416
|
+
# @!attribute [rw] workflow_id
|
1417
|
+
# The ID of the workflow where you are creating the new version.
|
1418
|
+
# @return [String]
|
1419
|
+
#
|
1420
|
+
# @!attribute [rw] version_name
|
1421
|
+
# A name for the workflow version. Provide a version name that is
|
1422
|
+
# unique for this workflow. You cannot change the name after
|
1423
|
+
# HealthOmics creates the version.
|
1424
|
+
#
|
1425
|
+
# The version name must start with a letter or number and it can
|
1426
|
+
# include upper-case and lower-case letters, numbers, hyphens, periods
|
1427
|
+
# and underscores. The maximum length is 64 characters. You can use a
|
1428
|
+
# simple naming scheme, such as version1, version2, version3. You can
|
1429
|
+
# also match your workflow versions with your own internal versioning
|
1430
|
+
# conventions, such as 2.7.0, 2.7.1, 2.7.2.
|
1431
|
+
# @return [String]
|
1432
|
+
#
|
1433
|
+
# @!attribute [rw] definition_zip
|
1434
|
+
# A zip archive containing the workflow definition for this workflow
|
1435
|
+
# version.
|
1436
|
+
# @return [String]
|
1437
|
+
#
|
1438
|
+
# @!attribute [rw] definition_uri
|
1439
|
+
# The URI specifies the location of the workflow definition for this
|
1440
|
+
# workflow version.
|
1441
|
+
# @return [String]
|
1442
|
+
#
|
1443
|
+
# @!attribute [rw] accelerators
|
1444
|
+
# The computational accelerator for this workflow version.
|
1445
|
+
# @return [String]
|
1446
|
+
#
|
1447
|
+
# @!attribute [rw] description
|
1448
|
+
# A description for this workflow version.
|
1449
|
+
# @return [String]
|
1450
|
+
#
|
1451
|
+
# @!attribute [rw] engine
|
1452
|
+
# The workflow engine for this workflow version.
|
1453
|
+
# @return [String]
|
1454
|
+
#
|
1455
|
+
# @!attribute [rw] main
|
1456
|
+
# The path of the main definition file for this workflow version.
|
1457
|
+
# @return [String]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] parameter_template
|
1460
|
+
# The parameter template defines the input parameters for runs that
|
1461
|
+
# use this workflow version.
|
1462
|
+
# @return [Hash<String,Types::WorkflowParameter>]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] request_id
|
1465
|
+
# To ensure that requests don't run multiple times, specify a unique
|
1466
|
+
# ID for each request.
|
1467
|
+
#
|
1468
|
+
# **A suitable default value is auto-generated.** You should normally
|
1469
|
+
# not need to pass this option.
|
1470
|
+
# @return [String]
|
1471
|
+
#
|
1472
|
+
# @!attribute [rw] storage_type
|
1473
|
+
# The default storage type for runs that use this workflow. STATIC
|
1474
|
+
# storage allocates a fixed amount of storage. DYNAMIC storage
|
1475
|
+
# dynamically scales the storage up or down, based on file system
|
1476
|
+
# utilization. For more information about static and dynamic storage,
|
1477
|
+
# see [Running workflows][1] in the *Amazon Web Services HealthOmics
|
1478
|
+
# User Guide*.
|
1479
|
+
#
|
1480
|
+
#
|
1481
|
+
#
|
1482
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
|
1483
|
+
# @return [String]
|
1484
|
+
#
|
1485
|
+
# @!attribute [rw] storage_capacity
|
1486
|
+
# The default static storage capacity (in gibibytes) for runs that use
|
1487
|
+
# this workflow or workflow version.
|
1488
|
+
# @return [Integer]
|
1489
|
+
#
|
1490
|
+
# @!attribute [rw] tags
|
1491
|
+
# Optional tags to associate with this workflow version.
|
1492
|
+
# @return [Hash<String,String>]
|
1493
|
+
#
|
1494
|
+
# @!attribute [rw] workflow_bucket_owner_id
|
1495
|
+
# Amazon Web Services Id of the owner of the S3 bucket that contains
|
1496
|
+
# the workflow definition. You need to specify this parameter if your
|
1497
|
+
# account is not the bucket owner.
|
1498
|
+
# @return [String]
|
1499
|
+
#
|
1500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateWorkflowVersionRequest AWS API Documentation
|
1501
|
+
#
|
1502
|
+
class CreateWorkflowVersionRequest < Struct.new(
|
1503
|
+
:workflow_id,
|
1504
|
+
:version_name,
|
1505
|
+
:definition_zip,
|
1506
|
+
:definition_uri,
|
1507
|
+
:accelerators,
|
1508
|
+
:description,
|
1509
|
+
:engine,
|
1510
|
+
:main,
|
1511
|
+
:parameter_template,
|
1512
|
+
:request_id,
|
1513
|
+
:storage_type,
|
1514
|
+
:storage_capacity,
|
1515
|
+
:tags,
|
1516
|
+
:workflow_bucket_owner_id)
|
1517
|
+
SENSITIVE = []
|
1518
|
+
include Aws::Structure
|
1519
|
+
end
|
1520
|
+
|
1521
|
+
# @!attribute [rw] arn
|
1522
|
+
# ARN of the workflow version.
|
1523
|
+
# @return [String]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] workflow_id
|
1526
|
+
# The workflow's ID.
|
1527
|
+
# @return [String]
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] version_name
|
1530
|
+
# The workflow version name.
|
1531
|
+
# @return [String]
|
1532
|
+
#
|
1533
|
+
# @!attribute [rw] status
|
1534
|
+
# The workflow version status.
|
1535
|
+
# @return [String]
|
1536
|
+
#
|
1537
|
+
# @!attribute [rw] tags
|
1538
|
+
# The workflow version's tags.
|
1539
|
+
# @return [Hash<String,String>]
|
1540
|
+
#
|
1541
|
+
# @!attribute [rw] uuid
|
1542
|
+
# The universally unique identifier (UUID) value for this workflow
|
1543
|
+
# version.
|
1544
|
+
# @return [String]
|
1545
|
+
#
|
1546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateWorkflowVersionResponse AWS API Documentation
|
1547
|
+
#
|
1548
|
+
class CreateWorkflowVersionResponse < Struct.new(
|
1549
|
+
:arn,
|
1550
|
+
:workflow_id,
|
1551
|
+
:version_name,
|
1552
|
+
:status,
|
1553
|
+
:tags,
|
1554
|
+
:uuid)
|
1392
1555
|
SENSITIVE = []
|
1393
1556
|
include Aws::Structure
|
1394
1557
|
end
|
@@ -1629,6 +1792,23 @@ module Aws::Omics
|
|
1629
1792
|
include Aws::Structure
|
1630
1793
|
end
|
1631
1794
|
|
1795
|
+
# @!attribute [rw] workflow_id
|
1796
|
+
# The workflow's ID.
|
1797
|
+
# @return [String]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] version_name
|
1800
|
+
# The workflow version name.
|
1801
|
+
# @return [String]
|
1802
|
+
#
|
1803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteWorkflowVersionRequest AWS API Documentation
|
1804
|
+
#
|
1805
|
+
class DeleteWorkflowVersionRequest < Struct.new(
|
1806
|
+
:workflow_id,
|
1807
|
+
:version_name)
|
1808
|
+
SENSITIVE = []
|
1809
|
+
include Aws::Structure
|
1810
|
+
end
|
1811
|
+
|
1632
1812
|
# The entity tag (ETag) is a hash of the object representing its
|
1633
1813
|
# semantic content.
|
1634
1814
|
#
|
@@ -2857,7 +3037,9 @@ module Aws::Omics
|
|
2857
3037
|
# @return [String]
|
2858
3038
|
#
|
2859
3039
|
# @!attribute [rw] engine_version
|
2860
|
-
# The
|
3040
|
+
# The actual Nextflow engine version that Amazon Web Services
|
3041
|
+
# HealthOmics used for the run. The other workflow definition
|
3042
|
+
# languages don't provide a value for this field.
|
2861
3043
|
# @return [String]
|
2862
3044
|
#
|
2863
3045
|
# @!attribute [rw] status
|
@@ -2978,6 +3160,14 @@ module Aws::Omics
|
|
2978
3160
|
# The ID of the workflow owner.
|
2979
3161
|
# @return [String]
|
2980
3162
|
#
|
3163
|
+
# @!attribute [rw] workflow_version_name
|
3164
|
+
# The workflow version name.
|
3165
|
+
# @return [String]
|
3166
|
+
#
|
3167
|
+
# @!attribute [rw] workflow_uuid
|
3168
|
+
# The universally unique identifier (UUID) value for the workflow.
|
3169
|
+
# @return [String]
|
3170
|
+
#
|
2981
3171
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetRunResponse AWS API Documentation
|
2982
3172
|
#
|
2983
3173
|
class GetRunResponse < Struct.new(
|
@@ -3014,7 +3204,9 @@ module Aws::Omics
|
|
3014
3204
|
:uuid,
|
3015
3205
|
:run_output_uri,
|
3016
3206
|
:storage_type,
|
3017
|
-
:workflow_owner_id
|
3207
|
+
:workflow_owner_id,
|
3208
|
+
:workflow_version_name,
|
3209
|
+
:workflow_uuid)
|
3018
3210
|
SENSITIVE = []
|
3019
3211
|
include Aws::Structure
|
3020
3212
|
end
|
@@ -3053,8 +3245,8 @@ module Aws::Omics
|
|
3053
3245
|
# @return [Integer]
|
3054
3246
|
#
|
3055
3247
|
# @!attribute [rw] cache_hit
|
3056
|
-
# Set to true if
|
3057
|
-
# cache for this task.
|
3248
|
+
# Set to true if Amazon Web Services HealthOmics found a matching
|
3249
|
+
# entry in the run cache for this task.
|
3058
3250
|
# @return [Boolean]
|
3059
3251
|
#
|
3060
3252
|
# @!attribute [rw] cache_s3_uri
|
@@ -3136,7 +3328,8 @@ module Aws::Omics
|
|
3136
3328
|
# @return [String]
|
3137
3329
|
#
|
3138
3330
|
# @!attribute [rw] store_id
|
3139
|
-
# The
|
3331
|
+
# The Amazon Web Services-generated Sequence Store or Reference Store
|
3332
|
+
# ID.
|
3140
3333
|
# @return [String]
|
3141
3334
|
#
|
3142
3335
|
# @!attribute [rw] store_type
|
@@ -3500,7 +3693,8 @@ module Aws::Omics
|
|
3500
3693
|
# @return [Hash<String,Types::WorkflowParameter>]
|
3501
3694
|
#
|
3502
3695
|
# @!attribute [rw] storage_capacity
|
3503
|
-
# The
|
3696
|
+
# The default static storage capacity (in gibibytes) for runs that use
|
3697
|
+
# this workflow or workflow version.
|
3504
3698
|
# @return [Integer]
|
3505
3699
|
#
|
3506
3700
|
# @!attribute [rw] creation_time
|
@@ -3516,13 +3710,21 @@ module Aws::Omics
|
|
3516
3710
|
# @return [Hash<String,String>]
|
3517
3711
|
#
|
3518
3712
|
# @!attribute [rw] metadata
|
3519
|
-
# Gets metadata for workflow.
|
3713
|
+
# Gets metadata for the workflow.
|
3520
3714
|
# @return [Hash<String,String>]
|
3521
3715
|
#
|
3522
3716
|
# @!attribute [rw] accelerators
|
3523
3717
|
# The computational accelerator specified to run the workflow.
|
3524
3718
|
# @return [String]
|
3525
3719
|
#
|
3720
|
+
# @!attribute [rw] storage_type
|
3721
|
+
# The default storage type for runs using this workflow.
|
3722
|
+
# @return [String]
|
3723
|
+
#
|
3724
|
+
# @!attribute [rw] uuid
|
3725
|
+
# The universally unique identifier (UUID) value for this workflow.
|
3726
|
+
# @return [String]
|
3727
|
+
#
|
3526
3728
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetWorkflowResponse AWS API Documentation
|
3527
3729
|
#
|
3528
3730
|
class GetWorkflowResponse < Struct.new(
|
@@ -3542,7 +3744,149 @@ module Aws::Omics
|
|
3542
3744
|
:status_message,
|
3543
3745
|
:tags,
|
3544
3746
|
:metadata,
|
3545
|
-
:accelerators
|
3747
|
+
:accelerators,
|
3748
|
+
:storage_type,
|
3749
|
+
:uuid)
|
3750
|
+
SENSITIVE = []
|
3751
|
+
include Aws::Structure
|
3752
|
+
end
|
3753
|
+
|
3754
|
+
# @!attribute [rw] workflow_id
|
3755
|
+
# The workflow's ID.
|
3756
|
+
# @return [String]
|
3757
|
+
#
|
3758
|
+
# @!attribute [rw] version_name
|
3759
|
+
# The workflow version name.
|
3760
|
+
# @return [String]
|
3761
|
+
#
|
3762
|
+
# @!attribute [rw] type
|
3763
|
+
# The workflow's type.
|
3764
|
+
# @return [String]
|
3765
|
+
#
|
3766
|
+
# @!attribute [rw] export
|
3767
|
+
# The export format for the workflow.
|
3768
|
+
# @return [Array<String>]
|
3769
|
+
#
|
3770
|
+
# @!attribute [rw] workflow_owner_id
|
3771
|
+
# Amazon Web Services Id of the owner of the workflow.
|
3772
|
+
# @return [String]
|
3773
|
+
#
|
3774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetWorkflowVersionRequest AWS API Documentation
|
3775
|
+
#
|
3776
|
+
class GetWorkflowVersionRequest < Struct.new(
|
3777
|
+
:workflow_id,
|
3778
|
+
:version_name,
|
3779
|
+
:type,
|
3780
|
+
:export,
|
3781
|
+
:workflow_owner_id)
|
3782
|
+
SENSITIVE = []
|
3783
|
+
include Aws::Structure
|
3784
|
+
end
|
3785
|
+
|
3786
|
+
# @!attribute [rw] arn
|
3787
|
+
# ARN of the workflow version.
|
3788
|
+
# @return [String]
|
3789
|
+
#
|
3790
|
+
# @!attribute [rw] workflow_id
|
3791
|
+
# The workflow's ID.
|
3792
|
+
# @return [String]
|
3793
|
+
#
|
3794
|
+
# @!attribute [rw] version_name
|
3795
|
+
# The workflow version name.
|
3796
|
+
# @return [String]
|
3797
|
+
#
|
3798
|
+
# @!attribute [rw] accelerators
|
3799
|
+
# The accelerator for this workflow version.
|
3800
|
+
# @return [String]
|
3801
|
+
#
|
3802
|
+
# @!attribute [rw] creation_time
|
3803
|
+
# When the workflow version was created.
|
3804
|
+
# @return [Time]
|
3805
|
+
#
|
3806
|
+
# @!attribute [rw] description
|
3807
|
+
# Description of the workflow version.
|
3808
|
+
# @return [String]
|
3809
|
+
#
|
3810
|
+
# @!attribute [rw] definition
|
3811
|
+
# Definition of the workflow version.
|
3812
|
+
# @return [String]
|
3813
|
+
#
|
3814
|
+
# @!attribute [rw] digest
|
3815
|
+
# The workflow version's digest.
|
3816
|
+
# @return [String]
|
3817
|
+
#
|
3818
|
+
# @!attribute [rw] engine
|
3819
|
+
# The workflow engine for this workflow version.
|
3820
|
+
# @return [String]
|
3821
|
+
#
|
3822
|
+
# @!attribute [rw] main
|
3823
|
+
# The path of the main definition file for the workflow.
|
3824
|
+
# @return [String]
|
3825
|
+
#
|
3826
|
+
# @!attribute [rw] metadata
|
3827
|
+
# The metadata for the workflow version.
|
3828
|
+
# @return [Hash<String,String>]
|
3829
|
+
#
|
3830
|
+
# @!attribute [rw] parameter_template
|
3831
|
+
# The parameter template for the workflow version.
|
3832
|
+
# @return [Hash<String,Types::WorkflowParameter>]
|
3833
|
+
#
|
3834
|
+
# @!attribute [rw] status
|
3835
|
+
# The workflow version status
|
3836
|
+
# @return [String]
|
3837
|
+
#
|
3838
|
+
# @!attribute [rw] status_message
|
3839
|
+
# The workflow version status message
|
3840
|
+
# @return [String]
|
3841
|
+
#
|
3842
|
+
# @!attribute [rw] storage_type
|
3843
|
+
# The default storage type for the run.
|
3844
|
+
# @return [String]
|
3845
|
+
#
|
3846
|
+
# @!attribute [rw] storage_capacity
|
3847
|
+
# The default run storage capacity for static storage.
|
3848
|
+
# @return [Integer]
|
3849
|
+
#
|
3850
|
+
# @!attribute [rw] type
|
3851
|
+
# The workflow version type
|
3852
|
+
# @return [String]
|
3853
|
+
#
|
3854
|
+
# @!attribute [rw] tags
|
3855
|
+
# The workflow version tags
|
3856
|
+
# @return [Hash<String,String>]
|
3857
|
+
#
|
3858
|
+
# @!attribute [rw] uuid
|
3859
|
+
# The universally unique identifier (UUID) value for this workflow
|
3860
|
+
# version
|
3861
|
+
# @return [String]
|
3862
|
+
#
|
3863
|
+
# @!attribute [rw] workflow_bucket_owner_id
|
3864
|
+
# Amazon Web Services Id of the owner of the bucket.
|
3865
|
+
# @return [String]
|
3866
|
+
#
|
3867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetWorkflowVersionResponse AWS API Documentation
|
3868
|
+
#
|
3869
|
+
class GetWorkflowVersionResponse < Struct.new(
|
3870
|
+
:arn,
|
3871
|
+
:workflow_id,
|
3872
|
+
:version_name,
|
3873
|
+
:accelerators,
|
3874
|
+
:creation_time,
|
3875
|
+
:description,
|
3876
|
+
:definition,
|
3877
|
+
:digest,
|
3878
|
+
:engine,
|
3879
|
+
:main,
|
3880
|
+
:metadata,
|
3881
|
+
:parameter_template,
|
3882
|
+
:status,
|
3883
|
+
:status_message,
|
3884
|
+
:storage_type,
|
3885
|
+
:storage_capacity,
|
3886
|
+
:type,
|
3887
|
+
:tags,
|
3888
|
+
:uuid,
|
3889
|
+
:workflow_bucket_owner_id)
|
3546
3890
|
SENSITIVE = []
|
3547
3891
|
include Aws::Structure
|
3548
3892
|
end
|
@@ -4804,6 +5148,56 @@ module Aws::Omics
|
|
4804
5148
|
include Aws::Structure
|
4805
5149
|
end
|
4806
5150
|
|
5151
|
+
# @!attribute [rw] workflow_id
|
5152
|
+
# The workflow's ID.
|
5153
|
+
# @return [String]
|
5154
|
+
#
|
5155
|
+
# @!attribute [rw] type
|
5156
|
+
# The workflow type.
|
5157
|
+
# @return [String]
|
5158
|
+
#
|
5159
|
+
# @!attribute [rw] workflow_owner_id
|
5160
|
+
# Amazon Web Services Id of the owner of the workflow.
|
5161
|
+
# @return [String]
|
5162
|
+
#
|
5163
|
+
# @!attribute [rw] starting_token
|
5164
|
+
# Specify the pagination token from a previous request to retrieve the
|
5165
|
+
# next page of results.
|
5166
|
+
# @return [String]
|
5167
|
+
#
|
5168
|
+
# @!attribute [rw] max_results
|
5169
|
+
# The maximum number of workflows to return in one page of results.
|
5170
|
+
# @return [Integer]
|
5171
|
+
#
|
5172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListWorkflowVersionsRequest AWS API Documentation
|
5173
|
+
#
|
5174
|
+
class ListWorkflowVersionsRequest < Struct.new(
|
5175
|
+
:workflow_id,
|
5176
|
+
:type,
|
5177
|
+
:workflow_owner_id,
|
5178
|
+
:starting_token,
|
5179
|
+
:max_results)
|
5180
|
+
SENSITIVE = []
|
5181
|
+
include Aws::Structure
|
5182
|
+
end
|
5183
|
+
|
5184
|
+
# @!attribute [rw] items
|
5185
|
+
# A list of workflow version items.
|
5186
|
+
# @return [Array<Types::WorkflowVersionListItem>]
|
5187
|
+
#
|
5188
|
+
# @!attribute [rw] next_token
|
5189
|
+
# A pagination token that's included if more results are available.
|
5190
|
+
# @return [String]
|
5191
|
+
#
|
5192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListWorkflowVersionsResponse AWS API Documentation
|
5193
|
+
#
|
5194
|
+
class ListWorkflowVersionsResponse < Struct.new(
|
5195
|
+
:items,
|
5196
|
+
:next_token)
|
5197
|
+
SENSITIVE = []
|
5198
|
+
include Aws::Structure
|
5199
|
+
end
|
5200
|
+
|
4807
5201
|
# @!attribute [rw] type
|
4808
5202
|
# Filter the list by workflow type.
|
4809
5203
|
# @return [String]
|
@@ -4950,7 +5344,8 @@ module Aws::Omics
|
|
4950
5344
|
# @return [String]
|
4951
5345
|
#
|
4952
5346
|
# @!attribute [rw] store_id
|
4953
|
-
# The
|
5347
|
+
# The Amazon Web Services-generated Sequence Store or Reference Store
|
5348
|
+
# ID.
|
4954
5349
|
# @return [String]
|
4955
5350
|
#
|
4956
5351
|
# @!attribute [rw] store_type
|
@@ -5654,6 +6049,10 @@ module Aws::Omics
|
|
5654
6049
|
# The run's storage type.
|
5655
6050
|
# @return [String]
|
5656
6051
|
#
|
6052
|
+
# @!attribute [rw] workflow_version_name
|
6053
|
+
# The name of the workflow version.
|
6054
|
+
# @return [String]
|
6055
|
+
#
|
5657
6056
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/RunListItem AWS API Documentation
|
5658
6057
|
#
|
5659
6058
|
class RunListItem < Struct.new(
|
@@ -5667,7 +6066,8 @@ module Aws::Omics
|
|
5667
6066
|
:creation_time,
|
5668
6067
|
:start_time,
|
5669
6068
|
:stop_time,
|
5670
|
-
:storage_type
|
6069
|
+
:storage_type,
|
6070
|
+
:workflow_version_name)
|
5671
6071
|
SENSITIVE = []
|
5672
6072
|
include Aws::Structure
|
5673
6073
|
end
|
@@ -6391,7 +6791,8 @@ module Aws::Omics
|
|
6391
6791
|
# The cache behavior for the run. You specify this value if you want
|
6392
6792
|
# to override the default behavior for the cache. You had set the
|
6393
6793
|
# default value when you created the cache. For more information, see
|
6394
|
-
# [Run cache behavior][1] in the
|
6794
|
+
# [Run cache behavior][1] in the Amazon Web Services HealthOmics User
|
6795
|
+
# Guide.
|
6395
6796
|
#
|
6396
6797
|
#
|
6397
6798
|
#
|
@@ -6411,9 +6812,9 @@ module Aws::Omics
|
|
6411
6812
|
# @return [Hash,Array,String,Numeric,Boolean]
|
6412
6813
|
#
|
6413
6814
|
# @!attribute [rw] storage_capacity
|
6414
|
-
#
|
6415
|
-
# required if the storage type is dynamic (the system ignores
|
6416
|
-
# value that you enter).
|
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).
|
6417
6818
|
# @return [Integer]
|
6418
6819
|
#
|
6419
6820
|
# @!attribute [rw] output_uri
|
@@ -6439,16 +6840,18 @@ module Aws::Omics
|
|
6439
6840
|
# @!attribute [rw] retention_mode
|
6440
6841
|
# The retention mode for the run. The default value is RETAIN.
|
6441
6842
|
#
|
6442
|
-
# HealthOmics stores a fixed number of runs that
|
6443
|
-
# console and API. In the default mode (RETAIN),
|
6444
|
-
# runs manually when the number of run exceeds the
|
6445
|
-
# the retention mode to `REMOVE`,
|
6446
|
-
# runs (that have mode set
|
6447
|
-
# the
|
6448
|
-
#
|
6843
|
+
# 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.
|
6449
6851
|
#
|
6450
6852
|
# For more information about retention mode, see [Specifying run
|
6451
|
-
# retention mode][1] in the *
|
6853
|
+
# retention mode][1] in the *Amazon Web Services HealthOmics User
|
6854
|
+
# Guide*.
|
6452
6855
|
#
|
6453
6856
|
#
|
6454
6857
|
#
|
@@ -6456,16 +6859,27 @@ module Aws::Omics
|
|
6456
6859
|
# @return [String]
|
6457
6860
|
#
|
6458
6861
|
# @!attribute [rw] storage_type
|
6459
|
-
# The
|
6460
|
-
# type, which allocates a fixed amount of storage. If you set
|
6461
|
-
# storage type to DYNAMIC,
|
6462
|
-
# up or down, based on file system
|
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*.
|
6869
|
+
#
|
6870
|
+
#
|
6871
|
+
#
|
6872
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
|
6463
6873
|
# @return [String]
|
6464
6874
|
#
|
6465
6875
|
# @!attribute [rw] workflow_owner_id
|
6466
6876
|
# The ID of the workflow owner.
|
6467
6877
|
# @return [String]
|
6468
6878
|
#
|
6879
|
+
# @!attribute [rw] workflow_version_name
|
6880
|
+
# The name of the workflow version.
|
6881
|
+
# @return [String]
|
6882
|
+
#
|
6469
6883
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartRunRequest AWS API Documentation
|
6470
6884
|
#
|
6471
6885
|
class StartRunRequest < Struct.new(
|
@@ -6486,7 +6900,8 @@ module Aws::Omics
|
|
6486
6900
|
:request_id,
|
6487
6901
|
:retention_mode,
|
6488
6902
|
:storage_type,
|
6489
|
-
:workflow_owner_id
|
6903
|
+
:workflow_owner_id,
|
6904
|
+
:workflow_version_name)
|
6490
6905
|
SENSITIVE = []
|
6491
6906
|
include Aws::Structure
|
6492
6907
|
end
|
@@ -6635,8 +7050,8 @@ module Aws::Omics
|
|
6635
7050
|
# @return [Integer]
|
6636
7051
|
#
|
6637
7052
|
# @!attribute [rw] cache_hit
|
6638
|
-
# Set to true if
|
6639
|
-
# cache for this task.
|
7053
|
+
# Set to true if Amazon Web Services HealthOmics found a matching
|
7054
|
+
# entry in the run cache for this task.
|
6640
7055
|
# @return [Boolean]
|
6641
7056
|
#
|
6642
7057
|
# @!attribute [rw] cache_s3_uri
|
@@ -7178,12 +7593,74 @@ module Aws::Omics
|
|
7178
7593
|
# A description for the workflow.
|
7179
7594
|
# @return [String]
|
7180
7595
|
#
|
7596
|
+
# @!attribute [rw] storage_type
|
7597
|
+
# The default storage type for runs that use this workflow. STATIC
|
7598
|
+
# storage allocates a fixed amount of storage. DYNAMIC storage
|
7599
|
+
# dynamically scales the storage up or down, based on file system
|
7600
|
+
# utilization. For more information about static and dynamic storage,
|
7601
|
+
# see [Running workflows][1] in the *Amazon Web Services HealthOmics
|
7602
|
+
# User Guide*.
|
7603
|
+
#
|
7604
|
+
#
|
7605
|
+
#
|
7606
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
|
7607
|
+
# @return [String]
|
7608
|
+
#
|
7609
|
+
# @!attribute [rw] storage_capacity
|
7610
|
+
# The default static storage capacity (in gibibytes) for runs that use
|
7611
|
+
# this workflow or workflow version.
|
7612
|
+
# @return [Integer]
|
7613
|
+
#
|
7181
7614
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateWorkflowRequest AWS API Documentation
|
7182
7615
|
#
|
7183
7616
|
class UpdateWorkflowRequest < Struct.new(
|
7184
7617
|
:id,
|
7185
7618
|
:name,
|
7186
|
-
:description
|
7619
|
+
:description,
|
7620
|
+
:storage_type,
|
7621
|
+
:storage_capacity)
|
7622
|
+
SENSITIVE = []
|
7623
|
+
include Aws::Structure
|
7624
|
+
end
|
7625
|
+
|
7626
|
+
# @!attribute [rw] workflow_id
|
7627
|
+
# The workflow's ID.
|
7628
|
+
# @return [String]
|
7629
|
+
#
|
7630
|
+
# @!attribute [rw] version_name
|
7631
|
+
# The name of the workflow version.
|
7632
|
+
# @return [String]
|
7633
|
+
#
|
7634
|
+
# @!attribute [rw] description
|
7635
|
+
# Description of the workflow version.
|
7636
|
+
# @return [String]
|
7637
|
+
#
|
7638
|
+
# @!attribute [rw] storage_type
|
7639
|
+
# The default storage type for runs that use this workflow. STATIC
|
7640
|
+
# storage allocates a fixed amount of storage. DYNAMIC storage
|
7641
|
+
# dynamically scales the storage up or down, based on file system
|
7642
|
+
# utilization. For more information about static and dynamic storage,
|
7643
|
+
# see [Running workflows][1] in the *Amazon Web Services HealthOmics
|
7644
|
+
# User Guide*.
|
7645
|
+
#
|
7646
|
+
#
|
7647
|
+
#
|
7648
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html
|
7649
|
+
# @return [String]
|
7650
|
+
#
|
7651
|
+
# @!attribute [rw] storage_capacity
|
7652
|
+
# The default static storage capacity (in gibibytes) for runs that use
|
7653
|
+
# this workflow or workflow version.
|
7654
|
+
# @return [Integer]
|
7655
|
+
#
|
7656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateWorkflowVersionRequest AWS API Documentation
|
7657
|
+
#
|
7658
|
+
class UpdateWorkflowVersionRequest < Struct.new(
|
7659
|
+
:workflow_id,
|
7660
|
+
:version_name,
|
7661
|
+
:description,
|
7662
|
+
:storage_type,
|
7663
|
+
:storage_capacity)
|
7187
7664
|
SENSITIVE = []
|
7188
7665
|
include Aws::Structure
|
7189
7666
|
end
|
@@ -7534,6 +8011,60 @@ module Aws::Omics
|
|
7534
8011
|
include Aws::Structure
|
7535
8012
|
end
|
7536
8013
|
|
8014
|
+
# A list of workflow version items.
|
8015
|
+
#
|
8016
|
+
# @!attribute [rw] arn
|
8017
|
+
# ARN of the workflow version.
|
8018
|
+
# @return [String]
|
8019
|
+
#
|
8020
|
+
# @!attribute [rw] workflow_id
|
8021
|
+
# The workflow's ID.
|
8022
|
+
# @return [String]
|
8023
|
+
#
|
8024
|
+
# @!attribute [rw] version_name
|
8025
|
+
# The name of the workflow version.
|
8026
|
+
# @return [String]
|
8027
|
+
#
|
8028
|
+
# @!attribute [rw] description
|
8029
|
+
# The description of the workflow version.
|
8030
|
+
# @return [String]
|
8031
|
+
#
|
8032
|
+
# @!attribute [rw] status
|
8033
|
+
# The status of the workflow version.
|
8034
|
+
# @return [String]
|
8035
|
+
#
|
8036
|
+
# @!attribute [rw] type
|
8037
|
+
# The type of the workflow version.
|
8038
|
+
# @return [String]
|
8039
|
+
#
|
8040
|
+
# @!attribute [rw] digest
|
8041
|
+
# The digist of the workflow version.
|
8042
|
+
# @return [String]
|
8043
|
+
#
|
8044
|
+
# @!attribute [rw] creation_time
|
8045
|
+
# The creation time of the workflow version.
|
8046
|
+
# @return [Time]
|
8047
|
+
#
|
8048
|
+
# @!attribute [rw] metadata
|
8049
|
+
# Metadata for the workflow version.
|
8050
|
+
# @return [Hash<String,String>]
|
8051
|
+
#
|
8052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/WorkflowVersionListItem AWS API Documentation
|
8053
|
+
#
|
8054
|
+
class WorkflowVersionListItem < Struct.new(
|
8055
|
+
:arn,
|
8056
|
+
:workflow_id,
|
8057
|
+
:version_name,
|
8058
|
+
:description,
|
8059
|
+
:status,
|
8060
|
+
:type,
|
8061
|
+
:digest,
|
8062
|
+
:creation_time,
|
8063
|
+
:metadata)
|
8064
|
+
SENSITIVE = []
|
8065
|
+
include Aws::Structure
|
8066
|
+
end
|
8067
|
+
|
7537
8068
|
end
|
7538
8069
|
end
|
7539
8070
|
|