aws-sdk-braket 1.12.0 → 1.16.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -23,6 +23,78 @@ module Aws::Braket
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
+ # Defines the Amazon Braket job to be created. Specifies the container
27
+ # image the job uses and the paths to the Python scripts used for entry
28
+ # and training.
29
+ #
30
+ # @note When making an API call, you may pass AlgorithmSpecification
31
+ # data as a hash:
32
+ #
33
+ # {
34
+ # container_image: {
35
+ # uri: "Uri", # required
36
+ # },
37
+ # script_mode_config: {
38
+ # compression_type: "NONE", # accepts NONE, GZIP
39
+ # entry_point: "String", # required
40
+ # s3_uri: "S3Path", # required
41
+ # },
42
+ # }
43
+ #
44
+ # @!attribute [rw] container_image
45
+ # The container image used to create an Amazon Braket job.
46
+ # @return [Types::ContainerImage]
47
+ #
48
+ # @!attribute [rw] script_mode_config
49
+ # Configures the paths to the Python scripts used for entry and
50
+ # training.
51
+ # @return [Types::ScriptModeConfig]
52
+ #
53
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/AlgorithmSpecification AWS API Documentation
54
+ #
55
+ class AlgorithmSpecification < Struct.new(
56
+ :container_image,
57
+ :script_mode_config)
58
+ SENSITIVE = []
59
+ include Aws::Structure
60
+ end
61
+
62
+ # @note When making an API call, you may pass CancelJobRequest
63
+ # data as a hash:
64
+ #
65
+ # {
66
+ # job_arn: "JobArn", # required
67
+ # }
68
+ #
69
+ # @!attribute [rw] job_arn
70
+ # The ARN of the Amazon Braket job to cancel.
71
+ # @return [String]
72
+ #
73
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelJobRequest AWS API Documentation
74
+ #
75
+ class CancelJobRequest < Struct.new(
76
+ :job_arn)
77
+ SENSITIVE = []
78
+ include Aws::Structure
79
+ end
80
+
81
+ # @!attribute [rw] cancellation_status
82
+ # The status of the job cancellation request.
83
+ # @return [String]
84
+ #
85
+ # @!attribute [rw] job_arn
86
+ # The ARN of the Amazon Braket job.
87
+ # @return [String]
88
+ #
89
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelJobResponse AWS API Documentation
90
+ #
91
+ class CancelJobResponse < Struct.new(
92
+ :cancellation_status,
93
+ :job_arn)
94
+ SENSITIVE = []
95
+ include Aws::Structure
96
+ end
97
+
26
98
  # @note When making an API call, you may pass CancelQuantumTaskRequest
27
99
  # data as a hash:
28
100
  #
@@ -81,6 +153,177 @@ module Aws::Braket
81
153
  include Aws::Structure
82
154
  end
83
155
 
156
+ # The container image used to create an Amazon Braket job.
157
+ #
158
+ # @note When making an API call, you may pass ContainerImage
159
+ # data as a hash:
160
+ #
161
+ # {
162
+ # uri: "Uri", # required
163
+ # }
164
+ #
165
+ # @!attribute [rw] uri
166
+ # The URI locating the container image.
167
+ # @return [String]
168
+ #
169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/ContainerImage AWS API Documentation
170
+ #
171
+ class ContainerImage < Struct.new(
172
+ :uri)
173
+ SENSITIVE = []
174
+ include Aws::Structure
175
+ end
176
+
177
+ # @note When making an API call, you may pass CreateJobRequest
178
+ # data as a hash:
179
+ #
180
+ # {
181
+ # algorithm_specification: { # required
182
+ # container_image: {
183
+ # uri: "Uri", # required
184
+ # },
185
+ # script_mode_config: {
186
+ # compression_type: "NONE", # accepts NONE, GZIP
187
+ # entry_point: "String", # required
188
+ # s3_uri: "S3Path", # required
189
+ # },
190
+ # },
191
+ # checkpoint_config: {
192
+ # local_path: "String4096",
193
+ # s3_uri: "S3Path", # required
194
+ # },
195
+ # client_token: "String64", # required
196
+ # device_config: { # required
197
+ # device: "String256", # required
198
+ # },
199
+ # hyper_parameters: {
200
+ # "String256" => "HyperParametersValueString",
201
+ # },
202
+ # input_data_config: [
203
+ # {
204
+ # channel_name: "InputFileConfigChannelNameString", # required
205
+ # content_type: "String256",
206
+ # data_source: { # required
207
+ # s3_data_source: { # required
208
+ # s3_uri: "S3Path", # required
209
+ # },
210
+ # },
211
+ # },
212
+ # ],
213
+ # instance_config: { # required
214
+ # instance_type: "ml.m4.xlarge", # required, accepts ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.p4d.24xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5n.xlarge, ml.c5n.2xlarge, ml.c5n.4xlarge, ml.c5n.9xlarge, ml.c5n.18xlarge
215
+ # volume_size_in_gb: 1, # required
216
+ # },
217
+ # job_name: "CreateJobRequestJobNameString", # required
218
+ # output_data_config: { # required
219
+ # kms_key_id: "String2048",
220
+ # s3_path: "S3Path", # required
221
+ # },
222
+ # role_arn: "RoleArn", # required
223
+ # stopping_condition: {
224
+ # max_runtime_in_seconds: 1,
225
+ # },
226
+ # tags: {
227
+ # "String" => "String",
228
+ # },
229
+ # }
230
+ #
231
+ # @!attribute [rw] algorithm_specification
232
+ # Definition of the Amazon Braket job to be created. Specifies the
233
+ # container image the job uses and information about the Python
234
+ # scripts used for entry and training.
235
+ # @return [Types::AlgorithmSpecification]
236
+ #
237
+ # @!attribute [rw] checkpoint_config
238
+ # Information about the output locations for job checkpoint data.
239
+ # @return [Types::JobCheckpointConfig]
240
+ #
241
+ # @!attribute [rw] client_token
242
+ # A unique token that guarantees that the call to this API is
243
+ # idempotent.
244
+ #
245
+ # **A suitable default value is auto-generated.** You should normally
246
+ # not need to pass this option.
247
+ # @return [String]
248
+ #
249
+ # @!attribute [rw] device_config
250
+ # The quantum processing unit (QPU) or simulator used to create an
251
+ # Amazon Braket job.
252
+ # @return [Types::DeviceConfig]
253
+ #
254
+ # @!attribute [rw] hyper_parameters
255
+ # Algorithm-specific parameters used by an Amazon Braket job that
256
+ # influence the quality of the training job. The values are set with a
257
+ # string of JSON key:value pairs, where the key is the name of the
258
+ # hyperparameter and the value is the value of th hyperparameter.
259
+ # @return [Hash<String,String>]
260
+ #
261
+ # @!attribute [rw] input_data_config
262
+ # A list of parameters that specify the name and type of input data
263
+ # and where it is located.
264
+ # @return [Array<Types::InputFileConfig>]
265
+ #
266
+ # @!attribute [rw] instance_config
267
+ # Configuration of the resource instances to use while running the
268
+ # hybrid job on Amazon Braket.
269
+ # @return [Types::InstanceConfig]
270
+ #
271
+ # @!attribute [rw] job_name
272
+ # The name of the Amazon Braket job.
273
+ # @return [String]
274
+ #
275
+ # @!attribute [rw] output_data_config
276
+ # The path to the S3 location where you want to store job artifacts
277
+ # and the encryption key used to store them.
278
+ # @return [Types::JobOutputDataConfig]
279
+ #
280
+ # @!attribute [rw] role_arn
281
+ # The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can
282
+ # assume to perform tasks on behalf of a user. It can access user
283
+ # resources, run an Amazon Braket job container on behalf of user, and
284
+ # output resources to the users' s3 buckets.
285
+ # @return [String]
286
+ #
287
+ # @!attribute [rw] stopping_condition
288
+ # The user-defined criteria that specifies when a job stops running.
289
+ # @return [Types::JobStoppingCondition]
290
+ #
291
+ # @!attribute [rw] tags
292
+ # A tag object that consists of a key and an optional value, used to
293
+ # manage metadata for Amazon Braket resources.
294
+ # @return [Hash<String,String>]
295
+ #
296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateJobRequest AWS API Documentation
297
+ #
298
+ class CreateJobRequest < Struct.new(
299
+ :algorithm_specification,
300
+ :checkpoint_config,
301
+ :client_token,
302
+ :device_config,
303
+ :hyper_parameters,
304
+ :input_data_config,
305
+ :instance_config,
306
+ :job_name,
307
+ :output_data_config,
308
+ :role_arn,
309
+ :stopping_condition,
310
+ :tags)
311
+ SENSITIVE = []
312
+ include Aws::Structure
313
+ end
314
+
315
+ # @!attribute [rw] job_arn
316
+ # The ARN of the Amazon Braket job created.
317
+ # @return [String]
318
+ #
319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateJobResponse AWS API Documentation
320
+ #
321
+ class CreateJobResponse < Struct.new(
322
+ :job_arn)
323
+ SENSITIVE = []
324
+ include Aws::Structure
325
+ end
326
+
84
327
  # @note When making an API call, you may pass CreateQuantumTaskRequest
85
328
  # data as a hash:
86
329
  #
@@ -89,6 +332,7 @@ module Aws::Braket
89
332
  # client_token: "String64", # required
90
333
  # device_arn: "DeviceArn", # required
91
334
  # device_parameters: "CreateQuantumTaskRequestDeviceParametersString",
335
+ # job_token: "JobToken",
92
336
  # output_s3_bucket: "CreateQuantumTaskRequestOutputS3BucketString", # required
93
337
  # output_s3_key_prefix: "CreateQuantumTaskRequestOutputS3KeyPrefixString", # required
94
338
  # shots: 1, # required
@@ -116,6 +360,11 @@ module Aws::Braket
116
360
  # The parameters for the device to run the task on.
117
361
  # @return [String]
118
362
  #
363
+ # @!attribute [rw] job_token
364
+ # The token for an Amazon Braket job that associates it with the
365
+ # quantum task.
366
+ # @return [String]
367
+ #
119
368
  # @!attribute [rw] output_s3_bucket
120
369
  # The S3 bucket to store task result files in.
121
370
  # @return [String]
@@ -140,6 +389,7 @@ module Aws::Braket
140
389
  :client_token,
141
390
  :device_arn,
142
391
  :device_parameters,
392
+ :job_token,
143
393
  :output_s3_bucket,
144
394
  :output_s3_key_prefix,
145
395
  :shots,
@@ -160,6 +410,54 @@ module Aws::Braket
160
410
  include Aws::Structure
161
411
  end
162
412
 
413
+ # Information about the source of the data used by the Amazon Braket
414
+ # job.
415
+ #
416
+ # @note When making an API call, you may pass DataSource
417
+ # data as a hash:
418
+ #
419
+ # {
420
+ # s3_data_source: { # required
421
+ # s3_uri: "S3Path", # required
422
+ # },
423
+ # }
424
+ #
425
+ # @!attribute [rw] s3_data_source
426
+ # Information about the data stored in Amazon S3 used by the Amazon
427
+ # Braket job.
428
+ # @return [Types::S3DataSource]
429
+ #
430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/DataSource AWS API Documentation
431
+ #
432
+ class DataSource < Struct.new(
433
+ :s3_data_source)
434
+ SENSITIVE = []
435
+ include Aws::Structure
436
+ end
437
+
438
+ # Configures the quantum processing units (QPUs) or simulator used to
439
+ # create and run an Amazon Braket job.
440
+ #
441
+ # @note When making an API call, you may pass DeviceConfig
442
+ # data as a hash:
443
+ #
444
+ # {
445
+ # device: "String256", # required
446
+ # }
447
+ #
448
+ # @!attribute [rw] device
449
+ # The primary quantum processing unit (QPU) or simulator used to
450
+ # create and run an Amazon Braket job.
451
+ # @return [String]
452
+ #
453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/DeviceConfig AWS API Documentation
454
+ #
455
+ class DeviceConfig < Struct.new(
456
+ :device)
457
+ SENSITIVE = []
458
+ include Aws::Structure
459
+ end
460
+
163
461
  # The specified device is currently offline.
164
462
  #
165
463
  # @!attribute [rw] message
@@ -276,6 +574,143 @@ module Aws::Braket
276
574
  include Aws::Structure
277
575
  end
278
576
 
577
+ # @note When making an API call, you may pass GetJobRequest
578
+ # data as a hash:
579
+ #
580
+ # {
581
+ # job_arn: "JobArn", # required
582
+ # }
583
+ #
584
+ # @!attribute [rw] job_arn
585
+ # The ARN of the job to retrieve.
586
+ # @return [String]
587
+ #
588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetJobRequest AWS API Documentation
589
+ #
590
+ class GetJobRequest < Struct.new(
591
+ :job_arn)
592
+ SENSITIVE = []
593
+ include Aws::Structure
594
+ end
595
+
596
+ # @!attribute [rw] algorithm_specification
597
+ # Definition of the Amazon Braket job created. Specifies the container
598
+ # image the job uses, information about the Python scripts used for
599
+ # entry and training, and the user-defined metrics used to evaluation
600
+ # the job.
601
+ # @return [Types::AlgorithmSpecification]
602
+ #
603
+ # @!attribute [rw] billable_duration
604
+ # The billable time the Amazon Braket job used to complete.
605
+ # @return [Integer]
606
+ #
607
+ # @!attribute [rw] checkpoint_config
608
+ # Information about the output locations for job checkpoint data.
609
+ # @return [Types::JobCheckpointConfig]
610
+ #
611
+ # @!attribute [rw] created_at
612
+ # The date and time that the Amazon Braket job was created.
613
+ # @return [Time]
614
+ #
615
+ # @!attribute [rw] device_config
616
+ # The quantum processing unit (QPU) or simulator used to run the
617
+ # Amazon Braket job.
618
+ # @return [Types::DeviceConfig]
619
+ #
620
+ # @!attribute [rw] ended_at
621
+ # The date and time that the Amazon Braket job ended.
622
+ # @return [Time]
623
+ #
624
+ # @!attribute [rw] events
625
+ # Details about the type and time events occurred related to the
626
+ # Amazon Braket job.
627
+ # @return [Array<Types::JobEventDetails>]
628
+ #
629
+ # @!attribute [rw] failure_reason
630
+ # A description of the reason why an Amazon Braket job failed, if it
631
+ # failed.
632
+ # @return [String]
633
+ #
634
+ # @!attribute [rw] hyper_parameters
635
+ # Algorithm-specific parameters used by an Amazon Braket job that
636
+ # influence the quality of the traiing job. The values are set with a
637
+ # string of JSON key:value pairs, where the key is the name of the
638
+ # hyperparameter and the value is the value of th hyperparameter.
639
+ # @return [Hash<String,String>]
640
+ #
641
+ # @!attribute [rw] input_data_config
642
+ # A list of parameters that specify the name and type of input data
643
+ # and where it is located.
644
+ # @return [Array<Types::InputFileConfig>]
645
+ #
646
+ # @!attribute [rw] instance_config
647
+ # The resource instances to use while running the hybrid job on Amazon
648
+ # Braket.
649
+ # @return [Types::InstanceConfig]
650
+ #
651
+ # @!attribute [rw] job_arn
652
+ # The ARN of the Amazon Braket job.
653
+ # @return [String]
654
+ #
655
+ # @!attribute [rw] job_name
656
+ # The name of the Amazon Braket job.
657
+ # @return [String]
658
+ #
659
+ # @!attribute [rw] output_data_config
660
+ # The path to the S3 location where job artifacts are stored and the
661
+ # encryption key used to store them there.
662
+ # @return [Types::JobOutputDataConfig]
663
+ #
664
+ # @!attribute [rw] role_arn
665
+ # The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can
666
+ # assume to perform tasks on behalf of a user. It can access user
667
+ # resources, run an Amazon Braket job container on behalf of user, and
668
+ # output resources to the s3 buckets of a user.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] started_at
672
+ # The date and time that the Amazon Braket job was started.
673
+ # @return [Time]
674
+ #
675
+ # @!attribute [rw] status
676
+ # The status of the Amazon Braket job.
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] stopping_condition
680
+ # The user-defined criteria that specifies when to stop a job running.
681
+ # @return [Types::JobStoppingCondition]
682
+ #
683
+ # @!attribute [rw] tags
684
+ # A tag object that consists of a key and an optional value, used to
685
+ # manage metadata for Amazon Braket resources.
686
+ # @return [Hash<String,String>]
687
+ #
688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetJobResponse AWS API Documentation
689
+ #
690
+ class GetJobResponse < Struct.new(
691
+ :algorithm_specification,
692
+ :billable_duration,
693
+ :checkpoint_config,
694
+ :created_at,
695
+ :device_config,
696
+ :ended_at,
697
+ :events,
698
+ :failure_reason,
699
+ :hyper_parameters,
700
+ :input_data_config,
701
+ :instance_config,
702
+ :job_arn,
703
+ :job_name,
704
+ :output_data_config,
705
+ :role_arn,
706
+ :started_at,
707
+ :status,
708
+ :stopping_condition,
709
+ :tags)
710
+ SENSITIVE = []
711
+ include Aws::Structure
712
+ end
713
+
279
714
  # @note When making an API call, you may pass GetQuantumTaskRequest
280
715
  # data as a hash:
281
716
  #
@@ -315,6 +750,10 @@ module Aws::Braket
315
750
  # The reason that a task failed.
316
751
  # @return [String]
317
752
  #
753
+ # @!attribute [rw] job_arn
754
+ # The ARN of the Amazon Braket job associated with the quantum task.
755
+ # @return [String]
756
+ #
318
757
  # @!attribute [rw] output_s3_bucket
319
758
  # The S3 bucket where task results are stored.
320
759
  # @return [String]
@@ -347,6 +786,7 @@ module Aws::Braket
347
786
  :device_parameters,
348
787
  :ended_at,
349
788
  :failure_reason,
789
+ :job_arn,
350
790
  :output_s3_bucket,
351
791
  :output_s3_directory,
352
792
  :quantum_task_arn,
@@ -357,6 +797,73 @@ module Aws::Braket
357
797
  include Aws::Structure
358
798
  end
359
799
 
800
+ # A list of parameters that specify the input channels, type of input
801
+ # data, and where it is located.
802
+ #
803
+ # @note When making an API call, you may pass InputFileConfig
804
+ # data as a hash:
805
+ #
806
+ # {
807
+ # channel_name: "InputFileConfigChannelNameString", # required
808
+ # content_type: "String256",
809
+ # data_source: { # required
810
+ # s3_data_source: { # required
811
+ # s3_uri: "S3Path", # required
812
+ # },
813
+ # },
814
+ # }
815
+ #
816
+ # @!attribute [rw] channel_name
817
+ # A named input source that an Amazon Braket job can consume.
818
+ # @return [String]
819
+ #
820
+ # @!attribute [rw] content_type
821
+ # The MIME type of the data.
822
+ # @return [String]
823
+ #
824
+ # @!attribute [rw] data_source
825
+ # The location of the channel data.
826
+ # @return [Types::DataSource]
827
+ #
828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/InputFileConfig AWS API Documentation
829
+ #
830
+ class InputFileConfig < Struct.new(
831
+ :channel_name,
832
+ :content_type,
833
+ :data_source)
834
+ SENSITIVE = []
835
+ include Aws::Structure
836
+ end
837
+
838
+ # Configures the resource instances to use while running the Amazon
839
+ # Braket hybrid job on Amazon Braket.
840
+ #
841
+ # @note When making an API call, you may pass InstanceConfig
842
+ # data as a hash:
843
+ #
844
+ # {
845
+ # instance_type: "ml.m4.xlarge", # required, accepts ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.p4d.24xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5n.xlarge, ml.c5n.2xlarge, ml.c5n.4xlarge, ml.c5n.9xlarge, ml.c5n.18xlarge
846
+ # volume_size_in_gb: 1, # required
847
+ # }
848
+ #
849
+ # @!attribute [rw] instance_type
850
+ # Configures the type resource instances to use while running an
851
+ # Amazon Braket hybrid job.
852
+ # @return [String]
853
+ #
854
+ # @!attribute [rw] volume_size_in_gb
855
+ # The size of the storage volume, in GB, that user wants to provision.
856
+ # @return [Integer]
857
+ #
858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/InstanceConfig AWS API Documentation
859
+ #
860
+ class InstanceConfig < Struct.new(
861
+ :instance_type,
862
+ :volume_size_in_gb)
863
+ SENSITIVE = []
864
+ include Aws::Structure
865
+ end
866
+
360
867
  # The request processing has failed because of an unknown error,
361
868
  # exception, or failure.
362
869
  #
@@ -371,6 +878,166 @@ module Aws::Braket
371
878
  include Aws::Structure
372
879
  end
373
880
 
881
+ # Contains information about the output locations for job checkpoint
882
+ # data.
883
+ #
884
+ # @note When making an API call, you may pass JobCheckpointConfig
885
+ # data as a hash:
886
+ #
887
+ # {
888
+ # local_path: "String4096",
889
+ # s3_uri: "S3Path", # required
890
+ # }
891
+ #
892
+ # @!attribute [rw] local_path
893
+ # (Optional) The local directory where checkpoints are written. The
894
+ # default directory is `/opt/braket/checkpoints/`.
895
+ # @return [String]
896
+ #
897
+ # @!attribute [rw] s3_uri
898
+ # Identifies the S3 path where you want Amazon Braket to store
899
+ # checkpoints. For example, `s3://bucket-name/key-name-prefix`.
900
+ # @return [String]
901
+ #
902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobCheckpointConfig AWS API Documentation
903
+ #
904
+ class JobCheckpointConfig < Struct.new(
905
+ :local_path,
906
+ :s3_uri)
907
+ SENSITIVE = []
908
+ include Aws::Structure
909
+ end
910
+
911
+ # Details about the type and time events occurred related to the Amazon
912
+ # Braket job.
913
+ #
914
+ # @!attribute [rw] event_type
915
+ # The type of event that occurred related to the Amazon Braket job.
916
+ # @return [String]
917
+ #
918
+ # @!attribute [rw] message
919
+ # A message describing the event that occurred related to the Amazon
920
+ # Braket job.
921
+ # @return [String]
922
+ #
923
+ # @!attribute [rw] time_of_event
924
+ # TThe type of event that occurred related to the Amazon Braket job.
925
+ # @return [Time]
926
+ #
927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobEventDetails AWS API Documentation
928
+ #
929
+ class JobEventDetails < Struct.new(
930
+ :event_type,
931
+ :message,
932
+ :time_of_event)
933
+ SENSITIVE = []
934
+ include Aws::Structure
935
+ end
936
+
937
+ # Specifies the path to the S3 location where you want to store job
938
+ # artifacts and the encryption key used to store them.
939
+ #
940
+ # @note When making an API call, you may pass JobOutputDataConfig
941
+ # data as a hash:
942
+ #
943
+ # {
944
+ # kms_key_id: "String2048",
945
+ # s3_path: "S3Path", # required
946
+ # }
947
+ #
948
+ # @!attribute [rw] kms_key_id
949
+ # The AWS Key Management Service (AWS KMS) key that Amazon Braket uses
950
+ # to encrypt the job training artifacts at rest using Amazon S3
951
+ # server-side encryption.
952
+ # @return [String]
953
+ #
954
+ # @!attribute [rw] s3_path
955
+ # Identifies the S3 path where you want Amazon Braket to store the job
956
+ # training artifacts. For example, `s3://bucket-name/key-name-prefix`.
957
+ # @return [String]
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobOutputDataConfig AWS API Documentation
960
+ #
961
+ class JobOutputDataConfig < Struct.new(
962
+ :kms_key_id,
963
+ :s3_path)
964
+ SENSITIVE = []
965
+ include Aws::Structure
966
+ end
967
+
968
+ # Specifies limits for how long an Amazon Braket job can run.
969
+ #
970
+ # @note When making an API call, you may pass JobStoppingCondition
971
+ # data as a hash:
972
+ #
973
+ # {
974
+ # max_runtime_in_seconds: 1,
975
+ # }
976
+ #
977
+ # @!attribute [rw] max_runtime_in_seconds
978
+ # The maximum length of time, in seconds, that an Amazon Braket job
979
+ # can run.
980
+ # @return [Integer]
981
+ #
982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobStoppingCondition AWS API Documentation
983
+ #
984
+ class JobStoppingCondition < Struct.new(
985
+ :max_runtime_in_seconds)
986
+ SENSITIVE = []
987
+ include Aws::Structure
988
+ end
989
+
990
+ # Provides summary information about an Amazon Braket job.
991
+ #
992
+ # @!attribute [rw] created_at
993
+ # The date and time that the Amazon Braket job was created.
994
+ # @return [Time]
995
+ #
996
+ # @!attribute [rw] device
997
+ # Provides summary information about the primary device used by an
998
+ # Amazon Braket job.
999
+ # @return [String]
1000
+ #
1001
+ # @!attribute [rw] ended_at
1002
+ # The date and time that the Amazon Braket job ended.
1003
+ # @return [Time]
1004
+ #
1005
+ # @!attribute [rw] job_arn
1006
+ # The ARN of the Amazon Braket job.
1007
+ # @return [String]
1008
+ #
1009
+ # @!attribute [rw] job_name
1010
+ # The name of the Amazon Braket job.
1011
+ # @return [String]
1012
+ #
1013
+ # @!attribute [rw] started_at
1014
+ # The date and time that the Amazon Braket job was started.
1015
+ # @return [Time]
1016
+ #
1017
+ # @!attribute [rw] status
1018
+ # The status of the Amazon Braket job.
1019
+ # @return [String]
1020
+ #
1021
+ # @!attribute [rw] tags
1022
+ # A tag object that consists of a key and an optional value, used to
1023
+ # manage metadata for Amazon Braket resources.
1024
+ # @return [Hash<String,String>]
1025
+ #
1026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/JobSummary AWS API Documentation
1027
+ #
1028
+ class JobSummary < Struct.new(
1029
+ :created_at,
1030
+ :device,
1031
+ :ended_at,
1032
+ :job_arn,
1033
+ :job_name,
1034
+ :started_at,
1035
+ :status,
1036
+ :tags)
1037
+ SENSITIVE = []
1038
+ include Aws::Structure
1039
+ end
1040
+
374
1041
  # @note When making an API call, you may pass ListTagsForResourceRequest
375
1042
  # data as a hash:
376
1043
  #
@@ -470,6 +1137,67 @@ module Aws::Braket
470
1137
  include Aws::Structure
471
1138
  end
472
1139
 
1140
+ # Information about the data stored in Amazon S3 used by the Amazon
1141
+ # Braket job.
1142
+ #
1143
+ # @note When making an API call, you may pass S3DataSource
1144
+ # data as a hash:
1145
+ #
1146
+ # {
1147
+ # s3_uri: "S3Path", # required
1148
+ # }
1149
+ #
1150
+ # @!attribute [rw] s3_uri
1151
+ # Depending on the value specified for the `S3DataType`, identifies
1152
+ # either a key name prefix or a manifest that locates the S3 data
1153
+ # source.
1154
+ # @return [String]
1155
+ #
1156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/S3DataSource AWS API Documentation
1157
+ #
1158
+ class S3DataSource < Struct.new(
1159
+ :s3_uri)
1160
+ SENSITIVE = []
1161
+ include Aws::Structure
1162
+ end
1163
+
1164
+ # Contains information about the Python scripts used for entry and by an
1165
+ # Amazon Braket job.
1166
+ #
1167
+ # @note When making an API call, you may pass ScriptModeConfig
1168
+ # data as a hash:
1169
+ #
1170
+ # {
1171
+ # compression_type: "NONE", # accepts NONE, GZIP
1172
+ # entry_point: "String", # required
1173
+ # s3_uri: "S3Path", # required
1174
+ # }
1175
+ #
1176
+ # @!attribute [rw] compression_type
1177
+ # The type of compression used by the Python scripts for an Amazon
1178
+ # Braket job.
1179
+ # @return [String]
1180
+ #
1181
+ # @!attribute [rw] entry_point
1182
+ # The path to the Python script that serves as the entry point for an
1183
+ # Amazon Braket job.
1184
+ # @return [String]
1185
+ #
1186
+ # @!attribute [rw] s3_uri
1187
+ # The URI that specifies the S3 path to the Python script module that
1188
+ # contains the training script used by an Amazon Braket job.
1189
+ # @return [String]
1190
+ #
1191
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/ScriptModeConfig AWS API Documentation
1192
+ #
1193
+ class ScriptModeConfig < Struct.new(
1194
+ :compression_type,
1195
+ :entry_point,
1196
+ :s3_uri)
1197
+ SENSITIVE = []
1198
+ include Aws::Structure
1199
+ end
1200
+
473
1201
  # The filter to use for searching devices.
474
1202
  #
475
1203
  # @note When making an API call, you may pass SearchDevicesFilter
@@ -555,6 +1283,98 @@ module Aws::Braket
555
1283
  include Aws::Structure
556
1284
  end
557
1285
 
1286
+ # A filter used to search for Amazon Braket jobs.
1287
+ #
1288
+ # @note When making an API call, you may pass SearchJobsFilter
1289
+ # data as a hash:
1290
+ #
1291
+ # {
1292
+ # name: "String64", # required
1293
+ # operator: "LT", # required, accepts LT, LTE, EQUAL, GT, GTE, BETWEEN, CONTAINS
1294
+ # values: ["String256"], # required
1295
+ # }
1296
+ #
1297
+ # @!attribute [rw] name
1298
+ # The name to use for the jobs filter.
1299
+ # @return [String]
1300
+ #
1301
+ # @!attribute [rw] operator
1302
+ # An operator to use for the jobs filter.
1303
+ # @return [String]
1304
+ #
1305
+ # @!attribute [rw] values
1306
+ # The values to use for the jobs filter.
1307
+ # @return [Array<String>]
1308
+ #
1309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchJobsFilter AWS API Documentation
1310
+ #
1311
+ class SearchJobsFilter < Struct.new(
1312
+ :name,
1313
+ :operator,
1314
+ :values)
1315
+ SENSITIVE = []
1316
+ include Aws::Structure
1317
+ end
1318
+
1319
+ # @note When making an API call, you may pass SearchJobsRequest
1320
+ # data as a hash:
1321
+ #
1322
+ # {
1323
+ # filters: [ # required
1324
+ # {
1325
+ # name: "String64", # required
1326
+ # operator: "LT", # required, accepts LT, LTE, EQUAL, GT, GTE, BETWEEN, CONTAINS
1327
+ # values: ["String256"], # required
1328
+ # },
1329
+ # ],
1330
+ # max_results: 1,
1331
+ # next_token: "String",
1332
+ # }
1333
+ #
1334
+ # @!attribute [rw] filters
1335
+ # The filter values to use when searching for a job.
1336
+ # @return [Array<Types::SearchJobsFilter>]
1337
+ #
1338
+ # @!attribute [rw] max_results
1339
+ # The maximum number of results to return in the response.
1340
+ # @return [Integer]
1341
+ #
1342
+ # @!attribute [rw] next_token
1343
+ # A token used for pagination of results returned in the response. Use
1344
+ # the token returned from the previous request to continue results
1345
+ # where the previous request ended.
1346
+ # @return [String]
1347
+ #
1348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchJobsRequest AWS API Documentation
1349
+ #
1350
+ class SearchJobsRequest < Struct.new(
1351
+ :filters,
1352
+ :max_results,
1353
+ :next_token)
1354
+ SENSITIVE = []
1355
+ include Aws::Structure
1356
+ end
1357
+
1358
+ # @!attribute [rw] jobs
1359
+ # An array of `JobSummary` objects for devices that match the
1360
+ # specified filter values.
1361
+ # @return [Array<Types::JobSummary>]
1362
+ #
1363
+ # @!attribute [rw] next_token
1364
+ # A token used for pagination of results, or `null` if there are no
1365
+ # additional results. Use the token value in a subsequent request to
1366
+ # continue results where the previous request ended.
1367
+ # @return [String]
1368
+ #
1369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchJobsResponse AWS API Documentation
1370
+ #
1371
+ class SearchJobsResponse < Struct.new(
1372
+ :jobs,
1373
+ :next_token)
1374
+ SENSITIVE = []
1375
+ include Aws::Structure
1376
+ end
1377
+
558
1378
  # A filter to use to search for tasks.
559
1379
  #
560
1380
  # @note When making an API call, you may pass SearchQuantumTasksFilter