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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-braket/client.rb +321 -3
- data/lib/aws-sdk-braket/client_api.rb +247 -2
- data/lib/aws-sdk-braket/types.rb +820 -0
- data/lib/aws-sdk-braket.rb +2 -2
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 000d201bcb0f95dbb7624eb39632fc3b4bfce1531fe0ba124e13ceee3f01c67e
|
4
|
+
data.tar.gz: 4934e35f1ea8d2cb6b7ab3b8f758d43af642f0cf02489d58b93e99fc363500e2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: aeb80fa9c8f4242f5026f6373652b66aa6abcf160623a4a20a5878a568be9eecd7e1384777e24b30797b4bd73582c2f3e783a5ec8fc3c7cd284bfd987dfd8434
|
7
|
+
data.tar.gz: 93b5a1333461457d6b7c257e4c11cf7929e77621175557615ae1c6890f2662f8f3c7379ed2d3ad25d93be706a10b013f767600df8a97590eead57cf5b5bcc561
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.16.0 (2021-12-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.15.0 (2021-11-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.14.0 (2021-11-22)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - This release adds support for Amazon Braket Hybrid Jobs.
|
18
|
+
|
19
|
+
1.13.0 (2021-11-04)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.12.0 (2021-10-18)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.16.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::Braket
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::Braket
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::Braket
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -275,6 +283,15 @@ module Aws::Braket
|
|
275
283
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
284
|
# requests are made, and retries are disabled.
|
277
285
|
#
|
286
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
287
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
288
|
+
# will be used if available.
|
289
|
+
#
|
290
|
+
# @option options [Boolean] :use_fips_endpoint
|
291
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
292
|
+
# When a `fips` region is used, the region is normalized and this config
|
293
|
+
# is set to `true`.
|
294
|
+
#
|
278
295
|
# @option options [Boolean] :validate_params (true)
|
279
296
|
# When `true`, request parameters are validated before
|
280
297
|
# sending the request.
|
@@ -286,7 +303,7 @@ module Aws::Braket
|
|
286
303
|
# seconds to wait when opening a HTTP session before raising a
|
287
304
|
# `Timeout::Error`.
|
288
305
|
#
|
289
|
-
# @option options [
|
306
|
+
# @option options [Float] :http_read_timeout (60) The default
|
290
307
|
# number of seconds to wait for response data. This value can
|
291
308
|
# safely be set per-request on the session.
|
292
309
|
#
|
@@ -302,6 +319,9 @@ module Aws::Braket
|
|
302
319
|
# disables this behaviour. This value can safely be set per
|
303
320
|
# request on the session.
|
304
321
|
#
|
322
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
323
|
+
# in seconds.
|
324
|
+
#
|
305
325
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
306
326
|
# HTTP debug output will be sent to the `:logger`.
|
307
327
|
#
|
@@ -327,6 +347,36 @@ module Aws::Braket
|
|
327
347
|
|
328
348
|
# @!group API Operations
|
329
349
|
|
350
|
+
# Cancels an Amazon Braket job.
|
351
|
+
#
|
352
|
+
# @option params [required, String] :job_arn
|
353
|
+
# The ARN of the Amazon Braket job to cancel.
|
354
|
+
#
|
355
|
+
# @return [Types::CancelJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
356
|
+
#
|
357
|
+
# * {Types::CancelJobResponse#cancellation_status #cancellation_status} => String
|
358
|
+
# * {Types::CancelJobResponse#job_arn #job_arn} => String
|
359
|
+
#
|
360
|
+
# @example Request syntax with placeholder values
|
361
|
+
#
|
362
|
+
# resp = client.cancel_job({
|
363
|
+
# job_arn: "JobArn", # required
|
364
|
+
# })
|
365
|
+
#
|
366
|
+
# @example Response structure
|
367
|
+
#
|
368
|
+
# resp.cancellation_status #=> String, one of "CANCELLING", "CANCELLED"
|
369
|
+
# resp.job_arn #=> String
|
370
|
+
#
|
371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelJob AWS API Documentation
|
372
|
+
#
|
373
|
+
# @overload cancel_job(params = {})
|
374
|
+
# @param [Hash] params ({})
|
375
|
+
def cancel_job(params = {}, options = {})
|
376
|
+
req = build_request(:cancel_job, params)
|
377
|
+
req.send_request(options)
|
378
|
+
end
|
379
|
+
|
330
380
|
# Cancels the specified task.
|
331
381
|
#
|
332
382
|
# @option params [required, String] :client_token
|
@@ -364,6 +414,131 @@ module Aws::Braket
|
|
364
414
|
req.send_request(options)
|
365
415
|
end
|
366
416
|
|
417
|
+
# Creates an Amazon Braket job.
|
418
|
+
#
|
419
|
+
# @option params [required, Types::AlgorithmSpecification] :algorithm_specification
|
420
|
+
# Definition of the Amazon Braket job to be created. Specifies the
|
421
|
+
# container image the job uses and information about the Python scripts
|
422
|
+
# used for entry and training.
|
423
|
+
#
|
424
|
+
# @option params [Types::JobCheckpointConfig] :checkpoint_config
|
425
|
+
# Information about the output locations for job checkpoint data.
|
426
|
+
#
|
427
|
+
# @option params [required, String] :client_token
|
428
|
+
# A unique token that guarantees that the call to this API is
|
429
|
+
# idempotent.
|
430
|
+
#
|
431
|
+
# **A suitable default value is auto-generated.** You should normally
|
432
|
+
# not need to pass this option.**
|
433
|
+
#
|
434
|
+
# @option params [required, Types::DeviceConfig] :device_config
|
435
|
+
# The quantum processing unit (QPU) or simulator used to create an
|
436
|
+
# Amazon Braket job.
|
437
|
+
#
|
438
|
+
# @option params [Hash<String,String>] :hyper_parameters
|
439
|
+
# Algorithm-specific parameters used by an Amazon Braket job that
|
440
|
+
# influence the quality of the training job. The values are set with a
|
441
|
+
# string of JSON key:value pairs, where the key is the name of the
|
442
|
+
# hyperparameter and the value is the value of th hyperparameter.
|
443
|
+
#
|
444
|
+
# @option params [Array<Types::InputFileConfig>] :input_data_config
|
445
|
+
# A list of parameters that specify the name and type of input data and
|
446
|
+
# where it is located.
|
447
|
+
#
|
448
|
+
# @option params [required, Types::InstanceConfig] :instance_config
|
449
|
+
# Configuration of the resource instances to use while running the
|
450
|
+
# hybrid job on Amazon Braket.
|
451
|
+
#
|
452
|
+
# @option params [required, String] :job_name
|
453
|
+
# The name of the Amazon Braket job.
|
454
|
+
#
|
455
|
+
# @option params [required, Types::JobOutputDataConfig] :output_data_config
|
456
|
+
# The path to the S3 location where you want to store job artifacts and
|
457
|
+
# the encryption key used to store them.
|
458
|
+
#
|
459
|
+
# @option params [required, String] :role_arn
|
460
|
+
# The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can
|
461
|
+
# assume to perform tasks on behalf of a user. It can access user
|
462
|
+
# resources, run an Amazon Braket job container on behalf of user, and
|
463
|
+
# output resources to the users' s3 buckets.
|
464
|
+
#
|
465
|
+
# @option params [Types::JobStoppingCondition] :stopping_condition
|
466
|
+
# The user-defined criteria that specifies when a job stops running.
|
467
|
+
#
|
468
|
+
# @option params [Hash<String,String>] :tags
|
469
|
+
# A tag object that consists of a key and an optional value, used to
|
470
|
+
# manage metadata for Amazon Braket resources.
|
471
|
+
#
|
472
|
+
# @return [Types::CreateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
473
|
+
#
|
474
|
+
# * {Types::CreateJobResponse#job_arn #job_arn} => String
|
475
|
+
#
|
476
|
+
# @example Request syntax with placeholder values
|
477
|
+
#
|
478
|
+
# resp = client.create_job({
|
479
|
+
# algorithm_specification: { # required
|
480
|
+
# container_image: {
|
481
|
+
# uri: "Uri", # required
|
482
|
+
# },
|
483
|
+
# script_mode_config: {
|
484
|
+
# compression_type: "NONE", # accepts NONE, GZIP
|
485
|
+
# entry_point: "String", # required
|
486
|
+
# s3_uri: "S3Path", # required
|
487
|
+
# },
|
488
|
+
# },
|
489
|
+
# checkpoint_config: {
|
490
|
+
# local_path: "String4096",
|
491
|
+
# s3_uri: "S3Path", # required
|
492
|
+
# },
|
493
|
+
# client_token: "String64", # required
|
494
|
+
# device_config: { # required
|
495
|
+
# device: "String256", # required
|
496
|
+
# },
|
497
|
+
# hyper_parameters: {
|
498
|
+
# "String256" => "HyperParametersValueString",
|
499
|
+
# },
|
500
|
+
# input_data_config: [
|
501
|
+
# {
|
502
|
+
# channel_name: "InputFileConfigChannelNameString", # required
|
503
|
+
# content_type: "String256",
|
504
|
+
# data_source: { # required
|
505
|
+
# s3_data_source: { # required
|
506
|
+
# s3_uri: "S3Path", # required
|
507
|
+
# },
|
508
|
+
# },
|
509
|
+
# },
|
510
|
+
# ],
|
511
|
+
# instance_config: { # required
|
512
|
+
# 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
|
513
|
+
# volume_size_in_gb: 1, # required
|
514
|
+
# },
|
515
|
+
# job_name: "CreateJobRequestJobNameString", # required
|
516
|
+
# output_data_config: { # required
|
517
|
+
# kms_key_id: "String2048",
|
518
|
+
# s3_path: "S3Path", # required
|
519
|
+
# },
|
520
|
+
# role_arn: "RoleArn", # required
|
521
|
+
# stopping_condition: {
|
522
|
+
# max_runtime_in_seconds: 1,
|
523
|
+
# },
|
524
|
+
# tags: {
|
525
|
+
# "String" => "String",
|
526
|
+
# },
|
527
|
+
# })
|
528
|
+
#
|
529
|
+
# @example Response structure
|
530
|
+
#
|
531
|
+
# resp.job_arn #=> String
|
532
|
+
#
|
533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateJob AWS API Documentation
|
534
|
+
#
|
535
|
+
# @overload create_job(params = {})
|
536
|
+
# @param [Hash] params ({})
|
537
|
+
def create_job(params = {}, options = {})
|
538
|
+
req = build_request(:create_job, params)
|
539
|
+
req.send_request(options)
|
540
|
+
end
|
541
|
+
|
367
542
|
# Creates a quantum task.
|
368
543
|
#
|
369
544
|
# @option params [required, String] :action
|
@@ -389,6 +564,10 @@ module Aws::Braket
|
|
389
564
|
# when the required value (Hash, Array, etc.) is provided according to
|
390
565
|
# the description.**
|
391
566
|
#
|
567
|
+
# @option params [String] :job_token
|
568
|
+
# The token for an Amazon Braket job that associates it with the quantum
|
569
|
+
# task.
|
570
|
+
#
|
392
571
|
# @option params [required, String] :output_s3_bucket
|
393
572
|
# The S3 bucket to store task result files in.
|
394
573
|
#
|
@@ -413,6 +592,7 @@ module Aws::Braket
|
|
413
592
|
# client_token: "String64", # required
|
414
593
|
# device_arn: "DeviceArn", # required
|
415
594
|
# device_parameters: "CreateQuantumTaskRequestDeviceParametersString",
|
595
|
+
# job_token: "JobToken",
|
416
596
|
# output_s3_bucket: "CreateQuantumTaskRequestOutputS3BucketString", # required
|
417
597
|
# output_s3_key_prefix: "CreateQuantumTaskRequestOutputS3KeyPrefixString", # required
|
418
598
|
# shots: 1, # required
|
@@ -472,6 +652,84 @@ module Aws::Braket
|
|
472
652
|
req.send_request(options)
|
473
653
|
end
|
474
654
|
|
655
|
+
# Retrieves the specified Amazon Braket job.
|
656
|
+
#
|
657
|
+
# @option params [required, String] :job_arn
|
658
|
+
# The ARN of the job to retrieve.
|
659
|
+
#
|
660
|
+
# @return [Types::GetJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
661
|
+
#
|
662
|
+
# * {Types::GetJobResponse#algorithm_specification #algorithm_specification} => Types::AlgorithmSpecification
|
663
|
+
# * {Types::GetJobResponse#billable_duration #billable_duration} => Integer
|
664
|
+
# * {Types::GetJobResponse#checkpoint_config #checkpoint_config} => Types::JobCheckpointConfig
|
665
|
+
# * {Types::GetJobResponse#created_at #created_at} => Time
|
666
|
+
# * {Types::GetJobResponse#device_config #device_config} => Types::DeviceConfig
|
667
|
+
# * {Types::GetJobResponse#ended_at #ended_at} => Time
|
668
|
+
# * {Types::GetJobResponse#events #events} => Array<Types::JobEventDetails>
|
669
|
+
# * {Types::GetJobResponse#failure_reason #failure_reason} => String
|
670
|
+
# * {Types::GetJobResponse#hyper_parameters #hyper_parameters} => Hash<String,String>
|
671
|
+
# * {Types::GetJobResponse#input_data_config #input_data_config} => Array<Types::InputFileConfig>
|
672
|
+
# * {Types::GetJobResponse#instance_config #instance_config} => Types::InstanceConfig
|
673
|
+
# * {Types::GetJobResponse#job_arn #job_arn} => String
|
674
|
+
# * {Types::GetJobResponse#job_name #job_name} => String
|
675
|
+
# * {Types::GetJobResponse#output_data_config #output_data_config} => Types::JobOutputDataConfig
|
676
|
+
# * {Types::GetJobResponse#role_arn #role_arn} => String
|
677
|
+
# * {Types::GetJobResponse#started_at #started_at} => Time
|
678
|
+
# * {Types::GetJobResponse#status #status} => String
|
679
|
+
# * {Types::GetJobResponse#stopping_condition #stopping_condition} => Types::JobStoppingCondition
|
680
|
+
# * {Types::GetJobResponse#tags #tags} => Hash<String,String>
|
681
|
+
#
|
682
|
+
# @example Request syntax with placeholder values
|
683
|
+
#
|
684
|
+
# resp = client.get_job({
|
685
|
+
# job_arn: "JobArn", # required
|
686
|
+
# })
|
687
|
+
#
|
688
|
+
# @example Response structure
|
689
|
+
#
|
690
|
+
# resp.algorithm_specification.container_image.uri #=> String
|
691
|
+
# resp.algorithm_specification.script_mode_config.compression_type #=> String, one of "NONE", "GZIP"
|
692
|
+
# resp.algorithm_specification.script_mode_config.entry_point #=> String
|
693
|
+
# resp.algorithm_specification.script_mode_config.s3_uri #=> String
|
694
|
+
# resp.billable_duration #=> Integer
|
695
|
+
# resp.checkpoint_config.local_path #=> String
|
696
|
+
# resp.checkpoint_config.s3_uri #=> String
|
697
|
+
# resp.created_at #=> Time
|
698
|
+
# resp.device_config.device #=> String
|
699
|
+
# resp.ended_at #=> Time
|
700
|
+
# resp.events #=> Array
|
701
|
+
# resp.events[0].event_type #=> String, one of "WAITING_FOR_PRIORITY", "QUEUED_FOR_EXECUTION", "STARTING_INSTANCE", "DOWNLOADING_DATA", "RUNNING", "DEPRIORITIZED_DUE_TO_INACTIVITY", "UPLOADING_RESULTS", "COMPLETED", "FAILED", "MAX_RUNTIME_EXCEEDED", "CANCELLED"
|
702
|
+
# resp.events[0].message #=> String
|
703
|
+
# resp.events[0].time_of_event #=> Time
|
704
|
+
# resp.failure_reason #=> String
|
705
|
+
# resp.hyper_parameters #=> Hash
|
706
|
+
# resp.hyper_parameters["String256"] #=> String
|
707
|
+
# resp.input_data_config #=> Array
|
708
|
+
# resp.input_data_config[0].channel_name #=> String
|
709
|
+
# resp.input_data_config[0].content_type #=> String
|
710
|
+
# resp.input_data_config[0].data_source.s3_data_source.s3_uri #=> String
|
711
|
+
# resp.instance_config.instance_type #=> String, one of "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"
|
712
|
+
# resp.instance_config.volume_size_in_gb #=> Integer
|
713
|
+
# resp.job_arn #=> String
|
714
|
+
# resp.job_name #=> String
|
715
|
+
# resp.output_data_config.kms_key_id #=> String
|
716
|
+
# resp.output_data_config.s3_path #=> String
|
717
|
+
# resp.role_arn #=> String
|
718
|
+
# resp.started_at #=> Time
|
719
|
+
# resp.status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
|
720
|
+
# resp.stopping_condition.max_runtime_in_seconds #=> Integer
|
721
|
+
# resp.tags #=> Hash
|
722
|
+
# resp.tags["String"] #=> String
|
723
|
+
#
|
724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetJob AWS API Documentation
|
725
|
+
#
|
726
|
+
# @overload get_job(params = {})
|
727
|
+
# @param [Hash] params ({})
|
728
|
+
def get_job(params = {}, options = {})
|
729
|
+
req = build_request(:get_job, params)
|
730
|
+
req.send_request(options)
|
731
|
+
end
|
732
|
+
|
475
733
|
# Retrieves the specified quantum task.
|
476
734
|
#
|
477
735
|
# @option params [required, String] :quantum_task_arn
|
@@ -484,6 +742,7 @@ module Aws::Braket
|
|
484
742
|
# * {Types::GetQuantumTaskResponse#device_parameters #device_parameters} => String
|
485
743
|
# * {Types::GetQuantumTaskResponse#ended_at #ended_at} => Time
|
486
744
|
# * {Types::GetQuantumTaskResponse#failure_reason #failure_reason} => String
|
745
|
+
# * {Types::GetQuantumTaskResponse#job_arn #job_arn} => String
|
487
746
|
# * {Types::GetQuantumTaskResponse#output_s3_bucket #output_s3_bucket} => String
|
488
747
|
# * {Types::GetQuantumTaskResponse#output_s3_directory #output_s3_directory} => String
|
489
748
|
# * {Types::GetQuantumTaskResponse#quantum_task_arn #quantum_task_arn} => String
|
@@ -504,6 +763,7 @@ module Aws::Braket
|
|
504
763
|
# resp.device_parameters #=> String
|
505
764
|
# resp.ended_at #=> Time
|
506
765
|
# resp.failure_reason #=> String
|
766
|
+
# resp.job_arn #=> String
|
507
767
|
# resp.output_s3_bucket #=> String
|
508
768
|
# resp.output_s3_directory #=> String
|
509
769
|
# resp.quantum_task_arn #=> String
|
@@ -602,6 +862,64 @@ module Aws::Braket
|
|
602
862
|
req.send_request(options)
|
603
863
|
end
|
604
864
|
|
865
|
+
# Searches for Amazon Braket jobs that match the specified filter
|
866
|
+
# values.
|
867
|
+
#
|
868
|
+
# @option params [required, Array<Types::SearchJobsFilter>] :filters
|
869
|
+
# The filter values to use when searching for a job.
|
870
|
+
#
|
871
|
+
# @option params [Integer] :max_results
|
872
|
+
# The maximum number of results to return in the response.
|
873
|
+
#
|
874
|
+
# @option params [String] :next_token
|
875
|
+
# A token used for pagination of results returned in the response. Use
|
876
|
+
# the token returned from the previous request to continue results where
|
877
|
+
# the previous request ended.
|
878
|
+
#
|
879
|
+
# @return [Types::SearchJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
880
|
+
#
|
881
|
+
# * {Types::SearchJobsResponse#jobs #jobs} => Array<Types::JobSummary>
|
882
|
+
# * {Types::SearchJobsResponse#next_token #next_token} => String
|
883
|
+
#
|
884
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
885
|
+
#
|
886
|
+
# @example Request syntax with placeholder values
|
887
|
+
#
|
888
|
+
# resp = client.search_jobs({
|
889
|
+
# filters: [ # required
|
890
|
+
# {
|
891
|
+
# name: "String64", # required
|
892
|
+
# operator: "LT", # required, accepts LT, LTE, EQUAL, GT, GTE, BETWEEN, CONTAINS
|
893
|
+
# values: ["String256"], # required
|
894
|
+
# },
|
895
|
+
# ],
|
896
|
+
# max_results: 1,
|
897
|
+
# next_token: "String",
|
898
|
+
# })
|
899
|
+
#
|
900
|
+
# @example Response structure
|
901
|
+
#
|
902
|
+
# resp.jobs #=> Array
|
903
|
+
# resp.jobs[0].created_at #=> Time
|
904
|
+
# resp.jobs[0].device #=> String
|
905
|
+
# resp.jobs[0].ended_at #=> Time
|
906
|
+
# resp.jobs[0].job_arn #=> String
|
907
|
+
# resp.jobs[0].job_name #=> String
|
908
|
+
# resp.jobs[0].started_at #=> Time
|
909
|
+
# resp.jobs[0].status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
|
910
|
+
# resp.jobs[0].tags #=> Hash
|
911
|
+
# resp.jobs[0].tags["String"] #=> String
|
912
|
+
# resp.next_token #=> String
|
913
|
+
#
|
914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchJobs AWS API Documentation
|
915
|
+
#
|
916
|
+
# @overload search_jobs(params = {})
|
917
|
+
# @param [Hash] params ({})
|
918
|
+
def search_jobs(params = {}, options = {})
|
919
|
+
req = build_request(:search_jobs, params)
|
920
|
+
req.send_request(options)
|
921
|
+
end
|
922
|
+
|
605
923
|
# Searches for tasks that match the specified filter values.
|
606
924
|
#
|
607
925
|
# @option params [required, Array<Types::SearchQuantumTasksFilter>] :filters
|
@@ -729,7 +1047,7 @@ module Aws::Braket
|
|
729
1047
|
params: params,
|
730
1048
|
config: config)
|
731
1049
|
context[:gem_name] = 'aws-sdk-braket'
|
732
|
-
context[:gem_version] = '1.
|
1050
|
+
context[:gem_version] = '1.16.0'
|
733
1051
|
Seahorse::Client::Request.new(handlers, context)
|
734
1052
|
end
|
735
1053
|
|