aws-sdk-braket 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 67dd00b62267776b25f104299c09e1bdcbd43ad3a4abd91c5cd74cb9fa30ceb4
4
+ data.tar.gz: e95f2ab31809a4674081953352d6642e51885a430b5434c33da1deb521161e35
5
+ SHA512:
6
+ metadata.gz: 3b1c0fd269a3793c715916307b6de8ad27a3501144bf6e32c4bc02ec99942c879d6faca3dab2a4193589d7e61f6227be51e5ae4e1669e9800e87119221b21613
7
+ data.tar.gz: b4b4d4f6ee649e673b1e643e1ee76c8dcf89817d0b8edea80f69919cabbc89281f1a40a64d48076ee93b55924af4111a7bf1b2a3ef3c589292d7449ab0264178
@@ -0,0 +1,52 @@
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/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'aws-sdk-core'
11
+ require 'aws-sigv4'
12
+
13
+ require_relative 'aws-sdk-braket/types'
14
+ require_relative 'aws-sdk-braket/client_api'
15
+ require_relative 'aws-sdk-braket/client'
16
+ require_relative 'aws-sdk-braket/errors'
17
+ require_relative 'aws-sdk-braket/resource'
18
+ require_relative 'aws-sdk-braket/customizations'
19
+
20
+ # This module provides support for Braket. This module is available in the
21
+ # `aws-sdk-braket` gem.
22
+ #
23
+ # # Client
24
+ #
25
+ # The {Client} class provides one method for each API operation. Operation
26
+ # methods each accept a hash of request parameters and return a response
27
+ # structure.
28
+ #
29
+ # braket = Aws::Braket::Client.new
30
+ # resp = braket.cancel_quantum_task(params)
31
+ #
32
+ # See {Client} for more information.
33
+ #
34
+ # # Errors
35
+ #
36
+ # Errors returned from Braket are defined in the
37
+ # {Errors} module and all extend {Errors::ServiceError}.
38
+ #
39
+ # begin
40
+ # # do stuff
41
+ # rescue Aws::Braket::Errors::ServiceError
42
+ # # rescues all Braket API errors
43
+ # end
44
+ #
45
+ # See {Errors} for more information.
46
+ #
47
+ # @service
48
+ module Aws::Braket
49
+
50
+ GEM_VERSION = '1.0.0'
51
+
52
+ end
@@ -0,0 +1,643 @@
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/master/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/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:braket)
34
+
35
+ module Aws::Braket
36
+ # An API client for Braket. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::Braket::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :braket
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
+ # from an EC2 IMDS on an EC2 instance.
90
+ #
91
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
92
+ # shared file, such as `~/.aws/config`.
93
+ #
94
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
95
+ #
96
+ # When `:credentials` are not configured directly, the following
97
+ # locations will be searched for credentials:
98
+ #
99
+ # * `Aws.config[:credentials]`
100
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
101
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
+ # * `~/.aws/credentials`
103
+ # * `~/.aws/config`
104
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
105
+ # very aggressive. Construct and pass an instance of
106
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
107
+ # timeouts.
108
+ #
109
+ # @option options [required, String] :region
110
+ # The AWS region to connect to. The configured `:region` is
111
+ # used to determine the service `:endpoint`. When not passed,
112
+ # a default `:region` is searched for in the following locations:
113
+ #
114
+ # * `Aws.config[:region]`
115
+ # * `ENV['AWS_REGION']`
116
+ # * `ENV['AMAZON_REGION']`
117
+ # * `ENV['AWS_DEFAULT_REGION']`
118
+ # * `~/.aws/credentials`
119
+ # * `~/.aws/config`
120
+ #
121
+ # @option options [String] :access_key_id
122
+ #
123
+ # @option options [Boolean] :active_endpoint_cache (false)
124
+ # When set to `true`, a thread polling for endpoints will be running in
125
+ # the background every 60 secs (default). Defaults to `false`.
126
+ #
127
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
128
+ # Used only in `adaptive` retry mode. When true, the request will sleep
129
+ # until there is sufficent client side capacity to retry the request.
130
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
131
+ # not retry instead of sleeping.
132
+ #
133
+ # @option options [Boolean] :client_side_monitoring (false)
134
+ # When `true`, client-side metrics will be collected for all API requests from
135
+ # this client.
136
+ #
137
+ # @option options [String] :client_side_monitoring_client_id ("")
138
+ # Allows you to provide an identifier for this client which will be attached to
139
+ # all generated client side metrics. Defaults to an empty string.
140
+ #
141
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
142
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
143
+ # side monitoring agent is running on, where client metrics will be published via UDP.
144
+ #
145
+ # @option options [Integer] :client_side_monitoring_port (31000)
146
+ # Required for publishing client metrics. The port that the client side monitoring
147
+ # agent is running on, where client metrics will be published via UDP.
148
+ #
149
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
150
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
151
+ # will use the Client Side Monitoring Agent Publisher.
152
+ #
153
+ # @option options [Boolean] :convert_params (true)
154
+ # When `true`, an attempt is made to coerce request parameters into
155
+ # the required types.
156
+ #
157
+ # @option options [Boolean] :correct_clock_skew (true)
158
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
159
+ # a clock skew correction and retry requests with skewed client clocks.
160
+ #
161
+ # @option options [Boolean] :disable_host_prefix_injection (false)
162
+ # Set to true to disable SDK automatically adding host prefix
163
+ # to default service endpoint when available.
164
+ #
165
+ # @option options [String] :endpoint
166
+ # The client endpoint is normally constructed from the `:region`
167
+ # option. You should only configure an `:endpoint` when connecting
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
169
+ #
170
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
171
+ # Used for the maximum size limit of the LRU cache storing endpoints data
172
+ # for endpoint discovery enabled operations. Defaults to 1000.
173
+ #
174
+ # @option options [Integer] :endpoint_cache_max_threads (10)
175
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
176
+ #
177
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
178
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
179
+ # Use this option to config the time interval in seconds for making
180
+ # requests fetching endpoints information. Defaults to 60 sec.
181
+ #
182
+ # @option options [Boolean] :endpoint_discovery (false)
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
184
+ #
185
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
186
+ # The log formatter.
187
+ #
188
+ # @option options [Symbol] :log_level (:info)
189
+ # The log level to send messages to the `:logger` at.
190
+ #
191
+ # @option options [Logger] :logger
192
+ # The Logger instance to send log messages to. If this option
193
+ # is not set, logging will be disabled.
194
+ #
195
+ # @option options [Integer] :max_attempts (3)
196
+ # An integer representing the maximum number attempts that will be made for
197
+ # a single request, including the initial attempt. For example,
198
+ # setting this value to 5 will result in a request being retried up to
199
+ # 4 times. Used in `standard` and `adaptive` retry modes.
200
+ #
201
+ # @option options [String] :profile ("default")
202
+ # Used when loading credentials from the shared credentials file
203
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
204
+ #
205
+ # @option options [Proc] :retry_backoff
206
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
207
+ # This option is only used in the `legacy` retry mode.
208
+ #
209
+ # @option options [Float] :retry_base_delay (0.3)
210
+ # The base delay in seconds used by the default backoff function. This option
211
+ # is only used in the `legacy` retry mode.
212
+ #
213
+ # @option options [Symbol] :retry_jitter (:none)
214
+ # A delay randomiser function used by the default backoff function.
215
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
216
+ # otherwise a Proc that takes and returns a number. This option is only used
217
+ # in the `legacy` retry mode.
218
+ #
219
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
220
+ #
221
+ # @option options [Integer] :retry_limit (3)
222
+ # The maximum number of times to retry failed requests. Only
223
+ # ~ 500 level server errors and certain ~ 400 level client errors
224
+ # are retried. Generally, these are throttling errors, data
225
+ # checksum errors, networking errors, timeout errors, auth errors,
226
+ # endpoint discovery, and errors from expired credentials.
227
+ # This option is only used in the `legacy` retry mode.
228
+ #
229
+ # @option options [Integer] :retry_max_delay (0)
230
+ # The maximum number of seconds to delay between retries (0 for no limit)
231
+ # used by the default backoff function. This option is only used in the
232
+ # `legacy` retry mode.
233
+ #
234
+ # @option options [String] :retry_mode ("legacy")
235
+ # Specifies which retry algorithm to use. Values are:
236
+ #
237
+ # * `legacy` - The pre-existing retry behavior. This is default value if
238
+ # no retry mode is provided.
239
+ #
240
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
241
+ # This includes support for retry quotas, which limit the number of
242
+ # unsuccessful retries a client can make.
243
+ #
244
+ # * `adaptive` - An experimental retry mode that includes all the
245
+ # functionality of `standard` mode along with automatic client side
246
+ # throttling. This is a provisional mode that may change behavior
247
+ # in the future.
248
+ #
249
+ #
250
+ # @option options [String] :secret_access_key
251
+ #
252
+ # @option options [String] :session_token
253
+ #
254
+ # @option options [Boolean] :stub_responses (false)
255
+ # Causes the client to return stubbed responses. By default
256
+ # fake responses are generated and returned. You can specify
257
+ # the response data to return or errors to raise by calling
258
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
259
+ #
260
+ # ** Please note ** When response stubbing is enabled, no HTTP
261
+ # requests are made, and retries are disabled.
262
+ #
263
+ # @option options [Boolean] :validate_params (true)
264
+ # When `true`, request parameters are validated before
265
+ # sending the request.
266
+ #
267
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
268
+ # requests through. Formatted like 'http://proxy.com:123'.
269
+ #
270
+ # @option options [Float] :http_open_timeout (15) The number of
271
+ # seconds to wait when opening a HTTP session before raising a
272
+ # `Timeout::Error`.
273
+ #
274
+ # @option options [Integer] :http_read_timeout (60) The default
275
+ # number of seconds to wait for response data. This value can
276
+ # safely be set per-request on the session.
277
+ #
278
+ # @option options [Float] :http_idle_timeout (5) The number of
279
+ # seconds a connection is allowed to sit idle before it is
280
+ # considered stale. Stale connections are closed and removed
281
+ # from the pool before making a request.
282
+ #
283
+ # @option options [Float] :http_continue_timeout (1) The number of
284
+ # seconds to wait for a 100-continue response before sending the
285
+ # request body. This option has no effect unless the request has
286
+ # "Expect" header set to "100-continue". Defaults to `nil` which
287
+ # disables this behaviour. This value can safely be set per
288
+ # request on the session.
289
+ #
290
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
291
+ # HTTP debug output will be sent to the `:logger`.
292
+ #
293
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
294
+ # SSL peer certificates are verified when establishing a
295
+ # connection.
296
+ #
297
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
298
+ # certificate authority bundle file that should be used when
299
+ # verifying peer certificates. If you do not pass
300
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
301
+ # will be used if available.
302
+ #
303
+ # @option options [String] :ssl_ca_directory Full path of the
304
+ # directory that contains the unbundled SSL certificate
305
+ # authority files for verifying peer certificates. If you do
306
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
307
+ # system default will be used if available.
308
+ #
309
+ def initialize(*args)
310
+ super
311
+ end
312
+
313
+ # @!group API Operations
314
+
315
+ # Cancels the specified task.
316
+ #
317
+ # @option params [required, String] :client_token
318
+ # The client token associated with the request.
319
+ #
320
+ # **A suitable default value is auto-generated.** You should normally
321
+ # not need to pass this option.**
322
+ #
323
+ # @option params [required, String] :quantum_task_arn
324
+ # The ARN of the task to cancel.
325
+ #
326
+ # @return [Types::CancelQuantumTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
327
+ #
328
+ # * {Types::CancelQuantumTaskResponse#cancellation_status #cancellation_status} => String
329
+ # * {Types::CancelQuantumTaskResponse#quantum_task_arn #quantum_task_arn} => String
330
+ #
331
+ # @example Request syntax with placeholder values
332
+ #
333
+ # resp = client.cancel_quantum_task({
334
+ # client_token: "String64", # required
335
+ # quantum_task_arn: "QuantumTaskArn", # required
336
+ # })
337
+ #
338
+ # @example Response structure
339
+ #
340
+ # resp.cancellation_status #=> String, one of "CANCELLED", "CANCELLING"
341
+ # resp.quantum_task_arn #=> String
342
+ #
343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelQuantumTask AWS API Documentation
344
+ #
345
+ # @overload cancel_quantum_task(params = {})
346
+ # @param [Hash] params ({})
347
+ def cancel_quantum_task(params = {}, options = {})
348
+ req = build_request(:cancel_quantum_task, params)
349
+ req.send_request(options)
350
+ end
351
+
352
+ # Creates a quantum task.
353
+ #
354
+ # @option params [required, String] :action
355
+ # The action associated with the task.
356
+ #
357
+ # **SDK automatically handles json encoding and base64 encoding for you
358
+ # when the required value (Hash, Array, etc.) is provided according to
359
+ # the description.**
360
+ #
361
+ # @option params [required, String] :client_token
362
+ # The client token associated with the request.
363
+ #
364
+ # **A suitable default value is auto-generated.** You should normally
365
+ # not need to pass this option.**
366
+ #
367
+ # @option params [required, String] :device_arn
368
+ # The ARN of the device to run the task on.
369
+ #
370
+ # @option params [String] :device_parameters
371
+ # The parameters for the device to run the task on.
372
+ #
373
+ # **SDK automatically handles json encoding and base64 encoding for you
374
+ # when the required value (Hash, Array, etc.) is provided according to
375
+ # the description.**
376
+ #
377
+ # @option params [required, String] :output_s3_bucket
378
+ # The S3 bucket to store task result files in.
379
+ #
380
+ # @option params [required, String] :output_s3_key_prefix
381
+ # The key prefix for the location in the S3 bucket to store task results
382
+ # in.
383
+ #
384
+ # @option params [required, Integer] :shots
385
+ # The number of shots to use for the task.
386
+ #
387
+ # @return [Types::CreateQuantumTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
388
+ #
389
+ # * {Types::CreateQuantumTaskResponse#quantum_task_arn #quantum_task_arn} => String
390
+ #
391
+ # @example Request syntax with placeholder values
392
+ #
393
+ # resp = client.create_quantum_task({
394
+ # action: "JsonValue", # required
395
+ # client_token: "String64", # required
396
+ # device_arn: "DeviceArn", # required
397
+ # device_parameters: "CreateQuantumTaskRequestdeviceParametersJsonValue",
398
+ # output_s3_bucket: "CreateQuantumTaskRequestoutputS3BucketString", # required
399
+ # output_s3_key_prefix: "CreateQuantumTaskRequestoutputS3KeyPrefixString", # required
400
+ # shots: 1, # required
401
+ # })
402
+ #
403
+ # @example Response structure
404
+ #
405
+ # resp.quantum_task_arn #=> String
406
+ #
407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateQuantumTask AWS API Documentation
408
+ #
409
+ # @overload create_quantum_task(params = {})
410
+ # @param [Hash] params ({})
411
+ def create_quantum_task(params = {}, options = {})
412
+ req = build_request(:create_quantum_task, params)
413
+ req.send_request(options)
414
+ end
415
+
416
+ # Retrieves the devices available in Amazon Braket.
417
+ #
418
+ # @option params [required, String] :device_arn
419
+ # The ARN of the device to retrieve.
420
+ #
421
+ # @return [Types::GetDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
422
+ #
423
+ # * {Types::GetDeviceResponse#device_arn #device_arn} => String
424
+ # * {Types::GetDeviceResponse#device_capabilities #device_capabilities} => String
425
+ # * {Types::GetDeviceResponse#device_name #device_name} => String
426
+ # * {Types::GetDeviceResponse#device_status #device_status} => String
427
+ # * {Types::GetDeviceResponse#device_type #device_type} => String
428
+ # * {Types::GetDeviceResponse#provider_name #provider_name} => String
429
+ #
430
+ # @example Request syntax with placeholder values
431
+ #
432
+ # resp = client.get_device({
433
+ # device_arn: "DeviceArn", # required
434
+ # })
435
+ #
436
+ # @example Response structure
437
+ #
438
+ # resp.device_arn #=> String
439
+ # resp.device_capabilities #=> String
440
+ # resp.device_name #=> String
441
+ # resp.device_status #=> String, one of "QPU", "SIMULATOR"
442
+ # resp.device_type #=> String, one of "OFFLINE", "ONLINE"
443
+ # resp.provider_name #=> String
444
+ #
445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetDevice AWS API Documentation
446
+ #
447
+ # @overload get_device(params = {})
448
+ # @param [Hash] params ({})
449
+ def get_device(params = {}, options = {})
450
+ req = build_request(:get_device, params)
451
+ req.send_request(options)
452
+ end
453
+
454
+ # Retrieves the specified quantum task.
455
+ #
456
+ # @option params [required, String] :quantum_task_arn
457
+ # the ARN of the task to retrieve.
458
+ #
459
+ # @return [Types::GetQuantumTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
460
+ #
461
+ # * {Types::GetQuantumTaskResponse#created_at #created_at} => Time
462
+ # * {Types::GetQuantumTaskResponse#device_arn #device_arn} => String
463
+ # * {Types::GetQuantumTaskResponse#device_parameters #device_parameters} => String
464
+ # * {Types::GetQuantumTaskResponse#ended_at #ended_at} => Time
465
+ # * {Types::GetQuantumTaskResponse#failure_reason #failure_reason} => String
466
+ # * {Types::GetQuantumTaskResponse#output_s3_bucket #output_s3_bucket} => String
467
+ # * {Types::GetQuantumTaskResponse#output_s3_directory #output_s3_directory} => String
468
+ # * {Types::GetQuantumTaskResponse#quantum_task_arn #quantum_task_arn} => String
469
+ # * {Types::GetQuantumTaskResponse#shots #shots} => Integer
470
+ # * {Types::GetQuantumTaskResponse#status #status} => String
471
+ #
472
+ # @example Request syntax with placeholder values
473
+ #
474
+ # resp = client.get_quantum_task({
475
+ # quantum_task_arn: "QuantumTaskArn", # required
476
+ # })
477
+ #
478
+ # @example Response structure
479
+ #
480
+ # resp.created_at #=> Time
481
+ # resp.device_arn #=> String
482
+ # resp.device_parameters #=> String
483
+ # resp.ended_at #=> Time
484
+ # resp.failure_reason #=> String
485
+ # resp.output_s3_bucket #=> String
486
+ # resp.output_s3_directory #=> String
487
+ # resp.quantum_task_arn #=> String
488
+ # resp.shots #=> Integer
489
+ # resp.status #=> String, one of "CANCELLED", "CANCELLING", "COMPLETED", "CREATED", "FAILED", "QUEUED", "RUNNING"
490
+ #
491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetQuantumTask AWS API Documentation
492
+ #
493
+ # @overload get_quantum_task(params = {})
494
+ # @param [Hash] params ({})
495
+ def get_quantum_task(params = {}, options = {})
496
+ req = build_request(:get_quantum_task, params)
497
+ req.send_request(options)
498
+ end
499
+
500
+ # Searches for devices using the specified filters.
501
+ #
502
+ # @option params [required, Array<Types::SearchDevicesFilter>] :filters
503
+ # The filter values to use to search for a device.
504
+ #
505
+ # @option params [Integer] :max_results
506
+ # The maximum number of results to return in the response.
507
+ #
508
+ # @option params [String] :next_token
509
+ # A token used for pagination of results returned in the response. Use
510
+ # the token returned from the previous request continue results where
511
+ # the previous request ended.
512
+ #
513
+ # @return [Types::SearchDevicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
514
+ #
515
+ # * {Types::SearchDevicesResponse#devices #devices} => Array&lt;Types::DeviceSummary&gt;
516
+ # * {Types::SearchDevicesResponse#next_token #next_token} => String
517
+ #
518
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
519
+ #
520
+ # @example Request syntax with placeholder values
521
+ #
522
+ # resp = client.search_devices({
523
+ # filters: [ # required
524
+ # {
525
+ # name: "SearchDevicesFilternameString", # required
526
+ # values: ["String256"], # required
527
+ # },
528
+ # ],
529
+ # max_results: 1,
530
+ # next_token: "String",
531
+ # })
532
+ #
533
+ # @example Response structure
534
+ #
535
+ # resp.devices #=> Array
536
+ # resp.devices[0].device_arn #=> String
537
+ # resp.devices[0].device_name #=> String
538
+ # resp.devices[0].device_status #=> String, one of "QPU", "SIMULATOR"
539
+ # resp.devices[0].device_type #=> String, one of "OFFLINE", "ONLINE"
540
+ # resp.devices[0].provider_name #=> String
541
+ # resp.next_token #=> String
542
+ #
543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchDevices AWS API Documentation
544
+ #
545
+ # @overload search_devices(params = {})
546
+ # @param [Hash] params ({})
547
+ def search_devices(params = {}, options = {})
548
+ req = build_request(:search_devices, params)
549
+ req.send_request(options)
550
+ end
551
+
552
+ # Searches for tasks that match the specified filter values.
553
+ #
554
+ # @option params [required, Array<Types::SearchQuantumTasksFilter>] :filters
555
+ # Array of `SearchQuantumTasksFilter` objects.
556
+ #
557
+ # @option params [Integer] :max_results
558
+ # Maximum number of results to return in the response.
559
+ #
560
+ # @option params [String] :next_token
561
+ # A token used for pagination of results returned in the response. Use
562
+ # the token returned from the previous request continue results where
563
+ # the previous request ended.
564
+ #
565
+ # @return [Types::SearchQuantumTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
566
+ #
567
+ # * {Types::SearchQuantumTasksResponse#next_token #next_token} => String
568
+ # * {Types::SearchQuantumTasksResponse#quantum_tasks #quantum_tasks} => Array&lt;Types::QuantumTaskSummary&gt;
569
+ #
570
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
571
+ #
572
+ # @example Request syntax with placeholder values
573
+ #
574
+ # resp = client.search_quantum_tasks({
575
+ # filters: [ # required
576
+ # {
577
+ # name: "String64", # required
578
+ # operator: "BETWEEN", # required, accepts BETWEEN, EQUAL, GT, GTE, LT, LTE
579
+ # values: ["String256"], # required
580
+ # },
581
+ # ],
582
+ # max_results: 1,
583
+ # next_token: "String",
584
+ # })
585
+ #
586
+ # @example Response structure
587
+ #
588
+ # resp.next_token #=> String
589
+ # resp.quantum_tasks #=> Array
590
+ # resp.quantum_tasks[0].created_at #=> Time
591
+ # resp.quantum_tasks[0].device_arn #=> String
592
+ # resp.quantum_tasks[0].ended_at #=> Time
593
+ # resp.quantum_tasks[0].output_s3_bucket #=> String
594
+ # resp.quantum_tasks[0].output_s3_directory #=> String
595
+ # resp.quantum_tasks[0].quantum_task_arn #=> String
596
+ # resp.quantum_tasks[0].shots #=> Integer
597
+ # resp.quantum_tasks[0].status #=> String, one of "CANCELLED", "CANCELLING", "COMPLETED", "CREATED", "FAILED", "QUEUED", "RUNNING"
598
+ #
599
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchQuantumTasks AWS API Documentation
600
+ #
601
+ # @overload search_quantum_tasks(params = {})
602
+ # @param [Hash] params ({})
603
+ def search_quantum_tasks(params = {}, options = {})
604
+ req = build_request(:search_quantum_tasks, params)
605
+ req.send_request(options)
606
+ end
607
+
608
+ # @!endgroup
609
+
610
+ # @param params ({})
611
+ # @api private
612
+ def build_request(operation_name, params = {})
613
+ handlers = @handlers.for(operation_name)
614
+ context = Seahorse::Client::RequestContext.new(
615
+ operation_name: operation_name,
616
+ operation: config.api.operation(operation_name),
617
+ client: self,
618
+ params: params,
619
+ config: config)
620
+ context[:gem_name] = 'aws-sdk-braket'
621
+ context[:gem_version] = '1.0.0'
622
+ Seahorse::Client::Request.new(handlers, context)
623
+ end
624
+
625
+ # @api private
626
+ # @deprecated
627
+ def waiter_names
628
+ []
629
+ end
630
+
631
+ class << self
632
+
633
+ # @api private
634
+ attr_reader :identifier
635
+
636
+ # @api private
637
+ def errors_module
638
+ Errors
639
+ end
640
+
641
+ end
642
+ end
643
+ end