aws-sdk-omics 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-omics/client.rb +3833 -0
- data/lib/aws-sdk-omics/client_api.rb +2932 -0
- data/lib/aws-sdk-omics/customizations.rb +0 -0
- data/lib/aws-sdk-omics/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-omics/endpoint_provider.rb +110 -0
- data/lib/aws-sdk-omics/endpoints.rb +939 -0
- data/lib/aws-sdk-omics/errors.rb +198 -0
- data/lib/aws-sdk-omics/plugins/endpoints.rb +200 -0
- data/lib/aws-sdk-omics/resource.rb +26 -0
- data/lib/aws-sdk-omics/types.rb +6190 -0
- data/lib/aws-sdk-omics/waiters.rb +1051 -0
- data/lib/aws-sdk-omics.rb +58 -0
- metadata +95 -0
@@ -0,0 +1,3833 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
|
+
|
36
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:omics)
|
37
|
+
|
38
|
+
module Aws::Omics
|
39
|
+
# An API client for Omics. To construct a client, you need to configure a `:region` and `:credentials`.
|
40
|
+
#
|
41
|
+
# client = Aws::Omics::Client.new(
|
42
|
+
# region: region_name,
|
43
|
+
# credentials: credentials,
|
44
|
+
# # ...
|
45
|
+
# )
|
46
|
+
#
|
47
|
+
# For details on configuring region and credentials see
|
48
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
49
|
+
#
|
50
|
+
# See {#initialize} for a full list of supported configuration options.
|
51
|
+
class Client < Seahorse::Client::Base
|
52
|
+
|
53
|
+
include Aws::ClientStubs
|
54
|
+
|
55
|
+
@identifier = :omics
|
56
|
+
|
57
|
+
set_api(ClientApi::API)
|
58
|
+
|
59
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
60
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
61
|
+
add_plugin(Aws::Plugins::Logging)
|
62
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
63
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
64
|
+
add_plugin(Aws::Plugins::UserAgent)
|
65
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
66
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
67
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
68
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
69
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
70
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
71
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
72
|
+
add_plugin(Aws::Plugins::StubResponses)
|
73
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
74
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
75
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
76
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
77
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
78
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
81
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::Omics::Plugins::Endpoints)
|
85
|
+
|
86
|
+
# @overload initialize(options)
|
87
|
+
# @param [Hash] options
|
88
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
89
|
+
# Your AWS credentials. This can be an instance of any one of the
|
90
|
+
# following classes:
|
91
|
+
#
|
92
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
93
|
+
# credentials.
|
94
|
+
#
|
95
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
96
|
+
# shared file, such as `~/.aws/config`.
|
97
|
+
#
|
98
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
99
|
+
#
|
100
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
101
|
+
# assume a role after providing credentials via the web.
|
102
|
+
#
|
103
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
104
|
+
# access token generated from `aws login`.
|
105
|
+
#
|
106
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
107
|
+
# process that outputs to stdout.
|
108
|
+
#
|
109
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
110
|
+
# from an EC2 IMDS on an EC2 instance.
|
111
|
+
#
|
112
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
113
|
+
# instances running in ECS.
|
114
|
+
#
|
115
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
116
|
+
# from the Cognito Identity service.
|
117
|
+
#
|
118
|
+
# When `:credentials` are not configured directly, the following
|
119
|
+
# locations will be searched for credentials:
|
120
|
+
#
|
121
|
+
# * `Aws.config[:credentials]`
|
122
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
123
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
124
|
+
# * `~/.aws/credentials`
|
125
|
+
# * `~/.aws/config`
|
126
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
127
|
+
# are very aggressive. Construct and pass an instance of
|
128
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
129
|
+
# enable retries and extended timeouts. Instance profile credential
|
130
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
131
|
+
# to true.
|
132
|
+
#
|
133
|
+
# @option options [required, String] :region
|
134
|
+
# The AWS region to connect to. The configured `:region` is
|
135
|
+
# used to determine the service `:endpoint`. When not passed,
|
136
|
+
# a default `:region` is searched for in the following locations:
|
137
|
+
#
|
138
|
+
# * `Aws.config[:region]`
|
139
|
+
# * `ENV['AWS_REGION']`
|
140
|
+
# * `ENV['AMAZON_REGION']`
|
141
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
142
|
+
# * `~/.aws/credentials`
|
143
|
+
# * `~/.aws/config`
|
144
|
+
#
|
145
|
+
# @option options [String] :access_key_id
|
146
|
+
#
|
147
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
148
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
149
|
+
# the background every 60 secs (default). Defaults to `false`.
|
150
|
+
#
|
151
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
152
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
153
|
+
# until there is sufficent client side capacity to retry the request.
|
154
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
155
|
+
# not retry instead of sleeping.
|
156
|
+
#
|
157
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
158
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
159
|
+
# this client.
|
160
|
+
#
|
161
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
162
|
+
# Allows you to provide an identifier for this client which will be attached to
|
163
|
+
# all generated client side metrics. Defaults to an empty string.
|
164
|
+
#
|
165
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
166
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
167
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
168
|
+
#
|
169
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
170
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
171
|
+
# agent is running on, where client metrics will be published via UDP.
|
172
|
+
#
|
173
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
174
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
175
|
+
# will use the Client Side Monitoring Agent Publisher.
|
176
|
+
#
|
177
|
+
# @option options [Boolean] :convert_params (true)
|
178
|
+
# When `true`, an attempt is made to coerce request parameters into
|
179
|
+
# the required types.
|
180
|
+
#
|
181
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
182
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
183
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
184
|
+
#
|
185
|
+
# @option options [String] :defaults_mode ("legacy")
|
186
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
187
|
+
# accepted modes and the configuration defaults that are included.
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
190
|
+
# Set to true to disable SDK automatically adding host prefix
|
191
|
+
# to default service endpoint when available.
|
192
|
+
#
|
193
|
+
# @option options [String] :endpoint
|
194
|
+
# The client endpoint is normally constructed from the `:region`
|
195
|
+
# option. You should only configure an `:endpoint` when connecting
|
196
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
197
|
+
#
|
198
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
199
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
200
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
201
|
+
#
|
202
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
203
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
204
|
+
#
|
205
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
206
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
207
|
+
# Use this option to config the time interval in seconds for making
|
208
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
209
|
+
#
|
210
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
211
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
212
|
+
#
|
213
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
214
|
+
# The log formatter.
|
215
|
+
#
|
216
|
+
# @option options [Symbol] :log_level (:info)
|
217
|
+
# The log level to send messages to the `:logger` at.
|
218
|
+
#
|
219
|
+
# @option options [Logger] :logger
|
220
|
+
# The Logger instance to send log messages to. If this option
|
221
|
+
# is not set, logging will be disabled.
|
222
|
+
#
|
223
|
+
# @option options [Integer] :max_attempts (3)
|
224
|
+
# An integer representing the maximum number attempts that will be made for
|
225
|
+
# a single request, including the initial attempt. For example,
|
226
|
+
# setting this value to 5 will result in a request being retried up to
|
227
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
228
|
+
#
|
229
|
+
# @option options [String] :profile ("default")
|
230
|
+
# Used when loading credentials from the shared credentials file
|
231
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
232
|
+
#
|
233
|
+
# @option options [Proc] :retry_backoff
|
234
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
235
|
+
# This option is only used in the `legacy` retry mode.
|
236
|
+
#
|
237
|
+
# @option options [Float] :retry_base_delay (0.3)
|
238
|
+
# The base delay in seconds used by the default backoff function. This option
|
239
|
+
# is only used in the `legacy` retry mode.
|
240
|
+
#
|
241
|
+
# @option options [Symbol] :retry_jitter (:none)
|
242
|
+
# A delay randomiser function used by the default backoff function.
|
243
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
244
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
245
|
+
# in the `legacy` retry mode.
|
246
|
+
#
|
247
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
248
|
+
#
|
249
|
+
# @option options [Integer] :retry_limit (3)
|
250
|
+
# The maximum number of times to retry failed requests. Only
|
251
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
252
|
+
# are retried. Generally, these are throttling errors, data
|
253
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
254
|
+
# endpoint discovery, and errors from expired credentials.
|
255
|
+
# This option is only used in the `legacy` retry mode.
|
256
|
+
#
|
257
|
+
# @option options [Integer] :retry_max_delay (0)
|
258
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
259
|
+
# used by the default backoff function. This option is only used in the
|
260
|
+
# `legacy` retry mode.
|
261
|
+
#
|
262
|
+
# @option options [String] :retry_mode ("legacy")
|
263
|
+
# Specifies which retry algorithm to use. Values are:
|
264
|
+
#
|
265
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
266
|
+
# no retry mode is provided.
|
267
|
+
#
|
268
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
269
|
+
# This includes support for retry quotas, which limit the number of
|
270
|
+
# unsuccessful retries a client can make.
|
271
|
+
#
|
272
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
273
|
+
# functionality of `standard` mode along with automatic client side
|
274
|
+
# throttling. This is a provisional mode that may change behavior
|
275
|
+
# in the future.
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# @option options [String] :secret_access_key
|
279
|
+
#
|
280
|
+
# @option options [String] :session_token
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :stub_responses (false)
|
283
|
+
# Causes the client to return stubbed responses. By default
|
284
|
+
# fake responses are generated and returned. You can specify
|
285
|
+
# the response data to return or errors to raise by calling
|
286
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
287
|
+
#
|
288
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
289
|
+
# requests are made, and retries are disabled.
|
290
|
+
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
304
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
305
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
306
|
+
# will be used if available.
|
307
|
+
#
|
308
|
+
# @option options [Boolean] :use_fips_endpoint
|
309
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
310
|
+
# When a `fips` region is used, the region is normalized and this config
|
311
|
+
# is set to `true`.
|
312
|
+
#
|
313
|
+
# @option options [Boolean] :validate_params (true)
|
314
|
+
# When `true`, request parameters are validated before
|
315
|
+
# sending the request.
|
316
|
+
#
|
317
|
+
# @option options [Aws::Omics::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Omics::EndpointParameters`
|
319
|
+
#
|
320
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
321
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
322
|
+
#
|
323
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
324
|
+
# seconds to wait when opening a HTTP session before raising a
|
325
|
+
# `Timeout::Error`.
|
326
|
+
#
|
327
|
+
# @option options [Float] :http_read_timeout (60) The default
|
328
|
+
# number of seconds to wait for response data. This value can
|
329
|
+
# safely be set per-request on the session.
|
330
|
+
#
|
331
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
332
|
+
# seconds a connection is allowed to sit idle before it is
|
333
|
+
# considered stale. Stale connections are closed and removed
|
334
|
+
# from the pool before making a request.
|
335
|
+
#
|
336
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
337
|
+
# seconds to wait for a 100-continue response before sending the
|
338
|
+
# request body. This option has no effect unless the request has
|
339
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
340
|
+
# disables this behaviour. This value can safely be set per
|
341
|
+
# request on the session.
|
342
|
+
#
|
343
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
344
|
+
# in seconds.
|
345
|
+
#
|
346
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
347
|
+
# HTTP debug output will be sent to the `:logger`.
|
348
|
+
#
|
349
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
350
|
+
# SSL peer certificates are verified when establishing a
|
351
|
+
# connection.
|
352
|
+
#
|
353
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
354
|
+
# certificate authority bundle file that should be used when
|
355
|
+
# verifying peer certificates. If you do not pass
|
356
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
357
|
+
# will be used if available.
|
358
|
+
#
|
359
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
360
|
+
# directory that contains the unbundled SSL certificate
|
361
|
+
# authority files for verifying peer certificates. If you do
|
362
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
363
|
+
# system default will be used if available.
|
364
|
+
#
|
365
|
+
def initialize(*args)
|
366
|
+
super
|
367
|
+
end
|
368
|
+
|
369
|
+
# @!group API Operations
|
370
|
+
|
371
|
+
# Deletes one or more read sets.
|
372
|
+
#
|
373
|
+
# @option params [required, Array<String>] :ids
|
374
|
+
# The read sets' IDs.
|
375
|
+
#
|
376
|
+
# @option params [required, String] :sequence_store_id
|
377
|
+
# The read sets' sequence store ID.
|
378
|
+
#
|
379
|
+
# @return [Types::BatchDeleteReadSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
380
|
+
#
|
381
|
+
# * {Types::BatchDeleteReadSetResponse#errors #errors} => Array<Types::ReadSetBatchError>
|
382
|
+
#
|
383
|
+
# @example Request syntax with placeholder values
|
384
|
+
#
|
385
|
+
# resp = client.batch_delete_read_set({
|
386
|
+
# ids: ["ReadSetId"], # required
|
387
|
+
# sequence_store_id: "SequenceStoreId", # required
|
388
|
+
# })
|
389
|
+
#
|
390
|
+
# @example Response structure
|
391
|
+
#
|
392
|
+
# resp.errors #=> Array
|
393
|
+
# resp.errors[0].code #=> String
|
394
|
+
# resp.errors[0].id #=> String
|
395
|
+
# resp.errors[0].message #=> String
|
396
|
+
#
|
397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/BatchDeleteReadSet AWS API Documentation
|
398
|
+
#
|
399
|
+
# @overload batch_delete_read_set(params = {})
|
400
|
+
# @param [Hash] params ({})
|
401
|
+
def batch_delete_read_set(params = {}, options = {})
|
402
|
+
req = build_request(:batch_delete_read_set, params)
|
403
|
+
req.send_request(options)
|
404
|
+
end
|
405
|
+
|
406
|
+
# Cancels an annotation import job.
|
407
|
+
#
|
408
|
+
# @option params [required, String] :job_id
|
409
|
+
# The job's ID.
|
410
|
+
#
|
411
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
412
|
+
#
|
413
|
+
# @example Request syntax with placeholder values
|
414
|
+
#
|
415
|
+
# resp = client.cancel_annotation_import_job({
|
416
|
+
# job_id: "ResourceId", # required
|
417
|
+
# })
|
418
|
+
#
|
419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CancelAnnotationImportJob AWS API Documentation
|
420
|
+
#
|
421
|
+
# @overload cancel_annotation_import_job(params = {})
|
422
|
+
# @param [Hash] params ({})
|
423
|
+
def cancel_annotation_import_job(params = {}, options = {})
|
424
|
+
req = build_request(:cancel_annotation_import_job, params)
|
425
|
+
req.send_request(options)
|
426
|
+
end
|
427
|
+
|
428
|
+
# Cancels a run.
|
429
|
+
#
|
430
|
+
# @option params [required, String] :id
|
431
|
+
# The run's ID.
|
432
|
+
#
|
433
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
434
|
+
#
|
435
|
+
# @example Request syntax with placeholder values
|
436
|
+
#
|
437
|
+
# resp = client.cancel_run({
|
438
|
+
# id: "RunId", # required
|
439
|
+
# })
|
440
|
+
#
|
441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CancelRun AWS API Documentation
|
442
|
+
#
|
443
|
+
# @overload cancel_run(params = {})
|
444
|
+
# @param [Hash] params ({})
|
445
|
+
def cancel_run(params = {}, options = {})
|
446
|
+
req = build_request(:cancel_run, params)
|
447
|
+
req.send_request(options)
|
448
|
+
end
|
449
|
+
|
450
|
+
# Cancels a variant import job.
|
451
|
+
#
|
452
|
+
# @option params [required, String] :job_id
|
453
|
+
# The job's ID.
|
454
|
+
#
|
455
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
456
|
+
#
|
457
|
+
# @example Request syntax with placeholder values
|
458
|
+
#
|
459
|
+
# resp = client.cancel_variant_import_job({
|
460
|
+
# job_id: "ResourceId", # required
|
461
|
+
# })
|
462
|
+
#
|
463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CancelVariantImportJob AWS API Documentation
|
464
|
+
#
|
465
|
+
# @overload cancel_variant_import_job(params = {})
|
466
|
+
# @param [Hash] params ({})
|
467
|
+
def cancel_variant_import_job(params = {}, options = {})
|
468
|
+
req = build_request(:cancel_variant_import_job, params)
|
469
|
+
req.send_request(options)
|
470
|
+
end
|
471
|
+
|
472
|
+
# Creates an annotation store.
|
473
|
+
#
|
474
|
+
# @option params [String] :description
|
475
|
+
# A description for the store.
|
476
|
+
#
|
477
|
+
# @option params [String] :name
|
478
|
+
# A name for the store.
|
479
|
+
#
|
480
|
+
# @option params [Types::ReferenceItem] :reference
|
481
|
+
# The genome reference for the store's annotations.
|
482
|
+
#
|
483
|
+
# @option params [Types::SseConfig] :sse_config
|
484
|
+
# Server-side encryption (SSE) settings for the store.
|
485
|
+
#
|
486
|
+
# @option params [required, String] :store_format
|
487
|
+
# The annotation file format of the store.
|
488
|
+
#
|
489
|
+
# @option params [Types::StoreOptions] :store_options
|
490
|
+
# File parsing options for the annotation store.
|
491
|
+
#
|
492
|
+
# @option params [Hash<String,String>] :tags
|
493
|
+
# Tags for the store.
|
494
|
+
#
|
495
|
+
# @return [Types::CreateAnnotationStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
496
|
+
#
|
497
|
+
# * {Types::CreateAnnotationStoreResponse#creation_time #creation_time} => Time
|
498
|
+
# * {Types::CreateAnnotationStoreResponse#id #id} => String
|
499
|
+
# * {Types::CreateAnnotationStoreResponse#name #name} => String
|
500
|
+
# * {Types::CreateAnnotationStoreResponse#reference #reference} => Types::ReferenceItem
|
501
|
+
# * {Types::CreateAnnotationStoreResponse#status #status} => String
|
502
|
+
# * {Types::CreateAnnotationStoreResponse#store_format #store_format} => String
|
503
|
+
# * {Types::CreateAnnotationStoreResponse#store_options #store_options} => Types::StoreOptions
|
504
|
+
#
|
505
|
+
# @example Request syntax with placeholder values
|
506
|
+
#
|
507
|
+
# resp = client.create_annotation_store({
|
508
|
+
# description: "StoreDescription",
|
509
|
+
# name: "CreateAnnotationStoreRequestNameString",
|
510
|
+
# reference: {
|
511
|
+
# reference_arn: "ReferenceArn",
|
512
|
+
# },
|
513
|
+
# sse_config: {
|
514
|
+
# key_arn: "SseConfigKeyArnString",
|
515
|
+
# type: "KMS", # required, accepts KMS
|
516
|
+
# },
|
517
|
+
# store_format: "GFF", # required, accepts GFF, TSV, VCF
|
518
|
+
# store_options: {
|
519
|
+
# tsv_store_options: {
|
520
|
+
# annotation_type: "GENERIC", # accepts GENERIC, CHR_POS, CHR_POS_REF_ALT, CHR_START_END_ONE_BASE, CHR_START_END_REF_ALT_ONE_BASE, CHR_START_END_ZERO_BASE, CHR_START_END_REF_ALT_ZERO_BASE
|
521
|
+
# format_to_header: {
|
522
|
+
# "CHR" => "FormatToHeaderValueString",
|
523
|
+
# },
|
524
|
+
# schema: [
|
525
|
+
# {
|
526
|
+
# "String" => "LONG", # accepts LONG, INT, STRING, FLOAT, DOUBLE, BOOLEAN
|
527
|
+
# },
|
528
|
+
# ],
|
529
|
+
# },
|
530
|
+
# },
|
531
|
+
# tags: {
|
532
|
+
# "TagKey" => "TagValue",
|
533
|
+
# },
|
534
|
+
# })
|
535
|
+
#
|
536
|
+
# @example Response structure
|
537
|
+
#
|
538
|
+
# resp.creation_time #=> Time
|
539
|
+
# resp.id #=> String
|
540
|
+
# resp.name #=> String
|
541
|
+
# resp.reference.reference_arn #=> String
|
542
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
543
|
+
# resp.store_format #=> String, one of "GFF", "TSV", "VCF"
|
544
|
+
# resp.store_options.tsv_store_options.annotation_type #=> String, one of "GENERIC", "CHR_POS", "CHR_POS_REF_ALT", "CHR_START_END_ONE_BASE", "CHR_START_END_REF_ALT_ONE_BASE", "CHR_START_END_ZERO_BASE", "CHR_START_END_REF_ALT_ZERO_BASE"
|
545
|
+
# resp.store_options.tsv_store_options.format_to_header #=> Hash
|
546
|
+
# resp.store_options.tsv_store_options.format_to_header["FormatToHeaderKey"] #=> String
|
547
|
+
# resp.store_options.tsv_store_options.schema #=> Array
|
548
|
+
# resp.store_options.tsv_store_options.schema[0] #=> Hash
|
549
|
+
# resp.store_options.tsv_store_options.schema[0]["String"] #=> String, one of "LONG", "INT", "STRING", "FLOAT", "DOUBLE", "BOOLEAN"
|
550
|
+
#
|
551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateAnnotationStore AWS API Documentation
|
552
|
+
#
|
553
|
+
# @overload create_annotation_store(params = {})
|
554
|
+
# @param [Hash] params ({})
|
555
|
+
def create_annotation_store(params = {}, options = {})
|
556
|
+
req = build_request(:create_annotation_store, params)
|
557
|
+
req.send_request(options)
|
558
|
+
end
|
559
|
+
|
560
|
+
# Creates a reference store.
|
561
|
+
#
|
562
|
+
# @option params [String] :client_token
|
563
|
+
# To ensure that requests don't run multiple times, specify a unique
|
564
|
+
# token for each request.
|
565
|
+
#
|
566
|
+
# @option params [String] :description
|
567
|
+
# A description for the store.
|
568
|
+
#
|
569
|
+
# @option params [required, String] :name
|
570
|
+
# A name for the store.
|
571
|
+
#
|
572
|
+
# @option params [Types::SseConfig] :sse_config
|
573
|
+
# Server-side encryption (SSE) settings for the store.
|
574
|
+
#
|
575
|
+
# @option params [Hash<String,String>] :tags
|
576
|
+
# Tags for the store.
|
577
|
+
#
|
578
|
+
# @return [Types::CreateReferenceStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
579
|
+
#
|
580
|
+
# * {Types::CreateReferenceStoreResponse#arn #arn} => String
|
581
|
+
# * {Types::CreateReferenceStoreResponse#creation_time #creation_time} => Time
|
582
|
+
# * {Types::CreateReferenceStoreResponse#description #description} => String
|
583
|
+
# * {Types::CreateReferenceStoreResponse#id #id} => String
|
584
|
+
# * {Types::CreateReferenceStoreResponse#name #name} => String
|
585
|
+
# * {Types::CreateReferenceStoreResponse#sse_config #sse_config} => Types::SseConfig
|
586
|
+
#
|
587
|
+
# @example Request syntax with placeholder values
|
588
|
+
#
|
589
|
+
# resp = client.create_reference_store({
|
590
|
+
# client_token: "ClientToken",
|
591
|
+
# description: "ReferenceStoreDescription",
|
592
|
+
# name: "ReferenceStoreName", # required
|
593
|
+
# sse_config: {
|
594
|
+
# key_arn: "SseConfigKeyArnString",
|
595
|
+
# type: "KMS", # required, accepts KMS
|
596
|
+
# },
|
597
|
+
# tags: {
|
598
|
+
# "TagKey" => "TagValue",
|
599
|
+
# },
|
600
|
+
# })
|
601
|
+
#
|
602
|
+
# @example Response structure
|
603
|
+
#
|
604
|
+
# resp.arn #=> String
|
605
|
+
# resp.creation_time #=> Time
|
606
|
+
# resp.description #=> String
|
607
|
+
# resp.id #=> String
|
608
|
+
# resp.name #=> String
|
609
|
+
# resp.sse_config.key_arn #=> String
|
610
|
+
# resp.sse_config.type #=> String, one of "KMS"
|
611
|
+
#
|
612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateReferenceStore AWS API Documentation
|
613
|
+
#
|
614
|
+
# @overload create_reference_store(params = {})
|
615
|
+
# @param [Hash] params ({})
|
616
|
+
def create_reference_store(params = {}, options = {})
|
617
|
+
req = build_request(:create_reference_store, params)
|
618
|
+
req.send_request(options)
|
619
|
+
end
|
620
|
+
|
621
|
+
# Creates a run group.
|
622
|
+
#
|
623
|
+
# @option params [Integer] :max_cpus
|
624
|
+
# The maximum number of CPUs to use in the group.
|
625
|
+
#
|
626
|
+
# @option params [Integer] :max_duration
|
627
|
+
# A max duration for the group.
|
628
|
+
#
|
629
|
+
# @option params [Integer] :max_runs
|
630
|
+
# The maximum number of concurrent runs for the group.
|
631
|
+
#
|
632
|
+
# @option params [String] :name
|
633
|
+
# A name for the group.
|
634
|
+
#
|
635
|
+
# @option params [required, String] :request_id
|
636
|
+
# A request ID for the group.
|
637
|
+
#
|
638
|
+
# **A suitable default value is auto-generated.** You should normally
|
639
|
+
# not need to pass this option.**
|
640
|
+
#
|
641
|
+
# @option params [Hash<String,String>] :tags
|
642
|
+
# Tags for the group.
|
643
|
+
#
|
644
|
+
# @return [Types::CreateRunGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
645
|
+
#
|
646
|
+
# * {Types::CreateRunGroupResponse#arn #arn} => String
|
647
|
+
# * {Types::CreateRunGroupResponse#id #id} => String
|
648
|
+
# * {Types::CreateRunGroupResponse#tags #tags} => Hash<String,String>
|
649
|
+
#
|
650
|
+
# @example Request syntax with placeholder values
|
651
|
+
#
|
652
|
+
# resp = client.create_run_group({
|
653
|
+
# max_cpus: 1,
|
654
|
+
# max_duration: 1,
|
655
|
+
# max_runs: 1,
|
656
|
+
# name: "RunGroupName",
|
657
|
+
# request_id: "RunGroupRequestId", # required
|
658
|
+
# tags: {
|
659
|
+
# "TagKey" => "TagValue",
|
660
|
+
# },
|
661
|
+
# })
|
662
|
+
#
|
663
|
+
# @example Response structure
|
664
|
+
#
|
665
|
+
# resp.arn #=> String
|
666
|
+
# resp.id #=> String
|
667
|
+
# resp.tags #=> Hash
|
668
|
+
# resp.tags["TagKey"] #=> String
|
669
|
+
#
|
670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateRunGroup AWS API Documentation
|
671
|
+
#
|
672
|
+
# @overload create_run_group(params = {})
|
673
|
+
# @param [Hash] params ({})
|
674
|
+
def create_run_group(params = {}, options = {})
|
675
|
+
req = build_request(:create_run_group, params)
|
676
|
+
req.send_request(options)
|
677
|
+
end
|
678
|
+
|
679
|
+
# Creates a sequence store.
|
680
|
+
#
|
681
|
+
# @option params [String] :client_token
|
682
|
+
# To ensure that requests don't run multiple times, specify a unique
|
683
|
+
# token for each request.
|
684
|
+
#
|
685
|
+
# @option params [String] :description
|
686
|
+
# A description for the store.
|
687
|
+
#
|
688
|
+
# @option params [required, String] :name
|
689
|
+
# A name for the store.
|
690
|
+
#
|
691
|
+
# @option params [Types::SseConfig] :sse_config
|
692
|
+
# Server-side encryption (SSE) settings for the store.
|
693
|
+
#
|
694
|
+
# @option params [Hash<String,String>] :tags
|
695
|
+
# Tags for the store.
|
696
|
+
#
|
697
|
+
# @return [Types::CreateSequenceStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
698
|
+
#
|
699
|
+
# * {Types::CreateSequenceStoreResponse#arn #arn} => String
|
700
|
+
# * {Types::CreateSequenceStoreResponse#creation_time #creation_time} => Time
|
701
|
+
# * {Types::CreateSequenceStoreResponse#description #description} => String
|
702
|
+
# * {Types::CreateSequenceStoreResponse#id #id} => String
|
703
|
+
# * {Types::CreateSequenceStoreResponse#name #name} => String
|
704
|
+
# * {Types::CreateSequenceStoreResponse#sse_config #sse_config} => Types::SseConfig
|
705
|
+
#
|
706
|
+
# @example Request syntax with placeholder values
|
707
|
+
#
|
708
|
+
# resp = client.create_sequence_store({
|
709
|
+
# client_token: "ClientToken",
|
710
|
+
# description: "SequenceStoreDescription",
|
711
|
+
# name: "SequenceStoreName", # required
|
712
|
+
# sse_config: {
|
713
|
+
# key_arn: "SseConfigKeyArnString",
|
714
|
+
# type: "KMS", # required, accepts KMS
|
715
|
+
# },
|
716
|
+
# tags: {
|
717
|
+
# "TagKey" => "TagValue",
|
718
|
+
# },
|
719
|
+
# })
|
720
|
+
#
|
721
|
+
# @example Response structure
|
722
|
+
#
|
723
|
+
# resp.arn #=> String
|
724
|
+
# resp.creation_time #=> Time
|
725
|
+
# resp.description #=> String
|
726
|
+
# resp.id #=> String
|
727
|
+
# resp.name #=> String
|
728
|
+
# resp.sse_config.key_arn #=> String
|
729
|
+
# resp.sse_config.type #=> String, one of "KMS"
|
730
|
+
#
|
731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateSequenceStore AWS API Documentation
|
732
|
+
#
|
733
|
+
# @overload create_sequence_store(params = {})
|
734
|
+
# @param [Hash] params ({})
|
735
|
+
def create_sequence_store(params = {}, options = {})
|
736
|
+
req = build_request(:create_sequence_store, params)
|
737
|
+
req.send_request(options)
|
738
|
+
end
|
739
|
+
|
740
|
+
# Creates a variant store.
|
741
|
+
#
|
742
|
+
# @option params [String] :description
|
743
|
+
# A description for the store.
|
744
|
+
#
|
745
|
+
# @option params [String] :name
|
746
|
+
# A name for the store.
|
747
|
+
#
|
748
|
+
# @option params [required, Types::ReferenceItem] :reference
|
749
|
+
# The genome reference for the store's variants.
|
750
|
+
#
|
751
|
+
# @option params [Types::SseConfig] :sse_config
|
752
|
+
# Server-side encryption (SSE) settings for the store.
|
753
|
+
#
|
754
|
+
# @option params [Hash<String,String>] :tags
|
755
|
+
# Tags for the store.
|
756
|
+
#
|
757
|
+
# @return [Types::CreateVariantStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
758
|
+
#
|
759
|
+
# * {Types::CreateVariantStoreResponse#creation_time #creation_time} => Time
|
760
|
+
# * {Types::CreateVariantStoreResponse#id #id} => String
|
761
|
+
# * {Types::CreateVariantStoreResponse#name #name} => String
|
762
|
+
# * {Types::CreateVariantStoreResponse#reference #reference} => Types::ReferenceItem
|
763
|
+
# * {Types::CreateVariantStoreResponse#status #status} => String
|
764
|
+
#
|
765
|
+
# @example Request syntax with placeholder values
|
766
|
+
#
|
767
|
+
# resp = client.create_variant_store({
|
768
|
+
# description: "StoreDescription",
|
769
|
+
# name: "CreateVariantStoreRequestNameString",
|
770
|
+
# reference: { # required
|
771
|
+
# reference_arn: "ReferenceArn",
|
772
|
+
# },
|
773
|
+
# sse_config: {
|
774
|
+
# key_arn: "SseConfigKeyArnString",
|
775
|
+
# type: "KMS", # required, accepts KMS
|
776
|
+
# },
|
777
|
+
# tags: {
|
778
|
+
# "TagKey" => "TagValue",
|
779
|
+
# },
|
780
|
+
# })
|
781
|
+
#
|
782
|
+
# @example Response structure
|
783
|
+
#
|
784
|
+
# resp.creation_time #=> Time
|
785
|
+
# resp.id #=> String
|
786
|
+
# resp.name #=> String
|
787
|
+
# resp.reference.reference_arn #=> String
|
788
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
789
|
+
#
|
790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateVariantStore AWS API Documentation
|
791
|
+
#
|
792
|
+
# @overload create_variant_store(params = {})
|
793
|
+
# @param [Hash] params ({})
|
794
|
+
def create_variant_store(params = {}, options = {})
|
795
|
+
req = build_request(:create_variant_store, params)
|
796
|
+
req.send_request(options)
|
797
|
+
end
|
798
|
+
|
799
|
+
# Creates a workflow.
|
800
|
+
#
|
801
|
+
# @option params [String] :definition_uri
|
802
|
+
# The URI of a definition for the workflow.
|
803
|
+
#
|
804
|
+
# @option params [String, StringIO, File] :definition_zip
|
805
|
+
# A ZIP archive for the workflow.
|
806
|
+
#
|
807
|
+
# @option params [String] :description
|
808
|
+
# A description for the workflow.
|
809
|
+
#
|
810
|
+
# @option params [String] :engine
|
811
|
+
# An engine for the workflow.
|
812
|
+
#
|
813
|
+
# @option params [String] :main
|
814
|
+
# The path of the main definition file for the workflow.
|
815
|
+
#
|
816
|
+
# @option params [String] :name
|
817
|
+
# A name for the workflow.
|
818
|
+
#
|
819
|
+
# @option params [Hash<String,Types::WorkflowParameter>] :parameter_template
|
820
|
+
# A parameter template for the workflow.
|
821
|
+
#
|
822
|
+
# @option params [required, String] :request_id
|
823
|
+
# A request ID for the workflow.
|
824
|
+
#
|
825
|
+
# **A suitable default value is auto-generated.** You should normally
|
826
|
+
# not need to pass this option.**
|
827
|
+
#
|
828
|
+
# @option params [Integer] :storage_capacity
|
829
|
+
# A storage capacity for the workflow.
|
830
|
+
#
|
831
|
+
# @option params [Hash<String,String>] :tags
|
832
|
+
# Tags for the workflow.
|
833
|
+
#
|
834
|
+
# @return [Types::CreateWorkflowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
835
|
+
#
|
836
|
+
# * {Types::CreateWorkflowResponse#arn #arn} => String
|
837
|
+
# * {Types::CreateWorkflowResponse#id #id} => String
|
838
|
+
# * {Types::CreateWorkflowResponse#status #status} => String
|
839
|
+
# * {Types::CreateWorkflowResponse#tags #tags} => Hash<String,String>
|
840
|
+
#
|
841
|
+
# @example Request syntax with placeholder values
|
842
|
+
#
|
843
|
+
# resp = client.create_workflow({
|
844
|
+
# definition_uri: "WorkflowDefinition",
|
845
|
+
# definition_zip: "data",
|
846
|
+
# description: "WorkflowDescription",
|
847
|
+
# engine: "WDL", # accepts WDL, NEXTFLOW
|
848
|
+
# main: "WorkflowMain",
|
849
|
+
# name: "WorkflowName",
|
850
|
+
# parameter_template: {
|
851
|
+
# "WorkflowParameterName" => {
|
852
|
+
# description: "WorkflowParameterDescription",
|
853
|
+
# optional: false,
|
854
|
+
# },
|
855
|
+
# },
|
856
|
+
# request_id: "WorkflowRequestId", # required
|
857
|
+
# storage_capacity: 1,
|
858
|
+
# tags: {
|
859
|
+
# "TagKey" => "TagValue",
|
860
|
+
# },
|
861
|
+
# })
|
862
|
+
#
|
863
|
+
# @example Response structure
|
864
|
+
#
|
865
|
+
# resp.arn #=> String
|
866
|
+
# resp.id #=> String
|
867
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETED", "FAILED"
|
868
|
+
# resp.tags #=> Hash
|
869
|
+
# resp.tags["TagKey"] #=> String
|
870
|
+
#
|
871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateWorkflow AWS API Documentation
|
872
|
+
#
|
873
|
+
# @overload create_workflow(params = {})
|
874
|
+
# @param [Hash] params ({})
|
875
|
+
def create_workflow(params = {}, options = {})
|
876
|
+
req = build_request(:create_workflow, params)
|
877
|
+
req.send_request(options)
|
878
|
+
end
|
879
|
+
|
880
|
+
# Deletes an annotation store.
|
881
|
+
#
|
882
|
+
# @option params [Boolean] :force
|
883
|
+
# Whether to force deletion.
|
884
|
+
#
|
885
|
+
# @option params [required, String] :name
|
886
|
+
# The store's name.
|
887
|
+
#
|
888
|
+
# @return [Types::DeleteAnnotationStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
889
|
+
#
|
890
|
+
# * {Types::DeleteAnnotationStoreResponse#status #status} => String
|
891
|
+
#
|
892
|
+
# @example Request syntax with placeholder values
|
893
|
+
#
|
894
|
+
# resp = client.delete_annotation_store({
|
895
|
+
# force: false,
|
896
|
+
# name: "String", # required
|
897
|
+
# })
|
898
|
+
#
|
899
|
+
# @example Response structure
|
900
|
+
#
|
901
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
902
|
+
#
|
903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteAnnotationStore AWS API Documentation
|
904
|
+
#
|
905
|
+
# @overload delete_annotation_store(params = {})
|
906
|
+
# @param [Hash] params ({})
|
907
|
+
def delete_annotation_store(params = {}, options = {})
|
908
|
+
req = build_request(:delete_annotation_store, params)
|
909
|
+
req.send_request(options)
|
910
|
+
end
|
911
|
+
|
912
|
+
# Deletes a genome reference.
|
913
|
+
#
|
914
|
+
# @option params [required, String] :id
|
915
|
+
# The reference's ID.
|
916
|
+
#
|
917
|
+
# @option params [required, String] :reference_store_id
|
918
|
+
# The reference's store ID.
|
919
|
+
#
|
920
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
921
|
+
#
|
922
|
+
# @example Request syntax with placeholder values
|
923
|
+
#
|
924
|
+
# resp = client.delete_reference({
|
925
|
+
# id: "ReferenceId", # required
|
926
|
+
# reference_store_id: "ReferenceStoreId", # required
|
927
|
+
# })
|
928
|
+
#
|
929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteReference AWS API Documentation
|
930
|
+
#
|
931
|
+
# @overload delete_reference(params = {})
|
932
|
+
# @param [Hash] params ({})
|
933
|
+
def delete_reference(params = {}, options = {})
|
934
|
+
req = build_request(:delete_reference, params)
|
935
|
+
req.send_request(options)
|
936
|
+
end
|
937
|
+
|
938
|
+
# Deletes a genome reference store.
|
939
|
+
#
|
940
|
+
# @option params [required, String] :id
|
941
|
+
# The store's ID.
|
942
|
+
#
|
943
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
944
|
+
#
|
945
|
+
# @example Request syntax with placeholder values
|
946
|
+
#
|
947
|
+
# resp = client.delete_reference_store({
|
948
|
+
# id: "ReferenceStoreId", # required
|
949
|
+
# })
|
950
|
+
#
|
951
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteReferenceStore AWS API Documentation
|
952
|
+
#
|
953
|
+
# @overload delete_reference_store(params = {})
|
954
|
+
# @param [Hash] params ({})
|
955
|
+
def delete_reference_store(params = {}, options = {})
|
956
|
+
req = build_request(:delete_reference_store, params)
|
957
|
+
req.send_request(options)
|
958
|
+
end
|
959
|
+
|
960
|
+
# Deletes a workflow run.
|
961
|
+
#
|
962
|
+
# @option params [required, String] :id
|
963
|
+
# The run's ID.
|
964
|
+
#
|
965
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
966
|
+
#
|
967
|
+
# @example Request syntax with placeholder values
|
968
|
+
#
|
969
|
+
# resp = client.delete_run({
|
970
|
+
# id: "RunId", # required
|
971
|
+
# })
|
972
|
+
#
|
973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteRun AWS API Documentation
|
974
|
+
#
|
975
|
+
# @overload delete_run(params = {})
|
976
|
+
# @param [Hash] params ({})
|
977
|
+
def delete_run(params = {}, options = {})
|
978
|
+
req = build_request(:delete_run, params)
|
979
|
+
req.send_request(options)
|
980
|
+
end
|
981
|
+
|
982
|
+
# Deletes a workflow run group.
|
983
|
+
#
|
984
|
+
# @option params [required, String] :id
|
985
|
+
# The run group's ID.
|
986
|
+
#
|
987
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
988
|
+
#
|
989
|
+
# @example Request syntax with placeholder values
|
990
|
+
#
|
991
|
+
# resp = client.delete_run_group({
|
992
|
+
# id: "RunGroupId", # required
|
993
|
+
# })
|
994
|
+
#
|
995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteRunGroup AWS API Documentation
|
996
|
+
#
|
997
|
+
# @overload delete_run_group(params = {})
|
998
|
+
# @param [Hash] params ({})
|
999
|
+
def delete_run_group(params = {}, options = {})
|
1000
|
+
req = build_request(:delete_run_group, params)
|
1001
|
+
req.send_request(options)
|
1002
|
+
end
|
1003
|
+
|
1004
|
+
# Deletes a sequence store.
|
1005
|
+
#
|
1006
|
+
# @option params [required, String] :id
|
1007
|
+
# The sequence store's ID.
|
1008
|
+
#
|
1009
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1010
|
+
#
|
1011
|
+
# @example Request syntax with placeholder values
|
1012
|
+
#
|
1013
|
+
# resp = client.delete_sequence_store({
|
1014
|
+
# id: "SequenceStoreId", # required
|
1015
|
+
# })
|
1016
|
+
#
|
1017
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteSequenceStore AWS API Documentation
|
1018
|
+
#
|
1019
|
+
# @overload delete_sequence_store(params = {})
|
1020
|
+
# @param [Hash] params ({})
|
1021
|
+
def delete_sequence_store(params = {}, options = {})
|
1022
|
+
req = build_request(:delete_sequence_store, params)
|
1023
|
+
req.send_request(options)
|
1024
|
+
end
|
1025
|
+
|
1026
|
+
# Deletes a variant store.
|
1027
|
+
#
|
1028
|
+
# @option params [Boolean] :force
|
1029
|
+
# Whether to force deletion.
|
1030
|
+
#
|
1031
|
+
# @option params [required, String] :name
|
1032
|
+
# The store's name.
|
1033
|
+
#
|
1034
|
+
# @return [Types::DeleteVariantStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1035
|
+
#
|
1036
|
+
# * {Types::DeleteVariantStoreResponse#status #status} => String
|
1037
|
+
#
|
1038
|
+
# @example Request syntax with placeholder values
|
1039
|
+
#
|
1040
|
+
# resp = client.delete_variant_store({
|
1041
|
+
# force: false,
|
1042
|
+
# name: "String", # required
|
1043
|
+
# })
|
1044
|
+
#
|
1045
|
+
# @example Response structure
|
1046
|
+
#
|
1047
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
1048
|
+
#
|
1049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteVariantStore AWS API Documentation
|
1050
|
+
#
|
1051
|
+
# @overload delete_variant_store(params = {})
|
1052
|
+
# @param [Hash] params ({})
|
1053
|
+
def delete_variant_store(params = {}, options = {})
|
1054
|
+
req = build_request(:delete_variant_store, params)
|
1055
|
+
req.send_request(options)
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
# Deletes a workflow.
|
1059
|
+
#
|
1060
|
+
# @option params [required, String] :id
|
1061
|
+
# The workflow's ID.
|
1062
|
+
#
|
1063
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1064
|
+
#
|
1065
|
+
# @example Request syntax with placeholder values
|
1066
|
+
#
|
1067
|
+
# resp = client.delete_workflow({
|
1068
|
+
# id: "WorkflowId", # required
|
1069
|
+
# })
|
1070
|
+
#
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/DeleteWorkflow AWS API Documentation
|
1072
|
+
#
|
1073
|
+
# @overload delete_workflow(params = {})
|
1074
|
+
# @param [Hash] params ({})
|
1075
|
+
def delete_workflow(params = {}, options = {})
|
1076
|
+
req = build_request(:delete_workflow, params)
|
1077
|
+
req.send_request(options)
|
1078
|
+
end
|
1079
|
+
|
1080
|
+
# Gets information about an annotation import job.
|
1081
|
+
#
|
1082
|
+
# @option params [required, String] :job_id
|
1083
|
+
# The job's ID.
|
1084
|
+
#
|
1085
|
+
# @return [Types::GetAnnotationImportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1086
|
+
#
|
1087
|
+
# * {Types::GetAnnotationImportResponse#completion_time #completion_time} => Time
|
1088
|
+
# * {Types::GetAnnotationImportResponse#creation_time #creation_time} => Time
|
1089
|
+
# * {Types::GetAnnotationImportResponse#destination_name #destination_name} => String
|
1090
|
+
# * {Types::GetAnnotationImportResponse#format_options #format_options} => Types::FormatOptions
|
1091
|
+
# * {Types::GetAnnotationImportResponse#id #id} => String
|
1092
|
+
# * {Types::GetAnnotationImportResponse#items #items} => Array<Types::AnnotationImportItemDetail>
|
1093
|
+
# * {Types::GetAnnotationImportResponse#role_arn #role_arn} => String
|
1094
|
+
# * {Types::GetAnnotationImportResponse#run_left_normalization #run_left_normalization} => Boolean
|
1095
|
+
# * {Types::GetAnnotationImportResponse#status #status} => String
|
1096
|
+
# * {Types::GetAnnotationImportResponse#status_message #status_message} => String
|
1097
|
+
# * {Types::GetAnnotationImportResponse#update_time #update_time} => Time
|
1098
|
+
#
|
1099
|
+
# @example Request syntax with placeholder values
|
1100
|
+
#
|
1101
|
+
# resp = client.get_annotation_import_job({
|
1102
|
+
# job_id: "ResourceId", # required
|
1103
|
+
# })
|
1104
|
+
#
|
1105
|
+
# @example Response structure
|
1106
|
+
#
|
1107
|
+
# resp.completion_time #=> Time
|
1108
|
+
# resp.creation_time #=> Time
|
1109
|
+
# resp.destination_name #=> String
|
1110
|
+
# resp.format_options.tsv_options.read_options.comment #=> String
|
1111
|
+
# resp.format_options.tsv_options.read_options.encoding #=> String
|
1112
|
+
# resp.format_options.tsv_options.read_options.escape #=> String
|
1113
|
+
# resp.format_options.tsv_options.read_options.escape_quotes #=> Boolean
|
1114
|
+
# resp.format_options.tsv_options.read_options.header #=> Boolean
|
1115
|
+
# resp.format_options.tsv_options.read_options.line_sep #=> String
|
1116
|
+
# resp.format_options.tsv_options.read_options.quote #=> String
|
1117
|
+
# resp.format_options.tsv_options.read_options.quote_all #=> Boolean
|
1118
|
+
# resp.format_options.tsv_options.read_options.sep #=> String
|
1119
|
+
# resp.format_options.vcf_options.ignore_filter_field #=> Boolean
|
1120
|
+
# resp.format_options.vcf_options.ignore_qual_field #=> Boolean
|
1121
|
+
# resp.id #=> String
|
1122
|
+
# resp.items #=> Array
|
1123
|
+
# resp.items[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED"
|
1124
|
+
# resp.items[0].source #=> String
|
1125
|
+
# resp.role_arn #=> String
|
1126
|
+
# resp.run_left_normalization #=> Boolean
|
1127
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED"
|
1128
|
+
# resp.status_message #=> String
|
1129
|
+
# resp.update_time #=> Time
|
1130
|
+
#
|
1131
|
+
#
|
1132
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1133
|
+
#
|
1134
|
+
# * annotation_import_job_created
|
1135
|
+
#
|
1136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetAnnotationImportJob AWS API Documentation
|
1137
|
+
#
|
1138
|
+
# @overload get_annotation_import_job(params = {})
|
1139
|
+
# @param [Hash] params ({})
|
1140
|
+
def get_annotation_import_job(params = {}, options = {})
|
1141
|
+
req = build_request(:get_annotation_import_job, params)
|
1142
|
+
req.send_request(options)
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
# Gets information about an annotation store.
|
1146
|
+
#
|
1147
|
+
# @option params [required, String] :name
|
1148
|
+
# The store's name.
|
1149
|
+
#
|
1150
|
+
# @return [Types::GetAnnotationStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1151
|
+
#
|
1152
|
+
# * {Types::GetAnnotationStoreResponse#creation_time #creation_time} => Time
|
1153
|
+
# * {Types::GetAnnotationStoreResponse#description #description} => String
|
1154
|
+
# * {Types::GetAnnotationStoreResponse#id #id} => String
|
1155
|
+
# * {Types::GetAnnotationStoreResponse#name #name} => String
|
1156
|
+
# * {Types::GetAnnotationStoreResponse#reference #reference} => Types::ReferenceItem
|
1157
|
+
# * {Types::GetAnnotationStoreResponse#sse_config #sse_config} => Types::SseConfig
|
1158
|
+
# * {Types::GetAnnotationStoreResponse#status #status} => String
|
1159
|
+
# * {Types::GetAnnotationStoreResponse#status_message #status_message} => String
|
1160
|
+
# * {Types::GetAnnotationStoreResponse#store_arn #store_arn} => String
|
1161
|
+
# * {Types::GetAnnotationStoreResponse#store_format #store_format} => String
|
1162
|
+
# * {Types::GetAnnotationStoreResponse#store_options #store_options} => Types::StoreOptions
|
1163
|
+
# * {Types::GetAnnotationStoreResponse#store_size_bytes #store_size_bytes} => Integer
|
1164
|
+
# * {Types::GetAnnotationStoreResponse#tags #tags} => Hash<String,String>
|
1165
|
+
# * {Types::GetAnnotationStoreResponse#update_time #update_time} => Time
|
1166
|
+
#
|
1167
|
+
# @example Request syntax with placeholder values
|
1168
|
+
#
|
1169
|
+
# resp = client.get_annotation_store({
|
1170
|
+
# name: "String", # required
|
1171
|
+
# })
|
1172
|
+
#
|
1173
|
+
# @example Response structure
|
1174
|
+
#
|
1175
|
+
# resp.creation_time #=> Time
|
1176
|
+
# resp.description #=> String
|
1177
|
+
# resp.id #=> String
|
1178
|
+
# resp.name #=> String
|
1179
|
+
# resp.reference.reference_arn #=> String
|
1180
|
+
# resp.sse_config.key_arn #=> String
|
1181
|
+
# resp.sse_config.type #=> String, one of "KMS"
|
1182
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
1183
|
+
# resp.status_message #=> String
|
1184
|
+
# resp.store_arn #=> String
|
1185
|
+
# resp.store_format #=> String, one of "GFF", "TSV", "VCF"
|
1186
|
+
# resp.store_options.tsv_store_options.annotation_type #=> String, one of "GENERIC", "CHR_POS", "CHR_POS_REF_ALT", "CHR_START_END_ONE_BASE", "CHR_START_END_REF_ALT_ONE_BASE", "CHR_START_END_ZERO_BASE", "CHR_START_END_REF_ALT_ZERO_BASE"
|
1187
|
+
# resp.store_options.tsv_store_options.format_to_header #=> Hash
|
1188
|
+
# resp.store_options.tsv_store_options.format_to_header["FormatToHeaderKey"] #=> String
|
1189
|
+
# resp.store_options.tsv_store_options.schema #=> Array
|
1190
|
+
# resp.store_options.tsv_store_options.schema[0] #=> Hash
|
1191
|
+
# resp.store_options.tsv_store_options.schema[0]["String"] #=> String, one of "LONG", "INT", "STRING", "FLOAT", "DOUBLE", "BOOLEAN"
|
1192
|
+
# resp.store_size_bytes #=> Integer
|
1193
|
+
# resp.tags #=> Hash
|
1194
|
+
# resp.tags["TagKey"] #=> String
|
1195
|
+
# resp.update_time #=> Time
|
1196
|
+
#
|
1197
|
+
#
|
1198
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1199
|
+
#
|
1200
|
+
# * annotation_store_created
|
1201
|
+
# * annotation_store_deleted
|
1202
|
+
#
|
1203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetAnnotationStore AWS API Documentation
|
1204
|
+
#
|
1205
|
+
# @overload get_annotation_store(params = {})
|
1206
|
+
# @param [Hash] params ({})
|
1207
|
+
def get_annotation_store(params = {}, options = {})
|
1208
|
+
req = build_request(:get_annotation_store, params)
|
1209
|
+
req.send_request(options)
|
1210
|
+
end
|
1211
|
+
|
1212
|
+
# Gets a file from a read set.
|
1213
|
+
#
|
1214
|
+
# @option params [String] :file
|
1215
|
+
# The file to retrieve.
|
1216
|
+
#
|
1217
|
+
# @option params [required, String] :id
|
1218
|
+
# The read set's ID.
|
1219
|
+
#
|
1220
|
+
# @option params [required, Integer] :part_number
|
1221
|
+
# The part number to retrieve.
|
1222
|
+
#
|
1223
|
+
# @option params [required, String] :sequence_store_id
|
1224
|
+
# The read set's sequence store ID.
|
1225
|
+
#
|
1226
|
+
# @return [Types::GetReadSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1227
|
+
#
|
1228
|
+
# * {Types::GetReadSetResponse#payload #payload} => IO
|
1229
|
+
#
|
1230
|
+
# @example Request syntax with placeholder values
|
1231
|
+
#
|
1232
|
+
# resp = client.get_read_set({
|
1233
|
+
# file: "SOURCE1", # accepts SOURCE1, SOURCE2, INDEX
|
1234
|
+
# id: "ReadSetId", # required
|
1235
|
+
# part_number: 1, # required
|
1236
|
+
# sequence_store_id: "SequenceStoreId", # required
|
1237
|
+
# })
|
1238
|
+
#
|
1239
|
+
# @example Response structure
|
1240
|
+
#
|
1241
|
+
# resp.payload #=> IO
|
1242
|
+
#
|
1243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetReadSet AWS API Documentation
|
1244
|
+
#
|
1245
|
+
# @overload get_read_set(params = {})
|
1246
|
+
# @param [Hash] params ({})
|
1247
|
+
def get_read_set(params = {}, options = {}, &block)
|
1248
|
+
req = build_request(:get_read_set, params)
|
1249
|
+
req.send_request(options, &block)
|
1250
|
+
end
|
1251
|
+
|
1252
|
+
# Gets information about a read set activation job.
|
1253
|
+
#
|
1254
|
+
# @option params [required, String] :id
|
1255
|
+
# The job's ID.
|
1256
|
+
#
|
1257
|
+
# @option params [required, String] :sequence_store_id
|
1258
|
+
# The job's sequence store ID.
|
1259
|
+
#
|
1260
|
+
# @return [Types::GetReadSetActivationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1261
|
+
#
|
1262
|
+
# * {Types::GetReadSetActivationJobResponse#completion_time #completion_time} => Time
|
1263
|
+
# * {Types::GetReadSetActivationJobResponse#creation_time #creation_time} => Time
|
1264
|
+
# * {Types::GetReadSetActivationJobResponse#id #id} => String
|
1265
|
+
# * {Types::GetReadSetActivationJobResponse#sequence_store_id #sequence_store_id} => String
|
1266
|
+
# * {Types::GetReadSetActivationJobResponse#sources #sources} => Array<Types::ActivateReadSetSourceItem>
|
1267
|
+
# * {Types::GetReadSetActivationJobResponse#status #status} => String
|
1268
|
+
# * {Types::GetReadSetActivationJobResponse#status_message #status_message} => String
|
1269
|
+
#
|
1270
|
+
# @example Request syntax with placeholder values
|
1271
|
+
#
|
1272
|
+
# resp = client.get_read_set_activation_job({
|
1273
|
+
# id: "ActivationJobId", # required
|
1274
|
+
# sequence_store_id: "SequenceStoreId", # required
|
1275
|
+
# })
|
1276
|
+
#
|
1277
|
+
# @example Response structure
|
1278
|
+
#
|
1279
|
+
# resp.completion_time #=> Time
|
1280
|
+
# resp.creation_time #=> Time
|
1281
|
+
# resp.id #=> String
|
1282
|
+
# resp.sequence_store_id #=> String
|
1283
|
+
# resp.sources #=> Array
|
1284
|
+
# resp.sources[0].read_set_id #=> String
|
1285
|
+
# resp.sources[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FINISHED", "FAILED"
|
1286
|
+
# resp.sources[0].status_message #=> String
|
1287
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
1288
|
+
# resp.status_message #=> String
|
1289
|
+
#
|
1290
|
+
#
|
1291
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1292
|
+
#
|
1293
|
+
# * read_set_activation_job_completed
|
1294
|
+
#
|
1295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetReadSetActivationJob AWS API Documentation
|
1296
|
+
#
|
1297
|
+
# @overload get_read_set_activation_job(params = {})
|
1298
|
+
# @param [Hash] params ({})
|
1299
|
+
def get_read_set_activation_job(params = {}, options = {})
|
1300
|
+
req = build_request(:get_read_set_activation_job, params)
|
1301
|
+
req.send_request(options)
|
1302
|
+
end
|
1303
|
+
|
1304
|
+
# Gets information about a read set export job.
|
1305
|
+
#
|
1306
|
+
# @option params [required, String] :id
|
1307
|
+
# The job's ID.
|
1308
|
+
#
|
1309
|
+
# @option params [required, String] :sequence_store_id
|
1310
|
+
# The job's sequence store ID.
|
1311
|
+
#
|
1312
|
+
# @return [Types::GetReadSetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1313
|
+
#
|
1314
|
+
# * {Types::GetReadSetExportJobResponse#completion_time #completion_time} => Time
|
1315
|
+
# * {Types::GetReadSetExportJobResponse#creation_time #creation_time} => Time
|
1316
|
+
# * {Types::GetReadSetExportJobResponse#destination #destination} => String
|
1317
|
+
# * {Types::GetReadSetExportJobResponse#id #id} => String
|
1318
|
+
# * {Types::GetReadSetExportJobResponse#read_sets #read_sets} => Array<Types::ExportReadSetDetail>
|
1319
|
+
# * {Types::GetReadSetExportJobResponse#sequence_store_id #sequence_store_id} => String
|
1320
|
+
# * {Types::GetReadSetExportJobResponse#status #status} => String
|
1321
|
+
# * {Types::GetReadSetExportJobResponse#status_message #status_message} => String
|
1322
|
+
#
|
1323
|
+
# @example Request syntax with placeholder values
|
1324
|
+
#
|
1325
|
+
# resp = client.get_read_set_export_job({
|
1326
|
+
# id: "ExportJobId", # required
|
1327
|
+
# sequence_store_id: "SequenceStoreId", # required
|
1328
|
+
# })
|
1329
|
+
#
|
1330
|
+
# @example Response structure
|
1331
|
+
#
|
1332
|
+
# resp.completion_time #=> Time
|
1333
|
+
# resp.creation_time #=> Time
|
1334
|
+
# resp.destination #=> String
|
1335
|
+
# resp.id #=> String
|
1336
|
+
# resp.read_sets #=> Array
|
1337
|
+
# resp.read_sets[0].id #=> String
|
1338
|
+
# resp.read_sets[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FINISHED", "FAILED"
|
1339
|
+
# resp.read_sets[0].status_message #=> String
|
1340
|
+
# resp.sequence_store_id #=> String
|
1341
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
1342
|
+
# resp.status_message #=> String
|
1343
|
+
#
|
1344
|
+
#
|
1345
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1346
|
+
#
|
1347
|
+
# * read_set_export_job_completed
|
1348
|
+
#
|
1349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetReadSetExportJob AWS API Documentation
|
1350
|
+
#
|
1351
|
+
# @overload get_read_set_export_job(params = {})
|
1352
|
+
# @param [Hash] params ({})
|
1353
|
+
def get_read_set_export_job(params = {}, options = {})
|
1354
|
+
req = build_request(:get_read_set_export_job, params)
|
1355
|
+
req.send_request(options)
|
1356
|
+
end
|
1357
|
+
|
1358
|
+
# Gets information about a read set import job.
|
1359
|
+
#
|
1360
|
+
# @option params [required, String] :id
|
1361
|
+
# The job's ID.
|
1362
|
+
#
|
1363
|
+
# @option params [required, String] :sequence_store_id
|
1364
|
+
# The job's sequence store ID.
|
1365
|
+
#
|
1366
|
+
# @return [Types::GetReadSetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1367
|
+
#
|
1368
|
+
# * {Types::GetReadSetImportJobResponse#completion_time #completion_time} => Time
|
1369
|
+
# * {Types::GetReadSetImportJobResponse#creation_time #creation_time} => Time
|
1370
|
+
# * {Types::GetReadSetImportJobResponse#id #id} => String
|
1371
|
+
# * {Types::GetReadSetImportJobResponse#role_arn #role_arn} => String
|
1372
|
+
# * {Types::GetReadSetImportJobResponse#sequence_store_id #sequence_store_id} => String
|
1373
|
+
# * {Types::GetReadSetImportJobResponse#sources #sources} => Array<Types::ImportReadSetSourceItem>
|
1374
|
+
# * {Types::GetReadSetImportJobResponse#status #status} => String
|
1375
|
+
# * {Types::GetReadSetImportJobResponse#status_message #status_message} => String
|
1376
|
+
#
|
1377
|
+
# @example Request syntax with placeholder values
|
1378
|
+
#
|
1379
|
+
# resp = client.get_read_set_import_job({
|
1380
|
+
# id: "ImportJobId", # required
|
1381
|
+
# sequence_store_id: "SequenceStoreId", # required
|
1382
|
+
# })
|
1383
|
+
#
|
1384
|
+
# @example Response structure
|
1385
|
+
#
|
1386
|
+
# resp.completion_time #=> Time
|
1387
|
+
# resp.creation_time #=> Time
|
1388
|
+
# resp.id #=> String
|
1389
|
+
# resp.role_arn #=> String
|
1390
|
+
# resp.sequence_store_id #=> String
|
1391
|
+
# resp.sources #=> Array
|
1392
|
+
# resp.sources[0].description #=> String
|
1393
|
+
# resp.sources[0].generated_from #=> String
|
1394
|
+
# resp.sources[0].name #=> String
|
1395
|
+
# resp.sources[0].reference_arn #=> String
|
1396
|
+
# resp.sources[0].sample_id #=> String
|
1397
|
+
# resp.sources[0].source_file_type #=> String, one of "FASTQ", "BAM", "CRAM"
|
1398
|
+
# resp.sources[0].source_files.source1 #=> String
|
1399
|
+
# resp.sources[0].source_files.source2 #=> String
|
1400
|
+
# resp.sources[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FINISHED", "FAILED"
|
1401
|
+
# resp.sources[0].status_message #=> String
|
1402
|
+
# resp.sources[0].subject_id #=> String
|
1403
|
+
# resp.sources[0].tags #=> Hash
|
1404
|
+
# resp.sources[0].tags["TagKey"] #=> String
|
1405
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
1406
|
+
# resp.status_message #=> String
|
1407
|
+
#
|
1408
|
+
#
|
1409
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1410
|
+
#
|
1411
|
+
# * read_set_import_job_completed
|
1412
|
+
#
|
1413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetReadSetImportJob AWS API Documentation
|
1414
|
+
#
|
1415
|
+
# @overload get_read_set_import_job(params = {})
|
1416
|
+
# @param [Hash] params ({})
|
1417
|
+
def get_read_set_import_job(params = {}, options = {})
|
1418
|
+
req = build_request(:get_read_set_import_job, params)
|
1419
|
+
req.send_request(options)
|
1420
|
+
end
|
1421
|
+
|
1422
|
+
# Gets details about a read set.
|
1423
|
+
#
|
1424
|
+
# @option params [required, String] :id
|
1425
|
+
# The read set's ID.
|
1426
|
+
#
|
1427
|
+
# @option params [required, String] :sequence_store_id
|
1428
|
+
# The read set's sequence store ID.
|
1429
|
+
#
|
1430
|
+
# @return [Types::GetReadSetMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1431
|
+
#
|
1432
|
+
# * {Types::GetReadSetMetadataResponse#arn #arn} => String
|
1433
|
+
# * {Types::GetReadSetMetadataResponse#creation_time #creation_time} => Time
|
1434
|
+
# * {Types::GetReadSetMetadataResponse#description #description} => String
|
1435
|
+
# * {Types::GetReadSetMetadataResponse#file_type #file_type} => String
|
1436
|
+
# * {Types::GetReadSetMetadataResponse#files #files} => Types::ReadSetFiles
|
1437
|
+
# * {Types::GetReadSetMetadataResponse#id #id} => String
|
1438
|
+
# * {Types::GetReadSetMetadataResponse#name #name} => String
|
1439
|
+
# * {Types::GetReadSetMetadataResponse#reference_arn #reference_arn} => String
|
1440
|
+
# * {Types::GetReadSetMetadataResponse#sample_id #sample_id} => String
|
1441
|
+
# * {Types::GetReadSetMetadataResponse#sequence_information #sequence_information} => Types::SequenceInformation
|
1442
|
+
# * {Types::GetReadSetMetadataResponse#sequence_store_id #sequence_store_id} => String
|
1443
|
+
# * {Types::GetReadSetMetadataResponse#status #status} => String
|
1444
|
+
# * {Types::GetReadSetMetadataResponse#subject_id #subject_id} => String
|
1445
|
+
#
|
1446
|
+
# @example Request syntax with placeholder values
|
1447
|
+
#
|
1448
|
+
# resp = client.get_read_set_metadata({
|
1449
|
+
# id: "ReadSetId", # required
|
1450
|
+
# sequence_store_id: "SequenceStoreId", # required
|
1451
|
+
# })
|
1452
|
+
#
|
1453
|
+
# @example Response structure
|
1454
|
+
#
|
1455
|
+
# resp.arn #=> String
|
1456
|
+
# resp.creation_time #=> Time
|
1457
|
+
# resp.description #=> String
|
1458
|
+
# resp.file_type #=> String, one of "FASTQ", "BAM", "CRAM"
|
1459
|
+
# resp.files.index.content_length #=> Integer
|
1460
|
+
# resp.files.index.part_size #=> Integer
|
1461
|
+
# resp.files.index.total_parts #=> Integer
|
1462
|
+
# resp.files.source1.content_length #=> Integer
|
1463
|
+
# resp.files.source1.part_size #=> Integer
|
1464
|
+
# resp.files.source1.total_parts #=> Integer
|
1465
|
+
# resp.files.source2.content_length #=> Integer
|
1466
|
+
# resp.files.source2.part_size #=> Integer
|
1467
|
+
# resp.files.source2.total_parts #=> Integer
|
1468
|
+
# resp.id #=> String
|
1469
|
+
# resp.name #=> String
|
1470
|
+
# resp.reference_arn #=> String
|
1471
|
+
# resp.sample_id #=> String
|
1472
|
+
# resp.sequence_information.alignment #=> String
|
1473
|
+
# resp.sequence_information.generated_from #=> String
|
1474
|
+
# resp.sequence_information.total_base_count #=> Integer
|
1475
|
+
# resp.sequence_information.total_read_count #=> Integer
|
1476
|
+
# resp.sequence_store_id #=> String
|
1477
|
+
# resp.status #=> String, one of "ARCHIVED", "ACTIVATING", "ACTIVE", "DELETING", "DELETED"
|
1478
|
+
# resp.subject_id #=> String
|
1479
|
+
#
|
1480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetReadSetMetadata AWS API Documentation
|
1481
|
+
#
|
1482
|
+
# @overload get_read_set_metadata(params = {})
|
1483
|
+
# @param [Hash] params ({})
|
1484
|
+
def get_read_set_metadata(params = {}, options = {})
|
1485
|
+
req = build_request(:get_read_set_metadata, params)
|
1486
|
+
req.send_request(options)
|
1487
|
+
end
|
1488
|
+
|
1489
|
+
# Gets a reference file.
|
1490
|
+
#
|
1491
|
+
# @option params [String] :file
|
1492
|
+
# The file to retrieve.
|
1493
|
+
#
|
1494
|
+
# @option params [required, String] :id
|
1495
|
+
# The reference's ID.
|
1496
|
+
#
|
1497
|
+
# @option params [required, Integer] :part_number
|
1498
|
+
# The part number to retrieve.
|
1499
|
+
#
|
1500
|
+
# @option params [String] :range
|
1501
|
+
# The range to retrieve.
|
1502
|
+
#
|
1503
|
+
# @option params [required, String] :reference_store_id
|
1504
|
+
# The reference's store ID.
|
1505
|
+
#
|
1506
|
+
# @return [Types::GetReferenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1507
|
+
#
|
1508
|
+
# * {Types::GetReferenceResponse#payload #payload} => IO
|
1509
|
+
#
|
1510
|
+
# @example Request syntax with placeholder values
|
1511
|
+
#
|
1512
|
+
# resp = client.get_reference({
|
1513
|
+
# file: "SOURCE", # accepts SOURCE, INDEX
|
1514
|
+
# id: "ReferenceId", # required
|
1515
|
+
# part_number: 1, # required
|
1516
|
+
# range: "Range",
|
1517
|
+
# reference_store_id: "ReferenceStoreId", # required
|
1518
|
+
# })
|
1519
|
+
#
|
1520
|
+
# @example Response structure
|
1521
|
+
#
|
1522
|
+
# resp.payload #=> IO
|
1523
|
+
#
|
1524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetReference AWS API Documentation
|
1525
|
+
#
|
1526
|
+
# @overload get_reference(params = {})
|
1527
|
+
# @param [Hash] params ({})
|
1528
|
+
def get_reference(params = {}, options = {}, &block)
|
1529
|
+
req = build_request(:get_reference, params)
|
1530
|
+
req.send_request(options, &block)
|
1531
|
+
end
|
1532
|
+
|
1533
|
+
# Gets information about a reference import job.
|
1534
|
+
#
|
1535
|
+
# @option params [required, String] :id
|
1536
|
+
# The job's ID.
|
1537
|
+
#
|
1538
|
+
# @option params [required, String] :reference_store_id
|
1539
|
+
# The job's reference store ID.
|
1540
|
+
#
|
1541
|
+
# @return [Types::GetReferenceImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1542
|
+
#
|
1543
|
+
# * {Types::GetReferenceImportJobResponse#completion_time #completion_time} => Time
|
1544
|
+
# * {Types::GetReferenceImportJobResponse#creation_time #creation_time} => Time
|
1545
|
+
# * {Types::GetReferenceImportJobResponse#id #id} => String
|
1546
|
+
# * {Types::GetReferenceImportJobResponse#reference_store_id #reference_store_id} => String
|
1547
|
+
# * {Types::GetReferenceImportJobResponse#role_arn #role_arn} => String
|
1548
|
+
# * {Types::GetReferenceImportJobResponse#sources #sources} => Array<Types::ImportReferenceSourceItem>
|
1549
|
+
# * {Types::GetReferenceImportJobResponse#status #status} => String
|
1550
|
+
# * {Types::GetReferenceImportJobResponse#status_message #status_message} => String
|
1551
|
+
#
|
1552
|
+
# @example Request syntax with placeholder values
|
1553
|
+
#
|
1554
|
+
# resp = client.get_reference_import_job({
|
1555
|
+
# id: "ImportJobId", # required
|
1556
|
+
# reference_store_id: "ReferenceStoreId", # required
|
1557
|
+
# })
|
1558
|
+
#
|
1559
|
+
# @example Response structure
|
1560
|
+
#
|
1561
|
+
# resp.completion_time #=> Time
|
1562
|
+
# resp.creation_time #=> Time
|
1563
|
+
# resp.id #=> String
|
1564
|
+
# resp.reference_store_id #=> String
|
1565
|
+
# resp.role_arn #=> String
|
1566
|
+
# resp.sources #=> Array
|
1567
|
+
# resp.sources[0].description #=> String
|
1568
|
+
# resp.sources[0].name #=> String
|
1569
|
+
# resp.sources[0].source_file #=> String
|
1570
|
+
# resp.sources[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FINISHED", "FAILED"
|
1571
|
+
# resp.sources[0].status_message #=> String
|
1572
|
+
# resp.sources[0].tags #=> Hash
|
1573
|
+
# resp.sources[0].tags["TagKey"] #=> String
|
1574
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
1575
|
+
# resp.status_message #=> String
|
1576
|
+
#
|
1577
|
+
#
|
1578
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1579
|
+
#
|
1580
|
+
# * reference_import_job_completed
|
1581
|
+
#
|
1582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetReferenceImportJob AWS API Documentation
|
1583
|
+
#
|
1584
|
+
# @overload get_reference_import_job(params = {})
|
1585
|
+
# @param [Hash] params ({})
|
1586
|
+
def get_reference_import_job(params = {}, options = {})
|
1587
|
+
req = build_request(:get_reference_import_job, params)
|
1588
|
+
req.send_request(options)
|
1589
|
+
end
|
1590
|
+
|
1591
|
+
# Gets information about a genome reference's metadata.
|
1592
|
+
#
|
1593
|
+
# @option params [required, String] :id
|
1594
|
+
# The reference's ID.
|
1595
|
+
#
|
1596
|
+
# @option params [required, String] :reference_store_id
|
1597
|
+
# The reference's reference store ID.
|
1598
|
+
#
|
1599
|
+
# @return [Types::GetReferenceMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1600
|
+
#
|
1601
|
+
# * {Types::GetReferenceMetadataResponse#arn #arn} => String
|
1602
|
+
# * {Types::GetReferenceMetadataResponse#creation_time #creation_time} => Time
|
1603
|
+
# * {Types::GetReferenceMetadataResponse#description #description} => String
|
1604
|
+
# * {Types::GetReferenceMetadataResponse#files #files} => Types::ReferenceFiles
|
1605
|
+
# * {Types::GetReferenceMetadataResponse#id #id} => String
|
1606
|
+
# * {Types::GetReferenceMetadataResponse#md5 #md5} => String
|
1607
|
+
# * {Types::GetReferenceMetadataResponse#name #name} => String
|
1608
|
+
# * {Types::GetReferenceMetadataResponse#reference_store_id #reference_store_id} => String
|
1609
|
+
# * {Types::GetReferenceMetadataResponse#status #status} => String
|
1610
|
+
# * {Types::GetReferenceMetadataResponse#update_time #update_time} => Time
|
1611
|
+
#
|
1612
|
+
# @example Request syntax with placeholder values
|
1613
|
+
#
|
1614
|
+
# resp = client.get_reference_metadata({
|
1615
|
+
# id: "ReferenceId", # required
|
1616
|
+
# reference_store_id: "ReferenceStoreId", # required
|
1617
|
+
# })
|
1618
|
+
#
|
1619
|
+
# @example Response structure
|
1620
|
+
#
|
1621
|
+
# resp.arn #=> String
|
1622
|
+
# resp.creation_time #=> Time
|
1623
|
+
# resp.description #=> String
|
1624
|
+
# resp.files.index.content_length #=> Integer
|
1625
|
+
# resp.files.index.part_size #=> Integer
|
1626
|
+
# resp.files.index.total_parts #=> Integer
|
1627
|
+
# resp.files.source.content_length #=> Integer
|
1628
|
+
# resp.files.source.part_size #=> Integer
|
1629
|
+
# resp.files.source.total_parts #=> Integer
|
1630
|
+
# resp.id #=> String
|
1631
|
+
# resp.md5 #=> String
|
1632
|
+
# resp.name #=> String
|
1633
|
+
# resp.reference_store_id #=> String
|
1634
|
+
# resp.status #=> String, one of "ACTIVE", "DELETING", "DELETED"
|
1635
|
+
# resp.update_time #=> Time
|
1636
|
+
#
|
1637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetReferenceMetadata AWS API Documentation
|
1638
|
+
#
|
1639
|
+
# @overload get_reference_metadata(params = {})
|
1640
|
+
# @param [Hash] params ({})
|
1641
|
+
def get_reference_metadata(params = {}, options = {})
|
1642
|
+
req = build_request(:get_reference_metadata, params)
|
1643
|
+
req.send_request(options)
|
1644
|
+
end
|
1645
|
+
|
1646
|
+
# Gets information about a reference store.
|
1647
|
+
#
|
1648
|
+
# @option params [required, String] :id
|
1649
|
+
# The store's ID.
|
1650
|
+
#
|
1651
|
+
# @return [Types::GetReferenceStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1652
|
+
#
|
1653
|
+
# * {Types::GetReferenceStoreResponse#arn #arn} => String
|
1654
|
+
# * {Types::GetReferenceStoreResponse#creation_time #creation_time} => Time
|
1655
|
+
# * {Types::GetReferenceStoreResponse#description #description} => String
|
1656
|
+
# * {Types::GetReferenceStoreResponse#id #id} => String
|
1657
|
+
# * {Types::GetReferenceStoreResponse#name #name} => String
|
1658
|
+
# * {Types::GetReferenceStoreResponse#sse_config #sse_config} => Types::SseConfig
|
1659
|
+
#
|
1660
|
+
# @example Request syntax with placeholder values
|
1661
|
+
#
|
1662
|
+
# resp = client.get_reference_store({
|
1663
|
+
# id: "ReferenceStoreId", # required
|
1664
|
+
# })
|
1665
|
+
#
|
1666
|
+
# @example Response structure
|
1667
|
+
#
|
1668
|
+
# resp.arn #=> String
|
1669
|
+
# resp.creation_time #=> Time
|
1670
|
+
# resp.description #=> String
|
1671
|
+
# resp.id #=> String
|
1672
|
+
# resp.name #=> String
|
1673
|
+
# resp.sse_config.key_arn #=> String
|
1674
|
+
# resp.sse_config.type #=> String, one of "KMS"
|
1675
|
+
#
|
1676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetReferenceStore AWS API Documentation
|
1677
|
+
#
|
1678
|
+
# @overload get_reference_store(params = {})
|
1679
|
+
# @param [Hash] params ({})
|
1680
|
+
def get_reference_store(params = {}, options = {})
|
1681
|
+
req = build_request(:get_reference_store, params)
|
1682
|
+
req.send_request(options)
|
1683
|
+
end
|
1684
|
+
|
1685
|
+
# Gets information about a workflow run.
|
1686
|
+
#
|
1687
|
+
# @option params [Array<String>] :export
|
1688
|
+
# The run's export format.
|
1689
|
+
#
|
1690
|
+
# @option params [required, String] :id
|
1691
|
+
# The run's ID.
|
1692
|
+
#
|
1693
|
+
# @return [Types::GetRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1694
|
+
#
|
1695
|
+
# * {Types::GetRunResponse#arn #arn} => String
|
1696
|
+
# * {Types::GetRunResponse#creation_time #creation_time} => Time
|
1697
|
+
# * {Types::GetRunResponse#definition #definition} => String
|
1698
|
+
# * {Types::GetRunResponse#digest #digest} => String
|
1699
|
+
# * {Types::GetRunResponse#id #id} => String
|
1700
|
+
# * {Types::GetRunResponse#log_level #log_level} => String
|
1701
|
+
# * {Types::GetRunResponse#name #name} => String
|
1702
|
+
# * {Types::GetRunResponse#output_uri #output_uri} => String
|
1703
|
+
# * {Types::GetRunResponse#parameters #parameters} => Hash,Array,String,Numeric,Boolean
|
1704
|
+
# * {Types::GetRunResponse#priority #priority} => Integer
|
1705
|
+
# * {Types::GetRunResponse#resource_digests #resource_digests} => Hash<String,String>
|
1706
|
+
# * {Types::GetRunResponse#role_arn #role_arn} => String
|
1707
|
+
# * {Types::GetRunResponse#run_group_id #run_group_id} => String
|
1708
|
+
# * {Types::GetRunResponse#run_id #run_id} => String
|
1709
|
+
# * {Types::GetRunResponse#start_time #start_time} => Time
|
1710
|
+
# * {Types::GetRunResponse#started_by #started_by} => String
|
1711
|
+
# * {Types::GetRunResponse#status #status} => String
|
1712
|
+
# * {Types::GetRunResponse#status_message #status_message} => String
|
1713
|
+
# * {Types::GetRunResponse#stop_time #stop_time} => Time
|
1714
|
+
# * {Types::GetRunResponse#storage_capacity #storage_capacity} => Integer
|
1715
|
+
# * {Types::GetRunResponse#tags #tags} => Hash<String,String>
|
1716
|
+
# * {Types::GetRunResponse#workflow_id #workflow_id} => String
|
1717
|
+
# * {Types::GetRunResponse#workflow_type #workflow_type} => String
|
1718
|
+
#
|
1719
|
+
# @example Request syntax with placeholder values
|
1720
|
+
#
|
1721
|
+
# resp = client.get_run({
|
1722
|
+
# export: ["DEFINITION"], # accepts DEFINITION
|
1723
|
+
# id: "RunId", # required
|
1724
|
+
# })
|
1725
|
+
#
|
1726
|
+
# @example Response structure
|
1727
|
+
#
|
1728
|
+
# resp.arn #=> String
|
1729
|
+
# resp.creation_time #=> Time
|
1730
|
+
# resp.definition #=> String
|
1731
|
+
# resp.digest #=> String
|
1732
|
+
# resp.id #=> String
|
1733
|
+
# resp.log_level #=> String, one of "OFF", "FATAL", "ERROR", "ALL"
|
1734
|
+
# resp.name #=> String
|
1735
|
+
# resp.output_uri #=> String
|
1736
|
+
# resp.priority #=> Integer
|
1737
|
+
# resp.resource_digests #=> Hash
|
1738
|
+
# resp.resource_digests["RunResourceDigestKey"] #=> String
|
1739
|
+
# resp.role_arn #=> String
|
1740
|
+
# resp.run_group_id #=> String
|
1741
|
+
# resp.run_id #=> String
|
1742
|
+
# resp.start_time #=> Time
|
1743
|
+
# resp.started_by #=> String
|
1744
|
+
# resp.status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "DELETED", "CANCELLED", "FAILED"
|
1745
|
+
# resp.status_message #=> String
|
1746
|
+
# resp.stop_time #=> Time
|
1747
|
+
# resp.storage_capacity #=> Integer
|
1748
|
+
# resp.tags #=> Hash
|
1749
|
+
# resp.tags["TagKey"] #=> String
|
1750
|
+
# resp.workflow_id #=> String
|
1751
|
+
# resp.workflow_type #=> String, one of "PRIVATE"
|
1752
|
+
#
|
1753
|
+
#
|
1754
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1755
|
+
#
|
1756
|
+
# * run_completed
|
1757
|
+
# * run_running
|
1758
|
+
#
|
1759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetRun AWS API Documentation
|
1760
|
+
#
|
1761
|
+
# @overload get_run(params = {})
|
1762
|
+
# @param [Hash] params ({})
|
1763
|
+
def get_run(params = {}, options = {})
|
1764
|
+
req = build_request(:get_run, params)
|
1765
|
+
req.send_request(options)
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
# Gets information about a workflow run group.
|
1769
|
+
#
|
1770
|
+
# @option params [required, String] :id
|
1771
|
+
# The group's ID.
|
1772
|
+
#
|
1773
|
+
# @return [Types::GetRunGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1774
|
+
#
|
1775
|
+
# * {Types::GetRunGroupResponse#arn #arn} => String
|
1776
|
+
# * {Types::GetRunGroupResponse#creation_time #creation_time} => Time
|
1777
|
+
# * {Types::GetRunGroupResponse#id #id} => String
|
1778
|
+
# * {Types::GetRunGroupResponse#max_cpus #max_cpus} => Integer
|
1779
|
+
# * {Types::GetRunGroupResponse#max_duration #max_duration} => Integer
|
1780
|
+
# * {Types::GetRunGroupResponse#max_runs #max_runs} => Integer
|
1781
|
+
# * {Types::GetRunGroupResponse#name #name} => String
|
1782
|
+
# * {Types::GetRunGroupResponse#tags #tags} => Hash<String,String>
|
1783
|
+
#
|
1784
|
+
# @example Request syntax with placeholder values
|
1785
|
+
#
|
1786
|
+
# resp = client.get_run_group({
|
1787
|
+
# id: "RunGroupId", # required
|
1788
|
+
# })
|
1789
|
+
#
|
1790
|
+
# @example Response structure
|
1791
|
+
#
|
1792
|
+
# resp.arn #=> String
|
1793
|
+
# resp.creation_time #=> Time
|
1794
|
+
# resp.id #=> String
|
1795
|
+
# resp.max_cpus #=> Integer
|
1796
|
+
# resp.max_duration #=> Integer
|
1797
|
+
# resp.max_runs #=> Integer
|
1798
|
+
# resp.name #=> String
|
1799
|
+
# resp.tags #=> Hash
|
1800
|
+
# resp.tags["TagKey"] #=> String
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetRunGroup AWS API Documentation
|
1803
|
+
#
|
1804
|
+
# @overload get_run_group(params = {})
|
1805
|
+
# @param [Hash] params ({})
|
1806
|
+
def get_run_group(params = {}, options = {})
|
1807
|
+
req = build_request(:get_run_group, params)
|
1808
|
+
req.send_request(options)
|
1809
|
+
end
|
1810
|
+
|
1811
|
+
# Gets information about a workflow run task.
|
1812
|
+
#
|
1813
|
+
# @option params [required, String] :id
|
1814
|
+
# The task's ID.
|
1815
|
+
#
|
1816
|
+
# @option params [required, String] :task_id
|
1817
|
+
# The task's ID.
|
1818
|
+
#
|
1819
|
+
# @return [Types::GetRunTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1820
|
+
#
|
1821
|
+
# * {Types::GetRunTaskResponse#cpus #cpus} => Integer
|
1822
|
+
# * {Types::GetRunTaskResponse#creation_time #creation_time} => Time
|
1823
|
+
# * {Types::GetRunTaskResponse#log_stream #log_stream} => String
|
1824
|
+
# * {Types::GetRunTaskResponse#memory #memory} => Integer
|
1825
|
+
# * {Types::GetRunTaskResponse#name #name} => String
|
1826
|
+
# * {Types::GetRunTaskResponse#start_time #start_time} => Time
|
1827
|
+
# * {Types::GetRunTaskResponse#status #status} => String
|
1828
|
+
# * {Types::GetRunTaskResponse#status_message #status_message} => String
|
1829
|
+
# * {Types::GetRunTaskResponse#stop_time #stop_time} => Time
|
1830
|
+
# * {Types::GetRunTaskResponse#task_id #task_id} => String
|
1831
|
+
#
|
1832
|
+
# @example Request syntax with placeholder values
|
1833
|
+
#
|
1834
|
+
# resp = client.get_run_task({
|
1835
|
+
# id: "RunId", # required
|
1836
|
+
# task_id: "TaskId", # required
|
1837
|
+
# })
|
1838
|
+
#
|
1839
|
+
# @example Response structure
|
1840
|
+
#
|
1841
|
+
# resp.cpus #=> Integer
|
1842
|
+
# resp.creation_time #=> Time
|
1843
|
+
# resp.log_stream #=> String
|
1844
|
+
# resp.memory #=> Integer
|
1845
|
+
# resp.name #=> String
|
1846
|
+
# resp.start_time #=> Time
|
1847
|
+
# resp.status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "CANCELLED", "FAILED"
|
1848
|
+
# resp.status_message #=> String
|
1849
|
+
# resp.stop_time #=> Time
|
1850
|
+
# resp.task_id #=> String
|
1851
|
+
#
|
1852
|
+
#
|
1853
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1854
|
+
#
|
1855
|
+
# * task_completed
|
1856
|
+
# * task_running
|
1857
|
+
#
|
1858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetRunTask AWS API Documentation
|
1859
|
+
#
|
1860
|
+
# @overload get_run_task(params = {})
|
1861
|
+
# @param [Hash] params ({})
|
1862
|
+
def get_run_task(params = {}, options = {})
|
1863
|
+
req = build_request(:get_run_task, params)
|
1864
|
+
req.send_request(options)
|
1865
|
+
end
|
1866
|
+
|
1867
|
+
# Gets information about a sequence store.
|
1868
|
+
#
|
1869
|
+
# @option params [required, String] :id
|
1870
|
+
# The store's ID.
|
1871
|
+
#
|
1872
|
+
# @return [Types::GetSequenceStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1873
|
+
#
|
1874
|
+
# * {Types::GetSequenceStoreResponse#arn #arn} => String
|
1875
|
+
# * {Types::GetSequenceStoreResponse#creation_time #creation_time} => Time
|
1876
|
+
# * {Types::GetSequenceStoreResponse#description #description} => String
|
1877
|
+
# * {Types::GetSequenceStoreResponse#id #id} => String
|
1878
|
+
# * {Types::GetSequenceStoreResponse#name #name} => String
|
1879
|
+
# * {Types::GetSequenceStoreResponse#sse_config #sse_config} => Types::SseConfig
|
1880
|
+
#
|
1881
|
+
# @example Request syntax with placeholder values
|
1882
|
+
#
|
1883
|
+
# resp = client.get_sequence_store({
|
1884
|
+
# id: "SequenceStoreId", # required
|
1885
|
+
# })
|
1886
|
+
#
|
1887
|
+
# @example Response structure
|
1888
|
+
#
|
1889
|
+
# resp.arn #=> String
|
1890
|
+
# resp.creation_time #=> Time
|
1891
|
+
# resp.description #=> String
|
1892
|
+
# resp.id #=> String
|
1893
|
+
# resp.name #=> String
|
1894
|
+
# resp.sse_config.key_arn #=> String
|
1895
|
+
# resp.sse_config.type #=> String, one of "KMS"
|
1896
|
+
#
|
1897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetSequenceStore AWS API Documentation
|
1898
|
+
#
|
1899
|
+
# @overload get_sequence_store(params = {})
|
1900
|
+
# @param [Hash] params ({})
|
1901
|
+
def get_sequence_store(params = {}, options = {})
|
1902
|
+
req = build_request(:get_sequence_store, params)
|
1903
|
+
req.send_request(options)
|
1904
|
+
end
|
1905
|
+
|
1906
|
+
# Gets information about a variant import job.
|
1907
|
+
#
|
1908
|
+
# @option params [required, String] :job_id
|
1909
|
+
# The job's ID.
|
1910
|
+
#
|
1911
|
+
# @return [Types::GetVariantImportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1912
|
+
#
|
1913
|
+
# * {Types::GetVariantImportResponse#completion_time #completion_time} => Time
|
1914
|
+
# * {Types::GetVariantImportResponse#creation_time #creation_time} => Time
|
1915
|
+
# * {Types::GetVariantImportResponse#destination_name #destination_name} => String
|
1916
|
+
# * {Types::GetVariantImportResponse#id #id} => String
|
1917
|
+
# * {Types::GetVariantImportResponse#items #items} => Array<Types::VariantImportItemDetail>
|
1918
|
+
# * {Types::GetVariantImportResponse#role_arn #role_arn} => String
|
1919
|
+
# * {Types::GetVariantImportResponse#run_left_normalization #run_left_normalization} => Boolean
|
1920
|
+
# * {Types::GetVariantImportResponse#status #status} => String
|
1921
|
+
# * {Types::GetVariantImportResponse#status_message #status_message} => String
|
1922
|
+
# * {Types::GetVariantImportResponse#update_time #update_time} => Time
|
1923
|
+
#
|
1924
|
+
# @example Request syntax with placeholder values
|
1925
|
+
#
|
1926
|
+
# resp = client.get_variant_import_job({
|
1927
|
+
# job_id: "ResourceId", # required
|
1928
|
+
# })
|
1929
|
+
#
|
1930
|
+
# @example Response structure
|
1931
|
+
#
|
1932
|
+
# resp.completion_time #=> Time
|
1933
|
+
# resp.creation_time #=> Time
|
1934
|
+
# resp.destination_name #=> String
|
1935
|
+
# resp.id #=> String
|
1936
|
+
# resp.items #=> Array
|
1937
|
+
# resp.items[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED"
|
1938
|
+
# resp.items[0].source #=> String
|
1939
|
+
# resp.role_arn #=> String
|
1940
|
+
# resp.run_left_normalization #=> Boolean
|
1941
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED"
|
1942
|
+
# resp.status_message #=> String
|
1943
|
+
# resp.update_time #=> Time
|
1944
|
+
#
|
1945
|
+
#
|
1946
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1947
|
+
#
|
1948
|
+
# * variant_import_job_created
|
1949
|
+
#
|
1950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetVariantImportJob AWS API Documentation
|
1951
|
+
#
|
1952
|
+
# @overload get_variant_import_job(params = {})
|
1953
|
+
# @param [Hash] params ({})
|
1954
|
+
def get_variant_import_job(params = {}, options = {})
|
1955
|
+
req = build_request(:get_variant_import_job, params)
|
1956
|
+
req.send_request(options)
|
1957
|
+
end
|
1958
|
+
|
1959
|
+
# Gets information about a variant store.
|
1960
|
+
#
|
1961
|
+
# @option params [required, String] :name
|
1962
|
+
# The store's name.
|
1963
|
+
#
|
1964
|
+
# @return [Types::GetVariantStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1965
|
+
#
|
1966
|
+
# * {Types::GetVariantStoreResponse#creation_time #creation_time} => Time
|
1967
|
+
# * {Types::GetVariantStoreResponse#description #description} => String
|
1968
|
+
# * {Types::GetVariantStoreResponse#id #id} => String
|
1969
|
+
# * {Types::GetVariantStoreResponse#name #name} => String
|
1970
|
+
# * {Types::GetVariantStoreResponse#reference #reference} => Types::ReferenceItem
|
1971
|
+
# * {Types::GetVariantStoreResponse#sse_config #sse_config} => Types::SseConfig
|
1972
|
+
# * {Types::GetVariantStoreResponse#status #status} => String
|
1973
|
+
# * {Types::GetVariantStoreResponse#status_message #status_message} => String
|
1974
|
+
# * {Types::GetVariantStoreResponse#store_arn #store_arn} => String
|
1975
|
+
# * {Types::GetVariantStoreResponse#store_size_bytes #store_size_bytes} => Integer
|
1976
|
+
# * {Types::GetVariantStoreResponse#tags #tags} => Hash<String,String>
|
1977
|
+
# * {Types::GetVariantStoreResponse#update_time #update_time} => Time
|
1978
|
+
#
|
1979
|
+
# @example Request syntax with placeholder values
|
1980
|
+
#
|
1981
|
+
# resp = client.get_variant_store({
|
1982
|
+
# name: "String", # required
|
1983
|
+
# })
|
1984
|
+
#
|
1985
|
+
# @example Response structure
|
1986
|
+
#
|
1987
|
+
# resp.creation_time #=> Time
|
1988
|
+
# resp.description #=> String
|
1989
|
+
# resp.id #=> String
|
1990
|
+
# resp.name #=> String
|
1991
|
+
# resp.reference.reference_arn #=> String
|
1992
|
+
# resp.sse_config.key_arn #=> String
|
1993
|
+
# resp.sse_config.type #=> String, one of "KMS"
|
1994
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
1995
|
+
# resp.status_message #=> String
|
1996
|
+
# resp.store_arn #=> String
|
1997
|
+
# resp.store_size_bytes #=> Integer
|
1998
|
+
# resp.tags #=> Hash
|
1999
|
+
# resp.tags["TagKey"] #=> String
|
2000
|
+
# resp.update_time #=> Time
|
2001
|
+
#
|
2002
|
+
#
|
2003
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
2004
|
+
#
|
2005
|
+
# * variant_store_created
|
2006
|
+
# * variant_store_deleted
|
2007
|
+
#
|
2008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetVariantStore AWS API Documentation
|
2009
|
+
#
|
2010
|
+
# @overload get_variant_store(params = {})
|
2011
|
+
# @param [Hash] params ({})
|
2012
|
+
def get_variant_store(params = {}, options = {})
|
2013
|
+
req = build_request(:get_variant_store, params)
|
2014
|
+
req.send_request(options)
|
2015
|
+
end
|
2016
|
+
|
2017
|
+
# Gets information about a workflow.
|
2018
|
+
#
|
2019
|
+
# @option params [Array<String>] :export
|
2020
|
+
# The export format for the workflow.
|
2021
|
+
#
|
2022
|
+
# @option params [required, String] :id
|
2023
|
+
# The workflow's ID.
|
2024
|
+
#
|
2025
|
+
# @option params [String] :type
|
2026
|
+
# The workflow's type.
|
2027
|
+
#
|
2028
|
+
# @return [Types::GetWorkflowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2029
|
+
#
|
2030
|
+
# * {Types::GetWorkflowResponse#arn #arn} => String
|
2031
|
+
# * {Types::GetWorkflowResponse#creation_time #creation_time} => Time
|
2032
|
+
# * {Types::GetWorkflowResponse#definition #definition} => String
|
2033
|
+
# * {Types::GetWorkflowResponse#description #description} => String
|
2034
|
+
# * {Types::GetWorkflowResponse#digest #digest} => String
|
2035
|
+
# * {Types::GetWorkflowResponse#engine #engine} => String
|
2036
|
+
# * {Types::GetWorkflowResponse#id #id} => String
|
2037
|
+
# * {Types::GetWorkflowResponse#main #main} => String
|
2038
|
+
# * {Types::GetWorkflowResponse#name #name} => String
|
2039
|
+
# * {Types::GetWorkflowResponse#parameter_template #parameter_template} => Hash<String,Types::WorkflowParameter>
|
2040
|
+
# * {Types::GetWorkflowResponse#status #status} => String
|
2041
|
+
# * {Types::GetWorkflowResponse#status_message #status_message} => String
|
2042
|
+
# * {Types::GetWorkflowResponse#storage_capacity #storage_capacity} => Integer
|
2043
|
+
# * {Types::GetWorkflowResponse#tags #tags} => Hash<String,String>
|
2044
|
+
# * {Types::GetWorkflowResponse#type #type} => String
|
2045
|
+
#
|
2046
|
+
# @example Request syntax with placeholder values
|
2047
|
+
#
|
2048
|
+
# resp = client.get_workflow({
|
2049
|
+
# export: ["DEFINITION"], # accepts DEFINITION
|
2050
|
+
# id: "WorkflowId", # required
|
2051
|
+
# type: "PRIVATE", # accepts PRIVATE
|
2052
|
+
# })
|
2053
|
+
#
|
2054
|
+
# @example Response structure
|
2055
|
+
#
|
2056
|
+
# resp.arn #=> String
|
2057
|
+
# resp.creation_time #=> Time
|
2058
|
+
# resp.definition #=> String
|
2059
|
+
# resp.description #=> String
|
2060
|
+
# resp.digest #=> String
|
2061
|
+
# resp.engine #=> String, one of "WDL", "NEXTFLOW"
|
2062
|
+
# resp.id #=> String
|
2063
|
+
# resp.main #=> String
|
2064
|
+
# resp.name #=> String
|
2065
|
+
# resp.parameter_template #=> Hash
|
2066
|
+
# resp.parameter_template["WorkflowParameterName"].description #=> String
|
2067
|
+
# resp.parameter_template["WorkflowParameterName"].optional #=> Boolean
|
2068
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETED", "FAILED"
|
2069
|
+
# resp.status_message #=> String
|
2070
|
+
# resp.storage_capacity #=> Integer
|
2071
|
+
# resp.tags #=> Hash
|
2072
|
+
# resp.tags["TagKey"] #=> String
|
2073
|
+
# resp.type #=> String, one of "PRIVATE"
|
2074
|
+
#
|
2075
|
+
#
|
2076
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
2077
|
+
#
|
2078
|
+
# * workflow_active
|
2079
|
+
#
|
2080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetWorkflow AWS API Documentation
|
2081
|
+
#
|
2082
|
+
# @overload get_workflow(params = {})
|
2083
|
+
# @param [Hash] params ({})
|
2084
|
+
def get_workflow(params = {}, options = {})
|
2085
|
+
req = build_request(:get_workflow, params)
|
2086
|
+
req.send_request(options)
|
2087
|
+
end
|
2088
|
+
|
2089
|
+
# Retrieves a list of annotation import jobs.
|
2090
|
+
#
|
2091
|
+
# @option params [Types::ListAnnotationImportJobsFilter] :filter
|
2092
|
+
# A filter to apply to the list.
|
2093
|
+
#
|
2094
|
+
# @option params [Array<String>] :ids
|
2095
|
+
# IDs of annotation import jobs to retrieve.
|
2096
|
+
#
|
2097
|
+
# @option params [Integer] :max_results
|
2098
|
+
# The maximum number of jobs to return in one page of results.
|
2099
|
+
#
|
2100
|
+
# @option params [String] :next_token
|
2101
|
+
# Specify the pagination token from a previous request to retrieve the
|
2102
|
+
# next page of results.
|
2103
|
+
#
|
2104
|
+
# @return [Types::ListAnnotationImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2105
|
+
#
|
2106
|
+
# * {Types::ListAnnotationImportJobsResponse#annotation_import_jobs #annotation_import_jobs} => Array<Types::AnnotationImportJobItem>
|
2107
|
+
# * {Types::ListAnnotationImportJobsResponse#next_token #next_token} => String
|
2108
|
+
#
|
2109
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2110
|
+
#
|
2111
|
+
# @example Request syntax with placeholder values
|
2112
|
+
#
|
2113
|
+
# resp = client.list_annotation_import_jobs({
|
2114
|
+
# filter: {
|
2115
|
+
# status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED
|
2116
|
+
# store_name: "String",
|
2117
|
+
# },
|
2118
|
+
# ids: ["ResourceIdentifier"],
|
2119
|
+
# max_results: 1,
|
2120
|
+
# next_token: "ListAnnotationImportJobsRequestNextTokenString",
|
2121
|
+
# })
|
2122
|
+
#
|
2123
|
+
# @example Response structure
|
2124
|
+
#
|
2125
|
+
# resp.annotation_import_jobs #=> Array
|
2126
|
+
# resp.annotation_import_jobs[0].completion_time #=> Time
|
2127
|
+
# resp.annotation_import_jobs[0].creation_time #=> Time
|
2128
|
+
# resp.annotation_import_jobs[0].destination_name #=> String
|
2129
|
+
# resp.annotation_import_jobs[0].id #=> String
|
2130
|
+
# resp.annotation_import_jobs[0].role_arn #=> String
|
2131
|
+
# resp.annotation_import_jobs[0].run_left_normalization #=> Boolean
|
2132
|
+
# resp.annotation_import_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED"
|
2133
|
+
# resp.annotation_import_jobs[0].update_time #=> Time
|
2134
|
+
# resp.next_token #=> String
|
2135
|
+
#
|
2136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListAnnotationImportJobs AWS API Documentation
|
2137
|
+
#
|
2138
|
+
# @overload list_annotation_import_jobs(params = {})
|
2139
|
+
# @param [Hash] params ({})
|
2140
|
+
def list_annotation_import_jobs(params = {}, options = {})
|
2141
|
+
req = build_request(:list_annotation_import_jobs, params)
|
2142
|
+
req.send_request(options)
|
2143
|
+
end
|
2144
|
+
|
2145
|
+
# Retrieves a list of annotation stores.
|
2146
|
+
#
|
2147
|
+
# @option params [Types::ListAnnotationStoresFilter] :filter
|
2148
|
+
# A filter to apply to the list.
|
2149
|
+
#
|
2150
|
+
# @option params [Array<String>] :ids
|
2151
|
+
# IDs of stores to list.
|
2152
|
+
#
|
2153
|
+
# @option params [Integer] :max_results
|
2154
|
+
# The maximum number of stores to return in one page of results.
|
2155
|
+
#
|
2156
|
+
# @option params [String] :next_token
|
2157
|
+
# Specify the pagination token from a previous request to retrieve the
|
2158
|
+
# next page of results.
|
2159
|
+
#
|
2160
|
+
# @return [Types::ListAnnotationStoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2161
|
+
#
|
2162
|
+
# * {Types::ListAnnotationStoresResponse#annotation_stores #annotation_stores} => Array<Types::AnnotationStoreItem>
|
2163
|
+
# * {Types::ListAnnotationStoresResponse#next_token #next_token} => String
|
2164
|
+
#
|
2165
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2166
|
+
#
|
2167
|
+
# @example Request syntax with placeholder values
|
2168
|
+
#
|
2169
|
+
# resp = client.list_annotation_stores({
|
2170
|
+
# filter: {
|
2171
|
+
# status: "CREATING", # accepts CREATING, UPDATING, DELETING, ACTIVE, FAILED
|
2172
|
+
# },
|
2173
|
+
# ids: ["ResourceIdentifier"],
|
2174
|
+
# max_results: 1,
|
2175
|
+
# next_token: "ListAnnotationStoresRequestNextTokenString",
|
2176
|
+
# })
|
2177
|
+
#
|
2178
|
+
# @example Response structure
|
2179
|
+
#
|
2180
|
+
# resp.annotation_stores #=> Array
|
2181
|
+
# resp.annotation_stores[0].creation_time #=> Time
|
2182
|
+
# resp.annotation_stores[0].description #=> String
|
2183
|
+
# resp.annotation_stores[0].id #=> String
|
2184
|
+
# resp.annotation_stores[0].name #=> String
|
2185
|
+
# resp.annotation_stores[0].reference.reference_arn #=> String
|
2186
|
+
# resp.annotation_stores[0].sse_config.key_arn #=> String
|
2187
|
+
# resp.annotation_stores[0].sse_config.type #=> String, one of "KMS"
|
2188
|
+
# resp.annotation_stores[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
2189
|
+
# resp.annotation_stores[0].status_message #=> String
|
2190
|
+
# resp.annotation_stores[0].store_arn #=> String
|
2191
|
+
# resp.annotation_stores[0].store_format #=> String, one of "GFF", "TSV", "VCF"
|
2192
|
+
# resp.annotation_stores[0].store_size_bytes #=> Integer
|
2193
|
+
# resp.annotation_stores[0].update_time #=> Time
|
2194
|
+
# resp.next_token #=> String
|
2195
|
+
#
|
2196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListAnnotationStores AWS API Documentation
|
2197
|
+
#
|
2198
|
+
# @overload list_annotation_stores(params = {})
|
2199
|
+
# @param [Hash] params ({})
|
2200
|
+
def list_annotation_stores(params = {}, options = {})
|
2201
|
+
req = build_request(:list_annotation_stores, params)
|
2202
|
+
req.send_request(options)
|
2203
|
+
end
|
2204
|
+
|
2205
|
+
# Retrieves a list of read set activation jobs.
|
2206
|
+
#
|
2207
|
+
# @option params [Types::ActivateReadSetFilter] :filter
|
2208
|
+
# A filter to apply to the list.
|
2209
|
+
#
|
2210
|
+
# @option params [Integer] :max_results
|
2211
|
+
# The maximum number of read set activation jobs to return in one page
|
2212
|
+
# of results.
|
2213
|
+
#
|
2214
|
+
# @option params [String] :next_token
|
2215
|
+
# Specify the pagination token from a previous request to retrieve the
|
2216
|
+
# next page of results.
|
2217
|
+
#
|
2218
|
+
# @option params [required, String] :sequence_store_id
|
2219
|
+
# The read set's sequence store ID.
|
2220
|
+
#
|
2221
|
+
# @return [Types::ListReadSetActivationJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2222
|
+
#
|
2223
|
+
# * {Types::ListReadSetActivationJobsResponse#activation_jobs #activation_jobs} => Array<Types::ActivateReadSetJobItem>
|
2224
|
+
# * {Types::ListReadSetActivationJobsResponse#next_token #next_token} => String
|
2225
|
+
#
|
2226
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2227
|
+
#
|
2228
|
+
# @example Request syntax with placeholder values
|
2229
|
+
#
|
2230
|
+
# resp = client.list_read_set_activation_jobs({
|
2231
|
+
# filter: {
|
2232
|
+
# created_after: Time.now,
|
2233
|
+
# created_before: Time.now,
|
2234
|
+
# status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES
|
2235
|
+
# },
|
2236
|
+
# max_results: 1,
|
2237
|
+
# next_token: "NextToken",
|
2238
|
+
# sequence_store_id: "SequenceStoreId", # required
|
2239
|
+
# })
|
2240
|
+
#
|
2241
|
+
# @example Response structure
|
2242
|
+
#
|
2243
|
+
# resp.activation_jobs #=> Array
|
2244
|
+
# resp.activation_jobs[0].completion_time #=> Time
|
2245
|
+
# resp.activation_jobs[0].creation_time #=> Time
|
2246
|
+
# resp.activation_jobs[0].id #=> String
|
2247
|
+
# resp.activation_jobs[0].sequence_store_id #=> String
|
2248
|
+
# resp.activation_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
2249
|
+
# resp.next_token #=> String
|
2250
|
+
#
|
2251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListReadSetActivationJobs AWS API Documentation
|
2252
|
+
#
|
2253
|
+
# @overload list_read_set_activation_jobs(params = {})
|
2254
|
+
# @param [Hash] params ({})
|
2255
|
+
def list_read_set_activation_jobs(params = {}, options = {})
|
2256
|
+
req = build_request(:list_read_set_activation_jobs, params)
|
2257
|
+
req.send_request(options)
|
2258
|
+
end
|
2259
|
+
|
2260
|
+
# Retrieves a list of read set export jobs.
|
2261
|
+
#
|
2262
|
+
# @option params [Types::ExportReadSetFilter] :filter
|
2263
|
+
# A filter to apply to the list.
|
2264
|
+
#
|
2265
|
+
# @option params [Integer] :max_results
|
2266
|
+
# The maximum number of jobs to return in one page of results.
|
2267
|
+
#
|
2268
|
+
# @option params [String] :next_token
|
2269
|
+
# Specify the pagination token from a previous request to retrieve the
|
2270
|
+
# next page of results.
|
2271
|
+
#
|
2272
|
+
# @option params [required, String] :sequence_store_id
|
2273
|
+
# The jobs' sequence store ID.
|
2274
|
+
#
|
2275
|
+
# @return [Types::ListReadSetExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2276
|
+
#
|
2277
|
+
# * {Types::ListReadSetExportJobsResponse#export_jobs #export_jobs} => Array<Types::ExportReadSetJobDetail>
|
2278
|
+
# * {Types::ListReadSetExportJobsResponse#next_token #next_token} => String
|
2279
|
+
#
|
2280
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2281
|
+
#
|
2282
|
+
# @example Request syntax with placeholder values
|
2283
|
+
#
|
2284
|
+
# resp = client.list_read_set_export_jobs({
|
2285
|
+
# filter: {
|
2286
|
+
# created_after: Time.now,
|
2287
|
+
# created_before: Time.now,
|
2288
|
+
# status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES
|
2289
|
+
# },
|
2290
|
+
# max_results: 1,
|
2291
|
+
# next_token: "NextToken",
|
2292
|
+
# sequence_store_id: "SequenceStoreId", # required
|
2293
|
+
# })
|
2294
|
+
#
|
2295
|
+
# @example Response structure
|
2296
|
+
#
|
2297
|
+
# resp.export_jobs #=> Array
|
2298
|
+
# resp.export_jobs[0].completion_time #=> Time
|
2299
|
+
# resp.export_jobs[0].creation_time #=> Time
|
2300
|
+
# resp.export_jobs[0].destination #=> String
|
2301
|
+
# resp.export_jobs[0].id #=> String
|
2302
|
+
# resp.export_jobs[0].sequence_store_id #=> String
|
2303
|
+
# resp.export_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
2304
|
+
# resp.next_token #=> String
|
2305
|
+
#
|
2306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListReadSetExportJobs AWS API Documentation
|
2307
|
+
#
|
2308
|
+
# @overload list_read_set_export_jobs(params = {})
|
2309
|
+
# @param [Hash] params ({})
|
2310
|
+
def list_read_set_export_jobs(params = {}, options = {})
|
2311
|
+
req = build_request(:list_read_set_export_jobs, params)
|
2312
|
+
req.send_request(options)
|
2313
|
+
end
|
2314
|
+
|
2315
|
+
# Retrieves a list of read set import jobs.
|
2316
|
+
#
|
2317
|
+
# @option params [Types::ImportReadSetFilter] :filter
|
2318
|
+
# A filter to apply to the list.
|
2319
|
+
#
|
2320
|
+
# @option params [Integer] :max_results
|
2321
|
+
# The maximum number of jobs to return in one page of results.
|
2322
|
+
#
|
2323
|
+
# @option params [String] :next_token
|
2324
|
+
# Specify the pagination token from a previous request to retrieve the
|
2325
|
+
# next page of results.
|
2326
|
+
#
|
2327
|
+
# @option params [required, String] :sequence_store_id
|
2328
|
+
# The jobs' sequence store ID.
|
2329
|
+
#
|
2330
|
+
# @return [Types::ListReadSetImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2331
|
+
#
|
2332
|
+
# * {Types::ListReadSetImportJobsResponse#import_jobs #import_jobs} => Array<Types::ImportReadSetJobItem>
|
2333
|
+
# * {Types::ListReadSetImportJobsResponse#next_token #next_token} => String
|
2334
|
+
#
|
2335
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2336
|
+
#
|
2337
|
+
# @example Request syntax with placeholder values
|
2338
|
+
#
|
2339
|
+
# resp = client.list_read_set_import_jobs({
|
2340
|
+
# filter: {
|
2341
|
+
# created_after: Time.now,
|
2342
|
+
# created_before: Time.now,
|
2343
|
+
# status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES
|
2344
|
+
# },
|
2345
|
+
# max_results: 1,
|
2346
|
+
# next_token: "NextToken",
|
2347
|
+
# sequence_store_id: "SequenceStoreId", # required
|
2348
|
+
# })
|
2349
|
+
#
|
2350
|
+
# @example Response structure
|
2351
|
+
#
|
2352
|
+
# resp.import_jobs #=> Array
|
2353
|
+
# resp.import_jobs[0].completion_time #=> Time
|
2354
|
+
# resp.import_jobs[0].creation_time #=> Time
|
2355
|
+
# resp.import_jobs[0].id #=> String
|
2356
|
+
# resp.import_jobs[0].role_arn #=> String
|
2357
|
+
# resp.import_jobs[0].sequence_store_id #=> String
|
2358
|
+
# resp.import_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
2359
|
+
# resp.next_token #=> String
|
2360
|
+
#
|
2361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListReadSetImportJobs AWS API Documentation
|
2362
|
+
#
|
2363
|
+
# @overload list_read_set_import_jobs(params = {})
|
2364
|
+
# @param [Hash] params ({})
|
2365
|
+
def list_read_set_import_jobs(params = {}, options = {})
|
2366
|
+
req = build_request(:list_read_set_import_jobs, params)
|
2367
|
+
req.send_request(options)
|
2368
|
+
end
|
2369
|
+
|
2370
|
+
# Retrieves a list of read sets.
|
2371
|
+
#
|
2372
|
+
# @option params [Types::ReadSetFilter] :filter
|
2373
|
+
# A filter to apply to the list.
|
2374
|
+
#
|
2375
|
+
# @option params [Integer] :max_results
|
2376
|
+
# The maximum number of read sets to return in one page of results.
|
2377
|
+
#
|
2378
|
+
# @option params [String] :next_token
|
2379
|
+
# Specify the pagination token from a previous request to retrieve the
|
2380
|
+
# next page of results.
|
2381
|
+
#
|
2382
|
+
# @option params [required, String] :sequence_store_id
|
2383
|
+
# The jobs' sequence store ID.
|
2384
|
+
#
|
2385
|
+
# @return [Types::ListReadSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2386
|
+
#
|
2387
|
+
# * {Types::ListReadSetsResponse#next_token #next_token} => String
|
2388
|
+
# * {Types::ListReadSetsResponse#read_sets #read_sets} => Array<Types::ReadSetListItem>
|
2389
|
+
#
|
2390
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2391
|
+
#
|
2392
|
+
# @example Request syntax with placeholder values
|
2393
|
+
#
|
2394
|
+
# resp = client.list_read_sets({
|
2395
|
+
# filter: {
|
2396
|
+
# created_after: Time.now,
|
2397
|
+
# created_before: Time.now,
|
2398
|
+
# name: "ReadSetName",
|
2399
|
+
# reference_arn: "ReferenceArn",
|
2400
|
+
# status: "ARCHIVED", # accepts ARCHIVED, ACTIVATING, ACTIVE, DELETING, DELETED
|
2401
|
+
# },
|
2402
|
+
# max_results: 1,
|
2403
|
+
# next_token: "NextToken",
|
2404
|
+
# sequence_store_id: "SequenceStoreId", # required
|
2405
|
+
# })
|
2406
|
+
#
|
2407
|
+
# @example Response structure
|
2408
|
+
#
|
2409
|
+
# resp.next_token #=> String
|
2410
|
+
# resp.read_sets #=> Array
|
2411
|
+
# resp.read_sets[0].arn #=> String
|
2412
|
+
# resp.read_sets[0].creation_time #=> Time
|
2413
|
+
# resp.read_sets[0].description #=> String
|
2414
|
+
# resp.read_sets[0].file_type #=> String, one of "FASTQ", "BAM", "CRAM"
|
2415
|
+
# resp.read_sets[0].id #=> String
|
2416
|
+
# resp.read_sets[0].name #=> String
|
2417
|
+
# resp.read_sets[0].reference_arn #=> String
|
2418
|
+
# resp.read_sets[0].sample_id #=> String
|
2419
|
+
# resp.read_sets[0].sequence_information.alignment #=> String
|
2420
|
+
# resp.read_sets[0].sequence_information.generated_from #=> String
|
2421
|
+
# resp.read_sets[0].sequence_information.total_base_count #=> Integer
|
2422
|
+
# resp.read_sets[0].sequence_information.total_read_count #=> Integer
|
2423
|
+
# resp.read_sets[0].sequence_store_id #=> String
|
2424
|
+
# resp.read_sets[0].status #=> String, one of "ARCHIVED", "ACTIVATING", "ACTIVE", "DELETING", "DELETED"
|
2425
|
+
# resp.read_sets[0].subject_id #=> String
|
2426
|
+
#
|
2427
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListReadSets AWS API Documentation
|
2428
|
+
#
|
2429
|
+
# @overload list_read_sets(params = {})
|
2430
|
+
# @param [Hash] params ({})
|
2431
|
+
def list_read_sets(params = {}, options = {})
|
2432
|
+
req = build_request(:list_read_sets, params)
|
2433
|
+
req.send_request(options)
|
2434
|
+
end
|
2435
|
+
|
2436
|
+
# Retrieves a list of reference import jobs.
|
2437
|
+
#
|
2438
|
+
# @option params [Types::ImportReferenceFilter] :filter
|
2439
|
+
# A filter to apply to the list.
|
2440
|
+
#
|
2441
|
+
# @option params [Integer] :max_results
|
2442
|
+
# The maximum number of jobs to return in one page of results.
|
2443
|
+
#
|
2444
|
+
# @option params [String] :next_token
|
2445
|
+
# Specify the pagination token from a previous request to retrieve the
|
2446
|
+
# next page of results.
|
2447
|
+
#
|
2448
|
+
# @option params [required, String] :reference_store_id
|
2449
|
+
# The job's reference store ID.
|
2450
|
+
#
|
2451
|
+
# @return [Types::ListReferenceImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2452
|
+
#
|
2453
|
+
# * {Types::ListReferenceImportJobsResponse#import_jobs #import_jobs} => Array<Types::ImportReferenceJobItem>
|
2454
|
+
# * {Types::ListReferenceImportJobsResponse#next_token #next_token} => String
|
2455
|
+
#
|
2456
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2457
|
+
#
|
2458
|
+
# @example Request syntax with placeholder values
|
2459
|
+
#
|
2460
|
+
# resp = client.list_reference_import_jobs({
|
2461
|
+
# filter: {
|
2462
|
+
# created_after: Time.now,
|
2463
|
+
# created_before: Time.now,
|
2464
|
+
# status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES
|
2465
|
+
# },
|
2466
|
+
# max_results: 1,
|
2467
|
+
# next_token: "NextToken",
|
2468
|
+
# reference_store_id: "ReferenceStoreId", # required
|
2469
|
+
# })
|
2470
|
+
#
|
2471
|
+
# @example Response structure
|
2472
|
+
#
|
2473
|
+
# resp.import_jobs #=> Array
|
2474
|
+
# resp.import_jobs[0].completion_time #=> Time
|
2475
|
+
# resp.import_jobs[0].creation_time #=> Time
|
2476
|
+
# resp.import_jobs[0].id #=> String
|
2477
|
+
# resp.import_jobs[0].reference_store_id #=> String
|
2478
|
+
# resp.import_jobs[0].role_arn #=> String
|
2479
|
+
# resp.import_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
2480
|
+
# resp.next_token #=> String
|
2481
|
+
#
|
2482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListReferenceImportJobs AWS API Documentation
|
2483
|
+
#
|
2484
|
+
# @overload list_reference_import_jobs(params = {})
|
2485
|
+
# @param [Hash] params ({})
|
2486
|
+
def list_reference_import_jobs(params = {}, options = {})
|
2487
|
+
req = build_request(:list_reference_import_jobs, params)
|
2488
|
+
req.send_request(options)
|
2489
|
+
end
|
2490
|
+
|
2491
|
+
# Retrieves a list of reference stores.
|
2492
|
+
#
|
2493
|
+
# @option params [Types::ReferenceStoreFilter] :filter
|
2494
|
+
# A filter to apply to the list.
|
2495
|
+
#
|
2496
|
+
# @option params [Integer] :max_results
|
2497
|
+
# The maximum number of stores to return in one page of results.
|
2498
|
+
#
|
2499
|
+
# @option params [String] :next_token
|
2500
|
+
# Specify the pagination token from a previous request to retrieve the
|
2501
|
+
# next page of results.
|
2502
|
+
#
|
2503
|
+
# @return [Types::ListReferenceStoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2504
|
+
#
|
2505
|
+
# * {Types::ListReferenceStoresResponse#next_token #next_token} => String
|
2506
|
+
# * {Types::ListReferenceStoresResponse#reference_stores #reference_stores} => Array<Types::ReferenceStoreDetail>
|
2507
|
+
#
|
2508
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2509
|
+
#
|
2510
|
+
# @example Request syntax with placeholder values
|
2511
|
+
#
|
2512
|
+
# resp = client.list_reference_stores({
|
2513
|
+
# filter: {
|
2514
|
+
# created_after: Time.now,
|
2515
|
+
# created_before: Time.now,
|
2516
|
+
# name: "ReferenceStoreName",
|
2517
|
+
# },
|
2518
|
+
# max_results: 1,
|
2519
|
+
# next_token: "NextToken",
|
2520
|
+
# })
|
2521
|
+
#
|
2522
|
+
# @example Response structure
|
2523
|
+
#
|
2524
|
+
# resp.next_token #=> String
|
2525
|
+
# resp.reference_stores #=> Array
|
2526
|
+
# resp.reference_stores[0].arn #=> String
|
2527
|
+
# resp.reference_stores[0].creation_time #=> Time
|
2528
|
+
# resp.reference_stores[0].description #=> String
|
2529
|
+
# resp.reference_stores[0].id #=> String
|
2530
|
+
# resp.reference_stores[0].name #=> String
|
2531
|
+
# resp.reference_stores[0].sse_config.key_arn #=> String
|
2532
|
+
# resp.reference_stores[0].sse_config.type #=> String, one of "KMS"
|
2533
|
+
#
|
2534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListReferenceStores AWS API Documentation
|
2535
|
+
#
|
2536
|
+
# @overload list_reference_stores(params = {})
|
2537
|
+
# @param [Hash] params ({})
|
2538
|
+
def list_reference_stores(params = {}, options = {})
|
2539
|
+
req = build_request(:list_reference_stores, params)
|
2540
|
+
req.send_request(options)
|
2541
|
+
end
|
2542
|
+
|
2543
|
+
# Retrieves a list of references.
|
2544
|
+
#
|
2545
|
+
# @option params [Types::ReferenceFilter] :filter
|
2546
|
+
# A filter to apply to the list.
|
2547
|
+
#
|
2548
|
+
# @option params [Integer] :max_results
|
2549
|
+
# The maximum number of references to return in one page of results.
|
2550
|
+
#
|
2551
|
+
# @option params [String] :next_token
|
2552
|
+
# Specify the pagination token from a previous request to retrieve the
|
2553
|
+
# next page of results.
|
2554
|
+
#
|
2555
|
+
# @option params [required, String] :reference_store_id
|
2556
|
+
# The references' reference store ID.
|
2557
|
+
#
|
2558
|
+
# @return [Types::ListReferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2559
|
+
#
|
2560
|
+
# * {Types::ListReferencesResponse#next_token #next_token} => String
|
2561
|
+
# * {Types::ListReferencesResponse#references #references} => Array<Types::ReferenceListItem>
|
2562
|
+
#
|
2563
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2564
|
+
#
|
2565
|
+
# @example Request syntax with placeholder values
|
2566
|
+
#
|
2567
|
+
# resp = client.list_references({
|
2568
|
+
# filter: {
|
2569
|
+
# created_after: Time.now,
|
2570
|
+
# created_before: Time.now,
|
2571
|
+
# md5: "Md5",
|
2572
|
+
# name: "ReferenceName",
|
2573
|
+
# },
|
2574
|
+
# max_results: 1,
|
2575
|
+
# next_token: "NextToken",
|
2576
|
+
# reference_store_id: "ReferenceStoreId", # required
|
2577
|
+
# })
|
2578
|
+
#
|
2579
|
+
# @example Response structure
|
2580
|
+
#
|
2581
|
+
# resp.next_token #=> String
|
2582
|
+
# resp.references #=> Array
|
2583
|
+
# resp.references[0].arn #=> String
|
2584
|
+
# resp.references[0].creation_time #=> Time
|
2585
|
+
# resp.references[0].description #=> String
|
2586
|
+
# resp.references[0].id #=> String
|
2587
|
+
# resp.references[0].md5 #=> String
|
2588
|
+
# resp.references[0].name #=> String
|
2589
|
+
# resp.references[0].reference_store_id #=> String
|
2590
|
+
# resp.references[0].status #=> String, one of "ACTIVE", "DELETING", "DELETED"
|
2591
|
+
# resp.references[0].update_time #=> Time
|
2592
|
+
#
|
2593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListReferences AWS API Documentation
|
2594
|
+
#
|
2595
|
+
# @overload list_references(params = {})
|
2596
|
+
# @param [Hash] params ({})
|
2597
|
+
def list_references(params = {}, options = {})
|
2598
|
+
req = build_request(:list_references, params)
|
2599
|
+
req.send_request(options)
|
2600
|
+
end
|
2601
|
+
|
2602
|
+
# Retrieves a list of run groups.
|
2603
|
+
#
|
2604
|
+
# @option params [Integer] :max_results
|
2605
|
+
# The maximum number of run groups to return in one page of results.
|
2606
|
+
#
|
2607
|
+
# @option params [String] :name
|
2608
|
+
# The run groups' name.
|
2609
|
+
#
|
2610
|
+
# @option params [String] :starting_token
|
2611
|
+
# Specify the pagination token from a previous request to retrieve the
|
2612
|
+
# next page of results.
|
2613
|
+
#
|
2614
|
+
# @return [Types::ListRunGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2615
|
+
#
|
2616
|
+
# * {Types::ListRunGroupsResponse#items #items} => Array<Types::RunGroupListItem>
|
2617
|
+
# * {Types::ListRunGroupsResponse#next_token #next_token} => String
|
2618
|
+
#
|
2619
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2620
|
+
#
|
2621
|
+
# @example Request syntax with placeholder values
|
2622
|
+
#
|
2623
|
+
# resp = client.list_run_groups({
|
2624
|
+
# max_results: 1,
|
2625
|
+
# name: "RunGroupName",
|
2626
|
+
# starting_token: "RunGroupListToken",
|
2627
|
+
# })
|
2628
|
+
#
|
2629
|
+
# @example Response structure
|
2630
|
+
#
|
2631
|
+
# resp.items #=> Array
|
2632
|
+
# resp.items[0].arn #=> String
|
2633
|
+
# resp.items[0].creation_time #=> Time
|
2634
|
+
# resp.items[0].id #=> String
|
2635
|
+
# resp.items[0].max_cpus #=> Integer
|
2636
|
+
# resp.items[0].max_duration #=> Integer
|
2637
|
+
# resp.items[0].max_runs #=> Integer
|
2638
|
+
# resp.items[0].name #=> String
|
2639
|
+
# resp.next_token #=> String
|
2640
|
+
#
|
2641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRunGroups AWS API Documentation
|
2642
|
+
#
|
2643
|
+
# @overload list_run_groups(params = {})
|
2644
|
+
# @param [Hash] params ({})
|
2645
|
+
def list_run_groups(params = {}, options = {})
|
2646
|
+
req = build_request(:list_run_groups, params)
|
2647
|
+
req.send_request(options)
|
2648
|
+
end
|
2649
|
+
|
2650
|
+
# Retrieves a list of tasks for a run.
|
2651
|
+
#
|
2652
|
+
# @option params [required, String] :id
|
2653
|
+
# The run's ID.
|
2654
|
+
#
|
2655
|
+
# @option params [Integer] :max_results
|
2656
|
+
# The maximum number of run tasks to return in one page of results.
|
2657
|
+
#
|
2658
|
+
# @option params [String] :starting_token
|
2659
|
+
# Specify the pagination token from a previous request to retrieve the
|
2660
|
+
# next page of results.
|
2661
|
+
#
|
2662
|
+
# @option params [String] :status
|
2663
|
+
# Filter the list by status.
|
2664
|
+
#
|
2665
|
+
# @return [Types::ListRunTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2666
|
+
#
|
2667
|
+
# * {Types::ListRunTasksResponse#items #items} => Array<Types::TaskListItem>
|
2668
|
+
# * {Types::ListRunTasksResponse#next_token #next_token} => String
|
2669
|
+
#
|
2670
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2671
|
+
#
|
2672
|
+
# @example Request syntax with placeholder values
|
2673
|
+
#
|
2674
|
+
# resp = client.list_run_tasks({
|
2675
|
+
# id: "RunId", # required
|
2676
|
+
# max_results: 1,
|
2677
|
+
# starting_token: "TaskListToken",
|
2678
|
+
# status: "PENDING", # accepts PENDING, STARTING, RUNNING, STOPPING, COMPLETED, CANCELLED, FAILED
|
2679
|
+
# })
|
2680
|
+
#
|
2681
|
+
# @example Response structure
|
2682
|
+
#
|
2683
|
+
# resp.items #=> Array
|
2684
|
+
# resp.items[0].cpus #=> Integer
|
2685
|
+
# resp.items[0].creation_time #=> Time
|
2686
|
+
# resp.items[0].memory #=> Integer
|
2687
|
+
# resp.items[0].name #=> String
|
2688
|
+
# resp.items[0].start_time #=> Time
|
2689
|
+
# resp.items[0].status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "CANCELLED", "FAILED"
|
2690
|
+
# resp.items[0].stop_time #=> Time
|
2691
|
+
# resp.items[0].task_id #=> String
|
2692
|
+
# resp.next_token #=> String
|
2693
|
+
#
|
2694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRunTasks AWS API Documentation
|
2695
|
+
#
|
2696
|
+
# @overload list_run_tasks(params = {})
|
2697
|
+
# @param [Hash] params ({})
|
2698
|
+
def list_run_tasks(params = {}, options = {})
|
2699
|
+
req = build_request(:list_run_tasks, params)
|
2700
|
+
req.send_request(options)
|
2701
|
+
end
|
2702
|
+
|
2703
|
+
# Retrieves a list of runs.
|
2704
|
+
#
|
2705
|
+
# @option params [Integer] :max_results
|
2706
|
+
# The maximum number of runs to return in one page of results.
|
2707
|
+
#
|
2708
|
+
# @option params [String] :name
|
2709
|
+
# Filter the list by run name.
|
2710
|
+
#
|
2711
|
+
# @option params [String] :run_group_id
|
2712
|
+
# Filter the list by run group ID.
|
2713
|
+
#
|
2714
|
+
# @option params [String] :starting_token
|
2715
|
+
# Specify the pagination token from a previous request to retrieve the
|
2716
|
+
# next page of results.
|
2717
|
+
#
|
2718
|
+
# @return [Types::ListRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2719
|
+
#
|
2720
|
+
# * {Types::ListRunsResponse#items #items} => Array<Types::RunListItem>
|
2721
|
+
# * {Types::ListRunsResponse#next_token #next_token} => String
|
2722
|
+
#
|
2723
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2724
|
+
#
|
2725
|
+
# @example Request syntax with placeholder values
|
2726
|
+
#
|
2727
|
+
# resp = client.list_runs({
|
2728
|
+
# max_results: 1,
|
2729
|
+
# name: "RunName",
|
2730
|
+
# run_group_id: "RunGroupId",
|
2731
|
+
# starting_token: "RunListToken",
|
2732
|
+
# })
|
2733
|
+
#
|
2734
|
+
# @example Response structure
|
2735
|
+
#
|
2736
|
+
# resp.items #=> Array
|
2737
|
+
# resp.items[0].arn #=> String
|
2738
|
+
# resp.items[0].creation_time #=> Time
|
2739
|
+
# resp.items[0].id #=> String
|
2740
|
+
# resp.items[0].name #=> String
|
2741
|
+
# resp.items[0].priority #=> Integer
|
2742
|
+
# resp.items[0].start_time #=> Time
|
2743
|
+
# resp.items[0].status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "DELETED", "CANCELLED", "FAILED"
|
2744
|
+
# resp.items[0].stop_time #=> Time
|
2745
|
+
# resp.items[0].storage_capacity #=> Integer
|
2746
|
+
# resp.items[0].workflow_id #=> String
|
2747
|
+
# resp.next_token #=> String
|
2748
|
+
#
|
2749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRuns AWS API Documentation
|
2750
|
+
#
|
2751
|
+
# @overload list_runs(params = {})
|
2752
|
+
# @param [Hash] params ({})
|
2753
|
+
def list_runs(params = {}, options = {})
|
2754
|
+
req = build_request(:list_runs, params)
|
2755
|
+
req.send_request(options)
|
2756
|
+
end
|
2757
|
+
|
2758
|
+
# Retrieves a list of sequence stores.
|
2759
|
+
#
|
2760
|
+
# @option params [Types::SequenceStoreFilter] :filter
|
2761
|
+
# A filter to apply to the list.
|
2762
|
+
#
|
2763
|
+
# @option params [Integer] :max_results
|
2764
|
+
# The maximum number of stores to return in one page of results.
|
2765
|
+
#
|
2766
|
+
# @option params [String] :next_token
|
2767
|
+
# Specify the pagination token from a previous request to retrieve the
|
2768
|
+
# next page of results.
|
2769
|
+
#
|
2770
|
+
# @return [Types::ListSequenceStoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2771
|
+
#
|
2772
|
+
# * {Types::ListSequenceStoresResponse#next_token #next_token} => String
|
2773
|
+
# * {Types::ListSequenceStoresResponse#sequence_stores #sequence_stores} => Array<Types::SequenceStoreDetail>
|
2774
|
+
#
|
2775
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2776
|
+
#
|
2777
|
+
# @example Request syntax with placeholder values
|
2778
|
+
#
|
2779
|
+
# resp = client.list_sequence_stores({
|
2780
|
+
# filter: {
|
2781
|
+
# created_after: Time.now,
|
2782
|
+
# created_before: Time.now,
|
2783
|
+
# name: "SequenceStoreName",
|
2784
|
+
# },
|
2785
|
+
# max_results: 1,
|
2786
|
+
# next_token: "NextToken",
|
2787
|
+
# })
|
2788
|
+
#
|
2789
|
+
# @example Response structure
|
2790
|
+
#
|
2791
|
+
# resp.next_token #=> String
|
2792
|
+
# resp.sequence_stores #=> Array
|
2793
|
+
# resp.sequence_stores[0].arn #=> String
|
2794
|
+
# resp.sequence_stores[0].creation_time #=> Time
|
2795
|
+
# resp.sequence_stores[0].description #=> String
|
2796
|
+
# resp.sequence_stores[0].id #=> String
|
2797
|
+
# resp.sequence_stores[0].name #=> String
|
2798
|
+
# resp.sequence_stores[0].sse_config.key_arn #=> String
|
2799
|
+
# resp.sequence_stores[0].sse_config.type #=> String, one of "KMS"
|
2800
|
+
#
|
2801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListSequenceStores AWS API Documentation
|
2802
|
+
#
|
2803
|
+
# @overload list_sequence_stores(params = {})
|
2804
|
+
# @param [Hash] params ({})
|
2805
|
+
def list_sequence_stores(params = {}, options = {})
|
2806
|
+
req = build_request(:list_sequence_stores, params)
|
2807
|
+
req.send_request(options)
|
2808
|
+
end
|
2809
|
+
|
2810
|
+
# Retrieves a list of tags for a resource.
|
2811
|
+
#
|
2812
|
+
# @option params [required, String] :resource_arn
|
2813
|
+
# The resource's ARN.
|
2814
|
+
#
|
2815
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2816
|
+
#
|
2817
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
2818
|
+
#
|
2819
|
+
# @example Request syntax with placeholder values
|
2820
|
+
#
|
2821
|
+
# resp = client.list_tags_for_resource({
|
2822
|
+
# resource_arn: "TagArn", # required
|
2823
|
+
# })
|
2824
|
+
#
|
2825
|
+
# @example Response structure
|
2826
|
+
#
|
2827
|
+
# resp.tags #=> Hash
|
2828
|
+
# resp.tags["TagKey"] #=> String
|
2829
|
+
#
|
2830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListTagsForResource AWS API Documentation
|
2831
|
+
#
|
2832
|
+
# @overload list_tags_for_resource(params = {})
|
2833
|
+
# @param [Hash] params ({})
|
2834
|
+
def list_tags_for_resource(params = {}, options = {})
|
2835
|
+
req = build_request(:list_tags_for_resource, params)
|
2836
|
+
req.send_request(options)
|
2837
|
+
end
|
2838
|
+
|
2839
|
+
# Retrieves a list of variant import jobs.
|
2840
|
+
#
|
2841
|
+
# @option params [Types::ListVariantImportJobsFilter] :filter
|
2842
|
+
# A filter to apply to the list.
|
2843
|
+
#
|
2844
|
+
# @option params [Array<String>] :ids
|
2845
|
+
# A list of job IDs.
|
2846
|
+
#
|
2847
|
+
# @option params [Integer] :max_results
|
2848
|
+
# The maximum number of import jobs to return in one page of results.
|
2849
|
+
#
|
2850
|
+
# @option params [String] :next_token
|
2851
|
+
# Specify the pagination token from a previous request to retrieve the
|
2852
|
+
# next page of results.
|
2853
|
+
#
|
2854
|
+
# @return [Types::ListVariantImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2855
|
+
#
|
2856
|
+
# * {Types::ListVariantImportJobsResponse#next_token #next_token} => String
|
2857
|
+
# * {Types::ListVariantImportJobsResponse#variant_import_jobs #variant_import_jobs} => Array<Types::VariantImportJobItem>
|
2858
|
+
#
|
2859
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2860
|
+
#
|
2861
|
+
# @example Request syntax with placeholder values
|
2862
|
+
#
|
2863
|
+
# resp = client.list_variant_import_jobs({
|
2864
|
+
# filter: {
|
2865
|
+
# status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED
|
2866
|
+
# store_name: "String",
|
2867
|
+
# },
|
2868
|
+
# ids: ["ResourceIdentifier"],
|
2869
|
+
# max_results: 1,
|
2870
|
+
# next_token: "ListVariantImportJobsRequestNextTokenString",
|
2871
|
+
# })
|
2872
|
+
#
|
2873
|
+
# @example Response structure
|
2874
|
+
#
|
2875
|
+
# resp.next_token #=> String
|
2876
|
+
# resp.variant_import_jobs #=> Array
|
2877
|
+
# resp.variant_import_jobs[0].completion_time #=> Time
|
2878
|
+
# resp.variant_import_jobs[0].creation_time #=> Time
|
2879
|
+
# resp.variant_import_jobs[0].destination_name #=> String
|
2880
|
+
# resp.variant_import_jobs[0].id #=> String
|
2881
|
+
# resp.variant_import_jobs[0].role_arn #=> String
|
2882
|
+
# resp.variant_import_jobs[0].run_left_normalization #=> Boolean
|
2883
|
+
# resp.variant_import_jobs[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED"
|
2884
|
+
# resp.variant_import_jobs[0].update_time #=> Time
|
2885
|
+
#
|
2886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListVariantImportJobs AWS API Documentation
|
2887
|
+
#
|
2888
|
+
# @overload list_variant_import_jobs(params = {})
|
2889
|
+
# @param [Hash] params ({})
|
2890
|
+
def list_variant_import_jobs(params = {}, options = {})
|
2891
|
+
req = build_request(:list_variant_import_jobs, params)
|
2892
|
+
req.send_request(options)
|
2893
|
+
end
|
2894
|
+
|
2895
|
+
# Retrieves a list of variant stores.
|
2896
|
+
#
|
2897
|
+
# @option params [Types::ListVariantStoresFilter] :filter
|
2898
|
+
# A filter to apply to the list.
|
2899
|
+
#
|
2900
|
+
# @option params [Array<String>] :ids
|
2901
|
+
# A list of store IDs.
|
2902
|
+
#
|
2903
|
+
# @option params [Integer] :max_results
|
2904
|
+
# The maximum number of stores to return in one page of results.
|
2905
|
+
#
|
2906
|
+
# @option params [String] :next_token
|
2907
|
+
# Specify the pagination token from a previous request to retrieve the
|
2908
|
+
# next page of results.
|
2909
|
+
#
|
2910
|
+
# @return [Types::ListVariantStoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2911
|
+
#
|
2912
|
+
# * {Types::ListVariantStoresResponse#next_token #next_token} => String
|
2913
|
+
# * {Types::ListVariantStoresResponse#variant_stores #variant_stores} => Array<Types::VariantStoreItem>
|
2914
|
+
#
|
2915
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2916
|
+
#
|
2917
|
+
# @example Request syntax with placeholder values
|
2918
|
+
#
|
2919
|
+
# resp = client.list_variant_stores({
|
2920
|
+
# filter: {
|
2921
|
+
# status: "CREATING", # accepts CREATING, UPDATING, DELETING, ACTIVE, FAILED
|
2922
|
+
# },
|
2923
|
+
# ids: ["ResourceIdentifier"],
|
2924
|
+
# max_results: 1,
|
2925
|
+
# next_token: "ListVariantStoresRequestNextTokenString",
|
2926
|
+
# })
|
2927
|
+
#
|
2928
|
+
# @example Response structure
|
2929
|
+
#
|
2930
|
+
# resp.next_token #=> String
|
2931
|
+
# resp.variant_stores #=> Array
|
2932
|
+
# resp.variant_stores[0].creation_time #=> Time
|
2933
|
+
# resp.variant_stores[0].description #=> String
|
2934
|
+
# resp.variant_stores[0].id #=> String
|
2935
|
+
# resp.variant_stores[0].name #=> String
|
2936
|
+
# resp.variant_stores[0].reference.reference_arn #=> String
|
2937
|
+
# resp.variant_stores[0].sse_config.key_arn #=> String
|
2938
|
+
# resp.variant_stores[0].sse_config.type #=> String, one of "KMS"
|
2939
|
+
# resp.variant_stores[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
2940
|
+
# resp.variant_stores[0].status_message #=> String
|
2941
|
+
# resp.variant_stores[0].store_arn #=> String
|
2942
|
+
# resp.variant_stores[0].store_size_bytes #=> Integer
|
2943
|
+
# resp.variant_stores[0].update_time #=> Time
|
2944
|
+
#
|
2945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListVariantStores AWS API Documentation
|
2946
|
+
#
|
2947
|
+
# @overload list_variant_stores(params = {})
|
2948
|
+
# @param [Hash] params ({})
|
2949
|
+
def list_variant_stores(params = {}, options = {})
|
2950
|
+
req = build_request(:list_variant_stores, params)
|
2951
|
+
req.send_request(options)
|
2952
|
+
end
|
2953
|
+
|
2954
|
+
# Retrieves a list of workflows.
|
2955
|
+
#
|
2956
|
+
# @option params [Integer] :max_results
|
2957
|
+
# The maximum number of workflows to return in one page of results.
|
2958
|
+
#
|
2959
|
+
# @option params [String] :name
|
2960
|
+
# The workflows' name.
|
2961
|
+
#
|
2962
|
+
# @option params [String] :starting_token
|
2963
|
+
# Specify the pagination token from a previous request to retrieve the
|
2964
|
+
# next page of results.
|
2965
|
+
#
|
2966
|
+
# @option params [String] :type
|
2967
|
+
# The workflows' type.
|
2968
|
+
#
|
2969
|
+
# @return [Types::ListWorkflowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2970
|
+
#
|
2971
|
+
# * {Types::ListWorkflowsResponse#items #items} => Array<Types::WorkflowListItem>
|
2972
|
+
# * {Types::ListWorkflowsResponse#next_token #next_token} => String
|
2973
|
+
#
|
2974
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2975
|
+
#
|
2976
|
+
# @example Request syntax with placeholder values
|
2977
|
+
#
|
2978
|
+
# resp = client.list_workflows({
|
2979
|
+
# max_results: 1,
|
2980
|
+
# name: "WorkflowName",
|
2981
|
+
# starting_token: "WorkflowListToken",
|
2982
|
+
# type: "PRIVATE", # accepts PRIVATE
|
2983
|
+
# })
|
2984
|
+
#
|
2985
|
+
# @example Response structure
|
2986
|
+
#
|
2987
|
+
# resp.items #=> Array
|
2988
|
+
# resp.items[0].arn #=> String
|
2989
|
+
# resp.items[0].creation_time #=> Time
|
2990
|
+
# resp.items[0].digest #=> String
|
2991
|
+
# resp.items[0].id #=> String
|
2992
|
+
# resp.items[0].name #=> String
|
2993
|
+
# resp.items[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETED", "FAILED"
|
2994
|
+
# resp.items[0].type #=> String, one of "PRIVATE"
|
2995
|
+
# resp.next_token #=> String
|
2996
|
+
#
|
2997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListWorkflows AWS API Documentation
|
2998
|
+
#
|
2999
|
+
# @overload list_workflows(params = {})
|
3000
|
+
# @param [Hash] params ({})
|
3001
|
+
def list_workflows(params = {}, options = {})
|
3002
|
+
req = build_request(:list_workflows, params)
|
3003
|
+
req.send_request(options)
|
3004
|
+
end
|
3005
|
+
|
3006
|
+
# Starts an annotation import job.
|
3007
|
+
#
|
3008
|
+
# @option params [required, String] :destination_name
|
3009
|
+
# A destination annotation store for the job.
|
3010
|
+
#
|
3011
|
+
# @option params [Types::FormatOptions] :format_options
|
3012
|
+
# Formatting options for the annotation file.
|
3013
|
+
#
|
3014
|
+
# @option params [required, Array<Types::AnnotationImportItemSource>] :items
|
3015
|
+
# Items to import.
|
3016
|
+
#
|
3017
|
+
# @option params [required, String] :role_arn
|
3018
|
+
# A service role for the job.
|
3019
|
+
#
|
3020
|
+
# @option params [Boolean] :run_left_normalization
|
3021
|
+
# The job's left normalization setting.
|
3022
|
+
#
|
3023
|
+
# @return [Types::StartAnnotationImportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3024
|
+
#
|
3025
|
+
# * {Types::StartAnnotationImportResponse#job_id #job_id} => String
|
3026
|
+
#
|
3027
|
+
# @example Request syntax with placeholder values
|
3028
|
+
#
|
3029
|
+
# resp = client.start_annotation_import_job({
|
3030
|
+
# destination_name: "StoreName", # required
|
3031
|
+
# format_options: {
|
3032
|
+
# tsv_options: {
|
3033
|
+
# read_options: {
|
3034
|
+
# comment: "CommentChar",
|
3035
|
+
# encoding: "Encoding",
|
3036
|
+
# escape: "EscapeChar",
|
3037
|
+
# escape_quotes: false,
|
3038
|
+
# header: false,
|
3039
|
+
# line_sep: "LineSep",
|
3040
|
+
# quote: "Quote",
|
3041
|
+
# quote_all: false,
|
3042
|
+
# sep: "Separator",
|
3043
|
+
# },
|
3044
|
+
# },
|
3045
|
+
# vcf_options: {
|
3046
|
+
# ignore_filter_field: false,
|
3047
|
+
# ignore_qual_field: false,
|
3048
|
+
# },
|
3049
|
+
# },
|
3050
|
+
# items: [ # required
|
3051
|
+
# {
|
3052
|
+
# source: "S3Uri", # required
|
3053
|
+
# },
|
3054
|
+
# ],
|
3055
|
+
# role_arn: "Arn", # required
|
3056
|
+
# run_left_normalization: false,
|
3057
|
+
# })
|
3058
|
+
#
|
3059
|
+
# @example Response structure
|
3060
|
+
#
|
3061
|
+
# resp.job_id #=> String
|
3062
|
+
#
|
3063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartAnnotationImportJob AWS API Documentation
|
3064
|
+
#
|
3065
|
+
# @overload start_annotation_import_job(params = {})
|
3066
|
+
# @param [Hash] params ({})
|
3067
|
+
def start_annotation_import_job(params = {}, options = {})
|
3068
|
+
req = build_request(:start_annotation_import_job, params)
|
3069
|
+
req.send_request(options)
|
3070
|
+
end
|
3071
|
+
|
3072
|
+
# Starts a read set activation job.
|
3073
|
+
#
|
3074
|
+
# @option params [String] :client_token
|
3075
|
+
# To ensure that jobs don't run multiple times, specify a unique token
|
3076
|
+
# for each job.
|
3077
|
+
#
|
3078
|
+
# @option params [required, String] :sequence_store_id
|
3079
|
+
# The read set's sequence store ID.
|
3080
|
+
#
|
3081
|
+
# @option params [required, Array<Types::StartReadSetActivationJobSourceItem>] :sources
|
3082
|
+
# The job's sources.
|
3083
|
+
#
|
3084
|
+
# @return [Types::StartReadSetActivationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3085
|
+
#
|
3086
|
+
# * {Types::StartReadSetActivationJobResponse#creation_time #creation_time} => Time
|
3087
|
+
# * {Types::StartReadSetActivationJobResponse#id #id} => String
|
3088
|
+
# * {Types::StartReadSetActivationJobResponse#sequence_store_id #sequence_store_id} => String
|
3089
|
+
# * {Types::StartReadSetActivationJobResponse#status #status} => String
|
3090
|
+
#
|
3091
|
+
# @example Request syntax with placeholder values
|
3092
|
+
#
|
3093
|
+
# resp = client.start_read_set_activation_job({
|
3094
|
+
# client_token: "ClientToken",
|
3095
|
+
# sequence_store_id: "SequenceStoreId", # required
|
3096
|
+
# sources: [ # required
|
3097
|
+
# {
|
3098
|
+
# read_set_id: "ReadSetId", # required
|
3099
|
+
# },
|
3100
|
+
# ],
|
3101
|
+
# })
|
3102
|
+
#
|
3103
|
+
# @example Response structure
|
3104
|
+
#
|
3105
|
+
# resp.creation_time #=> Time
|
3106
|
+
# resp.id #=> String
|
3107
|
+
# resp.sequence_store_id #=> String
|
3108
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
3109
|
+
#
|
3110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartReadSetActivationJob AWS API Documentation
|
3111
|
+
#
|
3112
|
+
# @overload start_read_set_activation_job(params = {})
|
3113
|
+
# @param [Hash] params ({})
|
3114
|
+
def start_read_set_activation_job(params = {}, options = {})
|
3115
|
+
req = build_request(:start_read_set_activation_job, params)
|
3116
|
+
req.send_request(options)
|
3117
|
+
end
|
3118
|
+
|
3119
|
+
# Starts a read set export job.
|
3120
|
+
#
|
3121
|
+
# @option params [String] :client_token
|
3122
|
+
# To ensure that jobs don't run multiple times, specify a unique token
|
3123
|
+
# for each job.
|
3124
|
+
#
|
3125
|
+
# @option params [required, String] :destination
|
3126
|
+
# A location for exported files in Amazon S3.
|
3127
|
+
#
|
3128
|
+
# @option params [required, String] :role_arn
|
3129
|
+
# A service role for the job.
|
3130
|
+
#
|
3131
|
+
# @option params [required, String] :sequence_store_id
|
3132
|
+
# The read set's sequence store ID.
|
3133
|
+
#
|
3134
|
+
# @option params [required, Array<Types::ExportReadSet>] :sources
|
3135
|
+
# Sources for the job.
|
3136
|
+
#
|
3137
|
+
# @return [Types::StartReadSetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3138
|
+
#
|
3139
|
+
# * {Types::StartReadSetExportJobResponse#creation_time #creation_time} => Time
|
3140
|
+
# * {Types::StartReadSetExportJobResponse#destination #destination} => String
|
3141
|
+
# * {Types::StartReadSetExportJobResponse#id #id} => String
|
3142
|
+
# * {Types::StartReadSetExportJobResponse#sequence_store_id #sequence_store_id} => String
|
3143
|
+
# * {Types::StartReadSetExportJobResponse#status #status} => String
|
3144
|
+
#
|
3145
|
+
# @example Request syntax with placeholder values
|
3146
|
+
#
|
3147
|
+
# resp = client.start_read_set_export_job({
|
3148
|
+
# client_token: "ClientToken",
|
3149
|
+
# destination: "S3Destination", # required
|
3150
|
+
# role_arn: "RoleArn", # required
|
3151
|
+
# sequence_store_id: "SequenceStoreId", # required
|
3152
|
+
# sources: [ # required
|
3153
|
+
# {
|
3154
|
+
# read_set_id: "ReadSetId", # required
|
3155
|
+
# },
|
3156
|
+
# ],
|
3157
|
+
# })
|
3158
|
+
#
|
3159
|
+
# @example Response structure
|
3160
|
+
#
|
3161
|
+
# resp.creation_time #=> Time
|
3162
|
+
# resp.destination #=> String
|
3163
|
+
# resp.id #=> String
|
3164
|
+
# resp.sequence_store_id #=> String
|
3165
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
3166
|
+
#
|
3167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartReadSetExportJob AWS API Documentation
|
3168
|
+
#
|
3169
|
+
# @overload start_read_set_export_job(params = {})
|
3170
|
+
# @param [Hash] params ({})
|
3171
|
+
def start_read_set_export_job(params = {}, options = {})
|
3172
|
+
req = build_request(:start_read_set_export_job, params)
|
3173
|
+
req.send_request(options)
|
3174
|
+
end
|
3175
|
+
|
3176
|
+
# Starts a read set import job.
|
3177
|
+
#
|
3178
|
+
# @option params [String] :client_token
|
3179
|
+
# To ensure that jobs don't run multiple times, specify a unique token
|
3180
|
+
# for each job.
|
3181
|
+
#
|
3182
|
+
# @option params [required, String] :role_arn
|
3183
|
+
# A service role for the job.
|
3184
|
+
#
|
3185
|
+
# @option params [required, String] :sequence_store_id
|
3186
|
+
# The read set's sequence store ID.
|
3187
|
+
#
|
3188
|
+
# @option params [required, Array<Types::StartReadSetImportJobSourceItem>] :sources
|
3189
|
+
# Source files to import.
|
3190
|
+
#
|
3191
|
+
# @return [Types::StartReadSetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3192
|
+
#
|
3193
|
+
# * {Types::StartReadSetImportJobResponse#creation_time #creation_time} => Time
|
3194
|
+
# * {Types::StartReadSetImportJobResponse#id #id} => String
|
3195
|
+
# * {Types::StartReadSetImportJobResponse#role_arn #role_arn} => String
|
3196
|
+
# * {Types::StartReadSetImportJobResponse#sequence_store_id #sequence_store_id} => String
|
3197
|
+
# * {Types::StartReadSetImportJobResponse#status #status} => String
|
3198
|
+
#
|
3199
|
+
# @example Request syntax with placeholder values
|
3200
|
+
#
|
3201
|
+
# resp = client.start_read_set_import_job({
|
3202
|
+
# client_token: "ClientToken",
|
3203
|
+
# role_arn: "RoleArn", # required
|
3204
|
+
# sequence_store_id: "SequenceStoreId", # required
|
3205
|
+
# sources: [ # required
|
3206
|
+
# {
|
3207
|
+
# description: "ReadSetDescription",
|
3208
|
+
# generated_from: "GeneratedFrom",
|
3209
|
+
# name: "ReadSetName",
|
3210
|
+
# reference_arn: "ReferenceArn", # required
|
3211
|
+
# sample_id: "SampleId", # required
|
3212
|
+
# source_file_type: "FASTQ", # required, accepts FASTQ, BAM, CRAM
|
3213
|
+
# source_files: { # required
|
3214
|
+
# source1: "S3Uri", # required
|
3215
|
+
# source2: "S3Uri",
|
3216
|
+
# },
|
3217
|
+
# subject_id: "SubjectId", # required
|
3218
|
+
# tags: {
|
3219
|
+
# "TagKey" => "TagValue",
|
3220
|
+
# },
|
3221
|
+
# },
|
3222
|
+
# ],
|
3223
|
+
# })
|
3224
|
+
#
|
3225
|
+
# @example Response structure
|
3226
|
+
#
|
3227
|
+
# resp.creation_time #=> Time
|
3228
|
+
# resp.id #=> String
|
3229
|
+
# resp.role_arn #=> String
|
3230
|
+
# resp.sequence_store_id #=> String
|
3231
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
3232
|
+
#
|
3233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartReadSetImportJob AWS API Documentation
|
3234
|
+
#
|
3235
|
+
# @overload start_read_set_import_job(params = {})
|
3236
|
+
# @param [Hash] params ({})
|
3237
|
+
def start_read_set_import_job(params = {}, options = {})
|
3238
|
+
req = build_request(:start_read_set_import_job, params)
|
3239
|
+
req.send_request(options)
|
3240
|
+
end
|
3241
|
+
|
3242
|
+
# Starts a reference import job.
|
3243
|
+
#
|
3244
|
+
# @option params [String] :client_token
|
3245
|
+
# To ensure that jobs don't run multiple times, specify a unique token
|
3246
|
+
# for each job.
|
3247
|
+
#
|
3248
|
+
# @option params [required, String] :reference_store_id
|
3249
|
+
# The job's reference store ID.
|
3250
|
+
#
|
3251
|
+
# @option params [required, String] :role_arn
|
3252
|
+
# A service role for the job.
|
3253
|
+
#
|
3254
|
+
# @option params [required, Array<Types::StartReferenceImportJobSourceItem>] :sources
|
3255
|
+
# Sources for the job.
|
3256
|
+
#
|
3257
|
+
# @return [Types::StartReferenceImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3258
|
+
#
|
3259
|
+
# * {Types::StartReferenceImportJobResponse#creation_time #creation_time} => Time
|
3260
|
+
# * {Types::StartReferenceImportJobResponse#id #id} => String
|
3261
|
+
# * {Types::StartReferenceImportJobResponse#reference_store_id #reference_store_id} => String
|
3262
|
+
# * {Types::StartReferenceImportJobResponse#role_arn #role_arn} => String
|
3263
|
+
# * {Types::StartReferenceImportJobResponse#status #status} => String
|
3264
|
+
#
|
3265
|
+
# @example Request syntax with placeholder values
|
3266
|
+
#
|
3267
|
+
# resp = client.start_reference_import_job({
|
3268
|
+
# client_token: "ClientToken",
|
3269
|
+
# reference_store_id: "ReferenceStoreId", # required
|
3270
|
+
# role_arn: "RoleArn", # required
|
3271
|
+
# sources: [ # required
|
3272
|
+
# {
|
3273
|
+
# description: "ReferenceDescription",
|
3274
|
+
# name: "ReferenceName", # required
|
3275
|
+
# source_file: "S3Uri", # required
|
3276
|
+
# tags: {
|
3277
|
+
# "TagKey" => "TagValue",
|
3278
|
+
# },
|
3279
|
+
# },
|
3280
|
+
# ],
|
3281
|
+
# })
|
3282
|
+
#
|
3283
|
+
# @example Response structure
|
3284
|
+
#
|
3285
|
+
# resp.creation_time #=> Time
|
3286
|
+
# resp.id #=> String
|
3287
|
+
# resp.reference_store_id #=> String
|
3288
|
+
# resp.role_arn #=> String
|
3289
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELLING", "CANCELLED", "FAILED", "COMPLETED", "COMPLETED_WITH_FAILURES"
|
3290
|
+
#
|
3291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartReferenceImportJob AWS API Documentation
|
3292
|
+
#
|
3293
|
+
# @overload start_reference_import_job(params = {})
|
3294
|
+
# @param [Hash] params ({})
|
3295
|
+
def start_reference_import_job(params = {}, options = {})
|
3296
|
+
req = build_request(:start_reference_import_job, params)
|
3297
|
+
req.send_request(options)
|
3298
|
+
end
|
3299
|
+
|
3300
|
+
# Starts a run.
|
3301
|
+
#
|
3302
|
+
# @option params [String] :log_level
|
3303
|
+
# A log level for the run.
|
3304
|
+
#
|
3305
|
+
# @option params [String] :name
|
3306
|
+
# A name for the run.
|
3307
|
+
#
|
3308
|
+
# @option params [String] :output_uri
|
3309
|
+
# An output URI for the run.
|
3310
|
+
#
|
3311
|
+
# @option params [Hash,Array,String,Numeric,Boolean] :parameters
|
3312
|
+
# Parameters for the run.
|
3313
|
+
#
|
3314
|
+
# Document type used to carry open content
|
3315
|
+
# (Hash,Array,String,Numeric,Boolean). A document type value is
|
3316
|
+
# serialized using the same format as its surroundings and requires no
|
3317
|
+
# additional encoding or escaping.
|
3318
|
+
#
|
3319
|
+
# @option params [Integer] :priority
|
3320
|
+
# A priority for the run.
|
3321
|
+
#
|
3322
|
+
# @option params [required, String] :request_id
|
3323
|
+
# A request ID for the run.
|
3324
|
+
#
|
3325
|
+
# **A suitable default value is auto-generated.** You should normally
|
3326
|
+
# not need to pass this option.**
|
3327
|
+
#
|
3328
|
+
# @option params [required, String] :role_arn
|
3329
|
+
# A service role for the run.
|
3330
|
+
#
|
3331
|
+
# @option params [String] :run_group_id
|
3332
|
+
# The run's group ID.
|
3333
|
+
#
|
3334
|
+
# @option params [String] :run_id
|
3335
|
+
# The run's ID.
|
3336
|
+
#
|
3337
|
+
# @option params [Integer] :storage_capacity
|
3338
|
+
# A storage capacity for the run.
|
3339
|
+
#
|
3340
|
+
# @option params [Hash<String,String>] :tags
|
3341
|
+
# Tags for the run.
|
3342
|
+
#
|
3343
|
+
# @option params [String] :workflow_id
|
3344
|
+
# The run's workflow ID.
|
3345
|
+
#
|
3346
|
+
# @option params [String] :workflow_type
|
3347
|
+
# The run's workflows type.
|
3348
|
+
#
|
3349
|
+
# @return [Types::StartRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3350
|
+
#
|
3351
|
+
# * {Types::StartRunResponse#arn #arn} => String
|
3352
|
+
# * {Types::StartRunResponse#id #id} => String
|
3353
|
+
# * {Types::StartRunResponse#status #status} => String
|
3354
|
+
# * {Types::StartRunResponse#tags #tags} => Hash<String,String>
|
3355
|
+
#
|
3356
|
+
# @example Request syntax with placeholder values
|
3357
|
+
#
|
3358
|
+
# resp = client.start_run({
|
3359
|
+
# log_level: "OFF", # accepts OFF, FATAL, ERROR, ALL
|
3360
|
+
# name: "RunName",
|
3361
|
+
# output_uri: "RunOutputUri",
|
3362
|
+
# parameters: {
|
3363
|
+
# },
|
3364
|
+
# priority: 1,
|
3365
|
+
# request_id: "RunRequestId", # required
|
3366
|
+
# role_arn: "RunRoleArn", # required
|
3367
|
+
# run_group_id: "RunGroupId",
|
3368
|
+
# run_id: "RunId",
|
3369
|
+
# storage_capacity: 1,
|
3370
|
+
# tags: {
|
3371
|
+
# "TagKey" => "TagValue",
|
3372
|
+
# },
|
3373
|
+
# workflow_id: "WorkflowId",
|
3374
|
+
# workflow_type: "PRIVATE", # accepts PRIVATE
|
3375
|
+
# })
|
3376
|
+
#
|
3377
|
+
# @example Response structure
|
3378
|
+
#
|
3379
|
+
# resp.arn #=> String
|
3380
|
+
# resp.id #=> String
|
3381
|
+
# resp.status #=> String, one of "PENDING", "STARTING", "RUNNING", "STOPPING", "COMPLETED", "DELETED", "CANCELLED", "FAILED"
|
3382
|
+
# resp.tags #=> Hash
|
3383
|
+
# resp.tags["TagKey"] #=> String
|
3384
|
+
#
|
3385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartRun AWS API Documentation
|
3386
|
+
#
|
3387
|
+
# @overload start_run(params = {})
|
3388
|
+
# @param [Hash] params ({})
|
3389
|
+
def start_run(params = {}, options = {})
|
3390
|
+
req = build_request(:start_run, params)
|
3391
|
+
req.send_request(options)
|
3392
|
+
end
|
3393
|
+
|
3394
|
+
# Starts a variant import job.
|
3395
|
+
#
|
3396
|
+
# @option params [required, String] :destination_name
|
3397
|
+
# The destination variant store for the job.
|
3398
|
+
#
|
3399
|
+
# @option params [required, Array<Types::VariantImportItemSource>] :items
|
3400
|
+
# Items to import.
|
3401
|
+
#
|
3402
|
+
# @option params [required, String] :role_arn
|
3403
|
+
# A service role for the job.
|
3404
|
+
#
|
3405
|
+
# @option params [Boolean] :run_left_normalization
|
3406
|
+
# The job's left normalization setting.
|
3407
|
+
#
|
3408
|
+
# @return [Types::StartVariantImportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3409
|
+
#
|
3410
|
+
# * {Types::StartVariantImportResponse#job_id #job_id} => String
|
3411
|
+
#
|
3412
|
+
# @example Request syntax with placeholder values
|
3413
|
+
#
|
3414
|
+
# resp = client.start_variant_import_job({
|
3415
|
+
# destination_name: "StoreName", # required
|
3416
|
+
# items: [ # required
|
3417
|
+
# {
|
3418
|
+
# source: "S3Uri", # required
|
3419
|
+
# },
|
3420
|
+
# ],
|
3421
|
+
# role_arn: "Arn", # required
|
3422
|
+
# run_left_normalization: false,
|
3423
|
+
# })
|
3424
|
+
#
|
3425
|
+
# @example Response structure
|
3426
|
+
#
|
3427
|
+
# resp.job_id #=> String
|
3428
|
+
#
|
3429
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartVariantImportJob AWS API Documentation
|
3430
|
+
#
|
3431
|
+
# @overload start_variant_import_job(params = {})
|
3432
|
+
# @param [Hash] params ({})
|
3433
|
+
def start_variant_import_job(params = {}, options = {})
|
3434
|
+
req = build_request(:start_variant_import_job, params)
|
3435
|
+
req.send_request(options)
|
3436
|
+
end
|
3437
|
+
|
3438
|
+
# Tags a resource.
|
3439
|
+
#
|
3440
|
+
# @option params [required, String] :resource_arn
|
3441
|
+
# The resource's ARN.
|
3442
|
+
#
|
3443
|
+
# @option params [required, Hash<String,String>] :tags
|
3444
|
+
# Tags for the resource.
|
3445
|
+
#
|
3446
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3447
|
+
#
|
3448
|
+
# @example Request syntax with placeholder values
|
3449
|
+
#
|
3450
|
+
# resp = client.tag_resource({
|
3451
|
+
# resource_arn: "TagArn", # required
|
3452
|
+
# tags: { # required
|
3453
|
+
# "TagKey" => "TagValue",
|
3454
|
+
# },
|
3455
|
+
# })
|
3456
|
+
#
|
3457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/TagResource AWS API Documentation
|
3458
|
+
#
|
3459
|
+
# @overload tag_resource(params = {})
|
3460
|
+
# @param [Hash] params ({})
|
3461
|
+
def tag_resource(params = {}, options = {})
|
3462
|
+
req = build_request(:tag_resource, params)
|
3463
|
+
req.send_request(options)
|
3464
|
+
end
|
3465
|
+
|
3466
|
+
# Removes tags from a resource.
|
3467
|
+
#
|
3468
|
+
# @option params [required, String] :resource_arn
|
3469
|
+
# The resource's ARN.
|
3470
|
+
#
|
3471
|
+
# @option params [required, Array<String>] :tag_keys
|
3472
|
+
# Keys of tags to remove.
|
3473
|
+
#
|
3474
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3475
|
+
#
|
3476
|
+
# @example Request syntax with placeholder values
|
3477
|
+
#
|
3478
|
+
# resp = client.untag_resource({
|
3479
|
+
# resource_arn: "TagArn", # required
|
3480
|
+
# tag_keys: ["TagKey"], # required
|
3481
|
+
# })
|
3482
|
+
#
|
3483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UntagResource AWS API Documentation
|
3484
|
+
#
|
3485
|
+
# @overload untag_resource(params = {})
|
3486
|
+
# @param [Hash] params ({})
|
3487
|
+
def untag_resource(params = {}, options = {})
|
3488
|
+
req = build_request(:untag_resource, params)
|
3489
|
+
req.send_request(options)
|
3490
|
+
end
|
3491
|
+
|
3492
|
+
# Updates an annotation store.
|
3493
|
+
#
|
3494
|
+
# @option params [String] :description
|
3495
|
+
# A description for the store.
|
3496
|
+
#
|
3497
|
+
# @option params [required, String] :name
|
3498
|
+
# A name for the store.
|
3499
|
+
#
|
3500
|
+
# @return [Types::UpdateAnnotationStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3501
|
+
#
|
3502
|
+
# * {Types::UpdateAnnotationStoreResponse#creation_time #creation_time} => Time
|
3503
|
+
# * {Types::UpdateAnnotationStoreResponse#description #description} => String
|
3504
|
+
# * {Types::UpdateAnnotationStoreResponse#id #id} => String
|
3505
|
+
# * {Types::UpdateAnnotationStoreResponse#name #name} => String
|
3506
|
+
# * {Types::UpdateAnnotationStoreResponse#reference #reference} => Types::ReferenceItem
|
3507
|
+
# * {Types::UpdateAnnotationStoreResponse#status #status} => String
|
3508
|
+
# * {Types::UpdateAnnotationStoreResponse#store_format #store_format} => String
|
3509
|
+
# * {Types::UpdateAnnotationStoreResponse#store_options #store_options} => Types::StoreOptions
|
3510
|
+
# * {Types::UpdateAnnotationStoreResponse#update_time #update_time} => Time
|
3511
|
+
#
|
3512
|
+
# @example Request syntax with placeholder values
|
3513
|
+
#
|
3514
|
+
# resp = client.update_annotation_store({
|
3515
|
+
# description: "StoreDescription",
|
3516
|
+
# name: "String", # required
|
3517
|
+
# })
|
3518
|
+
#
|
3519
|
+
# @example Response structure
|
3520
|
+
#
|
3521
|
+
# resp.creation_time #=> Time
|
3522
|
+
# resp.description #=> String
|
3523
|
+
# resp.id #=> String
|
3524
|
+
# resp.name #=> String
|
3525
|
+
# resp.reference.reference_arn #=> String
|
3526
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
3527
|
+
# resp.store_format #=> String, one of "GFF", "TSV", "VCF"
|
3528
|
+
# resp.store_options.tsv_store_options.annotation_type #=> String, one of "GENERIC", "CHR_POS", "CHR_POS_REF_ALT", "CHR_START_END_ONE_BASE", "CHR_START_END_REF_ALT_ONE_BASE", "CHR_START_END_ZERO_BASE", "CHR_START_END_REF_ALT_ZERO_BASE"
|
3529
|
+
# resp.store_options.tsv_store_options.format_to_header #=> Hash
|
3530
|
+
# resp.store_options.tsv_store_options.format_to_header["FormatToHeaderKey"] #=> String
|
3531
|
+
# resp.store_options.tsv_store_options.schema #=> Array
|
3532
|
+
# resp.store_options.tsv_store_options.schema[0] #=> Hash
|
3533
|
+
# resp.store_options.tsv_store_options.schema[0]["String"] #=> String, one of "LONG", "INT", "STRING", "FLOAT", "DOUBLE", "BOOLEAN"
|
3534
|
+
# resp.update_time #=> Time
|
3535
|
+
#
|
3536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateAnnotationStore AWS API Documentation
|
3537
|
+
#
|
3538
|
+
# @overload update_annotation_store(params = {})
|
3539
|
+
# @param [Hash] params ({})
|
3540
|
+
def update_annotation_store(params = {}, options = {})
|
3541
|
+
req = build_request(:update_annotation_store, params)
|
3542
|
+
req.send_request(options)
|
3543
|
+
end
|
3544
|
+
|
3545
|
+
# Updates a run group.
|
3546
|
+
#
|
3547
|
+
# @option params [required, String] :id
|
3548
|
+
# The group's ID.
|
3549
|
+
#
|
3550
|
+
# @option params [Integer] :max_cpus
|
3551
|
+
# The maximum number of CPUs to use.
|
3552
|
+
#
|
3553
|
+
# @option params [Integer] :max_duration
|
3554
|
+
# The maximum amount of time to run.
|
3555
|
+
#
|
3556
|
+
# @option params [Integer] :max_runs
|
3557
|
+
# The maximum number of concurrent runs for the group.
|
3558
|
+
#
|
3559
|
+
# @option params [String] :name
|
3560
|
+
# A name for the group.
|
3561
|
+
#
|
3562
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3563
|
+
#
|
3564
|
+
# @example Request syntax with placeholder values
|
3565
|
+
#
|
3566
|
+
# resp = client.update_run_group({
|
3567
|
+
# id: "RunGroupId", # required
|
3568
|
+
# max_cpus: 1,
|
3569
|
+
# max_duration: 1,
|
3570
|
+
# max_runs: 1,
|
3571
|
+
# name: "RunGroupName",
|
3572
|
+
# })
|
3573
|
+
#
|
3574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateRunGroup AWS API Documentation
|
3575
|
+
#
|
3576
|
+
# @overload update_run_group(params = {})
|
3577
|
+
# @param [Hash] params ({})
|
3578
|
+
def update_run_group(params = {}, options = {})
|
3579
|
+
req = build_request(:update_run_group, params)
|
3580
|
+
req.send_request(options)
|
3581
|
+
end
|
3582
|
+
|
3583
|
+
# Updates a variant store.
|
3584
|
+
#
|
3585
|
+
# @option params [String] :description
|
3586
|
+
# A description for the store.
|
3587
|
+
#
|
3588
|
+
# @option params [required, String] :name
|
3589
|
+
# A name for the store.
|
3590
|
+
#
|
3591
|
+
# @return [Types::UpdateVariantStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3592
|
+
#
|
3593
|
+
# * {Types::UpdateVariantStoreResponse#creation_time #creation_time} => Time
|
3594
|
+
# * {Types::UpdateVariantStoreResponse#description #description} => String
|
3595
|
+
# * {Types::UpdateVariantStoreResponse#id #id} => String
|
3596
|
+
# * {Types::UpdateVariantStoreResponse#name #name} => String
|
3597
|
+
# * {Types::UpdateVariantStoreResponse#reference #reference} => Types::ReferenceItem
|
3598
|
+
# * {Types::UpdateVariantStoreResponse#status #status} => String
|
3599
|
+
# * {Types::UpdateVariantStoreResponse#update_time #update_time} => Time
|
3600
|
+
#
|
3601
|
+
# @example Request syntax with placeholder values
|
3602
|
+
#
|
3603
|
+
# resp = client.update_variant_store({
|
3604
|
+
# description: "StoreDescription",
|
3605
|
+
# name: "String", # required
|
3606
|
+
# })
|
3607
|
+
#
|
3608
|
+
# @example Response structure
|
3609
|
+
#
|
3610
|
+
# resp.creation_time #=> Time
|
3611
|
+
# resp.description #=> String
|
3612
|
+
# resp.id #=> String
|
3613
|
+
# resp.name #=> String
|
3614
|
+
# resp.reference.reference_arn #=> String
|
3615
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
3616
|
+
# resp.update_time #=> Time
|
3617
|
+
#
|
3618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateVariantStore AWS API Documentation
|
3619
|
+
#
|
3620
|
+
# @overload update_variant_store(params = {})
|
3621
|
+
# @param [Hash] params ({})
|
3622
|
+
def update_variant_store(params = {}, options = {})
|
3623
|
+
req = build_request(:update_variant_store, params)
|
3624
|
+
req.send_request(options)
|
3625
|
+
end
|
3626
|
+
|
3627
|
+
# Updates a workflow.
|
3628
|
+
#
|
3629
|
+
# @option params [String] :description
|
3630
|
+
# A description for the workflow.
|
3631
|
+
#
|
3632
|
+
# @option params [required, String] :id
|
3633
|
+
# The workflow's ID.
|
3634
|
+
#
|
3635
|
+
# @option params [String] :name
|
3636
|
+
# A name for the workflow.
|
3637
|
+
#
|
3638
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3639
|
+
#
|
3640
|
+
# @example Request syntax with placeholder values
|
3641
|
+
#
|
3642
|
+
# resp = client.update_workflow({
|
3643
|
+
# description: "WorkflowDescription",
|
3644
|
+
# id: "WorkflowId", # required
|
3645
|
+
# name: "WorkflowName",
|
3646
|
+
# })
|
3647
|
+
#
|
3648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/UpdateWorkflow AWS API Documentation
|
3649
|
+
#
|
3650
|
+
# @overload update_workflow(params = {})
|
3651
|
+
# @param [Hash] params ({})
|
3652
|
+
def update_workflow(params = {}, options = {})
|
3653
|
+
req = build_request(:update_workflow, params)
|
3654
|
+
req.send_request(options)
|
3655
|
+
end
|
3656
|
+
|
3657
|
+
# @!endgroup
|
3658
|
+
|
3659
|
+
# @param params ({})
|
3660
|
+
# @api private
|
3661
|
+
def build_request(operation_name, params = {})
|
3662
|
+
handlers = @handlers.for(operation_name)
|
3663
|
+
context = Seahorse::Client::RequestContext.new(
|
3664
|
+
operation_name: operation_name,
|
3665
|
+
operation: config.api.operation(operation_name),
|
3666
|
+
client: self,
|
3667
|
+
params: params,
|
3668
|
+
config: config)
|
3669
|
+
context[:gem_name] = 'aws-sdk-omics'
|
3670
|
+
context[:gem_version] = '1.0.0'
|
3671
|
+
Seahorse::Client::Request.new(handlers, context)
|
3672
|
+
end
|
3673
|
+
|
3674
|
+
# Polls an API operation until a resource enters a desired state.
|
3675
|
+
#
|
3676
|
+
# ## Basic Usage
|
3677
|
+
#
|
3678
|
+
# A waiter will call an API operation until:
|
3679
|
+
#
|
3680
|
+
# * It is successful
|
3681
|
+
# * It enters a terminal state
|
3682
|
+
# * It makes the maximum number of attempts
|
3683
|
+
#
|
3684
|
+
# In between attempts, the waiter will sleep.
|
3685
|
+
#
|
3686
|
+
# # polls in a loop, sleeping between attempts
|
3687
|
+
# client.wait_until(waiter_name, params)
|
3688
|
+
#
|
3689
|
+
# ## Configuration
|
3690
|
+
#
|
3691
|
+
# You can configure the maximum number of polling attempts, and the
|
3692
|
+
# delay (in seconds) between each polling attempt. You can pass
|
3693
|
+
# configuration as the final arguments hash.
|
3694
|
+
#
|
3695
|
+
# # poll for ~25 seconds
|
3696
|
+
# client.wait_until(waiter_name, params, {
|
3697
|
+
# max_attempts: 5,
|
3698
|
+
# delay: 5,
|
3699
|
+
# })
|
3700
|
+
#
|
3701
|
+
# ## Callbacks
|
3702
|
+
#
|
3703
|
+
# You can be notified before each polling attempt and before each
|
3704
|
+
# delay. If you throw `:success` or `:failure` from these callbacks,
|
3705
|
+
# it will terminate the waiter.
|
3706
|
+
#
|
3707
|
+
# started_at = Time.now
|
3708
|
+
# client.wait_until(waiter_name, params, {
|
3709
|
+
#
|
3710
|
+
# # disable max attempts
|
3711
|
+
# max_attempts: nil,
|
3712
|
+
#
|
3713
|
+
# # poll for 1 hour, instead of a number of attempts
|
3714
|
+
# before_wait: -> (attempts, response) do
|
3715
|
+
# throw :failure if Time.now - started_at > 3600
|
3716
|
+
# end
|
3717
|
+
# })
|
3718
|
+
#
|
3719
|
+
# ## Handling Errors
|
3720
|
+
#
|
3721
|
+
# When a waiter is unsuccessful, it will raise an error.
|
3722
|
+
# All of the failure errors extend from
|
3723
|
+
# {Aws::Waiters::Errors::WaiterFailed}.
|
3724
|
+
#
|
3725
|
+
# begin
|
3726
|
+
# client.wait_until(...)
|
3727
|
+
# rescue Aws::Waiters::Errors::WaiterFailed
|
3728
|
+
# # resource did not enter the desired state in time
|
3729
|
+
# end
|
3730
|
+
#
|
3731
|
+
# ## Valid Waiters
|
3732
|
+
#
|
3733
|
+
# The following table lists the valid waiter names, the operations they call,
|
3734
|
+
# and the default `:delay` and `:max_attempts` values.
|
3735
|
+
#
|
3736
|
+
# | waiter_name | params | :delay | :max_attempts |
|
3737
|
+
# | --------------------------------- | ------------------------------------ | -------- | ------------- |
|
3738
|
+
# | annotation_import_job_created | {Client#get_annotation_import_job} | 30 | 20 |
|
3739
|
+
# | annotation_store_created | {Client#get_annotation_store} | 30 | 20 |
|
3740
|
+
# | annotation_store_deleted | {Client#get_annotation_store} | 30 | 20 |
|
3741
|
+
# | read_set_activation_job_completed | {Client#get_read_set_activation_job} | 30 | 20 |
|
3742
|
+
# | read_set_export_job_completed | {Client#get_read_set_export_job} | 30 | 20 |
|
3743
|
+
# | read_set_import_job_completed | {Client#get_read_set_import_job} | 30 | 20 |
|
3744
|
+
# | reference_import_job_completed | {Client#get_reference_import_job} | 30 | 20 |
|
3745
|
+
# | run_completed | {Client#get_run} | 30 | 20 |
|
3746
|
+
# | run_running | {Client#get_run} | 30 | 20 |
|
3747
|
+
# | task_completed | {Client#get_run_task} | 30 | 20 |
|
3748
|
+
# | task_running | {Client#get_run_task} | 30 | 20 |
|
3749
|
+
# | variant_import_job_created | {Client#get_variant_import_job} | 30 | 20 |
|
3750
|
+
# | variant_store_created | {Client#get_variant_store} | 30 | 20 |
|
3751
|
+
# | variant_store_deleted | {Client#get_variant_store} | 30 | 20 |
|
3752
|
+
# | workflow_active | {Client#get_workflow} | 3 | 10 |
|
3753
|
+
#
|
3754
|
+
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
3755
|
+
# because the waiter has entered a state that it will not transition
|
3756
|
+
# out of, preventing success.
|
3757
|
+
#
|
3758
|
+
# @raise [Errors::TooManyAttemptsError] Raised when the configured
|
3759
|
+
# maximum number of attempts have been made, and the waiter is not
|
3760
|
+
# yet successful.
|
3761
|
+
#
|
3762
|
+
# @raise [Errors::UnexpectedError] Raised when an error is encounted
|
3763
|
+
# while polling for a resource that is not expected.
|
3764
|
+
#
|
3765
|
+
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
|
3766
|
+
# for an unknown state.
|
3767
|
+
#
|
3768
|
+
# @return [Boolean] Returns `true` if the waiter was successful.
|
3769
|
+
# @param [Symbol] waiter_name
|
3770
|
+
# @param [Hash] params ({})
|
3771
|
+
# @param [Hash] options ({})
|
3772
|
+
# @option options [Integer] :max_attempts
|
3773
|
+
# @option options [Integer] :delay
|
3774
|
+
# @option options [Proc] :before_attempt
|
3775
|
+
# @option options [Proc] :before_wait
|
3776
|
+
def wait_until(waiter_name, params = {}, options = {})
|
3777
|
+
w = waiter(waiter_name, options)
|
3778
|
+
yield(w.waiter) if block_given? # deprecated
|
3779
|
+
w.wait(params)
|
3780
|
+
end
|
3781
|
+
|
3782
|
+
# @api private
|
3783
|
+
# @deprecated
|
3784
|
+
def waiter_names
|
3785
|
+
waiters.keys
|
3786
|
+
end
|
3787
|
+
|
3788
|
+
private
|
3789
|
+
|
3790
|
+
# @param [Symbol] waiter_name
|
3791
|
+
# @param [Hash] options ({})
|
3792
|
+
def waiter(waiter_name, options = {})
|
3793
|
+
waiter_class = waiters[waiter_name]
|
3794
|
+
if waiter_class
|
3795
|
+
waiter_class.new(options.merge(client: self))
|
3796
|
+
else
|
3797
|
+
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
|
3798
|
+
end
|
3799
|
+
end
|
3800
|
+
|
3801
|
+
def waiters
|
3802
|
+
{
|
3803
|
+
annotation_import_job_created: Waiters::AnnotationImportJobCreated,
|
3804
|
+
annotation_store_created: Waiters::AnnotationStoreCreated,
|
3805
|
+
annotation_store_deleted: Waiters::AnnotationStoreDeleted,
|
3806
|
+
read_set_activation_job_completed: Waiters::ReadSetActivationJobCompleted,
|
3807
|
+
read_set_export_job_completed: Waiters::ReadSetExportJobCompleted,
|
3808
|
+
read_set_import_job_completed: Waiters::ReadSetImportJobCompleted,
|
3809
|
+
reference_import_job_completed: Waiters::ReferenceImportJobCompleted,
|
3810
|
+
run_completed: Waiters::RunCompleted,
|
3811
|
+
run_running: Waiters::RunRunning,
|
3812
|
+
task_completed: Waiters::TaskCompleted,
|
3813
|
+
task_running: Waiters::TaskRunning,
|
3814
|
+
variant_import_job_created: Waiters::VariantImportJobCreated,
|
3815
|
+
variant_store_created: Waiters::VariantStoreCreated,
|
3816
|
+
variant_store_deleted: Waiters::VariantStoreDeleted,
|
3817
|
+
workflow_active: Waiters::WorkflowActive
|
3818
|
+
}
|
3819
|
+
end
|
3820
|
+
|
3821
|
+
class << self
|
3822
|
+
|
3823
|
+
# @api private
|
3824
|
+
attr_reader :identifier
|
3825
|
+
|
3826
|
+
# @api private
|
3827
|
+
def errors_module
|
3828
|
+
Errors
|
3829
|
+
end
|
3830
|
+
|
3831
|
+
end
|
3832
|
+
end
|
3833
|
+
end
|