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/types.rb
CHANGED
@@ -893,6 +893,106 @@ module Aws::Omics
|
|
893
893
|
include Aws::Structure
|
894
894
|
end
|
895
895
|
|
896
|
+
# @!attribute [rw] cache_behavior
|
897
|
+
# Default cache behavior for runs that use this cache. Supported
|
898
|
+
# values are:
|
899
|
+
#
|
900
|
+
# `CACHE_ON_FAILURE`: Caches task outputs from completed tasks for
|
901
|
+
# runs that fail. This setting is useful if you're debugging a
|
902
|
+
# workflow that fails after several tasks completed successfully. The
|
903
|
+
# subsequent run uses the cache outputs for previously-completed tasks
|
904
|
+
# if the task definition, inputs, and container in ECR are identical
|
905
|
+
# to the prior run.
|
906
|
+
#
|
907
|
+
# `CACHE_ALWAYS`: Caches task outputs from completed tasks for all
|
908
|
+
# runs. This setting is useful in development mode, but do not use it
|
909
|
+
# in a production setting.
|
910
|
+
#
|
911
|
+
# If you don't specify a value, the default behavior is
|
912
|
+
# CACHE\_ON\_FAILURE. When you start a run that uses this cache, you
|
913
|
+
# can override the default cache behavior.
|
914
|
+
#
|
915
|
+
# For more information, see [Run cache behavior][1] in the AWS
|
916
|
+
# HealthOmics User Guide.
|
917
|
+
#
|
918
|
+
#
|
919
|
+
#
|
920
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior
|
921
|
+
# @return [String]
|
922
|
+
#
|
923
|
+
# @!attribute [rw] cache_s3_location
|
924
|
+
# Specify the S3 location for storing the cached task outputs. This
|
925
|
+
# data must be immediately accessible (not in an archived state).
|
926
|
+
# @return [String]
|
927
|
+
#
|
928
|
+
# @!attribute [rw] description
|
929
|
+
# Enter a description of the run cache.
|
930
|
+
# @return [String]
|
931
|
+
#
|
932
|
+
# @!attribute [rw] name
|
933
|
+
# Enter a user-friendly name for the run cache.
|
934
|
+
# @return [String]
|
935
|
+
#
|
936
|
+
# @!attribute [rw] request_id
|
937
|
+
# A unique request token, to ensure idempotency. If you don't specify
|
938
|
+
# a token, HealthOmics automatically generates a universally unique
|
939
|
+
# identifier (UUID) for the request.
|
940
|
+
#
|
941
|
+
# **A suitable default value is auto-generated.** You should normally
|
942
|
+
# not need to pass this option.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] tags
|
946
|
+
# Specify one or more tags to associate with this run cache.
|
947
|
+
# @return [Hash<String,String>]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] cache_bucket_owner_id
|
950
|
+
# The AWS account ID of the expected owner of the S3 bucket for the
|
951
|
+
# run cache. If not provided, your account ID is set as the owner of
|
952
|
+
# the bucket.
|
953
|
+
# @return [String]
|
954
|
+
#
|
955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateRunCacheRequest AWS API Documentation
|
956
|
+
#
|
957
|
+
class CreateRunCacheRequest < Struct.new(
|
958
|
+
:cache_behavior,
|
959
|
+
:cache_s3_location,
|
960
|
+
:description,
|
961
|
+
:name,
|
962
|
+
:request_id,
|
963
|
+
:tags,
|
964
|
+
:cache_bucket_owner_id)
|
965
|
+
SENSITIVE = []
|
966
|
+
include Aws::Structure
|
967
|
+
end
|
968
|
+
|
969
|
+
# @!attribute [rw] arn
|
970
|
+
# Unique resource identifier for the run cache.
|
971
|
+
# @return [String]
|
972
|
+
#
|
973
|
+
# @!attribute [rw] id
|
974
|
+
# Identifier for the run cache.
|
975
|
+
# @return [String]
|
976
|
+
#
|
977
|
+
# @!attribute [rw] status
|
978
|
+
# Run cache status.
|
979
|
+
# @return [String]
|
980
|
+
#
|
981
|
+
# @!attribute [rw] tags
|
982
|
+
# The tags associated with this run cache.
|
983
|
+
# @return [Hash<String,String>]
|
984
|
+
#
|
985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateRunCacheResponse AWS API Documentation
|
986
|
+
#
|
987
|
+
class CreateRunCacheResponse < Struct.new(
|
988
|
+
:arn,
|
989
|
+
:id,
|
990
|
+
:status,
|
991
|
+
:tags)
|
992
|
+
SENSITIVE = []
|
993
|
+
include Aws::Structure
|
994
|
+
end
|
995
|
+
|
896
996
|
# @!attribute [rw] name
|
897
997
|
# A name for the group.
|
898
998
|
# @return [String]
|
@@ -983,6 +1083,9 @@ module Aws::Omics
|
|
983
1083
|
# @!attribute [rw] client_token
|
984
1084
|
# To ensure that requests don't run multiple times, specify a unique
|
985
1085
|
# token for each request.
|
1086
|
+
#
|
1087
|
+
# **A suitable default value is auto-generated.** You should normally
|
1088
|
+
# not need to pass this option.
|
986
1089
|
# @return [String]
|
987
1090
|
#
|
988
1091
|
# @!attribute [rw] fallback_location
|
@@ -994,6 +1097,15 @@ module Aws::Omics
|
|
994
1097
|
# The ETag algorithm family to use for ingested read sets.
|
995
1098
|
# @return [String]
|
996
1099
|
#
|
1100
|
+
# @!attribute [rw] propagated_set_level_tags
|
1101
|
+
# The tags keys to propagate to the S3 objects associated with read
|
1102
|
+
# sets in the sequence store.
|
1103
|
+
# @return [Array<String>]
|
1104
|
+
#
|
1105
|
+
# @!attribute [rw] s3_access_config
|
1106
|
+
# S3 access configuration parameters
|
1107
|
+
# @return [Types::S3AccessConfig]
|
1108
|
+
#
|
997
1109
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateSequenceStoreRequest AWS API Documentation
|
998
1110
|
#
|
999
1111
|
class CreateSequenceStoreRequest < Struct.new(
|
@@ -1003,7 +1115,9 @@ module Aws::Omics
|
|
1003
1115
|
:tags,
|
1004
1116
|
:client_token,
|
1005
1117
|
:fallback_location,
|
1006
|
-
:e_tag_algorithm_family
|
1118
|
+
:e_tag_algorithm_family,
|
1119
|
+
:propagated_set_level_tags,
|
1120
|
+
:s3_access_config)
|
1007
1121
|
SENSITIVE = []
|
1008
1122
|
include Aws::Structure
|
1009
1123
|
end
|
@@ -1041,6 +1155,23 @@ module Aws::Omics
|
|
1041
1155
|
# The algorithm family of the ETag.
|
1042
1156
|
# @return [String]
|
1043
1157
|
#
|
1158
|
+
# @!attribute [rw] status
|
1159
|
+
# The status of the sequence store.
|
1160
|
+
# @return [String]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] status_message
|
1163
|
+
# The status message of the sequence store.
|
1164
|
+
# @return [String]
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] propagated_set_level_tags
|
1167
|
+
# The tags keys to propagate to the S3 objects associated with read
|
1168
|
+
# sets in the sequence store.
|
1169
|
+
# @return [Array<String>]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] s3_access
|
1172
|
+
# The S3 access metadata of the sequence store.
|
1173
|
+
# @return [Types::SequenceStoreS3Access]
|
1174
|
+
#
|
1044
1175
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateSequenceStoreResponse AWS API Documentation
|
1045
1176
|
#
|
1046
1177
|
class CreateSequenceStoreResponse < Struct.new(
|
@@ -1051,7 +1182,11 @@ module Aws::Omics
|
|
1051
1182
|
:sse_config,
|
1052
1183
|
:creation_time,
|
1053
1184
|
:fallback_location,
|
1054
|
-
:e_tag_algorithm_family
|
1185
|
+
:e_tag_algorithm_family,
|
1186
|
+
:status,
|
1187
|
+
:status_message,
|
1188
|
+
:propagated_set_level_tags,
|
1189
|
+
:s3_access)
|
1055
1190
|
SENSITIVE = []
|
1056
1191
|
include Aws::Structure
|
1057
1192
|
end
|
@@ -1361,6 +1496,18 @@ module Aws::Omics
|
|
1361
1496
|
#
|
1362
1497
|
class DeleteReferenceStoreResponse < Aws::EmptyStructure; end
|
1363
1498
|
|
1499
|
+
# @!attribute [rw] id
|
1500
|
+
# Run cache identifier for the cache you want to delete.
|
1501
|
+
# @return [String]
|
1502
|
+
#
|
1503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteRunCacheRequest AWS API Documentation
|
1504
|
+
#
|
1505
|
+
class DeleteRunCacheRequest < Struct.new(
|
1506
|
+
:id)
|
1507
|
+
SENSITIVE = []
|
1508
|
+
include Aws::Structure
|
1509
|
+
end
|
1510
|
+
|
1364
1511
|
# @!attribute [rw] id
|
1365
1512
|
# The run group's ID.
|
1366
1513
|
# @return [String]
|
@@ -1385,6 +1532,22 @@ module Aws::Omics
|
|
1385
1532
|
include Aws::Structure
|
1386
1533
|
end
|
1387
1534
|
|
1535
|
+
# @!attribute [rw] s3_access_point_arn
|
1536
|
+
# The S3 access point ARN that has the access policy.
|
1537
|
+
# @return [String]
|
1538
|
+
#
|
1539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteS3AccessPolicyRequest AWS API Documentation
|
1540
|
+
#
|
1541
|
+
class DeleteS3AccessPolicyRequest < Struct.new(
|
1542
|
+
:s3_access_point_arn)
|
1543
|
+
SENSITIVE = []
|
1544
|
+
include Aws::Structure
|
1545
|
+
end
|
1546
|
+
|
1547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteS3AccessPolicyResponse AWS API Documentation
|
1548
|
+
#
|
1549
|
+
class DeleteS3AccessPolicyResponse < Aws::EmptyStructure; end
|
1550
|
+
|
1388
1551
|
# @!attribute [rw] id
|
1389
1552
|
# The sequence store's ID.
|
1390
1553
|
# @return [String]
|
@@ -2527,6 +2690,75 @@ module Aws::Omics
|
|
2527
2690
|
include Aws::Structure
|
2528
2691
|
end
|
2529
2692
|
|
2693
|
+
# @!attribute [rw] id
|
2694
|
+
# The identifier of the run cache to retrieve.
|
2695
|
+
# @return [String]
|
2696
|
+
#
|
2697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetRunCacheRequest AWS API Documentation
|
2698
|
+
#
|
2699
|
+
class GetRunCacheRequest < Struct.new(
|
2700
|
+
:id)
|
2701
|
+
SENSITIVE = []
|
2702
|
+
include Aws::Structure
|
2703
|
+
end
|
2704
|
+
|
2705
|
+
# @!attribute [rw] arn
|
2706
|
+
# Unique resource identifier for the run cache.
|
2707
|
+
# @return [String]
|
2708
|
+
#
|
2709
|
+
# @!attribute [rw] cache_behavior
|
2710
|
+
# The default cache behavior for runs using this cache.
|
2711
|
+
# @return [String]
|
2712
|
+
#
|
2713
|
+
# @!attribute [rw] cache_bucket_owner_id
|
2714
|
+
# The identifier of the bucket owner.
|
2715
|
+
# @return [String]
|
2716
|
+
#
|
2717
|
+
# @!attribute [rw] cache_s3_uri
|
2718
|
+
# The S3 URI where the cache data is stored.
|
2719
|
+
# @return [String]
|
2720
|
+
#
|
2721
|
+
# @!attribute [rw] creation_time
|
2722
|
+
# Creation time of the run cache (an ISO 8601 formatted string).
|
2723
|
+
# @return [Time]
|
2724
|
+
#
|
2725
|
+
# @!attribute [rw] description
|
2726
|
+
# The run cache description.
|
2727
|
+
# @return [String]
|
2728
|
+
#
|
2729
|
+
# @!attribute [rw] id
|
2730
|
+
# The run cache ID.
|
2731
|
+
# @return [String]
|
2732
|
+
#
|
2733
|
+
# @!attribute [rw] name
|
2734
|
+
# The run cache name.
|
2735
|
+
# @return [String]
|
2736
|
+
#
|
2737
|
+
# @!attribute [rw] status
|
2738
|
+
# The run cache status.
|
2739
|
+
# @return [String]
|
2740
|
+
#
|
2741
|
+
# @!attribute [rw] tags
|
2742
|
+
# The tags associated with the run cache.
|
2743
|
+
# @return [Hash<String,String>]
|
2744
|
+
#
|
2745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetRunCacheResponse AWS API Documentation
|
2746
|
+
#
|
2747
|
+
class GetRunCacheResponse < Struct.new(
|
2748
|
+
:arn,
|
2749
|
+
:cache_behavior,
|
2750
|
+
:cache_bucket_owner_id,
|
2751
|
+
:cache_s3_uri,
|
2752
|
+
:creation_time,
|
2753
|
+
:description,
|
2754
|
+
:id,
|
2755
|
+
:name,
|
2756
|
+
:status,
|
2757
|
+
:tags)
|
2758
|
+
SENSITIVE = []
|
2759
|
+
include Aws::Structure
|
2760
|
+
end
|
2761
|
+
|
2530
2762
|
# @!attribute [rw] id
|
2531
2763
|
# The group's ID.
|
2532
2764
|
# @return [String]
|
@@ -2616,6 +2848,18 @@ module Aws::Omics
|
|
2616
2848
|
# The run's ID.
|
2617
2849
|
# @return [String]
|
2618
2850
|
#
|
2851
|
+
# @!attribute [rw] cache_id
|
2852
|
+
# The run cache associated with the run.
|
2853
|
+
# @return [String]
|
2854
|
+
#
|
2855
|
+
# @!attribute [rw] cache_behavior
|
2856
|
+
# The run cache behavior for the run.
|
2857
|
+
# @return [String]
|
2858
|
+
#
|
2859
|
+
# @!attribute [rw] engine_version
|
2860
|
+
# The workflow engine version.
|
2861
|
+
# @return [String]
|
2862
|
+
#
|
2619
2863
|
# @!attribute [rw] status
|
2620
2864
|
# The run's status.
|
2621
2865
|
# @return [String]
|
@@ -2739,6 +2983,9 @@ module Aws::Omics
|
|
2739
2983
|
class GetRunResponse < Struct.new(
|
2740
2984
|
:arn,
|
2741
2985
|
:id,
|
2986
|
+
:cache_id,
|
2987
|
+
:cache_behavior,
|
2988
|
+
:engine_version,
|
2742
2989
|
:status,
|
2743
2990
|
:workflow_id,
|
2744
2991
|
:workflow_type,
|
@@ -2805,6 +3052,15 @@ module Aws::Omics
|
|
2805
3052
|
# The task's CPU usage.
|
2806
3053
|
# @return [Integer]
|
2807
3054
|
#
|
3055
|
+
# @!attribute [rw] cache_hit
|
3056
|
+
# Set to true if AWS HealthOmics found a matching entry in the run
|
3057
|
+
# cache for this task.
|
3058
|
+
# @return [Boolean]
|
3059
|
+
#
|
3060
|
+
# @!attribute [rw] cache_s3_uri
|
3061
|
+
# The S3 URI of the cache location.
|
3062
|
+
# @return [String]
|
3063
|
+
#
|
2808
3064
|
# @!attribute [rw] memory
|
2809
3065
|
# The task's memory use in gigabytes.
|
2810
3066
|
# @return [Integer]
|
@@ -2848,6 +3104,8 @@ module Aws::Omics
|
|
2848
3104
|
:status,
|
2849
3105
|
:name,
|
2850
3106
|
:cpus,
|
3107
|
+
:cache_hit,
|
3108
|
+
:cache_s3_uri,
|
2851
3109
|
:memory,
|
2852
3110
|
:creation_time,
|
2853
3111
|
:start_time,
|
@@ -2861,6 +3119,50 @@ module Aws::Omics
|
|
2861
3119
|
include Aws::Structure
|
2862
3120
|
end
|
2863
3121
|
|
3122
|
+
# @!attribute [rw] s3_access_point_arn
|
3123
|
+
# The S3 access point ARN that has the access policy.
|
3124
|
+
# @return [String]
|
3125
|
+
#
|
3126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetS3AccessPolicyRequest AWS API Documentation
|
3127
|
+
#
|
3128
|
+
class GetS3AccessPolicyRequest < Struct.new(
|
3129
|
+
:s3_access_point_arn)
|
3130
|
+
SENSITIVE = []
|
3131
|
+
include Aws::Structure
|
3132
|
+
end
|
3133
|
+
|
3134
|
+
# @!attribute [rw] s3_access_point_arn
|
3135
|
+
# The S3 access point ARN that has the access policy.
|
3136
|
+
# @return [String]
|
3137
|
+
#
|
3138
|
+
# @!attribute [rw] store_id
|
3139
|
+
# The AWS-generated Sequence Store or Reference Store ID.
|
3140
|
+
# @return [String]
|
3141
|
+
#
|
3142
|
+
# @!attribute [rw] store_type
|
3143
|
+
# The type of store associated with the access point.
|
3144
|
+
# @return [String]
|
3145
|
+
#
|
3146
|
+
# @!attribute [rw] update_time
|
3147
|
+
# The time when the policy was last updated.
|
3148
|
+
# @return [Time]
|
3149
|
+
#
|
3150
|
+
# @!attribute [rw] s3_access_policy
|
3151
|
+
# The current resource policy that controls S3 access on the store.
|
3152
|
+
# @return [String]
|
3153
|
+
#
|
3154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetS3AccessPolicyResponse AWS API Documentation
|
3155
|
+
#
|
3156
|
+
class GetS3AccessPolicyResponse < Struct.new(
|
3157
|
+
:s3_access_point_arn,
|
3158
|
+
:store_id,
|
3159
|
+
:store_type,
|
3160
|
+
:update_time,
|
3161
|
+
:s3_access_policy)
|
3162
|
+
SENSITIVE = []
|
3163
|
+
include Aws::Structure
|
3164
|
+
end
|
3165
|
+
|
2864
3166
|
# @!attribute [rw] id
|
2865
3167
|
# The store's ID.
|
2866
3168
|
# @return [String]
|
@@ -2911,6 +3213,23 @@ module Aws::Omics
|
|
2911
3213
|
# The algorithm family of the ETag.
|
2912
3214
|
# @return [String]
|
2913
3215
|
#
|
3216
|
+
# @!attribute [rw] status
|
3217
|
+
# The status of the sequence store.
|
3218
|
+
# @return [String]
|
3219
|
+
#
|
3220
|
+
# @!attribute [rw] status_message
|
3221
|
+
# The status message of the sequence store.
|
3222
|
+
# @return [String]
|
3223
|
+
#
|
3224
|
+
# @!attribute [rw] propagated_set_level_tags
|
3225
|
+
# The tags keys to propagate to the S3 objects associated with read
|
3226
|
+
# sets in the sequence store.
|
3227
|
+
# @return [Array<String>]
|
3228
|
+
#
|
3229
|
+
# @!attribute [rw] update_time
|
3230
|
+
# The last-updated time of the sequence store.
|
3231
|
+
# @return [Time]
|
3232
|
+
#
|
2914
3233
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetSequenceStoreResponse AWS API Documentation
|
2915
3234
|
#
|
2916
3235
|
class GetSequenceStoreResponse < Struct.new(
|
@@ -2922,7 +3241,11 @@ module Aws::Omics
|
|
2922
3241
|
:creation_time,
|
2923
3242
|
:fallback_location,
|
2924
3243
|
:s3_access,
|
2925
|
-
:e_tag_algorithm_family
|
3244
|
+
:e_tag_algorithm_family,
|
3245
|
+
:status,
|
3246
|
+
:status_message,
|
3247
|
+
:propagated_set_level_tags,
|
3248
|
+
:update_time)
|
2926
3249
|
SENSITIVE = []
|
2927
3250
|
include Aws::Structure
|
2928
3251
|
end
|
@@ -4074,6 +4397,43 @@ module Aws::Omics
|
|
4074
4397
|
include Aws::Structure
|
4075
4398
|
end
|
4076
4399
|
|
4400
|
+
# @!attribute [rw] max_results
|
4401
|
+
# The maximum number of results to return.
|
4402
|
+
# @return [Integer]
|
4403
|
+
#
|
4404
|
+
# @!attribute [rw] starting_token
|
4405
|
+
# Optional pagination token returned from a prior call to the
|
4406
|
+
# `ListRunCaches` API operation.
|
4407
|
+
# @return [String]
|
4408
|
+
#
|
4409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRunCachesRequest AWS API Documentation
|
4410
|
+
#
|
4411
|
+
class ListRunCachesRequest < Struct.new(
|
4412
|
+
:max_results,
|
4413
|
+
:starting_token)
|
4414
|
+
SENSITIVE = []
|
4415
|
+
include Aws::Structure
|
4416
|
+
end
|
4417
|
+
|
4418
|
+
# @!attribute [rw] items
|
4419
|
+
# Details about each run cache in the response.
|
4420
|
+
# @return [Array<Types::RunCacheListItem>]
|
4421
|
+
#
|
4422
|
+
# @!attribute [rw] next_token
|
4423
|
+
# Pagination token to retrieve additional run caches. If the response
|
4424
|
+
# does not have a `nextToken`value, you have reached to the end of the
|
4425
|
+
# list.
|
4426
|
+
# @return [String]
|
4427
|
+
#
|
4428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRunCachesResponse AWS API Documentation
|
4429
|
+
#
|
4430
|
+
class ListRunCachesResponse < Struct.new(
|
4431
|
+
:items,
|
4432
|
+
:next_token)
|
4433
|
+
SENSITIVE = []
|
4434
|
+
include Aws::Structure
|
4435
|
+
end
|
4436
|
+
|
4077
4437
|
# @!attribute [rw] name
|
4078
4438
|
# The run groups' name.
|
4079
4439
|
# @return [String]
|
@@ -4568,6 +4928,45 @@ module Aws::Omics
|
|
4568
4928
|
include Aws::Structure
|
4569
4929
|
end
|
4570
4930
|
|
4931
|
+
# @!attribute [rw] s3_access_point_arn
|
4932
|
+
# The S3 access point ARN where you want to put the access policy.
|
4933
|
+
# @return [String]
|
4934
|
+
#
|
4935
|
+
# @!attribute [rw] s3_access_policy
|
4936
|
+
# The resource policy that controls S3 access to the store.
|
4937
|
+
# @return [String]
|
4938
|
+
#
|
4939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/PutS3AccessPolicyRequest AWS API Documentation
|
4940
|
+
#
|
4941
|
+
class PutS3AccessPolicyRequest < Struct.new(
|
4942
|
+
:s3_access_point_arn,
|
4943
|
+
:s3_access_policy)
|
4944
|
+
SENSITIVE = []
|
4945
|
+
include Aws::Structure
|
4946
|
+
end
|
4947
|
+
|
4948
|
+
# @!attribute [rw] s3_access_point_arn
|
4949
|
+
# The S3 access point ARN that now has the access policy.
|
4950
|
+
# @return [String]
|
4951
|
+
#
|
4952
|
+
# @!attribute [rw] store_id
|
4953
|
+
# The AWS-generated Sequence Store or Reference Store ID.
|
4954
|
+
# @return [String]
|
4955
|
+
#
|
4956
|
+
# @!attribute [rw] store_type
|
4957
|
+
# The type of store associated with the access point.
|
4958
|
+
# @return [String]
|
4959
|
+
#
|
4960
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/PutS3AccessPolicyResponse AWS API Documentation
|
4961
|
+
#
|
4962
|
+
class PutS3AccessPolicyResponse < Struct.new(
|
4963
|
+
:s3_access_point_arn,
|
4964
|
+
:store_id,
|
4965
|
+
:store_type)
|
4966
|
+
SENSITIVE = []
|
4967
|
+
include Aws::Structure
|
4968
|
+
end
|
4969
|
+
|
4571
4970
|
# The ranges specified in the request are not valid.
|
4572
4971
|
#
|
4573
4972
|
# @!attribute [rw] message
|
@@ -5113,6 +5512,51 @@ module Aws::Omics
|
|
5113
5512
|
include Aws::Structure
|
5114
5513
|
end
|
5115
5514
|
|
5515
|
+
# List entry for one run cache.
|
5516
|
+
#
|
5517
|
+
# @!attribute [rw] arn
|
5518
|
+
# Unique resource identifier for the run cache.
|
5519
|
+
# @return [String]
|
5520
|
+
#
|
5521
|
+
# @!attribute [rw] cache_behavior
|
5522
|
+
# Default cache behavior for the run cache.
|
5523
|
+
# @return [String]
|
5524
|
+
#
|
5525
|
+
# @!attribute [rw] cache_s3_uri
|
5526
|
+
# The S3 uri for the run cache data.
|
5527
|
+
# @return [String]
|
5528
|
+
#
|
5529
|
+
# @!attribute [rw] creation_time
|
5530
|
+
# The time that this run cache was created (an ISO 8601 formatted
|
5531
|
+
# string).
|
5532
|
+
# @return [Time]
|
5533
|
+
#
|
5534
|
+
# @!attribute [rw] id
|
5535
|
+
# The identifier for this run cache.
|
5536
|
+
# @return [String]
|
5537
|
+
#
|
5538
|
+
# @!attribute [rw] name
|
5539
|
+
# The name of the run cache.
|
5540
|
+
# @return [String]
|
5541
|
+
#
|
5542
|
+
# @!attribute [rw] status
|
5543
|
+
# The run cache status.
|
5544
|
+
# @return [String]
|
5545
|
+
#
|
5546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/RunCacheListItem AWS API Documentation
|
5547
|
+
#
|
5548
|
+
class RunCacheListItem < Struct.new(
|
5549
|
+
:arn,
|
5550
|
+
:cache_behavior,
|
5551
|
+
:cache_s3_uri,
|
5552
|
+
:creation_time,
|
5553
|
+
:id,
|
5554
|
+
:name,
|
5555
|
+
:status)
|
5556
|
+
SENSITIVE = []
|
5557
|
+
include Aws::Structure
|
5558
|
+
end
|
5559
|
+
|
5116
5560
|
# A run group.
|
5117
5561
|
#
|
5118
5562
|
# @!attribute [rw] arn
|
@@ -5247,6 +5691,20 @@ module Aws::Omics
|
|
5247
5691
|
include Aws::Structure
|
5248
5692
|
end
|
5249
5693
|
|
5694
|
+
# S3 access configuration parameters.
|
5695
|
+
#
|
5696
|
+
# @!attribute [rw] access_log_location
|
5697
|
+
# Location of the access logs.
|
5698
|
+
# @return [String]
|
5699
|
+
#
|
5700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/S3AccessConfig AWS API Documentation
|
5701
|
+
#
|
5702
|
+
class S3AccessConfig < Struct.new(
|
5703
|
+
:access_log_location)
|
5704
|
+
SENSITIVE = []
|
5705
|
+
include Aws::Structure
|
5706
|
+
end
|
5707
|
+
|
5250
5708
|
# Details about a sequence.
|
5251
5709
|
#
|
5252
5710
|
# @!attribute [rw] total_read_count
|
@@ -5311,6 +5769,18 @@ module Aws::Omics
|
|
5311
5769
|
# The algorithm family of the ETag.
|
5312
5770
|
# @return [String]
|
5313
5771
|
#
|
5772
|
+
# @!attribute [rw] status
|
5773
|
+
# Status of the sequence store.
|
5774
|
+
# @return [String]
|
5775
|
+
#
|
5776
|
+
# @!attribute [rw] status_message
|
5777
|
+
# The status message of the sequence store.
|
5778
|
+
# @return [String]
|
5779
|
+
#
|
5780
|
+
# @!attribute [rw] update_time
|
5781
|
+
# The last-updated time of the Sequence Store.
|
5782
|
+
# @return [Time]
|
5783
|
+
#
|
5314
5784
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/SequenceStoreDetail AWS API Documentation
|
5315
5785
|
#
|
5316
5786
|
class SequenceStoreDetail < Struct.new(
|
@@ -5321,7 +5791,10 @@ module Aws::Omics
|
|
5321
5791
|
:sse_config,
|
5322
5792
|
:creation_time,
|
5323
5793
|
:fallback_location,
|
5324
|
-
:e_tag_algorithm_family
|
5794
|
+
:e_tag_algorithm_family,
|
5795
|
+
:status,
|
5796
|
+
:status_message,
|
5797
|
+
:update_time)
|
5325
5798
|
SENSITIVE = []
|
5326
5799
|
include Aws::Structure
|
5327
5800
|
end
|
@@ -5340,12 +5813,27 @@ module Aws::Omics
|
|
5340
5813
|
# The filter's end date.
|
5341
5814
|
# @return [Time]
|
5342
5815
|
#
|
5816
|
+
# @!attribute [rw] status
|
5817
|
+
# Filter results based on status.
|
5818
|
+
# @return [String]
|
5819
|
+
#
|
5820
|
+
# @!attribute [rw] updated_after
|
5821
|
+
# Filter results based on stores updated after the specified time.
|
5822
|
+
# @return [Time]
|
5823
|
+
#
|
5824
|
+
# @!attribute [rw] updated_before
|
5825
|
+
# Filter results based on stores updated before the specified time.
|
5826
|
+
# @return [Time]
|
5827
|
+
#
|
5343
5828
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/SequenceStoreFilter AWS API Documentation
|
5344
5829
|
#
|
5345
5830
|
class SequenceStoreFilter < Struct.new(
|
5346
5831
|
:name,
|
5347
5832
|
:created_after,
|
5348
|
-
:created_before
|
5833
|
+
:created_before,
|
5834
|
+
:status,
|
5835
|
+
:updated_after,
|
5836
|
+
:updated_before)
|
5349
5837
|
SENSITIVE = []
|
5350
5838
|
include Aws::Structure
|
5351
5839
|
end
|
@@ -5361,11 +5849,16 @@ module Aws::Omics
|
|
5361
5849
|
# storing read sets.
|
5362
5850
|
# @return [String]
|
5363
5851
|
#
|
5852
|
+
# @!attribute [rw] access_log_location
|
5853
|
+
# Location of the access logs.
|
5854
|
+
# @return [String]
|
5855
|
+
#
|
5364
5856
|
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/SequenceStoreS3Access AWS API Documentation
|
5365
5857
|
#
|
5366
5858
|
class SequenceStoreS3Access < Struct.new(
|
5367
5859
|
:s3_uri,
|
5368
|
-
:s3_access_point_arn
|
5860
|
+
:s3_access_point_arn,
|
5861
|
+
:access_log_location)
|
5369
5862
|
SENSITIVE = []
|
5370
5863
|
include Aws::Structure
|
5371
5864
|
end
|
@@ -5889,6 +6382,22 @@ module Aws::Omics
|
|
5889
6382
|
# A name for the run.
|
5890
6383
|
# @return [String]
|
5891
6384
|
#
|
6385
|
+
# @!attribute [rw] cache_id
|
6386
|
+
# Identifier of the cache associated with this run. If you don't
|
6387
|
+
# specify a cache ID, no task outputs are cached for this run.
|
6388
|
+
# @return [String]
|
6389
|
+
#
|
6390
|
+
# @!attribute [rw] cache_behavior
|
6391
|
+
# The cache behavior for the run. You specify this value if you want
|
6392
|
+
# to override the default behavior for the cache. You had set the
|
6393
|
+
# default value when you created the cache. For more information, see
|
6394
|
+
# [Run cache behavior][1] in the AWS HealthOmics User Guide.
|
6395
|
+
#
|
6396
|
+
#
|
6397
|
+
#
|
6398
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior
|
6399
|
+
# @return [String]
|
6400
|
+
#
|
5892
6401
|
# @!attribute [rw] run_group_id
|
5893
6402
|
# The run's group ID.
|
5894
6403
|
# @return [String]
|
@@ -5928,7 +6437,22 @@ module Aws::Omics
|
|
5928
6437
|
# @return [String]
|
5929
6438
|
#
|
5930
6439
|
# @!attribute [rw] retention_mode
|
5931
|
-
# The retention mode for the run.
|
6440
|
+
# The retention mode for the run. The default value is RETAIN.
|
6441
|
+
#
|
6442
|
+
# HealthOmics stores a fixed number of runs that are available to the
|
6443
|
+
# console and API. In the default mode (RETAIN), you need to remove
|
6444
|
+
# runs manually when the number of run exceeds the maximum. If you set
|
6445
|
+
# the retention mode to `REMOVE`, HealthOmics automatically removes
|
6446
|
+
# runs (that have mode set to REMOVE) when the number of run exceeds
|
6447
|
+
# the maximum. All run logs are available in CloudWatch logs, if you
|
6448
|
+
# need information about a run that is no longer available to the API.
|
6449
|
+
#
|
6450
|
+
# For more information about retention mode, see [Specifying run
|
6451
|
+
# retention mode][1] in the *AWS HealthOmics User Guide*.
|
6452
|
+
#
|
6453
|
+
#
|
6454
|
+
#
|
6455
|
+
# [1]: https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html
|
5932
6456
|
# @return [String]
|
5933
6457
|
#
|
5934
6458
|
# @!attribute [rw] storage_type
|
@@ -5950,6 +6474,8 @@ module Aws::Omics
|
|
5950
6474
|
:run_id,
|
5951
6475
|
:role_arn,
|
5952
6476
|
:name,
|
6477
|
+
:cache_id,
|
6478
|
+
:cache_behavior,
|
5953
6479
|
:run_group_id,
|
5954
6480
|
:priority,
|
5955
6481
|
:parameters,
|
@@ -5966,7 +6492,7 @@ module Aws::Omics
|
|
5966
6492
|
end
|
5967
6493
|
|
5968
6494
|
# @!attribute [rw] arn
|
5969
|
-
#
|
6495
|
+
# Unique resource identifier for the run.
|
5970
6496
|
# @return [String]
|
5971
6497
|
#
|
5972
6498
|
# @!attribute [rw] id
|
@@ -6108,6 +6634,15 @@ module Aws::Omics
|
|
6108
6634
|
# The task's CPU count.
|
6109
6635
|
# @return [Integer]
|
6110
6636
|
#
|
6637
|
+
# @!attribute [rw] cache_hit
|
6638
|
+
# Set to true if AWS HealthOmics found a matching entry in the run
|
6639
|
+
# cache for this task.
|
6640
|
+
# @return [Boolean]
|
6641
|
+
#
|
6642
|
+
# @!attribute [rw] cache_s3_uri
|
6643
|
+
# The S3 URI of the cache location.
|
6644
|
+
# @return [String]
|
6645
|
+
#
|
6111
6646
|
# @!attribute [rw] memory
|
6112
6647
|
# The task's memory use in gigabyes.
|
6113
6648
|
# @return [Integer]
|
@@ -6140,6 +6675,8 @@ module Aws::Omics
|
|
6140
6675
|
:status,
|
6141
6676
|
:name,
|
6142
6677
|
:cpus,
|
6678
|
+
:cache_hit,
|
6679
|
+
:cache_s3_uri,
|
6143
6680
|
:memory,
|
6144
6681
|
:creation_time,
|
6145
6682
|
:start_time,
|
@@ -6384,6 +6921,33 @@ module Aws::Omics
|
|
6384
6921
|
include Aws::Structure
|
6385
6922
|
end
|
6386
6923
|
|
6924
|
+
# @!attribute [rw] cache_behavior
|
6925
|
+
# Update the default run cache behavior.
|
6926
|
+
# @return [String]
|
6927
|
+
#
|
6928
|
+
# @!attribute [rw] description
|
6929
|
+
# Update the run cache description.
|
6930
|
+
# @return [String]
|
6931
|
+
#
|
6932
|
+
# @!attribute [rw] id
|
6933
|
+
# The identifier of the run cache you want to update.
|
6934
|
+
# @return [String]
|
6935
|
+
#
|
6936
|
+
# @!attribute [rw] name
|
6937
|
+
# Update the name of the run cache.
|
6938
|
+
# @return [String]
|
6939
|
+
#
|
6940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateRunCacheRequest AWS API Documentation
|
6941
|
+
#
|
6942
|
+
class UpdateRunCacheRequest < Struct.new(
|
6943
|
+
:cache_behavior,
|
6944
|
+
:description,
|
6945
|
+
:id,
|
6946
|
+
:name)
|
6947
|
+
SENSITIVE = []
|
6948
|
+
include Aws::Structure
|
6949
|
+
end
|
6950
|
+
|
6387
6951
|
# @!attribute [rw] id
|
6388
6952
|
# The group's ID.
|
6389
6953
|
# @return [String]
|
@@ -6421,6 +6985,128 @@ module Aws::Omics
|
|
6421
6985
|
include Aws::Structure
|
6422
6986
|
end
|
6423
6987
|
|
6988
|
+
# @!attribute [rw] id
|
6989
|
+
# The ID of the sequence store.
|
6990
|
+
# @return [String]
|
6991
|
+
#
|
6992
|
+
# @!attribute [rw] name
|
6993
|
+
# A name for the sequence store.
|
6994
|
+
# @return [String]
|
6995
|
+
#
|
6996
|
+
# @!attribute [rw] description
|
6997
|
+
# A description for the sequence store.
|
6998
|
+
# @return [String]
|
6999
|
+
#
|
7000
|
+
# @!attribute [rw] client_token
|
7001
|
+
# To ensure that requests don't run multiple times, specify a unique
|
7002
|
+
# token for each request.
|
7003
|
+
#
|
7004
|
+
# **A suitable default value is auto-generated.** You should normally
|
7005
|
+
# not need to pass this option.
|
7006
|
+
# @return [String]
|
7007
|
+
#
|
7008
|
+
# @!attribute [rw] fallback_location
|
7009
|
+
# The S3 URI of a bucket and folder to store Read Sets that fail to
|
7010
|
+
# upload.
|
7011
|
+
# @return [String]
|
7012
|
+
#
|
7013
|
+
# @!attribute [rw] propagated_set_level_tags
|
7014
|
+
# The tags keys to propagate to the S3 objects associated with read
|
7015
|
+
# sets in the sequence store.
|
7016
|
+
# @return [Array<String>]
|
7017
|
+
#
|
7018
|
+
# @!attribute [rw] s3_access_config
|
7019
|
+
# S3 access configuration parameters.
|
7020
|
+
# @return [Types::S3AccessConfig]
|
7021
|
+
#
|
7022
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateSequenceStoreRequest AWS API Documentation
|
7023
|
+
#
|
7024
|
+
class UpdateSequenceStoreRequest < Struct.new(
|
7025
|
+
:id,
|
7026
|
+
:name,
|
7027
|
+
:description,
|
7028
|
+
:client_token,
|
7029
|
+
:fallback_location,
|
7030
|
+
:propagated_set_level_tags,
|
7031
|
+
:s3_access_config)
|
7032
|
+
SENSITIVE = []
|
7033
|
+
include Aws::Structure
|
7034
|
+
end
|
7035
|
+
|
7036
|
+
# @!attribute [rw] id
|
7037
|
+
# The ID of the sequence store.
|
7038
|
+
# @return [String]
|
7039
|
+
#
|
7040
|
+
# @!attribute [rw] arn
|
7041
|
+
# The ARN of the sequence store.
|
7042
|
+
# @return [String]
|
7043
|
+
#
|
7044
|
+
# @!attribute [rw] name
|
7045
|
+
# The name of the sequence store.
|
7046
|
+
# @return [String]
|
7047
|
+
#
|
7048
|
+
# @!attribute [rw] description
|
7049
|
+
# Description of the sequence store.
|
7050
|
+
# @return [String]
|
7051
|
+
#
|
7052
|
+
# @!attribute [rw] sse_config
|
7053
|
+
# Server-side encryption (SSE) settings for a store.
|
7054
|
+
# @return [Types::SseConfig]
|
7055
|
+
#
|
7056
|
+
# @!attribute [rw] creation_time
|
7057
|
+
# The time when the store was created.
|
7058
|
+
# @return [Time]
|
7059
|
+
#
|
7060
|
+
# @!attribute [rw] update_time
|
7061
|
+
# The last-updated time of the Sequence Store.
|
7062
|
+
# @return [Time]
|
7063
|
+
#
|
7064
|
+
# @!attribute [rw] propagated_set_level_tags
|
7065
|
+
# The tags keys to propagate to the S3 objects associated with read
|
7066
|
+
# sets in the sequence store.
|
7067
|
+
# @return [Array<String>]
|
7068
|
+
#
|
7069
|
+
# @!attribute [rw] status
|
7070
|
+
# The status of the sequence store.
|
7071
|
+
# @return [String]
|
7072
|
+
#
|
7073
|
+
# @!attribute [rw] status_message
|
7074
|
+
# The status message of the sequence store.
|
7075
|
+
# @return [String]
|
7076
|
+
#
|
7077
|
+
# @!attribute [rw] fallback_location
|
7078
|
+
# The S3 URI of a bucket and folder to store Read Sets that fail to
|
7079
|
+
# upload.
|
7080
|
+
# @return [String]
|
7081
|
+
#
|
7082
|
+
# @!attribute [rw] s3_access
|
7083
|
+
# The S3 access metadata of the sequence store.
|
7084
|
+
# @return [Types::SequenceStoreS3Access]
|
7085
|
+
#
|
7086
|
+
# @!attribute [rw] e_tag_algorithm_family
|
7087
|
+
# The ETag algorithm family to use on ingested read sets.
|
7088
|
+
# @return [String]
|
7089
|
+
#
|
7090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateSequenceStoreResponse AWS API Documentation
|
7091
|
+
#
|
7092
|
+
class UpdateSequenceStoreResponse < Struct.new(
|
7093
|
+
:id,
|
7094
|
+
:arn,
|
7095
|
+
:name,
|
7096
|
+
:description,
|
7097
|
+
:sse_config,
|
7098
|
+
:creation_time,
|
7099
|
+
:update_time,
|
7100
|
+
:propagated_set_level_tags,
|
7101
|
+
:status,
|
7102
|
+
:status_message,
|
7103
|
+
:fallback_location,
|
7104
|
+
:s3_access,
|
7105
|
+
:e_tag_algorithm_family)
|
7106
|
+
SENSITIVE = []
|
7107
|
+
include Aws::Structure
|
7108
|
+
end
|
7109
|
+
|
6424
7110
|
# @!attribute [rw] name
|
6425
7111
|
# A name for the store.
|
6426
7112
|
# @return [String]
|