aws-sdk-braket 1.56.0 → 1.57.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-braket/client.rb +248 -229
- data/lib/aws-sdk-braket/client_api.rb +101 -77
- data/lib/aws-sdk-braket/errors.rb +10 -0
- data/lib/aws-sdk-braket/types.rb +580 -477
- data/lib/aws-sdk-braket.rb +1 -1
- data/sig/client.rbs +88 -86
- data/sig/errors.rbs +2 -0
- data/sig/types.rbs +91 -73
- metadata +3 -3
data/lib/aws-sdk-braket/types.rb
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
module Aws::Braket
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# You do not have sufficient
|
13
|
+
# You do not have sufficient permissions to perform this action.
|
14
14
|
#
|
15
15
|
# @!attribute [rw] message
|
16
16
|
# @return [String]
|
@@ -23,24 +23,51 @@ module Aws::Braket
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
-
#
|
27
|
-
#
|
28
|
-
# and training.
|
26
|
+
# Contains metadata about the quantum task action, including the action
|
27
|
+
# type and program statistics.
|
29
28
|
#
|
30
|
-
# @!attribute [rw]
|
31
|
-
# The
|
32
|
-
# @return [
|
29
|
+
# @!attribute [rw] action_type
|
30
|
+
# The type of action associated with the quantum task.
|
31
|
+
# @return [String]
|
32
|
+
#
|
33
|
+
# @!attribute [rw] program_count
|
34
|
+
# The number of programs in a program set. This is only available for
|
35
|
+
# a Program Set.
|
36
|
+
# @return [Integer]
|
37
|
+
#
|
38
|
+
# @!attribute [rw] executable_count
|
39
|
+
# The number of executables in a program set. This is only available
|
40
|
+
# for a Program Set.
|
41
|
+
# @return [Integer]
|
42
|
+
#
|
43
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/ActionMetadata AWS API Documentation
|
44
|
+
#
|
45
|
+
class ActionMetadata < Struct.new(
|
46
|
+
:action_type,
|
47
|
+
:program_count,
|
48
|
+
:executable_count)
|
49
|
+
SENSITIVE = []
|
50
|
+
include Aws::Structure
|
51
|
+
end
|
52
|
+
|
53
|
+
# Defines the Amazon Braket hybrid job to be created. Specifies the
|
54
|
+
# container image the job uses and the paths to the Python scripts used
|
55
|
+
# for entry and training.
|
33
56
|
#
|
34
57
|
# @!attribute [rw] script_mode_config
|
35
58
|
# Configures the paths to the Python scripts used for entry and
|
36
59
|
# training.
|
37
60
|
# @return [Types::ScriptModeConfig]
|
38
61
|
#
|
62
|
+
# @!attribute [rw] container_image
|
63
|
+
# The container image used to create an Amazon Braket hybrid job.
|
64
|
+
# @return [Types::ContainerImage]
|
65
|
+
#
|
39
66
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/AlgorithmSpecification AWS API Documentation
|
40
67
|
#
|
41
68
|
class AlgorithmSpecification < Struct.new(
|
42
|
-
:
|
43
|
-
:
|
69
|
+
:script_mode_config,
|
70
|
+
:container_image)
|
44
71
|
SENSITIVE = []
|
45
72
|
include Aws::Structure
|
46
73
|
end
|
@@ -65,7 +92,7 @@ module Aws::Braket
|
|
65
92
|
end
|
66
93
|
|
67
94
|
# @!attribute [rw] job_arn
|
68
|
-
# The ARN of the Amazon Braket job to cancel.
|
95
|
+
# The ARN of the Amazon Braket hybrid job to cancel.
|
69
96
|
# @return [String]
|
70
97
|
#
|
71
98
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelJobRequest AWS API Documentation
|
@@ -76,56 +103,56 @@ module Aws::Braket
|
|
76
103
|
include Aws::Structure
|
77
104
|
end
|
78
105
|
|
79
|
-
# @!attribute [rw] cancellation_status
|
80
|
-
# The status of the job cancellation request.
|
81
|
-
# @return [String]
|
82
|
-
#
|
83
106
|
# @!attribute [rw] job_arn
|
84
107
|
# The ARN of the Amazon Braket job.
|
85
108
|
# @return [String]
|
86
109
|
#
|
110
|
+
# @!attribute [rw] cancellation_status
|
111
|
+
# The status of the hybrid job.
|
112
|
+
# @return [String]
|
113
|
+
#
|
87
114
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelJobResponse AWS API Documentation
|
88
115
|
#
|
89
116
|
class CancelJobResponse < Struct.new(
|
90
|
-
:
|
91
|
-
:
|
117
|
+
:job_arn,
|
118
|
+
:cancellation_status)
|
92
119
|
SENSITIVE = []
|
93
120
|
include Aws::Structure
|
94
121
|
end
|
95
122
|
|
123
|
+
# @!attribute [rw] quantum_task_arn
|
124
|
+
# The ARN of the quantum task to cancel.
|
125
|
+
# @return [String]
|
126
|
+
#
|
96
127
|
# @!attribute [rw] client_token
|
97
|
-
# The client token associated with the request.
|
128
|
+
# The client token associated with the cancellation request.
|
98
129
|
#
|
99
130
|
# **A suitable default value is auto-generated.** You should normally
|
100
131
|
# not need to pass this option.
|
101
132
|
# @return [String]
|
102
133
|
#
|
103
|
-
# @!attribute [rw] quantum_task_arn
|
104
|
-
# The ARN of the task to cancel.
|
105
|
-
# @return [String]
|
106
|
-
#
|
107
134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelQuantumTaskRequest AWS API Documentation
|
108
135
|
#
|
109
136
|
class CancelQuantumTaskRequest < Struct.new(
|
110
|
-
:
|
111
|
-
:
|
137
|
+
:quantum_task_arn,
|
138
|
+
:client_token)
|
112
139
|
SENSITIVE = []
|
113
140
|
include Aws::Structure
|
114
141
|
end
|
115
142
|
|
116
|
-
# @!attribute [rw]
|
117
|
-
# The
|
143
|
+
# @!attribute [rw] quantum_task_arn
|
144
|
+
# The ARN of the quantum task.
|
118
145
|
# @return [String]
|
119
146
|
#
|
120
|
-
# @!attribute [rw]
|
121
|
-
# The
|
147
|
+
# @!attribute [rw] cancellation_status
|
148
|
+
# The status of the quantum task.
|
122
149
|
# @return [String]
|
123
150
|
#
|
124
151
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelQuantumTaskResponse AWS API Documentation
|
125
152
|
#
|
126
153
|
class CancelQuantumTaskResponse < Struct.new(
|
127
|
-
:
|
128
|
-
:
|
154
|
+
:quantum_task_arn,
|
155
|
+
:cancellation_status)
|
129
156
|
SENSITIVE = []
|
130
157
|
include Aws::Structure
|
131
158
|
end
|
@@ -143,7 +170,7 @@ module Aws::Braket
|
|
143
170
|
include Aws::Structure
|
144
171
|
end
|
145
172
|
|
146
|
-
# The container image used to create an Amazon Braket job.
|
173
|
+
# The container image used to create an Amazon Braket hybrid job.
|
147
174
|
#
|
148
175
|
# @!attribute [rw] uri
|
149
176
|
# The URI locating the container image.
|
@@ -157,97 +184,105 @@ module Aws::Braket
|
|
157
184
|
include Aws::Structure
|
158
185
|
end
|
159
186
|
|
160
|
-
# @!attribute [rw] algorithm_specification
|
161
|
-
# Definition of the Amazon Braket job to be created. Specifies the
|
162
|
-
# container image the job uses and information about the Python
|
163
|
-
# scripts used for entry and training.
|
164
|
-
# @return [Types::AlgorithmSpecification]
|
165
|
-
#
|
166
|
-
# @!attribute [rw] associations
|
167
|
-
# The list of Amazon Braket resources associated with the hybrid job.
|
168
|
-
# @return [Array<Types::Association>]
|
169
|
-
#
|
170
|
-
# @!attribute [rw] checkpoint_config
|
171
|
-
# Information about the output locations for job checkpoint data.
|
172
|
-
# @return [Types::JobCheckpointConfig]
|
173
|
-
#
|
174
187
|
# @!attribute [rw] client_token
|
175
|
-
#
|
176
|
-
# idempotent.
|
188
|
+
# The client token associated with this request that guarantees that
|
189
|
+
# the request is idempotent.
|
177
190
|
#
|
178
191
|
# **A suitable default value is auto-generated.** You should normally
|
179
192
|
# not need to pass this option.
|
180
193
|
# @return [String]
|
181
194
|
#
|
182
|
-
# @!attribute [rw]
|
183
|
-
#
|
184
|
-
#
|
185
|
-
#
|
186
|
-
#
|
187
|
-
# @!attribute [rw] hyper_parameters
|
188
|
-
# Algorithm-specific parameters used by an Amazon Braket job that
|
189
|
-
# influence the quality of the training job. The values are set with a
|
190
|
-
# string of JSON key:value pairs, where the key is the name of the
|
191
|
-
# hyperparameter and the value is the value of th hyperparameter.
|
192
|
-
# @return [Hash<String,String>]
|
195
|
+
# @!attribute [rw] algorithm_specification
|
196
|
+
# Definition of the Amazon Braket job to be created. Specifies the
|
197
|
+
# container image the job uses and information about the Python
|
198
|
+
# scripts used for entry and training.
|
199
|
+
# @return [Types::AlgorithmSpecification]
|
193
200
|
#
|
194
201
|
# @!attribute [rw] input_data_config
|
195
202
|
# A list of parameters that specify the name and type of input data
|
196
203
|
# and where it is located.
|
197
204
|
# @return [Array<Types::InputFileConfig>]
|
198
205
|
#
|
199
|
-
# @!attribute [rw]
|
200
|
-
#
|
201
|
-
#
|
202
|
-
# @return [Types::
|
206
|
+
# @!attribute [rw] output_data_config
|
207
|
+
# The path to the S3 location where you want to store hybrid job
|
208
|
+
# artifacts and the encryption key used to store them.
|
209
|
+
# @return [Types::JobOutputDataConfig]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] checkpoint_config
|
212
|
+
# Information about the output locations for hybrid job checkpoint
|
213
|
+
# data.
|
214
|
+
# @return [Types::JobCheckpointConfig]
|
203
215
|
#
|
204
216
|
# @!attribute [rw] job_name
|
205
|
-
# The name of the Amazon Braket job.
|
217
|
+
# The name of the Amazon Braket hybrid job.
|
206
218
|
# @return [String]
|
207
219
|
#
|
208
|
-
# @!attribute [rw] output_data_config
|
209
|
-
# The path to the S3 location where you want to store job artifacts
|
210
|
-
# and the encryption key used to store them.
|
211
|
-
# @return [Types::JobOutputDataConfig]
|
212
|
-
#
|
213
220
|
# @!attribute [rw] role_arn
|
214
221
|
# The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can
|
215
222
|
# assume to perform tasks on behalf of a user. It can access user
|
216
223
|
# resources, run an Amazon Braket job container on behalf of user, and
|
217
|
-
# output
|
224
|
+
# output results and hybrid job details to the users' s3 buckets.
|
218
225
|
# @return [String]
|
219
226
|
#
|
220
227
|
# @!attribute [rw] stopping_condition
|
221
|
-
# The user-defined criteria that specifies when a job stops
|
228
|
+
# The user-defined criteria that specifies when a hybrid job stops
|
229
|
+
# running.
|
222
230
|
# @return [Types::JobStoppingCondition]
|
223
231
|
#
|
232
|
+
# @!attribute [rw] instance_config
|
233
|
+
# Configuration of the resource instances to use while running the
|
234
|
+
# hybrid job on Amazon Braket.
|
235
|
+
# @return [Types::InstanceConfig]
|
236
|
+
#
|
237
|
+
# @!attribute [rw] hyper_parameters
|
238
|
+
# Algorithm-specific parameters used by an Amazon Braket hybrid job
|
239
|
+
# that influence the quality of the training job. The values are set
|
240
|
+
# with a map of JSON key:value pairs, where the key is the name of the
|
241
|
+
# hyperparameter and the value is the value of the hyperparameter.
|
242
|
+
#
|
243
|
+
# Do not include any security-sensitive information including account
|
244
|
+
# access IDs, secrets, or tokens in any hyperparameter fields. As part
|
245
|
+
# of the shared responsibility model, you are responsible for any
|
246
|
+
# potential exposure, unauthorized access, or compromise of your
|
247
|
+
# sensitive data if caused by security-sensitive information included
|
248
|
+
# in the request hyperparameter variable or plain text fields.
|
249
|
+
# @return [Hash<String,String>]
|
250
|
+
#
|
251
|
+
# @!attribute [rw] device_config
|
252
|
+
# The quantum processing unit (QPU) or simulator used to create an
|
253
|
+
# Amazon Braket hybrid job.
|
254
|
+
# @return [Types::DeviceConfig]
|
255
|
+
#
|
224
256
|
# @!attribute [rw] tags
|
225
|
-
#
|
226
|
-
# manage metadata for Amazon Braket resources.
|
257
|
+
# Tags to be added to the hybrid job you're creating.
|
227
258
|
# @return [Hash<String,String>]
|
228
259
|
#
|
260
|
+
# @!attribute [rw] associations
|
261
|
+
# The list of Amazon Braket resources associated with the hybrid job.
|
262
|
+
# @return [Array<Types::Association>]
|
263
|
+
#
|
229
264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateJobRequest AWS API Documentation
|
230
265
|
#
|
231
266
|
class CreateJobRequest < Struct.new(
|
232
|
-
:algorithm_specification,
|
233
|
-
:associations,
|
234
|
-
:checkpoint_config,
|
235
267
|
:client_token,
|
236
|
-
:
|
237
|
-
:hyper_parameters,
|
268
|
+
:algorithm_specification,
|
238
269
|
:input_data_config,
|
239
|
-
:instance_config,
|
240
|
-
:job_name,
|
241
270
|
:output_data_config,
|
271
|
+
:checkpoint_config,
|
272
|
+
:job_name,
|
242
273
|
:role_arn,
|
243
274
|
:stopping_condition,
|
244
|
-
:
|
275
|
+
:instance_config,
|
276
|
+
:hyper_parameters,
|
277
|
+
:device_config,
|
278
|
+
:tags,
|
279
|
+
:associations)
|
245
280
|
SENSITIVE = []
|
246
281
|
include Aws::Structure
|
247
282
|
end
|
248
283
|
|
249
284
|
# @!attribute [rw] job_arn
|
250
|
-
# The ARN of the Amazon Braket job created.
|
285
|
+
# The ARN of the Amazon Braket hybrid job created.
|
251
286
|
# @return [String]
|
252
287
|
#
|
253
288
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateJobResponse AWS API Documentation
|
@@ -258,15 +293,6 @@ module Aws::Braket
|
|
258
293
|
include Aws::Structure
|
259
294
|
end
|
260
295
|
|
261
|
-
# @!attribute [rw] action
|
262
|
-
# The action associated with the task.
|
263
|
-
# @return [String]
|
264
|
-
#
|
265
|
-
# @!attribute [rw] associations
|
266
|
-
# The list of Amazon Braket resources associated with the quantum
|
267
|
-
# task.
|
268
|
-
# @return [Array<Types::Association>]
|
269
|
-
#
|
270
296
|
# @!attribute [rw] client_token
|
271
297
|
# The client token associated with the request.
|
272
298
|
#
|
@@ -275,54 +301,63 @@ module Aws::Braket
|
|
275
301
|
# @return [String]
|
276
302
|
#
|
277
303
|
# @!attribute [rw] device_arn
|
278
|
-
# The ARN of the device to run the task on.
|
304
|
+
# The ARN of the device to run the quantum task on.
|
279
305
|
# @return [String]
|
280
306
|
#
|
281
307
|
# @!attribute [rw] device_parameters
|
282
|
-
# The parameters for the device to run the task on.
|
308
|
+
# The parameters for the device to run the quantum task on.
|
283
309
|
# @return [String]
|
284
310
|
#
|
285
|
-
# @!attribute [rw]
|
286
|
-
# The
|
287
|
-
#
|
288
|
-
# @return [String]
|
311
|
+
# @!attribute [rw] shots
|
312
|
+
# The number of shots to use for the quantum task.
|
313
|
+
# @return [Integer]
|
289
314
|
#
|
290
315
|
# @!attribute [rw] output_s3_bucket
|
291
|
-
# The S3 bucket to store task result files in.
|
316
|
+
# The S3 bucket to store quantum task result files in.
|
292
317
|
# @return [String]
|
293
318
|
#
|
294
319
|
# @!attribute [rw] output_s3_key_prefix
|
295
|
-
# The key prefix for the location in the S3 bucket to store
|
296
|
-
# results in.
|
320
|
+
# The key prefix for the location in the S3 bucket to store quantum
|
321
|
+
# task results in.
|
297
322
|
# @return [String]
|
298
323
|
#
|
299
|
-
# @!attribute [rw]
|
300
|
-
# The
|
301
|
-
# @return [
|
324
|
+
# @!attribute [rw] action
|
325
|
+
# The action associated with the quantum task.
|
326
|
+
# @return [String]
|
302
327
|
#
|
303
328
|
# @!attribute [rw] tags
|
304
329
|
# Tags to be added to the quantum task you're creating.
|
305
330
|
# @return [Hash<String,String>]
|
306
331
|
#
|
332
|
+
# @!attribute [rw] job_token
|
333
|
+
# The token for an Amazon Braket hybrid job that associates it with
|
334
|
+
# the quantum task.
|
335
|
+
# @return [String]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] associations
|
338
|
+
# The list of Amazon Braket resources associated with the quantum
|
339
|
+
# task.
|
340
|
+
# @return [Array<Types::Association>]
|
341
|
+
#
|
307
342
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateQuantumTaskRequest AWS API Documentation
|
308
343
|
#
|
309
344
|
class CreateQuantumTaskRequest < Struct.new(
|
310
|
-
:action,
|
311
|
-
:associations,
|
312
345
|
:client_token,
|
313
346
|
:device_arn,
|
314
347
|
:device_parameters,
|
315
|
-
:
|
348
|
+
:shots,
|
316
349
|
:output_s3_bucket,
|
317
350
|
:output_s3_key_prefix,
|
318
|
-
:
|
319
|
-
:tags
|
351
|
+
:action,
|
352
|
+
:tags,
|
353
|
+
:job_token,
|
354
|
+
:associations)
|
320
355
|
SENSITIVE = []
|
321
356
|
include Aws::Structure
|
322
357
|
end
|
323
358
|
|
324
359
|
# @!attribute [rw] quantum_task_arn
|
325
|
-
# The ARN of the task created by the request.
|
360
|
+
# The ARN of the quantum task created by the request.
|
326
361
|
# @return [String]
|
327
362
|
#
|
328
363
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateQuantumTaskResponse AWS API Documentation
|
@@ -333,12 +368,11 @@ module Aws::Braket
|
|
333
368
|
include Aws::Structure
|
334
369
|
end
|
335
370
|
|
336
|
-
# Information about the source of the data used by the Amazon
|
337
|
-
# job.
|
371
|
+
# Information about the source of the input data used by the Amazon
|
372
|
+
# Braket hybrid job.
|
338
373
|
#
|
339
374
|
# @!attribute [rw] s3_data_source
|
340
|
-
#
|
341
|
-
# Braket job.
|
375
|
+
# Amazon S3 path of the input data used by the hybrid job.
|
342
376
|
# @return [Types::S3DataSource]
|
343
377
|
#
|
344
378
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/DataSource AWS API Documentation
|
@@ -349,12 +383,12 @@ module Aws::Braket
|
|
349
383
|
include Aws::Structure
|
350
384
|
end
|
351
385
|
|
352
|
-
# Configures the
|
353
|
-
#
|
386
|
+
# Configures the primary device used to create and run an Amazon Braket
|
387
|
+
# hybrid job.
|
354
388
|
#
|
355
389
|
# @!attribute [rw] device
|
356
|
-
# The primary
|
357
|
-
#
|
390
|
+
# The primary device ARN used to create and run an Amazon Braket
|
391
|
+
# hybrid job.
|
358
392
|
# @return [String]
|
359
393
|
#
|
360
394
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/DeviceConfig AWS API Documentation
|
@@ -378,27 +412,29 @@ module Aws::Braket
|
|
378
412
|
include Aws::Structure
|
379
413
|
end
|
380
414
|
|
381
|
-
# Information about tasks and jobs queued on a device.
|
415
|
+
# Information about quantum tasks and hybrid jobs queued on a device.
|
382
416
|
#
|
383
417
|
# @!attribute [rw] queue
|
384
418
|
# The name of the queue.
|
385
419
|
# @return [String]
|
386
420
|
#
|
387
|
-
# @!attribute [rw]
|
388
|
-
#
|
389
|
-
#
|
421
|
+
# @!attribute [rw] queue_size
|
422
|
+
# The number of hybrid jobs or quantum tasks in the queue for a given
|
423
|
+
# device.
|
390
424
|
# @return [String]
|
391
425
|
#
|
392
|
-
# @!attribute [rw]
|
393
|
-
#
|
426
|
+
# @!attribute [rw] queue_priority
|
427
|
+
# Optional. Specifies the priority of the queue. Quantum tasks in a
|
428
|
+
# priority queue are processed before the quantum tasks in a normal
|
429
|
+
# queue.
|
394
430
|
# @return [String]
|
395
431
|
#
|
396
432
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/DeviceQueueInfo AWS API Documentation
|
397
433
|
#
|
398
434
|
class DeviceQueueInfo < Struct.new(
|
399
435
|
:queue,
|
400
|
-
:
|
401
|
-
:
|
436
|
+
:queue_size,
|
437
|
+
:queue_priority)
|
402
438
|
SENSITIVE = []
|
403
439
|
include Aws::Structure
|
404
440
|
end
|
@@ -426,16 +462,16 @@ module Aws::Braket
|
|
426
462
|
# The name of the device.
|
427
463
|
# @return [String]
|
428
464
|
#
|
429
|
-
# @!attribute [rw]
|
430
|
-
# The
|
465
|
+
# @!attribute [rw] provider_name
|
466
|
+
# The provider of the device.
|
431
467
|
# @return [String]
|
432
468
|
#
|
433
469
|
# @!attribute [rw] device_type
|
434
470
|
# The type of the device.
|
435
471
|
# @return [String]
|
436
472
|
#
|
437
|
-
# @!attribute [rw]
|
438
|
-
# The
|
473
|
+
# @!attribute [rw] device_status
|
474
|
+
# The status of the device.
|
439
475
|
# @return [String]
|
440
476
|
#
|
441
477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/DeviceSummary AWS API Documentation
|
@@ -443,9 +479,9 @@ module Aws::Braket
|
|
443
479
|
class DeviceSummary < Struct.new(
|
444
480
|
:device_arn,
|
445
481
|
:device_name,
|
446
|
-
:
|
482
|
+
:provider_name,
|
447
483
|
:device_type,
|
448
|
-
:
|
484
|
+
:device_status)
|
449
485
|
SENSITIVE = []
|
450
486
|
include Aws::Structure
|
451
487
|
end
|
@@ -466,107 +502,92 @@ module Aws::Braket
|
|
466
502
|
# The ARN of the device.
|
467
503
|
# @return [String]
|
468
504
|
#
|
469
|
-
# @!attribute [rw] device_capabilities
|
470
|
-
# Details about the capabilities of the device.
|
471
|
-
# @return [String]
|
472
|
-
#
|
473
505
|
# @!attribute [rw] device_name
|
474
506
|
# The name of the device.
|
475
507
|
# @return [String]
|
476
508
|
#
|
477
|
-
# @!attribute [rw]
|
478
|
-
#
|
479
|
-
# @return [Array<Types::DeviceQueueInfo>]
|
480
|
-
#
|
481
|
-
# @!attribute [rw] device_status
|
482
|
-
# The status of the device.
|
509
|
+
# @!attribute [rw] provider_name
|
510
|
+
# The name of the partner company for the device.
|
483
511
|
# @return [String]
|
484
512
|
#
|
485
513
|
# @!attribute [rw] device_type
|
486
514
|
# The type of the device.
|
487
515
|
# @return [String]
|
488
516
|
#
|
489
|
-
# @!attribute [rw]
|
490
|
-
# The
|
517
|
+
# @!attribute [rw] device_status
|
518
|
+
# The status of the device.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @!attribute [rw] device_capabilities
|
522
|
+
# Details about the capabilities of the device.
|
491
523
|
# @return [String]
|
492
524
|
#
|
525
|
+
# @!attribute [rw] device_queue_info
|
526
|
+
# The number of quantum tasks and hybrid jobs currently queued on the
|
527
|
+
# device.
|
528
|
+
# @return [Array<Types::DeviceQueueInfo>]
|
529
|
+
#
|
493
530
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetDeviceResponse AWS API Documentation
|
494
531
|
#
|
495
532
|
class GetDeviceResponse < Struct.new(
|
496
533
|
:device_arn,
|
497
|
-
:device_capabilities,
|
498
534
|
:device_name,
|
499
|
-
:
|
500
|
-
:device_status,
|
535
|
+
:provider_name,
|
501
536
|
:device_type,
|
502
|
-
:
|
537
|
+
:device_status,
|
538
|
+
:device_capabilities,
|
539
|
+
:device_queue_info)
|
503
540
|
SENSITIVE = []
|
504
541
|
include Aws::Structure
|
505
542
|
end
|
506
543
|
|
507
|
-
# @!attribute [rw] additional_attribute_names
|
508
|
-
# A list of attributes to return information for.
|
509
|
-
# @return [Array<String>]
|
510
|
-
#
|
511
544
|
# @!attribute [rw] job_arn
|
512
|
-
# The ARN of the job to retrieve.
|
545
|
+
# The ARN of the hybrid job to retrieve.
|
513
546
|
# @return [String]
|
514
547
|
#
|
548
|
+
# @!attribute [rw] additional_attribute_names
|
549
|
+
# A list of attributes to return additional information for. Only the
|
550
|
+
# QueueInfo additional attribute name is currently supported.
|
551
|
+
# @return [Array<String>]
|
552
|
+
#
|
515
553
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetJobRequest AWS API Documentation
|
516
554
|
#
|
517
555
|
class GetJobRequest < Struct.new(
|
518
|
-
:
|
519
|
-
:
|
556
|
+
:job_arn,
|
557
|
+
:additional_attribute_names)
|
520
558
|
SENSITIVE = []
|
521
559
|
include Aws::Structure
|
522
560
|
end
|
523
561
|
|
524
|
-
# @!attribute [rw]
|
525
|
-
#
|
526
|
-
#
|
527
|
-
# entry and training, and the user-defined metrics used to evaluation
|
528
|
-
# the job.
|
529
|
-
# @return [Types::AlgorithmSpecification]
|
530
|
-
#
|
531
|
-
# @!attribute [rw] associations
|
532
|
-
# The list of Amazon Braket resources associated with the hybrid job.
|
533
|
-
# @return [Array<Types::Association>]
|
534
|
-
#
|
535
|
-
# @!attribute [rw] billable_duration
|
536
|
-
# The billable time the Amazon Braket job used to complete.
|
537
|
-
# @return [Integer]
|
538
|
-
#
|
539
|
-
# @!attribute [rw] checkpoint_config
|
540
|
-
# Information about the output locations for job checkpoint data.
|
541
|
-
# @return [Types::JobCheckpointConfig]
|
542
|
-
#
|
543
|
-
# @!attribute [rw] created_at
|
544
|
-
# The date and time that the Amazon Braket job was created.
|
545
|
-
# @return [Time]
|
546
|
-
#
|
547
|
-
# @!attribute [rw] device_config
|
548
|
-
# The quantum processing unit (QPU) or simulator used to run the
|
549
|
-
# Amazon Braket job.
|
550
|
-
# @return [Types::DeviceConfig]
|
562
|
+
# @!attribute [rw] status
|
563
|
+
# The status of the Amazon Braket hybrid job.
|
564
|
+
# @return [String]
|
551
565
|
#
|
552
|
-
# @!attribute [rw]
|
553
|
-
# The
|
554
|
-
# @return [
|
566
|
+
# @!attribute [rw] job_arn
|
567
|
+
# The ARN of the Amazon Braket hybrid job.
|
568
|
+
# @return [String]
|
555
569
|
#
|
556
|
-
# @!attribute [rw]
|
557
|
-
#
|
558
|
-
#
|
559
|
-
#
|
570
|
+
# @!attribute [rw] role_arn
|
571
|
+
# The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can
|
572
|
+
# assume to perform tasks on behalf of a user. It can access user
|
573
|
+
# resources, run an Amazon Braket job container on behalf of user, and
|
574
|
+
# output results and other hybrid job details to the s3 buckets of a
|
575
|
+
# user.
|
576
|
+
# @return [String]
|
560
577
|
#
|
561
578
|
# @!attribute [rw] failure_reason
|
562
|
-
# A description of the reason why an Amazon Braket job failed,
|
563
|
-
# failed.
|
579
|
+
# A description of the reason why an Amazon Braket hybrid job failed,
|
580
|
+
# if it failed.
|
581
|
+
# @return [String]
|
582
|
+
#
|
583
|
+
# @!attribute [rw] job_name
|
584
|
+
# The name of the Amazon Braket hybrid job.
|
564
585
|
# @return [String]
|
565
586
|
#
|
566
587
|
# @!attribute [rw] hyper_parameters
|
567
|
-
# Algorithm-specific parameters used by an Amazon Braket job
|
568
|
-
# influence the quality of the traiing job. The values are set
|
569
|
-
#
|
588
|
+
# Algorithm-specific parameters used by an Amazon Braket hybrid job
|
589
|
+
# that influence the quality of the traiing job. The values are set
|
590
|
+
# with a map of JSON key:value pairs, where the key is the name of the
|
570
591
|
# hyperparameter and the value is the value of th hyperparameter.
|
571
592
|
# @return [Hash<String,String>]
|
572
593
|
#
|
@@ -575,138 +596,164 @@ module Aws::Braket
|
|
575
596
|
# and where it is located.
|
576
597
|
# @return [Array<Types::InputFileConfig>]
|
577
598
|
#
|
578
|
-
# @!attribute [rw]
|
579
|
-
# The
|
580
|
-
#
|
581
|
-
# @return [Types::
|
599
|
+
# @!attribute [rw] output_data_config
|
600
|
+
# The path to the S3 location where hybrid job artifacts are stored
|
601
|
+
# and the encryption key used to store them there.
|
602
|
+
# @return [Types::JobOutputDataConfig]
|
582
603
|
#
|
583
|
-
# @!attribute [rw]
|
584
|
-
# The
|
585
|
-
#
|
604
|
+
# @!attribute [rw] stopping_condition
|
605
|
+
# The user-defined criteria that specifies when to stop a running
|
606
|
+
# hybrid job.
|
607
|
+
# @return [Types::JobStoppingCondition]
|
586
608
|
#
|
587
|
-
# @!attribute [rw]
|
588
|
-
#
|
589
|
-
#
|
609
|
+
# @!attribute [rw] checkpoint_config
|
610
|
+
# Information about the output locations for hybrid job checkpoint
|
611
|
+
# data.
|
612
|
+
# @return [Types::JobCheckpointConfig]
|
590
613
|
#
|
591
|
-
# @!attribute [rw]
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
614
|
+
# @!attribute [rw] algorithm_specification
|
615
|
+
# Definition of the Amazon Braket hybrid job created. Provides
|
616
|
+
# information about the container image used, and the Python scripts
|
617
|
+
# used for training.
|
618
|
+
# @return [Types::AlgorithmSpecification]
|
595
619
|
#
|
596
|
-
# @!attribute [rw]
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
# @return [Types::HybridJobQueueInfo]
|
620
|
+
# @!attribute [rw] instance_config
|
621
|
+
# The resource instances to use while running the hybrid job on Amazon
|
622
|
+
# Braket.
|
623
|
+
# @return [Types::InstanceConfig]
|
601
624
|
#
|
602
|
-
# @!attribute [rw]
|
603
|
-
# The
|
604
|
-
#
|
605
|
-
# resources, run an Amazon Braket job container on behalf of user, and
|
606
|
-
# output resources to the s3 buckets of a user.
|
607
|
-
# @return [String]
|
625
|
+
# @!attribute [rw] created_at
|
626
|
+
# The time at which the Amazon Braket hybrid job was created.
|
627
|
+
# @return [Time]
|
608
628
|
#
|
609
629
|
# @!attribute [rw] started_at
|
610
|
-
# The
|
630
|
+
# The time at which the Amazon Braket hybrid job was started.
|
611
631
|
# @return [Time]
|
612
632
|
#
|
613
|
-
# @!attribute [rw]
|
614
|
-
# The
|
615
|
-
# @return [
|
633
|
+
# @!attribute [rw] ended_at
|
634
|
+
# The time at which the Amazon Braket hybrid job ended.
|
635
|
+
# @return [Time]
|
616
636
|
#
|
617
|
-
# @!attribute [rw]
|
618
|
-
# The
|
619
|
-
#
|
637
|
+
# @!attribute [rw] billable_duration
|
638
|
+
# The billable time for which the Amazon Braket hybrid job used to
|
639
|
+
# complete.
|
640
|
+
# @return [Integer]
|
641
|
+
#
|
642
|
+
# @!attribute [rw] device_config
|
643
|
+
# The primary device used by the Amazon Braket hybrid job.
|
644
|
+
# @return [Types::DeviceConfig]
|
645
|
+
#
|
646
|
+
# @!attribute [rw] events
|
647
|
+
# Details about the time and type of events occurred related to the
|
648
|
+
# Amazon Braket hybrid job.
|
649
|
+
# @return [Array<Types::JobEventDetails>]
|
620
650
|
#
|
621
651
|
# @!attribute [rw] tags
|
622
|
-
#
|
623
|
-
# manage metadata for Amazon Braket resources.
|
652
|
+
# The tags associated with this hybrid job.
|
624
653
|
# @return [Hash<String,String>]
|
625
654
|
#
|
655
|
+
# @!attribute [rw] queue_info
|
656
|
+
# Queue information for the requested hybrid job. Only returned if
|
657
|
+
# `QueueInfo` is specified in the `additionalAttributeNames"` field in
|
658
|
+
# the `GetJob` API request.
|
659
|
+
# @return [Types::HybridJobQueueInfo]
|
660
|
+
#
|
661
|
+
# @!attribute [rw] associations
|
662
|
+
# The list of Amazon Braket resources associated with the hybrid job.
|
663
|
+
# @return [Array<Types::Association>]
|
664
|
+
#
|
626
665
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetJobResponse AWS API Documentation
|
627
666
|
#
|
628
667
|
class GetJobResponse < Struct.new(
|
629
|
-
:
|
630
|
-
:
|
631
|
-
:
|
632
|
-
:checkpoint_config,
|
633
|
-
:created_at,
|
634
|
-
:device_config,
|
635
|
-
:ended_at,
|
636
|
-
:events,
|
668
|
+
:status,
|
669
|
+
:job_arn,
|
670
|
+
:role_arn,
|
637
671
|
:failure_reason,
|
672
|
+
:job_name,
|
638
673
|
:hyper_parameters,
|
639
674
|
:input_data_config,
|
640
|
-
:instance_config,
|
641
|
-
:job_arn,
|
642
|
-
:job_name,
|
643
675
|
:output_data_config,
|
644
|
-
:queue_info,
|
645
|
-
:role_arn,
|
646
|
-
:started_at,
|
647
|
-
:status,
|
648
676
|
:stopping_condition,
|
649
|
-
:
|
677
|
+
:checkpoint_config,
|
678
|
+
:algorithm_specification,
|
679
|
+
:instance_config,
|
680
|
+
:created_at,
|
681
|
+
:started_at,
|
682
|
+
:ended_at,
|
683
|
+
:billable_duration,
|
684
|
+
:device_config,
|
685
|
+
:events,
|
686
|
+
:tags,
|
687
|
+
:queue_info,
|
688
|
+
:associations)
|
650
689
|
SENSITIVE = []
|
651
690
|
include Aws::Structure
|
652
691
|
end
|
653
692
|
|
654
|
-
# @!attribute [rw] additional_attribute_names
|
655
|
-
# A list of attributes to return information for.
|
656
|
-
# @return [Array<String>]
|
657
|
-
#
|
658
693
|
# @!attribute [rw] quantum_task_arn
|
659
|
-
# The ARN of the task to retrieve.
|
694
|
+
# The ARN of the quantum task to retrieve.
|
660
695
|
# @return [String]
|
661
696
|
#
|
697
|
+
# @!attribute [rw] additional_attribute_names
|
698
|
+
# A list of attributes to return additional information for. Only the
|
699
|
+
# QueueInfo additional attribute name is currently supported.
|
700
|
+
# @return [Array<String>]
|
701
|
+
#
|
662
702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetQuantumTaskRequest AWS API Documentation
|
663
703
|
#
|
664
704
|
class GetQuantumTaskRequest < Struct.new(
|
665
|
-
:
|
666
|
-
:
|
705
|
+
:quantum_task_arn,
|
706
|
+
:additional_attribute_names)
|
667
707
|
SENSITIVE = []
|
668
708
|
include Aws::Structure
|
669
709
|
end
|
670
710
|
|
671
|
-
# @!attribute [rw]
|
672
|
-
# The
|
673
|
-
# task.
|
674
|
-
# @return [Array<Types::Association>]
|
675
|
-
#
|
676
|
-
# @!attribute [rw] created_at
|
677
|
-
# The time at which the task was created.
|
678
|
-
# @return [Time]
|
679
|
-
#
|
680
|
-
# @!attribute [rw] device_arn
|
681
|
-
# The ARN of the device the task was run on.
|
711
|
+
# @!attribute [rw] quantum_task_arn
|
712
|
+
# The ARN of the quantum task.
|
682
713
|
# @return [String]
|
683
714
|
#
|
684
|
-
# @!attribute [rw]
|
685
|
-
# The
|
715
|
+
# @!attribute [rw] status
|
716
|
+
# The status of the quantum task.
|
686
717
|
# @return [String]
|
687
718
|
#
|
688
|
-
# @!attribute [rw] ended_at
|
689
|
-
# The time at which the task ended.
|
690
|
-
# @return [Time]
|
691
|
-
#
|
692
719
|
# @!attribute [rw] failure_reason
|
693
|
-
# The reason that a task failed.
|
720
|
+
# The reason that a quantum task failed.
|
694
721
|
# @return [String]
|
695
722
|
#
|
696
|
-
# @!attribute [rw]
|
697
|
-
# The ARN of the
|
723
|
+
# @!attribute [rw] device_arn
|
724
|
+
# The ARN of the device the quantum task was run on.
|
725
|
+
# @return [String]
|
726
|
+
#
|
727
|
+
# @!attribute [rw] device_parameters
|
728
|
+
# The parameters for the device on which the quantum task ran.
|
698
729
|
# @return [String]
|
699
730
|
#
|
731
|
+
# @!attribute [rw] shots
|
732
|
+
# The number of shots used in the quantum task.
|
733
|
+
# @return [Integer]
|
734
|
+
#
|
700
735
|
# @!attribute [rw] output_s3_bucket
|
701
|
-
# The S3 bucket where task results are stored.
|
736
|
+
# The S3 bucket where quantum task results are stored.
|
702
737
|
# @return [String]
|
703
738
|
#
|
704
739
|
# @!attribute [rw] output_s3_directory
|
705
|
-
# The folder in the S3 bucket where task results are stored.
|
740
|
+
# The folder in the S3 bucket where quantum task results are stored.
|
706
741
|
# @return [String]
|
707
742
|
#
|
708
|
-
# @!attribute [rw]
|
709
|
-
# The
|
743
|
+
# @!attribute [rw] created_at
|
744
|
+
# The time at which the quantum task was created.
|
745
|
+
# @return [Time]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] ended_at
|
748
|
+
# The time at which the quantum task ended.
|
749
|
+
# @return [Time]
|
750
|
+
#
|
751
|
+
# @!attribute [rw] tags
|
752
|
+
# The tags that belong to this quantum task.
|
753
|
+
# @return [Hash<String,String>]
|
754
|
+
#
|
755
|
+
# @!attribute [rw] job_arn
|
756
|
+
# The ARN of the Amazon Braket job associated with the quantum task.
|
710
757
|
# @return [String]
|
711
758
|
#
|
712
759
|
# @!attribute [rw] queue_info
|
@@ -715,61 +762,66 @@ module Aws::Braket
|
|
715
762
|
# the `GetQuantumTask` API request.
|
716
763
|
# @return [Types::QuantumTaskQueueInfo]
|
717
764
|
#
|
718
|
-
# @!attribute [rw]
|
719
|
-
# The
|
720
|
-
#
|
765
|
+
# @!attribute [rw] associations
|
766
|
+
# The list of Amazon Braket resources associated with the quantum
|
767
|
+
# task.
|
768
|
+
# @return [Array<Types::Association>]
|
721
769
|
#
|
722
|
-
# @!attribute [rw]
|
723
|
-
# The
|
724
|
-
#
|
770
|
+
# @!attribute [rw] num_successful_shots
|
771
|
+
# The number of successful shots for the quantum task. This is
|
772
|
+
# available after a successfully completed quantum task.
|
773
|
+
# @return [Integer]
|
725
774
|
#
|
726
|
-
# @!attribute [rw]
|
727
|
-
#
|
728
|
-
#
|
775
|
+
# @!attribute [rw] action_metadata
|
776
|
+
# Metadata about the action performed by the quantum task, including
|
777
|
+
# information about the type of action and program counts.
|
778
|
+
# @return [Types::ActionMetadata]
|
729
779
|
#
|
730
780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetQuantumTaskResponse AWS API Documentation
|
731
781
|
#
|
732
782
|
class GetQuantumTaskResponse < Struct.new(
|
733
|
-
:
|
734
|
-
:
|
783
|
+
:quantum_task_arn,
|
784
|
+
:status,
|
785
|
+
:failure_reason,
|
735
786
|
:device_arn,
|
736
787
|
:device_parameters,
|
737
|
-
:
|
738
|
-
:failure_reason,
|
739
|
-
:job_arn,
|
788
|
+
:shots,
|
740
789
|
:output_s3_bucket,
|
741
790
|
:output_s3_directory,
|
742
|
-
:
|
791
|
+
:created_at,
|
792
|
+
:ended_at,
|
793
|
+
:tags,
|
794
|
+
:job_arn,
|
743
795
|
:queue_info,
|
744
|
-
:
|
745
|
-
:
|
746
|
-
:
|
796
|
+
:associations,
|
797
|
+
:num_successful_shots,
|
798
|
+
:action_metadata)
|
747
799
|
SENSITIVE = []
|
748
800
|
include Aws::Structure
|
749
801
|
end
|
750
802
|
|
751
|
-
# Information about the queue for a specified job.
|
803
|
+
# Information about the queue for a specified hybrid job.
|
752
804
|
#
|
753
|
-
# @!attribute [rw]
|
754
|
-
#
|
755
|
-
# example, if the job is complete and no longer in the queue, the
|
756
|
-
# message field contains that information.
|
805
|
+
# @!attribute [rw] queue
|
806
|
+
# The name of the queue.
|
757
807
|
# @return [String]
|
758
808
|
#
|
759
809
|
# @!attribute [rw] position
|
760
|
-
# Current position of the job in the jobs queue.
|
810
|
+
# Current position of the hybrid job in the jobs queue.
|
761
811
|
# @return [String]
|
762
812
|
#
|
763
|
-
# @!attribute [rw]
|
764
|
-
#
|
813
|
+
# @!attribute [rw] message
|
814
|
+
# Optional. Provides more information about the queue position. For
|
815
|
+
# example, if the hybrid job is complete and no longer in the queue,
|
816
|
+
# the message field contains that information.
|
765
817
|
# @return [String]
|
766
818
|
#
|
767
819
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/HybridJobQueueInfo AWS API Documentation
|
768
820
|
#
|
769
821
|
class HybridJobQueueInfo < Struct.new(
|
770
|
-
:
|
822
|
+
:queue,
|
771
823
|
:position,
|
772
|
-
:
|
824
|
+
:message)
|
773
825
|
SENSITIVE = []
|
774
826
|
include Aws::Structure
|
775
827
|
end
|
@@ -778,7 +830,7 @@ module Aws::Braket
|
|
778
830
|
# data, and where it is located.
|
779
831
|
#
|
780
832
|
# @!attribute [rw] channel_name
|
781
|
-
# A named input source that an Amazon Braket job can consume.
|
833
|
+
# A named input source that an Amazon Braket hybrid job can consume.
|
782
834
|
# @return [String]
|
783
835
|
#
|
784
836
|
# @!attribute [rw] content_type
|
@@ -786,7 +838,7 @@ module Aws::Braket
|
|
786
838
|
# @return [String]
|
787
839
|
#
|
788
840
|
# @!attribute [rw] data_source
|
789
|
-
# The location of the
|
841
|
+
# The location of the input data.
|
790
842
|
# @return [Types::DataSource]
|
791
843
|
#
|
792
844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/InputFileConfig AWS API Documentation
|
@@ -802,32 +854,31 @@ module Aws::Braket
|
|
802
854
|
# Configures the resource instances to use while running the Amazon
|
803
855
|
# Braket hybrid job on Amazon Braket.
|
804
856
|
#
|
805
|
-
# @!attribute [rw] instance_count
|
806
|
-
# Configures the number of resource instances to use while running an
|
807
|
-
# Amazon Braket job on Amazon Braket. The default value is 1.
|
808
|
-
# @return [Integer]
|
809
|
-
#
|
810
857
|
# @!attribute [rw] instance_type
|
811
|
-
# Configures the type resource instances to use while running an
|
858
|
+
# Configures the type of resource instances to use while running an
|
812
859
|
# Amazon Braket hybrid job.
|
813
860
|
# @return [String]
|
814
861
|
#
|
815
862
|
# @!attribute [rw] volume_size_in_gb
|
816
|
-
# The size of the storage volume, in GB,
|
863
|
+
# The size of the storage volume, in GB, to provision.
|
864
|
+
# @return [Integer]
|
865
|
+
#
|
866
|
+
# @!attribute [rw] instance_count
|
867
|
+
# Configures the number of resource instances to use while running an
|
868
|
+
# Amazon Braket hybrid job on Amazon Braket. The default value is 1.
|
817
869
|
# @return [Integer]
|
818
870
|
#
|
819
871
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/InstanceConfig AWS API Documentation
|
820
872
|
#
|
821
873
|
class InstanceConfig < Struct.new(
|
822
|
-
:instance_count,
|
823
874
|
:instance_type,
|
824
|
-
:volume_size_in_gb
|
875
|
+
:volume_size_in_gb,
|
876
|
+
:instance_count)
|
825
877
|
SENSITIVE = []
|
826
878
|
include Aws::Structure
|
827
879
|
end
|
828
880
|
|
829
|
-
# The request
|
830
|
-
# exception, or failure.
|
881
|
+
# The request failed because of an unknown error.
|
831
882
|
#
|
832
883
|
# @!attribute [rw] message
|
833
884
|
# @return [String]
|
@@ -840,17 +891,17 @@ module Aws::Braket
|
|
840
891
|
include Aws::Structure
|
841
892
|
end
|
842
893
|
|
843
|
-
# Contains information about the output locations for job
|
844
|
-
# data.
|
894
|
+
# Contains information about the output locations for hybrid job
|
895
|
+
# checkpoint data.
|
845
896
|
#
|
846
897
|
# @!attribute [rw] local_path
|
847
|
-
# (Optional) The local directory where
|
898
|
+
# (Optional) The local directory where checkpoint data is stored. The
|
848
899
|
# default directory is `/opt/braket/checkpoints/`.
|
849
900
|
# @return [String]
|
850
901
|
#
|
851
902
|
# @!attribute [rw] s3_uri
|
852
903
|
# Identifies the S3 path where you want Amazon Braket to store
|
853
|
-
#
|
904
|
+
# checkpoint data. For example, `s3://bucket-name/key-name-prefix`.
|
854
905
|
# @return [String]
|
855
906
|
#
|
856
907
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobCheckpointConfig AWS API Documentation
|
@@ -862,44 +913,47 @@ module Aws::Braket
|
|
862
913
|
include Aws::Structure
|
863
914
|
end
|
864
915
|
|
865
|
-
# Details about the type and time events occurred related to the
|
866
|
-
# Braket job.
|
916
|
+
# Details about the type and time events that occurred related to the
|
917
|
+
# Amazon Braket hybrid job.
|
867
918
|
#
|
868
919
|
# @!attribute [rw] event_type
|
869
|
-
# The type of event that occurred related to the Amazon Braket
|
920
|
+
# The type of event that occurred related to the Amazon Braket hybrid
|
921
|
+
# job.
|
870
922
|
# @return [String]
|
871
923
|
#
|
924
|
+
# @!attribute [rw] time_of_event
|
925
|
+
# The time of the event that occurred related to the Amazon Braket
|
926
|
+
# hybrid job.
|
927
|
+
# @return [Time]
|
928
|
+
#
|
872
929
|
# @!attribute [rw] message
|
873
930
|
# A message describing the event that occurred related to the Amazon
|
874
|
-
# Braket job.
|
931
|
+
# Braket hybrid job.
|
875
932
|
# @return [String]
|
876
933
|
#
|
877
|
-
# @!attribute [rw] time_of_event
|
878
|
-
# The type of event that occurred related to the Amazon Braket job.
|
879
|
-
# @return [Time]
|
880
|
-
#
|
881
934
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobEventDetails AWS API Documentation
|
882
935
|
#
|
883
936
|
class JobEventDetails < Struct.new(
|
884
937
|
:event_type,
|
885
|
-
:
|
886
|
-
:
|
938
|
+
:time_of_event,
|
939
|
+
:message)
|
887
940
|
SENSITIVE = []
|
888
941
|
include Aws::Structure
|
889
942
|
end
|
890
943
|
|
891
|
-
# Specifies the path to the S3 location where you want to store
|
892
|
-
# artifacts and the encryption key used to store them.
|
944
|
+
# Specifies the path to the S3 location where you want to store hybrid
|
945
|
+
# job artifacts and the encryption key used to store them.
|
893
946
|
#
|
894
947
|
# @!attribute [rw] kms_key_id
|
895
948
|
# The AWS Key Management Service (AWS KMS) key that Amazon Braket uses
|
896
|
-
# to encrypt the job training artifacts at rest using Amazon S3
|
949
|
+
# to encrypt the hybrid job training artifacts at rest using Amazon S3
|
897
950
|
# server-side encryption.
|
898
951
|
# @return [String]
|
899
952
|
#
|
900
953
|
# @!attribute [rw] s3_path
|
901
|
-
# Identifies the S3 path where you want Amazon Braket to store the
|
902
|
-
# training artifacts. For example,
|
954
|
+
# Identifies the S3 path where you want Amazon Braket to store the
|
955
|
+
# hybrid job training artifacts. For example,
|
956
|
+
# `s3://bucket-name/key-name-prefix`.
|
903
957
|
# @return [String]
|
904
958
|
#
|
905
959
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobOutputDataConfig AWS API Documentation
|
@@ -911,11 +965,11 @@ module Aws::Braket
|
|
911
965
|
include Aws::Structure
|
912
966
|
end
|
913
967
|
|
914
|
-
# Specifies limits for how long an Amazon Braket job can run.
|
968
|
+
# Specifies limits for how long an Amazon Braket hybrid job can run.
|
915
969
|
#
|
916
970
|
# @!attribute [rw] max_runtime_in_seconds
|
917
|
-
# The maximum length of time, in seconds, that an Amazon Braket
|
918
|
-
# can run.
|
971
|
+
# The maximum length of time, in seconds, that an Amazon Braket hybrid
|
972
|
+
# job can run.
|
919
973
|
# @return [Integer]
|
920
974
|
#
|
921
975
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobStoppingCondition AWS API Documentation
|
@@ -926,52 +980,51 @@ module Aws::Braket
|
|
926
980
|
include Aws::Structure
|
927
981
|
end
|
928
982
|
|
929
|
-
# Provides summary information about an Amazon Braket job.
|
930
|
-
#
|
931
|
-
# @!attribute [rw] created_at
|
932
|
-
# The date and time that the Amazon Braket job was created.
|
933
|
-
# @return [Time]
|
983
|
+
# Provides summary information about an Amazon Braket hybrid job.
|
934
984
|
#
|
935
|
-
# @!attribute [rw]
|
936
|
-
#
|
937
|
-
# Amazon Braket job.
|
985
|
+
# @!attribute [rw] status
|
986
|
+
# The status of the Amazon Braket hybrid job.
|
938
987
|
# @return [String]
|
939
988
|
#
|
940
|
-
# @!attribute [rw] ended_at
|
941
|
-
# The date and time that the Amazon Braket job ended.
|
942
|
-
# @return [Time]
|
943
|
-
#
|
944
989
|
# @!attribute [rw] job_arn
|
945
|
-
# The ARN of the Amazon Braket job.
|
990
|
+
# The ARN of the Amazon Braket hybrid job.
|
946
991
|
# @return [String]
|
947
992
|
#
|
948
993
|
# @!attribute [rw] job_name
|
949
|
-
# The name of the Amazon Braket job.
|
994
|
+
# The name of the Amazon Braket hybrid job.
|
950
995
|
# @return [String]
|
951
996
|
#
|
997
|
+
# @!attribute [rw] device
|
998
|
+
# The primary device used by an Amazon Braket hybrid job.
|
999
|
+
# @return [String]
|
1000
|
+
#
|
1001
|
+
# @!attribute [rw] created_at
|
1002
|
+
# The time at which the Amazon Braket hybrid job was created.
|
1003
|
+
# @return [Time]
|
1004
|
+
#
|
952
1005
|
# @!attribute [rw] started_at
|
953
|
-
# The
|
1006
|
+
# The time at which the Amazon Braket hybrid job was started.
|
954
1007
|
# @return [Time]
|
955
1008
|
#
|
956
|
-
# @!attribute [rw]
|
957
|
-
# The
|
958
|
-
# @return [
|
1009
|
+
# @!attribute [rw] ended_at
|
1010
|
+
# The time at which the Amazon Braket hybrid job ended.
|
1011
|
+
# @return [Time]
|
959
1012
|
#
|
960
1013
|
# @!attribute [rw] tags
|
961
|
-
#
|
962
|
-
#
|
1014
|
+
# Displays the key, value pairs of tags associated with this hybrid
|
1015
|
+
# job.
|
963
1016
|
# @return [Hash<String,String>]
|
964
1017
|
#
|
965
1018
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobSummary AWS API Documentation
|
966
1019
|
#
|
967
1020
|
class JobSummary < Struct.new(
|
968
|
-
:
|
969
|
-
:device,
|
970
|
-
:ended_at,
|
1021
|
+
:status,
|
971
1022
|
:job_arn,
|
972
1023
|
:job_name,
|
1024
|
+
:device,
|
1025
|
+
:created_at,
|
973
1026
|
:started_at,
|
974
|
-
:
|
1027
|
+
:ended_at,
|
975
1028
|
:tags)
|
976
1029
|
SENSITIVE = []
|
977
1030
|
include Aws::Structure
|
@@ -1001,71 +1054,101 @@ module Aws::Braket
|
|
1001
1054
|
include Aws::Structure
|
1002
1055
|
end
|
1003
1056
|
|
1004
|
-
#
|
1057
|
+
# Contains information about validation failures that occurred during
|
1058
|
+
# the processing of a program set in a quantum task.
|
1005
1059
|
#
|
1006
|
-
# @!attribute [rw]
|
1007
|
-
#
|
1008
|
-
#
|
1009
|
-
#
|
1010
|
-
# @return [String]
|
1060
|
+
# @!attribute [rw] program_index
|
1061
|
+
# The index of the program within the program set that failed
|
1062
|
+
# validation.
|
1063
|
+
# @return [Integer]
|
1011
1064
|
#
|
1012
|
-
# @!attribute [rw]
|
1013
|
-
#
|
1014
|
-
#
|
1065
|
+
# @!attribute [rw] inputs_index
|
1066
|
+
# The index of the input within the program set that failed
|
1067
|
+
# validation.
|
1068
|
+
# @return [Integer]
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] errors
|
1071
|
+
# A list of error messages describing the validation failures that
|
1072
|
+
# occurred.
|
1073
|
+
# @return [Array<String>]
|
1074
|
+
#
|
1075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/ProgramSetValidationFailure AWS API Documentation
|
1076
|
+
#
|
1077
|
+
class ProgramSetValidationFailure < Struct.new(
|
1078
|
+
:program_index,
|
1079
|
+
:inputs_index,
|
1080
|
+
:errors)
|
1081
|
+
SENSITIVE = []
|
1082
|
+
include Aws::Structure
|
1083
|
+
end
|
1084
|
+
|
1085
|
+
# The queue information for the specified quantum task.
|
1015
1086
|
#
|
1016
1087
|
# @!attribute [rw] queue
|
1017
1088
|
# The name of the queue.
|
1018
1089
|
# @return [String]
|
1019
1090
|
#
|
1091
|
+
# @!attribute [rw] position
|
1092
|
+
# Current position of the quantum task in the quantum tasks queue.
|
1093
|
+
# @return [String]
|
1094
|
+
#
|
1020
1095
|
# @!attribute [rw] queue_priority
|
1021
1096
|
# Optional. Specifies the priority of the queue. Quantum tasks in a
|
1022
|
-
# priority queue are processed before the tasks in a normal
|
1097
|
+
# priority queue are processed before the quantum tasks in a normal
|
1098
|
+
# queue.
|
1099
|
+
# @return [String]
|
1100
|
+
#
|
1101
|
+
# @!attribute [rw] message
|
1102
|
+
# Optional. Provides more information about the queue position. For
|
1103
|
+
# example, if the quantum task is complete and no longer in the queue,
|
1104
|
+
# the message field contains that information.
|
1023
1105
|
# @return [String]
|
1024
1106
|
#
|
1025
1107
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/QuantumTaskQueueInfo AWS API Documentation
|
1026
1108
|
#
|
1027
1109
|
class QuantumTaskQueueInfo < Struct.new(
|
1028
|
-
:message,
|
1029
|
-
:position,
|
1030
1110
|
:queue,
|
1031
|
-
:
|
1111
|
+
:position,
|
1112
|
+
:queue_priority,
|
1113
|
+
:message)
|
1032
1114
|
SENSITIVE = []
|
1033
1115
|
include Aws::Structure
|
1034
1116
|
end
|
1035
1117
|
|
1036
1118
|
# Includes information about a quantum task.
|
1037
1119
|
#
|
1038
|
-
# @!attribute [rw]
|
1039
|
-
# The
|
1040
|
-
# @return [
|
1120
|
+
# @!attribute [rw] quantum_task_arn
|
1121
|
+
# The ARN of the quantum task.
|
1122
|
+
# @return [String]
|
1123
|
+
#
|
1124
|
+
# @!attribute [rw] status
|
1125
|
+
# The status of the quantum task.
|
1126
|
+
# @return [String]
|
1041
1127
|
#
|
1042
1128
|
# @!attribute [rw] device_arn
|
1043
|
-
# The ARN of the device the task ran on.
|
1129
|
+
# The ARN of the device the quantum task ran on.
|
1044
1130
|
# @return [String]
|
1045
1131
|
#
|
1046
|
-
# @!attribute [rw]
|
1047
|
-
# The
|
1048
|
-
# @return [
|
1132
|
+
# @!attribute [rw] shots
|
1133
|
+
# The shots used for the quantum task.
|
1134
|
+
# @return [Integer]
|
1049
1135
|
#
|
1050
1136
|
# @!attribute [rw] output_s3_bucket
|
1051
|
-
# The S3 bucket where the task result file is stored
|
1137
|
+
# The S3 bucket where the quantum task result file is stored.
|
1052
1138
|
# @return [String]
|
1053
1139
|
#
|
1054
1140
|
# @!attribute [rw] output_s3_directory
|
1055
|
-
# The folder in the S3 bucket where the task result file is
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
# @!attribute [rw] quantum_task_arn
|
1059
|
-
# The ARN of the task.
|
1141
|
+
# The folder in the S3 bucket where the quantum task result file is
|
1142
|
+
# stored.
|
1060
1143
|
# @return [String]
|
1061
1144
|
#
|
1062
|
-
# @!attribute [rw]
|
1063
|
-
# The
|
1064
|
-
# @return [
|
1145
|
+
# @!attribute [rw] created_at
|
1146
|
+
# The time at which the quantum task was created.
|
1147
|
+
# @return [Time]
|
1065
1148
|
#
|
1066
|
-
# @!attribute [rw]
|
1067
|
-
# The
|
1068
|
-
# @return [
|
1149
|
+
# @!attribute [rw] ended_at
|
1150
|
+
# The time at which the quantum task finished.
|
1151
|
+
# @return [Time]
|
1069
1152
|
#
|
1070
1153
|
# @!attribute [rw] tags
|
1071
1154
|
# Displays the key, value pairs of tags associated with this quantum
|
@@ -1075,14 +1158,14 @@ module Aws::Braket
|
|
1075
1158
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/QuantumTaskSummary AWS API Documentation
|
1076
1159
|
#
|
1077
1160
|
class QuantumTaskSummary < Struct.new(
|
1078
|
-
:
|
1161
|
+
:quantum_task_arn,
|
1162
|
+
:status,
|
1079
1163
|
:device_arn,
|
1080
|
-
:
|
1164
|
+
:shots,
|
1081
1165
|
:output_s3_bucket,
|
1082
1166
|
:output_s3_directory,
|
1083
|
-
:
|
1084
|
-
:
|
1085
|
-
:status,
|
1167
|
+
:created_at,
|
1168
|
+
:ended_at,
|
1086
1169
|
:tags)
|
1087
1170
|
SENSITIVE = []
|
1088
1171
|
include Aws::Structure
|
@@ -1101,8 +1184,8 @@ module Aws::Braket
|
|
1101
1184
|
include Aws::Structure
|
1102
1185
|
end
|
1103
1186
|
|
1104
|
-
# Information about the
|
1105
|
-
#
|
1187
|
+
# Information about the Amazon S3 storage used by the Amazon Braket
|
1188
|
+
# hybrid job.
|
1106
1189
|
#
|
1107
1190
|
# @!attribute [rw] s3_uri
|
1108
1191
|
# Depending on the value specified for the `S3DataType`, identifies
|
@@ -1118,42 +1201,43 @@ module Aws::Braket
|
|
1118
1201
|
include Aws::Structure
|
1119
1202
|
end
|
1120
1203
|
|
1121
|
-
# Contains information about
|
1122
|
-
#
|
1123
|
-
#
|
1124
|
-
# @!attribute [rw] compression_type
|
1125
|
-
# The type of compression used by the Python scripts for an Amazon
|
1126
|
-
# Braket job.
|
1127
|
-
# @return [String]
|
1204
|
+
# Contains information about algorithm scripts used for the Amazon
|
1205
|
+
# Braket hybrid job.
|
1128
1206
|
#
|
1129
1207
|
# @!attribute [rw] entry_point
|
1130
|
-
# The
|
1131
|
-
#
|
1208
|
+
# The entry point in the algorithm scripts from where the execution
|
1209
|
+
# begins in the hybrid job.
|
1132
1210
|
# @return [String]
|
1133
1211
|
#
|
1134
1212
|
# @!attribute [rw] s3_uri
|
1135
|
-
# The URI that specifies the S3 path to the
|
1136
|
-
#
|
1213
|
+
# The URI that specifies the S3 path to the algorithm scripts used by
|
1214
|
+
# an Amazon Braket hybrid job.
|
1215
|
+
# @return [String]
|
1216
|
+
#
|
1217
|
+
# @!attribute [rw] compression_type
|
1218
|
+
# The type of compression used to store the algorithm scripts in
|
1219
|
+
# Amazon S3 storage.
|
1137
1220
|
# @return [String]
|
1138
1221
|
#
|
1139
1222
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/ScriptModeConfig AWS API Documentation
|
1140
1223
|
#
|
1141
1224
|
class ScriptModeConfig < Struct.new(
|
1142
|
-
:compression_type,
|
1143
1225
|
:entry_point,
|
1144
|
-
:s3_uri
|
1226
|
+
:s3_uri,
|
1227
|
+
:compression_type)
|
1145
1228
|
SENSITIVE = []
|
1146
1229
|
include Aws::Structure
|
1147
1230
|
end
|
1148
1231
|
|
1149
|
-
# The filter to
|
1232
|
+
# The filter used to search for devices.
|
1150
1233
|
#
|
1151
1234
|
# @!attribute [rw] name
|
1152
|
-
# The name
|
1235
|
+
# The name of the device parameter to filter based on. Only
|
1236
|
+
# `deviceArn` filter name is currently supported.
|
1153
1237
|
# @return [String]
|
1154
1238
|
#
|
1155
1239
|
# @!attribute [rw] values
|
1156
|
-
# The values to
|
1240
|
+
# The values used to filter devices based on the filter name.
|
1157
1241
|
# @return [Array<String>]
|
1158
1242
|
#
|
1159
1243
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchDevicesFilter AWS API Documentation
|
@@ -1165,26 +1249,27 @@ module Aws::Braket
|
|
1165
1249
|
include Aws::Structure
|
1166
1250
|
end
|
1167
1251
|
|
1168
|
-
# @!attribute [rw]
|
1169
|
-
#
|
1170
|
-
#
|
1252
|
+
# @!attribute [rw] next_token
|
1253
|
+
# A token used for pagination of results returned in the response. Use
|
1254
|
+
# the token returned from the previous request to continue search
|
1255
|
+
# where the previous request ended.
|
1256
|
+
# @return [String]
|
1171
1257
|
#
|
1172
1258
|
# @!attribute [rw] max_results
|
1173
1259
|
# The maximum number of results to return in the response.
|
1174
1260
|
# @return [Integer]
|
1175
1261
|
#
|
1176
|
-
# @!attribute [rw]
|
1177
|
-
#
|
1178
|
-
#
|
1179
|
-
#
|
1180
|
-
# @return [String]
|
1262
|
+
# @!attribute [rw] filters
|
1263
|
+
# Array of SearchDevicesFilter objects to use when searching for
|
1264
|
+
# devices.
|
1265
|
+
# @return [Array<Types::SearchDevicesFilter>]
|
1181
1266
|
#
|
1182
1267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchDevicesRequest AWS API Documentation
|
1183
1268
|
#
|
1184
1269
|
class SearchDevicesRequest < Struct.new(
|
1185
|
-
:
|
1270
|
+
:next_token,
|
1186
1271
|
:max_results,
|
1187
|
-
:
|
1272
|
+
:filters)
|
1188
1273
|
SENSITIVE = []
|
1189
1274
|
include Aws::Structure
|
1190
1275
|
end
|
@@ -1197,7 +1282,7 @@ module Aws::Braket
|
|
1197
1282
|
# @!attribute [rw] next_token
|
1198
1283
|
# A token used for pagination of results, or null if there are no
|
1199
1284
|
# additional results. Use the token value in a subsequent request to
|
1200
|
-
# continue
|
1285
|
+
# continue search where the previous request ended.
|
1201
1286
|
# @return [String]
|
1202
1287
|
#
|
1203
1288
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchDevicesResponse AWS API Documentation
|
@@ -1209,50 +1294,53 @@ module Aws::Braket
|
|
1209
1294
|
include Aws::Structure
|
1210
1295
|
end
|
1211
1296
|
|
1212
|
-
# A filter used to search for Amazon Braket jobs.
|
1297
|
+
# A filter used to search for Amazon Braket hybrid jobs.
|
1213
1298
|
#
|
1214
1299
|
# @!attribute [rw] name
|
1215
|
-
# The name
|
1216
|
-
#
|
1217
|
-
#
|
1218
|
-
# @!attribute [rw] operator
|
1219
|
-
# An operator to use for the jobs filter.
|
1300
|
+
# The name of the hybrid job parameter to filter based on. Filter name
|
1301
|
+
# can be either `jobArn` or `createdAt`.
|
1220
1302
|
# @return [String]
|
1221
1303
|
#
|
1222
1304
|
# @!attribute [rw] values
|
1223
|
-
# The values to
|
1305
|
+
# The values used to filter hybrid jobs based on the filter name and
|
1306
|
+
# operator.
|
1224
1307
|
# @return [Array<String>]
|
1225
1308
|
#
|
1309
|
+
# @!attribute [rw] operator
|
1310
|
+
# An operator to use for the filter.
|
1311
|
+
# @return [String]
|
1312
|
+
#
|
1226
1313
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchJobsFilter AWS API Documentation
|
1227
1314
|
#
|
1228
1315
|
class SearchJobsFilter < Struct.new(
|
1229
1316
|
:name,
|
1230
|
-
:
|
1231
|
-
:
|
1317
|
+
:values,
|
1318
|
+
:operator)
|
1232
1319
|
SENSITIVE = []
|
1233
1320
|
include Aws::Structure
|
1234
1321
|
end
|
1235
1322
|
|
1236
|
-
# @!attribute [rw]
|
1237
|
-
#
|
1238
|
-
#
|
1323
|
+
# @!attribute [rw] next_token
|
1324
|
+
# A token used for pagination of results returned in the response. Use
|
1325
|
+
# the token returned from the previous request to continue search
|
1326
|
+
# where the previous request ended.
|
1327
|
+
# @return [String]
|
1239
1328
|
#
|
1240
1329
|
# @!attribute [rw] max_results
|
1241
1330
|
# The maximum number of results to return in the response.
|
1242
1331
|
# @return [Integer]
|
1243
1332
|
#
|
1244
|
-
# @!attribute [rw]
|
1245
|
-
#
|
1246
|
-
#
|
1247
|
-
#
|
1248
|
-
# @return [String]
|
1333
|
+
# @!attribute [rw] filters
|
1334
|
+
# Array of SearchJobsFilter objects to use when searching for hybrid
|
1335
|
+
# jobs.
|
1336
|
+
# @return [Array<Types::SearchJobsFilter>]
|
1249
1337
|
#
|
1250
1338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchJobsRequest AWS API Documentation
|
1251
1339
|
#
|
1252
1340
|
class SearchJobsRequest < Struct.new(
|
1253
|
-
:
|
1341
|
+
:next_token,
|
1254
1342
|
:max_results,
|
1255
|
-
:
|
1343
|
+
:filters)
|
1256
1344
|
SENSITIVE = []
|
1257
1345
|
include Aws::Structure
|
1258
1346
|
end
|
@@ -1265,7 +1353,7 @@ module Aws::Braket
|
|
1265
1353
|
# @!attribute [rw] next_token
|
1266
1354
|
# A token used for pagination of results, or `null` if there are no
|
1267
1355
|
# additional results. Use the token value in a subsequent request to
|
1268
|
-
# continue
|
1356
|
+
# continue search where the previous request ended.
|
1269
1357
|
# @return [String]
|
1270
1358
|
#
|
1271
1359
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchJobsResponse AWS API Documentation
|
@@ -1277,70 +1365,74 @@ module Aws::Braket
|
|
1277
1365
|
include Aws::Structure
|
1278
1366
|
end
|
1279
1367
|
|
1280
|
-
# A filter
|
1368
|
+
# A filter used to search for quantum tasks.
|
1281
1369
|
#
|
1282
1370
|
# @!attribute [rw] name
|
1283
|
-
# The name of the
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
# @!attribute [rw] operator
|
1287
|
-
# An operator to use in the filter.
|
1371
|
+
# The name of the quantum task parameter to filter based on. Filter
|
1372
|
+
# name can be either `quantumTaskArn`, `deviceArn`, `jobArn`, `status`
|
1373
|
+
# or `createdAt`.
|
1288
1374
|
# @return [String]
|
1289
1375
|
#
|
1290
1376
|
# @!attribute [rw] values
|
1291
|
-
# The values to
|
1377
|
+
# The values used to filter quantum tasks based on the filter name and
|
1378
|
+
# operator.
|
1292
1379
|
# @return [Array<String>]
|
1293
1380
|
#
|
1381
|
+
# @!attribute [rw] operator
|
1382
|
+
# An operator to use for the filter.
|
1383
|
+
# @return [String]
|
1384
|
+
#
|
1294
1385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchQuantumTasksFilter AWS API Documentation
|
1295
1386
|
#
|
1296
1387
|
class SearchQuantumTasksFilter < Struct.new(
|
1297
1388
|
:name,
|
1298
|
-
:
|
1299
|
-
:
|
1389
|
+
:values,
|
1390
|
+
:operator)
|
1300
1391
|
SENSITIVE = []
|
1301
1392
|
include Aws::Structure
|
1302
1393
|
end
|
1303
1394
|
|
1304
|
-
# @!attribute [rw]
|
1305
|
-
#
|
1306
|
-
#
|
1395
|
+
# @!attribute [rw] next_token
|
1396
|
+
# A token used for pagination of results returned in the response. Use
|
1397
|
+
# the token returned from the previous request to continue search
|
1398
|
+
# where the previous request ended.
|
1399
|
+
# @return [String]
|
1307
1400
|
#
|
1308
1401
|
# @!attribute [rw] max_results
|
1309
1402
|
# Maximum number of results to return in the response.
|
1310
1403
|
# @return [Integer]
|
1311
1404
|
#
|
1312
|
-
# @!attribute [rw]
|
1313
|
-
#
|
1314
|
-
#
|
1315
|
-
#
|
1316
|
-
# @return [String]
|
1405
|
+
# @!attribute [rw] filters
|
1406
|
+
# Array of `SearchQuantumTasksFilter` objects to use when searching
|
1407
|
+
# for quantum tasks.
|
1408
|
+
# @return [Array<Types::SearchQuantumTasksFilter>]
|
1317
1409
|
#
|
1318
1410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchQuantumTasksRequest AWS API Documentation
|
1319
1411
|
#
|
1320
1412
|
class SearchQuantumTasksRequest < Struct.new(
|
1321
|
-
:
|
1413
|
+
:next_token,
|
1322
1414
|
:max_results,
|
1323
|
-
:
|
1415
|
+
:filters)
|
1324
1416
|
SENSITIVE = []
|
1325
1417
|
include Aws::Structure
|
1326
1418
|
end
|
1327
1419
|
|
1420
|
+
# @!attribute [rw] quantum_tasks
|
1421
|
+
# An array of `QuantumTaskSummary` objects for quantum tasks that
|
1422
|
+
# match the specified filters.
|
1423
|
+
# @return [Array<Types::QuantumTaskSummary>]
|
1424
|
+
#
|
1328
1425
|
# @!attribute [rw] next_token
|
1329
1426
|
# A token used for pagination of results, or null if there are no
|
1330
1427
|
# additional results. Use the token value in a subsequent request to
|
1331
|
-
# continue
|
1428
|
+
# continue search where the previous request ended.
|
1332
1429
|
# @return [String]
|
1333
1430
|
#
|
1334
|
-
# @!attribute [rw] quantum_tasks
|
1335
|
-
# An array of `QuantumTaskSummary` objects for tasks that match the
|
1336
|
-
# specified filters.
|
1337
|
-
# @return [Array<Types::QuantumTaskSummary>]
|
1338
|
-
#
|
1339
1431
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchQuantumTasksResponse AWS API Documentation
|
1340
1432
|
#
|
1341
1433
|
class SearchQuantumTasksResponse < Struct.new(
|
1342
|
-
:
|
1343
|
-
:
|
1434
|
+
:quantum_tasks,
|
1435
|
+
:next_token)
|
1344
1436
|
SENSITIVE = []
|
1345
1437
|
include Aws::Structure
|
1346
1438
|
end
|
@@ -1364,7 +1456,8 @@ module Aws::Braket
|
|
1364
1456
|
# @return [String]
|
1365
1457
|
#
|
1366
1458
|
# @!attribute [rw] tags
|
1367
|
-
# Specify the tags to add to the resource.
|
1459
|
+
# Specify the tags to add to the resource. Tags can be specified as a
|
1460
|
+
# key-value map.
|
1368
1461
|
# @return [Hash<String,String>]
|
1369
1462
|
#
|
1370
1463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/TagResourceRequest AWS API Documentation
|
@@ -1380,7 +1473,7 @@ module Aws::Braket
|
|
1380
1473
|
#
|
1381
1474
|
class TagResourceResponse < Aws::EmptyStructure; end
|
1382
1475
|
|
1383
|
-
# The throttling rate limit is
|
1476
|
+
# The API throttling rate limit is exceeded.
|
1384
1477
|
#
|
1385
1478
|
# @!attribute [rw] message
|
1386
1479
|
# @return [String]
|
@@ -1415,16 +1508,26 @@ module Aws::Braket
|
|
1415
1508
|
#
|
1416
1509
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
1417
1510
|
|
1418
|
-
# The input
|
1419
|
-
#
|
1511
|
+
# The input request failed to satisfy constraints expected by Amazon
|
1512
|
+
# Braket.
|
1420
1513
|
#
|
1421
1514
|
# @!attribute [rw] message
|
1422
1515
|
# @return [String]
|
1423
1516
|
#
|
1517
|
+
# @!attribute [rw] reason
|
1518
|
+
# The reason for validation failure.
|
1519
|
+
# @return [String]
|
1520
|
+
#
|
1521
|
+
# @!attribute [rw] program_set_validation_failures
|
1522
|
+
# The validation failures in the program set submitted in the request.
|
1523
|
+
# @return [Array<Types::ProgramSetValidationFailure>]
|
1524
|
+
#
|
1424
1525
|
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/ValidationException AWS API Documentation
|
1425
1526
|
#
|
1426
1527
|
class ValidationException < Struct.new(
|
1427
|
-
:message
|
1528
|
+
:message,
|
1529
|
+
:reason,
|
1530
|
+
:program_set_validation_failures)
|
1428
1531
|
SENSITIVE = []
|
1429
1532
|
include Aws::Structure
|
1430
1533
|
end
|