aws-sdk-omics 1.39.0 → 1.41.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-omics/client.rb +566 -6
- data/lib/aws-sdk-omics/client_api.rb +352 -1
- data/lib/aws-sdk-omics/types.rb +694 -8
- data/lib/aws-sdk-omics.rb +1 -1
- data/sig/client.rbs +155 -2
- data/sig/types.rbs +168 -0
- metadata +2 -2
data/lib/aws-sdk-omics/client.rb
CHANGED
@@ -967,6 +967,110 @@ module Aws::Omics
|
|
967
967
|
req.send_request(options)
|
968
968
|
end
|
969
969
|
|
970
|
+
# You can create a run cache to save the task outputs from completed
|
971
|
+
# tasks in a run for a private workflow. Subsequent runs use the task
|
972
|
+
# outputs from the cache, rather than computing the task outputs again.
|
973
|
+
# You specify an Amazon S3 location where HealthOmics saves the cached
|
974
|
+
# data. This data must be immediately accessible (not in an archived
|
975
|
+
# state).
|
976
|
+
#
|
977
|
+
# For more information, see [Creating a run cache][1] in the AWS
|
978
|
+
# HealthOmics User Guide.
|
979
|
+
#
|
980
|
+
#
|
981
|
+
#
|
982
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-cache-create.html
|
983
|
+
#
|
984
|
+
# @option params [String] :cache_behavior
|
985
|
+
# Default cache behavior for runs that use this cache. Supported values
|
986
|
+
# are:
|
987
|
+
#
|
988
|
+
# `CACHE_ON_FAILURE`: Caches task outputs from completed tasks for runs
|
989
|
+
# that fail. This setting is useful if you're debugging a workflow that
|
990
|
+
# fails after several tasks completed successfully. The subsequent run
|
991
|
+
# uses the cache outputs for previously-completed tasks if the task
|
992
|
+
# definition, inputs, and container in ECR are identical to the prior
|
993
|
+
# run.
|
994
|
+
#
|
995
|
+
# `CACHE_ALWAYS`: Caches task outputs from completed tasks for all runs.
|
996
|
+
# This setting is useful in development mode, but do not use it in a
|
997
|
+
# production setting.
|
998
|
+
#
|
999
|
+
# If you don't specify a value, the default behavior is
|
1000
|
+
# CACHE\_ON\_FAILURE. When you start a run that uses this cache, you can
|
1001
|
+
# override the default cache behavior.
|
1002
|
+
#
|
1003
|
+
# For more information, see [Run cache behavior][1] in the AWS
|
1004
|
+
# HealthOmics User Guide.
|
1005
|
+
#
|
1006
|
+
#
|
1007
|
+
#
|
1008
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior
|
1009
|
+
#
|
1010
|
+
# @option params [required, String] :cache_s3_location
|
1011
|
+
# Specify the S3 location for storing the cached task outputs. This data
|
1012
|
+
# must be immediately accessible (not in an archived state).
|
1013
|
+
#
|
1014
|
+
# @option params [String] :description
|
1015
|
+
# Enter a description of the run cache.
|
1016
|
+
#
|
1017
|
+
# @option params [String] :name
|
1018
|
+
# Enter a user-friendly name for the run cache.
|
1019
|
+
#
|
1020
|
+
# @option params [required, String] :request_id
|
1021
|
+
# A unique request token, to ensure idempotency. If you don't specify a
|
1022
|
+
# token, HealthOmics automatically generates a universally unique
|
1023
|
+
# identifier (UUID) for the request.
|
1024
|
+
#
|
1025
|
+
# **A suitable default value is auto-generated.** You should normally
|
1026
|
+
# not need to pass this option.**
|
1027
|
+
#
|
1028
|
+
# @option params [Hash<String,String>] :tags
|
1029
|
+
# Specify one or more tags to associate with this run cache.
|
1030
|
+
#
|
1031
|
+
# @option params [String] :cache_bucket_owner_id
|
1032
|
+
# The AWS account ID of the expected owner of the S3 bucket for the run
|
1033
|
+
# cache. If not provided, your account ID is set as the owner of the
|
1034
|
+
# bucket.
|
1035
|
+
#
|
1036
|
+
# @return [Types::CreateRunCacheResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1037
|
+
#
|
1038
|
+
# * {Types::CreateRunCacheResponse#arn #arn} => String
|
1039
|
+
# * {Types::CreateRunCacheResponse#id #id} => String
|
1040
|
+
# * {Types::CreateRunCacheResponse#status #status} => String
|
1041
|
+
# * {Types::CreateRunCacheResponse#tags #tags} => Hash<String,String>
|
1042
|
+
#
|
1043
|
+
# @example Request syntax with placeholder values
|
1044
|
+
#
|
1045
|
+
# resp = client.create_run_cache({
|
1046
|
+
# cache_behavior: "CACHE_ON_FAILURE", # accepts CACHE_ON_FAILURE, CACHE_ALWAYS
|
1047
|
+
# cache_s3_location: "S3UriForBucketOrObject", # required
|
1048
|
+
# description: "UserCustomDescription",
|
1049
|
+
# name: "UserCustomName",
|
1050
|
+
# request_id: "RunCacheRequestId", # required
|
1051
|
+
# tags: {
|
1052
|
+
# "TagKey" => "TagValue",
|
1053
|
+
# },
|
1054
|
+
# cache_bucket_owner_id: "AwsAccountId",
|
1055
|
+
# })
|
1056
|
+
#
|
1057
|
+
# @example Response structure
|
1058
|
+
#
|
1059
|
+
# resp.arn #=> String
|
1060
|
+
# resp.id #=> String
|
1061
|
+
# resp.status #=> String, one of "ACTIVE", "DELETED", "FAILED"
|
1062
|
+
# resp.tags #=> Hash
|
1063
|
+
# resp.tags["TagKey"] #=> String
|
1064
|
+
#
|
1065
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateRunCache AWS API Documentation
|
1066
|
+
#
|
1067
|
+
# @overload create_run_cache(params = {})
|
1068
|
+
# @param [Hash] params ({})
|
1069
|
+
def create_run_cache(params = {}, options = {})
|
1070
|
+
req = build_request(:create_run_cache, params)
|
1071
|
+
req.send_request(options)
|
1072
|
+
end
|
1073
|
+
|
970
1074
|
# You can optionally create a run group to limit the compute resources
|
971
1075
|
# for the runs that you add to the group.
|
972
1076
|
#
|
@@ -1052,6 +1156,9 @@ module Aws::Omics
|
|
1052
1156
|
# To ensure that requests don't run multiple times, specify a unique
|
1053
1157
|
# token for each request.
|
1054
1158
|
#
|
1159
|
+
# **A suitable default value is auto-generated.** You should normally
|
1160
|
+
# not need to pass this option.**
|
1161
|
+
#
|
1055
1162
|
# @option params [String] :fallback_location
|
1056
1163
|
# An S3 location that is used to store files that have failed a direct
|
1057
1164
|
# upload.
|
@@ -1059,6 +1166,13 @@ module Aws::Omics
|
|
1059
1166
|
# @option params [String] :e_tag_algorithm_family
|
1060
1167
|
# The ETag algorithm family to use for ingested read sets.
|
1061
1168
|
#
|
1169
|
+
# @option params [Array<String>] :propagated_set_level_tags
|
1170
|
+
# The tags keys to propagate to the S3 objects associated with read sets
|
1171
|
+
# in the sequence store.
|
1172
|
+
#
|
1173
|
+
# @option params [Types::S3AccessConfig] :s3_access_config
|
1174
|
+
# S3 access configuration parameters
|
1175
|
+
#
|
1062
1176
|
# @return [Types::CreateSequenceStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1063
1177
|
#
|
1064
1178
|
# * {Types::CreateSequenceStoreResponse#id #id} => String
|
@@ -1069,6 +1183,10 @@ module Aws::Omics
|
|
1069
1183
|
# * {Types::CreateSequenceStoreResponse#creation_time #creation_time} => Time
|
1070
1184
|
# * {Types::CreateSequenceStoreResponse#fallback_location #fallback_location} => String
|
1071
1185
|
# * {Types::CreateSequenceStoreResponse#e_tag_algorithm_family #e_tag_algorithm_family} => String
|
1186
|
+
# * {Types::CreateSequenceStoreResponse#status #status} => String
|
1187
|
+
# * {Types::CreateSequenceStoreResponse#status_message #status_message} => String
|
1188
|
+
# * {Types::CreateSequenceStoreResponse#propagated_set_level_tags #propagated_set_level_tags} => Array<String>
|
1189
|
+
# * {Types::CreateSequenceStoreResponse#s3_access #s3_access} => Types::SequenceStoreS3Access
|
1072
1190
|
#
|
1073
1191
|
# @example Request syntax with placeholder values
|
1074
1192
|
#
|
@@ -1085,6 +1203,10 @@ module Aws::Omics
|
|
1085
1203
|
# client_token: "ClientToken",
|
1086
1204
|
# fallback_location: "S3Destination",
|
1087
1205
|
# e_tag_algorithm_family: "MD5up", # accepts MD5up, SHA256up, SHA512up
|
1206
|
+
# propagated_set_level_tags: ["TagKey"],
|
1207
|
+
# s3_access_config: {
|
1208
|
+
# access_log_location: "AccessLogLocation",
|
1209
|
+
# },
|
1088
1210
|
# })
|
1089
1211
|
#
|
1090
1212
|
# @example Response structure
|
@@ -1098,6 +1220,13 @@ module Aws::Omics
|
|
1098
1220
|
# resp.creation_time #=> Time
|
1099
1221
|
# resp.fallback_location #=> String
|
1100
1222
|
# resp.e_tag_algorithm_family #=> String, one of "MD5up", "SHA256up", "SHA512up"
|
1223
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
1224
|
+
# resp.status_message #=> String
|
1225
|
+
# resp.propagated_set_level_tags #=> Array
|
1226
|
+
# resp.propagated_set_level_tags[0] #=> String
|
1227
|
+
# resp.s3_access.s3_uri #=> String
|
1228
|
+
# resp.s3_access.s3_access_point_arn #=> String
|
1229
|
+
# resp.s3_access.access_log_location #=> String
|
1101
1230
|
#
|
1102
1231
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateSequenceStore AWS API Documentation
|
1103
1232
|
#
|
@@ -1446,6 +1575,39 @@ module Aws::Omics
|
|
1446
1575
|
req.send_request(options)
|
1447
1576
|
end
|
1448
1577
|
|
1578
|
+
# Delete a run cache. This action removes the cache metadata stored in
|
1579
|
+
# the service account, but doesn't delete the data in Amazon S3. You
|
1580
|
+
# can access the cache data in Amazon S3, for inspection or to
|
1581
|
+
# troubleshoot issues. You can remove old cache data using standard S3
|
1582
|
+
# `Delete` operations.
|
1583
|
+
#
|
1584
|
+
# For more information, see [Deleting a run cache][1] in the AWS
|
1585
|
+
# HealthOmics User Guide.
|
1586
|
+
#
|
1587
|
+
#
|
1588
|
+
#
|
1589
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-cache-delete.html
|
1590
|
+
#
|
1591
|
+
# @option params [required, String] :id
|
1592
|
+
# Run cache identifier for the cache you want to delete.
|
1593
|
+
#
|
1594
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1595
|
+
#
|
1596
|
+
# @example Request syntax with placeholder values
|
1597
|
+
#
|
1598
|
+
# resp = client.delete_run_cache({
|
1599
|
+
# id: "RunCacheId", # required
|
1600
|
+
# })
|
1601
|
+
#
|
1602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteRunCache AWS API Documentation
|
1603
|
+
#
|
1604
|
+
# @overload delete_run_cache(params = {})
|
1605
|
+
# @param [Hash] params ({})
|
1606
|
+
def delete_run_cache(params = {}, options = {})
|
1607
|
+
req = build_request(:delete_run_cache, params)
|
1608
|
+
req.send_request(options)
|
1609
|
+
end
|
1610
|
+
|
1449
1611
|
# Deletes a workflow run group.
|
1450
1612
|
#
|
1451
1613
|
# @option params [required, String] :id
|
@@ -1468,6 +1630,28 @@ module Aws::Omics
|
|
1468
1630
|
req.send_request(options)
|
1469
1631
|
end
|
1470
1632
|
|
1633
|
+
# Deletes an access policy for the specified store.
|
1634
|
+
#
|
1635
|
+
# @option params [required, String] :s3_access_point_arn
|
1636
|
+
# The S3 access point ARN that has the access policy.
|
1637
|
+
#
|
1638
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1639
|
+
#
|
1640
|
+
# @example Request syntax with placeholder values
|
1641
|
+
#
|
1642
|
+
# resp = client.delete_s3_access_policy({
|
1643
|
+
# s3_access_point_arn: "S3AccessPointArn", # required
|
1644
|
+
# })
|
1645
|
+
#
|
1646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteS3AccessPolicy AWS API Documentation
|
1647
|
+
#
|
1648
|
+
# @overload delete_s3_access_policy(params = {})
|
1649
|
+
# @param [Hash] params ({})
|
1650
|
+
def delete_s3_access_policy(params = {}, options = {})
|
1651
|
+
req = build_request(:delete_s3_access_policy, params)
|
1652
|
+
req.send_request(options)
|
1653
|
+
end
|
1654
|
+
|
1471
1655
|
# Deletes a sequence store.
|
1472
1656
|
#
|
1473
1657
|
# @option params [required, String] :id
|
@@ -2282,6 +2466,16 @@ module Aws::Omics
|
|
2282
2466
|
# If a workflow is shared with you, you cannot export information about
|
2283
2467
|
# the run.
|
2284
2468
|
#
|
2469
|
+
# HealthOmics stores a fixed number of runs that are available to the
|
2470
|
+
# console and API. If GetRun doesn't return the requested run, you can
|
2471
|
+
# find run logs for all runs in the CloudWatch logs. For more
|
2472
|
+
# information about viewing the run logs, see [CloudWatch logs][1] in
|
2473
|
+
# the *AWS HealthOmics User Guide*.
|
2474
|
+
#
|
2475
|
+
#
|
2476
|
+
#
|
2477
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/cloudwatch-logs.html
|
2478
|
+
#
|
2285
2479
|
# @option params [required, String] :id
|
2286
2480
|
# The run's ID.
|
2287
2481
|
#
|
@@ -2292,6 +2486,9 @@ module Aws::Omics
|
|
2292
2486
|
#
|
2293
2487
|
# * {Types::GetRunResponse#arn #arn} => String
|
2294
2488
|
# * {Types::GetRunResponse#id #id} => String
|
2489
|
+
# * {Types::GetRunResponse#cache_id #cache_id} => String
|
2490
|
+
# * {Types::GetRunResponse#cache_behavior #cache_behavior} => String
|
2491
|
+
# * {Types::GetRunResponse#engine_version #engine_version} => String
|
2295
2492
|
# * {Types::GetRunResponse#status #status} => String
|
2296
2493
|
# * {Types::GetRunResponse#workflow_id #workflow_id} => String
|
2297
2494
|
# * {Types::GetRunResponse#workflow_type #workflow_type} => String
|
@@ -2333,6 +2530,9 @@ module Aws::Omics
|
|
2333
2530
|
#
|
2334
2531
|
# resp.arn #=> String
|
2335
2532
|
# resp.id #=> String
|
2533
|
+
# resp.cache_id #=> String
|
2534
|
+
# resp.cache_behavior #=> String, one of "CACHE_ON_FAILURE", "CACHE_ALWAYS"
|
2535
|
+
# resp.engine_version #=> String
|
2336
2536
|
# resp.status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "DELETED", "CANCELLED", "FAILED"
|
2337
2537
|
# resp.workflow_id #=> String
|
2338
2538
|
# resp.workflow_type #=> String, one of "PRIVATE", "READY2RUN"
|
@@ -2380,6 +2580,60 @@ module Aws::Omics
|
|
2380
2580
|
req.send_request(options)
|
2381
2581
|
end
|
2382
2582
|
|
2583
|
+
# Retrieve the details for the specified run cache.
|
2584
|
+
#
|
2585
|
+
# For more information, see [Call caching for HealthOmics runs][1] in
|
2586
|
+
# the AWS HealthOmics User Guide.
|
2587
|
+
#
|
2588
|
+
#
|
2589
|
+
#
|
2590
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/workflow-call-caching.html
|
2591
|
+
#
|
2592
|
+
# @option params [required, String] :id
|
2593
|
+
# The identifier of the run cache to retrieve.
|
2594
|
+
#
|
2595
|
+
# @return [Types::GetRunCacheResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2596
|
+
#
|
2597
|
+
# * {Types::GetRunCacheResponse#arn #arn} => String
|
2598
|
+
# * {Types::GetRunCacheResponse#cache_behavior #cache_behavior} => String
|
2599
|
+
# * {Types::GetRunCacheResponse#cache_bucket_owner_id #cache_bucket_owner_id} => String
|
2600
|
+
# * {Types::GetRunCacheResponse#cache_s3_uri #cache_s3_uri} => String
|
2601
|
+
# * {Types::GetRunCacheResponse#creation_time #creation_time} => Time
|
2602
|
+
# * {Types::GetRunCacheResponse#description #description} => String
|
2603
|
+
# * {Types::GetRunCacheResponse#id #id} => String
|
2604
|
+
# * {Types::GetRunCacheResponse#name #name} => String
|
2605
|
+
# * {Types::GetRunCacheResponse#status #status} => String
|
2606
|
+
# * {Types::GetRunCacheResponse#tags #tags} => Hash<String,String>
|
2607
|
+
#
|
2608
|
+
# @example Request syntax with placeholder values
|
2609
|
+
#
|
2610
|
+
# resp = client.get_run_cache({
|
2611
|
+
# id: "RunCacheId", # required
|
2612
|
+
# })
|
2613
|
+
#
|
2614
|
+
# @example Response structure
|
2615
|
+
#
|
2616
|
+
# resp.arn #=> String
|
2617
|
+
# resp.cache_behavior #=> String, one of "CACHE_ON_FAILURE", "CACHE_ALWAYS"
|
2618
|
+
# resp.cache_bucket_owner_id #=> String
|
2619
|
+
# resp.cache_s3_uri #=> String
|
2620
|
+
# resp.creation_time #=> Time
|
2621
|
+
# resp.description #=> String
|
2622
|
+
# resp.id #=> String
|
2623
|
+
# resp.name #=> String
|
2624
|
+
# resp.status #=> String, one of "ACTIVE", "DELETED", "FAILED"
|
2625
|
+
# resp.tags #=> Hash
|
2626
|
+
# resp.tags["TagKey"] #=> String
|
2627
|
+
#
|
2628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetRunCache AWS API Documentation
|
2629
|
+
#
|
2630
|
+
# @overload get_run_cache(params = {})
|
2631
|
+
# @param [Hash] params ({})
|
2632
|
+
def get_run_cache(params = {}, options = {})
|
2633
|
+
req = build_request(:get_run_cache, params)
|
2634
|
+
req.send_request(options)
|
2635
|
+
end
|
2636
|
+
|
2383
2637
|
# Gets information about a workflow run group.
|
2384
2638
|
#
|
2385
2639
|
# @option params [required, String] :id
|
@@ -2439,6 +2693,8 @@ module Aws::Omics
|
|
2439
2693
|
# * {Types::GetRunTaskResponse#status #status} => String
|
2440
2694
|
# * {Types::GetRunTaskResponse#name #name} => String
|
2441
2695
|
# * {Types::GetRunTaskResponse#cpus #cpus} => Integer
|
2696
|
+
# * {Types::GetRunTaskResponse#cache_hit #cache_hit} => Boolean
|
2697
|
+
# * {Types::GetRunTaskResponse#cache_s3_uri #cache_s3_uri} => String
|
2442
2698
|
# * {Types::GetRunTaskResponse#memory #memory} => Integer
|
2443
2699
|
# * {Types::GetRunTaskResponse#creation_time #creation_time} => Time
|
2444
2700
|
# * {Types::GetRunTaskResponse#start_time #start_time} => Time
|
@@ -2462,6 +2718,8 @@ module Aws::Omics
|
|
2462
2718
|
# resp.status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "CANCELLED", "FAILED"
|
2463
2719
|
# resp.name #=> String
|
2464
2720
|
# resp.cpus #=> Integer
|
2721
|
+
# resp.cache_hit #=> Boolean
|
2722
|
+
# resp.cache_s3_uri #=> String
|
2465
2723
|
# resp.memory #=> Integer
|
2466
2724
|
# resp.creation_time #=> Time
|
2467
2725
|
# resp.start_time #=> Time
|
@@ -2487,6 +2745,42 @@ module Aws::Omics
|
|
2487
2745
|
req.send_request(options)
|
2488
2746
|
end
|
2489
2747
|
|
2748
|
+
# Retrieves details about an access policy on a given store.
|
2749
|
+
#
|
2750
|
+
# @option params [required, String] :s3_access_point_arn
|
2751
|
+
# The S3 access point ARN that has the access policy.
|
2752
|
+
#
|
2753
|
+
# @return [Types::GetS3AccessPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2754
|
+
#
|
2755
|
+
# * {Types::GetS3AccessPolicyResponse#s3_access_point_arn #s3_access_point_arn} => String
|
2756
|
+
# * {Types::GetS3AccessPolicyResponse#store_id #store_id} => String
|
2757
|
+
# * {Types::GetS3AccessPolicyResponse#store_type #store_type} => String
|
2758
|
+
# * {Types::GetS3AccessPolicyResponse#update_time #update_time} => Time
|
2759
|
+
# * {Types::GetS3AccessPolicyResponse#s3_access_policy #s3_access_policy} => String
|
2760
|
+
#
|
2761
|
+
# @example Request syntax with placeholder values
|
2762
|
+
#
|
2763
|
+
# resp = client.get_s3_access_policy({
|
2764
|
+
# s3_access_point_arn: "S3AccessPointArn", # required
|
2765
|
+
# })
|
2766
|
+
#
|
2767
|
+
# @example Response structure
|
2768
|
+
#
|
2769
|
+
# resp.s3_access_point_arn #=> String
|
2770
|
+
# resp.store_id #=> String
|
2771
|
+
# resp.store_type #=> String, one of "SEQUENCE_STORE", "REFERENCE_STORE"
|
2772
|
+
# resp.update_time #=> Time
|
2773
|
+
# resp.s3_access_policy #=> String
|
2774
|
+
#
|
2775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetS3AccessPolicy AWS API Documentation
|
2776
|
+
#
|
2777
|
+
# @overload get_s3_access_policy(params = {})
|
2778
|
+
# @param [Hash] params ({})
|
2779
|
+
def get_s3_access_policy(params = {}, options = {})
|
2780
|
+
req = build_request(:get_s3_access_policy, params)
|
2781
|
+
req.send_request(options)
|
2782
|
+
end
|
2783
|
+
|
2490
2784
|
# Gets information about a sequence store.
|
2491
2785
|
#
|
2492
2786
|
# @option params [required, String] :id
|
@@ -2503,6 +2797,10 @@ module Aws::Omics
|
|
2503
2797
|
# * {Types::GetSequenceStoreResponse#fallback_location #fallback_location} => String
|
2504
2798
|
# * {Types::GetSequenceStoreResponse#s3_access #s3_access} => Types::SequenceStoreS3Access
|
2505
2799
|
# * {Types::GetSequenceStoreResponse#e_tag_algorithm_family #e_tag_algorithm_family} => String
|
2800
|
+
# * {Types::GetSequenceStoreResponse#status #status} => String
|
2801
|
+
# * {Types::GetSequenceStoreResponse#status_message #status_message} => String
|
2802
|
+
# * {Types::GetSequenceStoreResponse#propagated_set_level_tags #propagated_set_level_tags} => Array<String>
|
2803
|
+
# * {Types::GetSequenceStoreResponse#update_time #update_time} => Time
|
2506
2804
|
#
|
2507
2805
|
# @example Request syntax with placeholder values
|
2508
2806
|
#
|
@@ -2522,7 +2820,13 @@ module Aws::Omics
|
|
2522
2820
|
# resp.fallback_location #=> String
|
2523
2821
|
# resp.s3_access.s3_uri #=> String
|
2524
2822
|
# resp.s3_access.s3_access_point_arn #=> String
|
2823
|
+
# resp.s3_access.access_log_location #=> String
|
2525
2824
|
# resp.e_tag_algorithm_family #=> String, one of "MD5up", "SHA256up", "SHA512up"
|
2825
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
2826
|
+
# resp.status_message #=> String
|
2827
|
+
# resp.propagated_set_level_tags #=> Array
|
2828
|
+
# resp.propagated_set_level_tags[0] #=> String
|
2829
|
+
# resp.update_time #=> Time
|
2526
2830
|
#
|
2527
2831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetSequenceStore AWS API Documentation
|
2528
2832
|
#
|
@@ -3473,6 +3777,50 @@ module Aws::Omics
|
|
3473
3777
|
req.send_request(options)
|
3474
3778
|
end
|
3475
3779
|
|
3780
|
+
# Retrieves a list of your run caches.
|
3781
|
+
#
|
3782
|
+
# @option params [Integer] :max_results
|
3783
|
+
# The maximum number of results to return.
|
3784
|
+
#
|
3785
|
+
# @option params [String] :starting_token
|
3786
|
+
# Optional pagination token returned from a prior call to the
|
3787
|
+
# `ListRunCaches` API operation.
|
3788
|
+
#
|
3789
|
+
# @return [Types::ListRunCachesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3790
|
+
#
|
3791
|
+
# * {Types::ListRunCachesResponse#items #items} => Array<Types::RunCacheListItem>
|
3792
|
+
# * {Types::ListRunCachesResponse#next_token #next_token} => String
|
3793
|
+
#
|
3794
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3795
|
+
#
|
3796
|
+
# @example Request syntax with placeholder values
|
3797
|
+
#
|
3798
|
+
# resp = client.list_run_caches({
|
3799
|
+
# max_results: 1,
|
3800
|
+
# starting_token: "ListToken",
|
3801
|
+
# })
|
3802
|
+
#
|
3803
|
+
# @example Response structure
|
3804
|
+
#
|
3805
|
+
# resp.items #=> Array
|
3806
|
+
# resp.items[0].arn #=> String
|
3807
|
+
# resp.items[0].cache_behavior #=> String, one of "CACHE_ON_FAILURE", "CACHE_ALWAYS"
|
3808
|
+
# resp.items[0].cache_s3_uri #=> String
|
3809
|
+
# resp.items[0].creation_time #=> Time
|
3810
|
+
# resp.items[0].id #=> String
|
3811
|
+
# resp.items[0].name #=> String
|
3812
|
+
# resp.items[0].status #=> String, one of "ACTIVE", "DELETED", "FAILED"
|
3813
|
+
# resp.next_token #=> String
|
3814
|
+
#
|
3815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRunCaches AWS API Documentation
|
3816
|
+
#
|
3817
|
+
# @overload list_run_caches(params = {})
|
3818
|
+
# @param [Hash] params ({})
|
3819
|
+
def list_run_caches(params = {}, options = {})
|
3820
|
+
req = build_request(:list_run_caches, params)
|
3821
|
+
req.send_request(options)
|
3822
|
+
end
|
3823
|
+
|
3476
3824
|
# Retrieves a list of run groups.
|
3477
3825
|
#
|
3478
3826
|
# @option params [String] :name
|
@@ -3560,6 +3908,8 @@ module Aws::Omics
|
|
3560
3908
|
# resp.items[0].status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "CANCELLED", "FAILED"
|
3561
3909
|
# resp.items[0].name #=> String
|
3562
3910
|
# resp.items[0].cpus #=> Integer
|
3911
|
+
# resp.items[0].cache_hit #=> Boolean
|
3912
|
+
# resp.items[0].cache_s3_uri #=> String
|
3563
3913
|
# resp.items[0].memory #=> Integer
|
3564
3914
|
# resp.items[0].creation_time #=> Time
|
3565
3915
|
# resp.items[0].start_time #=> Time
|
@@ -3579,6 +3929,16 @@ module Aws::Omics
|
|
3579
3929
|
|
3580
3930
|
# Retrieves a list of runs.
|
3581
3931
|
#
|
3932
|
+
# HealthOmics stores a fixed number of runs that are available to the
|
3933
|
+
# console and API. If the ListRuns response doesn't include specific
|
3934
|
+
# runs that you expected, you can find run logs for all runs in the
|
3935
|
+
# CloudWatch logs. For more information about viewing the run logs, see
|
3936
|
+
# [CloudWatch logs][1] in the *AWS HealthOmics User Guide*.
|
3937
|
+
#
|
3938
|
+
#
|
3939
|
+
#
|
3940
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/cloudwatch-logs.html
|
3941
|
+
#
|
3582
3942
|
# @option params [String] :name
|
3583
3943
|
# Filter the list by run name.
|
3584
3944
|
#
|
@@ -3665,6 +4025,9 @@ module Aws::Omics
|
|
3665
4025
|
# name: "SequenceStoreName",
|
3666
4026
|
# created_after: Time.now,
|
3667
4027
|
# created_before: Time.now,
|
4028
|
+
# status: "CREATING", # accepts CREATING, ACTIVE, UPDATING, DELETING, FAILED
|
4029
|
+
# updated_after: Time.now,
|
4030
|
+
# updated_before: Time.now,
|
3668
4031
|
# },
|
3669
4032
|
# })
|
3670
4033
|
#
|
@@ -3681,6 +4044,9 @@ module Aws::Omics
|
|
3681
4044
|
# resp.sequence_stores[0].creation_time #=> Time
|
3682
4045
|
# resp.sequence_stores[0].fallback_location #=> String
|
3683
4046
|
# resp.sequence_stores[0].e_tag_algorithm_family #=> String, one of "MD5up", "SHA256up", "SHA512up"
|
4047
|
+
# resp.sequence_stores[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
4048
|
+
# resp.sequence_stores[0].status_message #=> String
|
4049
|
+
# resp.sequence_stores[0].update_time #=> Time
|
3684
4050
|
#
|
3685
4051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListSequenceStores AWS API Documentation
|
3686
4052
|
#
|
@@ -3953,6 +4319,46 @@ module Aws::Omics
|
|
3953
4319
|
req.send_request(options)
|
3954
4320
|
end
|
3955
4321
|
|
4322
|
+
# Adds an access policy to the specified store.
|
4323
|
+
#
|
4324
|
+
# @option params [required, String] :s3_access_point_arn
|
4325
|
+
# The S3 access point ARN where you want to put the access policy.
|
4326
|
+
#
|
4327
|
+
# @option params [required, String] :s3_access_policy
|
4328
|
+
# The resource policy that controls S3 access to the store.
|
4329
|
+
#
|
4330
|
+
# **SDK automatically handles json encoding and base64 encoding for you
|
4331
|
+
# when the required value (Hash, Array, etc.) is provided according to
|
4332
|
+
# the description.**
|
4333
|
+
#
|
4334
|
+
# @return [Types::PutS3AccessPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4335
|
+
#
|
4336
|
+
# * {Types::PutS3AccessPolicyResponse#s3_access_point_arn #s3_access_point_arn} => String
|
4337
|
+
# * {Types::PutS3AccessPolicyResponse#store_id #store_id} => String
|
4338
|
+
# * {Types::PutS3AccessPolicyResponse#store_type #store_type} => String
|
4339
|
+
#
|
4340
|
+
# @example Request syntax with placeholder values
|
4341
|
+
#
|
4342
|
+
# resp = client.put_s3_access_policy({
|
4343
|
+
# s3_access_point_arn: "S3AccessPointArn", # required
|
4344
|
+
# s3_access_policy: "S3AccessPolicy", # required
|
4345
|
+
# })
|
4346
|
+
#
|
4347
|
+
# @example Response structure
|
4348
|
+
#
|
4349
|
+
# resp.s3_access_point_arn #=> String
|
4350
|
+
# resp.store_id #=> String
|
4351
|
+
# resp.store_type #=> String, one of "SEQUENCE_STORE", "REFERENCE_STORE"
|
4352
|
+
#
|
4353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/PutS3AccessPolicy AWS API Documentation
|
4354
|
+
#
|
4355
|
+
# @overload put_s3_access_policy(params = {})
|
4356
|
+
# @param [Hash] params ({})
|
4357
|
+
def put_s3_access_policy(params = {}, options = {})
|
4358
|
+
req = build_request(:put_s3_access_policy, params)
|
4359
|
+
req.send_request(options)
|
4360
|
+
end
|
4361
|
+
|
3956
4362
|
# Starts an annotation import job.
|
3957
4363
|
#
|
3958
4364
|
# @option params [required, String] :destination_name
|
@@ -4264,10 +4670,11 @@ module Aws::Omics
|
|
4264
4670
|
# StartRun will not support re-run for a workflow that is shared with
|
4265
4671
|
# you.
|
4266
4672
|
#
|
4267
|
-
#
|
4268
|
-
#
|
4269
|
-
#
|
4270
|
-
#
|
4673
|
+
# HealthOmics stores a fixed number of runs that are available to the
|
4674
|
+
# console and API. By default, HealthOmics doesn't any remove any runs.
|
4675
|
+
# If HealthOmics reaches the maximum number of runs, you must manually
|
4676
|
+
# remove runs. To have older runs removed automatically, set the
|
4677
|
+
# retention mode to `REMOVE`.
|
4271
4678
|
#
|
4272
4679
|
# By default, the run uses STATIC storage. For STATIC storage, set the
|
4273
4680
|
# `storageCapacity` field. You can set the storage type to DYNAMIC. You
|
@@ -4295,6 +4702,20 @@ module Aws::Omics
|
|
4295
4702
|
# @option params [String] :name
|
4296
4703
|
# A name for the run.
|
4297
4704
|
#
|
4705
|
+
# @option params [String] :cache_id
|
4706
|
+
# Identifier of the cache associated with this run. If you don't
|
4707
|
+
# specify a cache ID, no task outputs are cached for this run.
|
4708
|
+
#
|
4709
|
+
# @option params [String] :cache_behavior
|
4710
|
+
# The cache behavior for the run. You specify this value if you want to
|
4711
|
+
# override the default behavior for the cache. You had set the default
|
4712
|
+
# value when you created the cache. For more information, see [Run cache
|
4713
|
+
# behavior][1] in the AWS HealthOmics User Guide.
|
4714
|
+
#
|
4715
|
+
#
|
4716
|
+
#
|
4717
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior
|
4718
|
+
#
|
4298
4719
|
# @option params [String] :run_group_id
|
4299
4720
|
# The run's group ID.
|
4300
4721
|
#
|
@@ -4331,7 +4752,22 @@ module Aws::Omics
|
|
4331
4752
|
# not need to pass this option.**
|
4332
4753
|
#
|
4333
4754
|
# @option params [String] :retention_mode
|
4334
|
-
# The retention mode for the run.
|
4755
|
+
# The retention mode for the run. The default value is RETAIN.
|
4756
|
+
#
|
4757
|
+
# HealthOmics stores a fixed number of runs that are available to the
|
4758
|
+
# console and API. In the default mode (RETAIN), you need to remove runs
|
4759
|
+
# manually when the number of run exceeds the maximum. If you set the
|
4760
|
+
# retention mode to `REMOVE`, HealthOmics automatically removes runs
|
4761
|
+
# (that have mode set to REMOVE) when the number of run exceeds the
|
4762
|
+
# maximum. All run logs are available in CloudWatch logs, if you need
|
4763
|
+
# information about a run that is no longer available to the API.
|
4764
|
+
#
|
4765
|
+
# For more information about retention mode, see [Specifying run
|
4766
|
+
# retention mode][1] in the *AWS HealthOmics User Guide*.
|
4767
|
+
#
|
4768
|
+
#
|
4769
|
+
#
|
4770
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html
|
4335
4771
|
#
|
4336
4772
|
# @option params [String] :storage_type
|
4337
4773
|
# The run's storage type. By default, the run uses STATIC storage type,
|
@@ -4359,6 +4795,8 @@ module Aws::Omics
|
|
4359
4795
|
# run_id: "RunId",
|
4360
4796
|
# role_arn: "RunRoleArn", # required
|
4361
4797
|
# name: "RunName",
|
4798
|
+
# cache_id: "NumericIdInArn",
|
4799
|
+
# cache_behavior: "CACHE_ON_FAILURE", # accepts CACHE_ON_FAILURE, CACHE_ALWAYS
|
4362
4800
|
# run_group_id: "RunGroupId",
|
4363
4801
|
# priority: 1,
|
4364
4802
|
# parameters: {
|
@@ -4601,6 +5039,40 @@ module Aws::Omics
|
|
4601
5039
|
req.send_request(options)
|
4602
5040
|
end
|
4603
5041
|
|
5042
|
+
# Update a run cache.
|
5043
|
+
#
|
5044
|
+
# @option params [String] :cache_behavior
|
5045
|
+
# Update the default run cache behavior.
|
5046
|
+
#
|
5047
|
+
# @option params [String] :description
|
5048
|
+
# Update the run cache description.
|
5049
|
+
#
|
5050
|
+
# @option params [required, String] :id
|
5051
|
+
# The identifier of the run cache you want to update.
|
5052
|
+
#
|
5053
|
+
# @option params [String] :name
|
5054
|
+
# Update the name of the run cache.
|
5055
|
+
#
|
5056
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5057
|
+
#
|
5058
|
+
# @example Request syntax with placeholder values
|
5059
|
+
#
|
5060
|
+
# resp = client.update_run_cache({
|
5061
|
+
# cache_behavior: "CACHE_ON_FAILURE", # accepts CACHE_ON_FAILURE, CACHE_ALWAYS
|
5062
|
+
# description: "UserCustomDescription",
|
5063
|
+
# id: "RunCacheId", # required
|
5064
|
+
# name: "UserCustomName",
|
5065
|
+
# })
|
5066
|
+
#
|
5067
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateRunCache AWS API Documentation
|
5068
|
+
#
|
5069
|
+
# @overload update_run_cache(params = {})
|
5070
|
+
# @param [Hash] params ({})
|
5071
|
+
def update_run_cache(params = {}, options = {})
|
5072
|
+
req = build_request(:update_run_cache, params)
|
5073
|
+
req.send_request(options)
|
5074
|
+
end
|
5075
|
+
|
4604
5076
|
# Updates a run group.
|
4605
5077
|
#
|
4606
5078
|
# @option params [required, String] :id
|
@@ -4643,6 +5115,94 @@ module Aws::Omics
|
|
4643
5115
|
req.send_request(options)
|
4644
5116
|
end
|
4645
5117
|
|
5118
|
+
# Update one or more parameters for the sequence store.
|
5119
|
+
#
|
5120
|
+
# @option params [required, String] :id
|
5121
|
+
# The ID of the sequence store.
|
5122
|
+
#
|
5123
|
+
# @option params [String] :name
|
5124
|
+
# A name for the sequence store.
|
5125
|
+
#
|
5126
|
+
# @option params [String] :description
|
5127
|
+
# A description for the sequence store.
|
5128
|
+
#
|
5129
|
+
# @option params [String] :client_token
|
5130
|
+
# To ensure that requests don't run multiple times, specify a unique
|
5131
|
+
# token for each request.
|
5132
|
+
#
|
5133
|
+
# **A suitable default value is auto-generated.** You should normally
|
5134
|
+
# not need to pass this option.**
|
5135
|
+
#
|
5136
|
+
# @option params [String] :fallback_location
|
5137
|
+
# The S3 URI of a bucket and folder to store Read Sets that fail to
|
5138
|
+
# upload.
|
5139
|
+
#
|
5140
|
+
# @option params [Array<String>] :propagated_set_level_tags
|
5141
|
+
# The tags keys to propagate to the S3 objects associated with read sets
|
5142
|
+
# in the sequence store.
|
5143
|
+
#
|
5144
|
+
# @option params [Types::S3AccessConfig] :s3_access_config
|
5145
|
+
# S3 access configuration parameters.
|
5146
|
+
#
|
5147
|
+
# @return [Types::UpdateSequenceStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5148
|
+
#
|
5149
|
+
# * {Types::UpdateSequenceStoreResponse#id #id} => String
|
5150
|
+
# * {Types::UpdateSequenceStoreResponse#arn #arn} => String
|
5151
|
+
# * {Types::UpdateSequenceStoreResponse#name #name} => String
|
5152
|
+
# * {Types::UpdateSequenceStoreResponse#description #description} => String
|
5153
|
+
# * {Types::UpdateSequenceStoreResponse#sse_config #sse_config} => Types::SseConfig
|
5154
|
+
# * {Types::UpdateSequenceStoreResponse#creation_time #creation_time} => Time
|
5155
|
+
# * {Types::UpdateSequenceStoreResponse#update_time #update_time} => Time
|
5156
|
+
# * {Types::UpdateSequenceStoreResponse#propagated_set_level_tags #propagated_set_level_tags} => Array<String>
|
5157
|
+
# * {Types::UpdateSequenceStoreResponse#status #status} => String
|
5158
|
+
# * {Types::UpdateSequenceStoreResponse#status_message #status_message} => String
|
5159
|
+
# * {Types::UpdateSequenceStoreResponse#fallback_location #fallback_location} => String
|
5160
|
+
# * {Types::UpdateSequenceStoreResponse#s3_access #s3_access} => Types::SequenceStoreS3Access
|
5161
|
+
# * {Types::UpdateSequenceStoreResponse#e_tag_algorithm_family #e_tag_algorithm_family} => String
|
5162
|
+
#
|
5163
|
+
# @example Request syntax with placeholder values
|
5164
|
+
#
|
5165
|
+
# resp = client.update_sequence_store({
|
5166
|
+
# id: "SequenceStoreId", # required
|
5167
|
+
# name: "SequenceStoreName",
|
5168
|
+
# description: "SequenceStoreDescription",
|
5169
|
+
# client_token: "ClientToken",
|
5170
|
+
# fallback_location: "S3Destination",
|
5171
|
+
# propagated_set_level_tags: ["TagKey"],
|
5172
|
+
# s3_access_config: {
|
5173
|
+
# access_log_location: "AccessLogLocation",
|
5174
|
+
# },
|
5175
|
+
# })
|
5176
|
+
#
|
5177
|
+
# @example Response structure
|
5178
|
+
#
|
5179
|
+
# resp.id #=> String
|
5180
|
+
# resp.arn #=> String
|
5181
|
+
# resp.name #=> String
|
5182
|
+
# resp.description #=> String
|
5183
|
+
# resp.sse_config.type #=> String, one of "KMS"
|
5184
|
+
# resp.sse_config.key_arn #=> String
|
5185
|
+
# resp.creation_time #=> Time
|
5186
|
+
# resp.update_time #=> Time
|
5187
|
+
# resp.propagated_set_level_tags #=> Array
|
5188
|
+
# resp.propagated_set_level_tags[0] #=> String
|
5189
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
5190
|
+
# resp.status_message #=> String
|
5191
|
+
# resp.fallback_location #=> String
|
5192
|
+
# resp.s3_access.s3_uri #=> String
|
5193
|
+
# resp.s3_access.s3_access_point_arn #=> String
|
5194
|
+
# resp.s3_access.access_log_location #=> String
|
5195
|
+
# resp.e_tag_algorithm_family #=> String, one of "MD5up", "SHA256up", "SHA512up"
|
5196
|
+
#
|
5197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateSequenceStore AWS API Documentation
|
5198
|
+
#
|
5199
|
+
# @overload update_sequence_store(params = {})
|
5200
|
+
# @param [Hash] params ({})
|
5201
|
+
def update_sequence_store(params = {}, options = {})
|
5202
|
+
req = build_request(:update_sequence_store, params)
|
5203
|
+
req.send_request(options)
|
5204
|
+
end
|
5205
|
+
|
4646
5206
|
# Updates a variant store.
|
4647
5207
|
#
|
4648
5208
|
# @option params [required, String] :name
|
@@ -4781,7 +5341,7 @@ module Aws::Omics
|
|
4781
5341
|
tracer: tracer
|
4782
5342
|
)
|
4783
5343
|
context[:gem_name] = 'aws-sdk-omics'
|
4784
|
-
context[:gem_version] = '1.
|
5344
|
+
context[:gem_version] = '1.41.0'
|
4785
5345
|
Seahorse::Client::Request.new(handlers, context)
|
4786
5346
|
end
|
4787
5347
|
|