aws-sdk-braket 1.11.0 → 1.15.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 +311 -2
- 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: b805c64599e14d0144b1c3268dae92ab3b6a52cd451f849bcda68694bc26806b
|
4
|
+
data.tar.gz: ea5ca43272b0ad22cc199bf57c3fdcfb6870e00ec2b2c6787063ceb79439da35
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e07a261dc8d9dcfc0dbf60849528578ef08abc1cdfbf0bc39a115638cce364213cb445e3e041bd654a201e9848ab35f0aa6be85108c6a35f39b38a31a0c5a14a
|
7
|
+
data.tar.gz: 4dce14a71703ac7587584e046c573bc9e5726c00e114bb51b03ec9f649cb420551f073b0a5f27b1875f5b6bfc25ce9878b1148dde7c6ed291318c1db8efbbb21
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.15.0 (2021-11-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.14.0 (2021-11-22)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds support for Amazon Braket Hybrid Jobs.
|
13
|
+
|
14
|
+
1.13.0 (2021-11-04)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.12.0 (2021-10-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.11.0 (2021-09-01)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.15.0
|
@@ -119,7 +119,9 @@ module Aws::Braket
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -275,6 +277,15 @@ module Aws::Braket
|
|
275
277
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
278
|
# requests are made, and retries are disabled.
|
277
279
|
#
|
280
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
281
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
|
+
# will be used if available.
|
283
|
+
#
|
284
|
+
# @option options [Boolean] :use_fips_endpoint
|
285
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
286
|
+
# When a `fips` region is used, the region is normalized and this config
|
287
|
+
# is set to `true`.
|
288
|
+
#
|
278
289
|
# @option options [Boolean] :validate_params (true)
|
279
290
|
# When `true`, request parameters are validated before
|
280
291
|
# sending the request.
|
@@ -327,6 +338,36 @@ module Aws::Braket
|
|
327
338
|
|
328
339
|
# @!group API Operations
|
329
340
|
|
341
|
+
# Cancels an Amazon Braket job.
|
342
|
+
#
|
343
|
+
# @option params [required, String] :job_arn
|
344
|
+
# The ARN of the Amazon Braket job to cancel.
|
345
|
+
#
|
346
|
+
# @return [Types::CancelJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
347
|
+
#
|
348
|
+
# * {Types::CancelJobResponse#cancellation_status #cancellation_status} => String
|
349
|
+
# * {Types::CancelJobResponse#job_arn #job_arn} => String
|
350
|
+
#
|
351
|
+
# @example Request syntax with placeholder values
|
352
|
+
#
|
353
|
+
# resp = client.cancel_job({
|
354
|
+
# job_arn: "JobArn", # required
|
355
|
+
# })
|
356
|
+
#
|
357
|
+
# @example Response structure
|
358
|
+
#
|
359
|
+
# resp.cancellation_status #=> String, one of "CANCELLING", "CANCELLED"
|
360
|
+
# resp.job_arn #=> String
|
361
|
+
#
|
362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelJob AWS API Documentation
|
363
|
+
#
|
364
|
+
# @overload cancel_job(params = {})
|
365
|
+
# @param [Hash] params ({})
|
366
|
+
def cancel_job(params = {}, options = {})
|
367
|
+
req = build_request(:cancel_job, params)
|
368
|
+
req.send_request(options)
|
369
|
+
end
|
370
|
+
|
330
371
|
# Cancels the specified task.
|
331
372
|
#
|
332
373
|
# @option params [required, String] :client_token
|
@@ -364,6 +405,131 @@ module Aws::Braket
|
|
364
405
|
req.send_request(options)
|
365
406
|
end
|
366
407
|
|
408
|
+
# Creates an Amazon Braket job.
|
409
|
+
#
|
410
|
+
# @option params [required, Types::AlgorithmSpecification] :algorithm_specification
|
411
|
+
# Definition of the Amazon Braket job to be created. Specifies the
|
412
|
+
# container image the job uses and information about the Python scripts
|
413
|
+
# used for entry and training.
|
414
|
+
#
|
415
|
+
# @option params [Types::JobCheckpointConfig] :checkpoint_config
|
416
|
+
# Information about the output locations for job checkpoint data.
|
417
|
+
#
|
418
|
+
# @option params [required, String] :client_token
|
419
|
+
# A unique token that guarantees that the call to this API is
|
420
|
+
# idempotent.
|
421
|
+
#
|
422
|
+
# **A suitable default value is auto-generated.** You should normally
|
423
|
+
# not need to pass this option.**
|
424
|
+
#
|
425
|
+
# @option params [required, Types::DeviceConfig] :device_config
|
426
|
+
# The quantum processing unit (QPU) or simulator used to create an
|
427
|
+
# Amazon Braket job.
|
428
|
+
#
|
429
|
+
# @option params [Hash<String,String>] :hyper_parameters
|
430
|
+
# Algorithm-specific parameters used by an Amazon Braket job that
|
431
|
+
# influence the quality of the training job. The values are set with a
|
432
|
+
# string of JSON key:value pairs, where the key is the name of the
|
433
|
+
# hyperparameter and the value is the value of th hyperparameter.
|
434
|
+
#
|
435
|
+
# @option params [Array<Types::InputFileConfig>] :input_data_config
|
436
|
+
# A list of parameters that specify the name and type of input data and
|
437
|
+
# where it is located.
|
438
|
+
#
|
439
|
+
# @option params [required, Types::InstanceConfig] :instance_config
|
440
|
+
# Configuration of the resource instances to use while running the
|
441
|
+
# hybrid job on Amazon Braket.
|
442
|
+
#
|
443
|
+
# @option params [required, String] :job_name
|
444
|
+
# The name of the Amazon Braket job.
|
445
|
+
#
|
446
|
+
# @option params [required, Types::JobOutputDataConfig] :output_data_config
|
447
|
+
# The path to the S3 location where you want to store job artifacts and
|
448
|
+
# the encryption key used to store them.
|
449
|
+
#
|
450
|
+
# @option params [required, String] :role_arn
|
451
|
+
# The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can
|
452
|
+
# assume to perform tasks on behalf of a user. It can access user
|
453
|
+
# resources, run an Amazon Braket job container on behalf of user, and
|
454
|
+
# output resources to the users' s3 buckets.
|
455
|
+
#
|
456
|
+
# @option params [Types::JobStoppingCondition] :stopping_condition
|
457
|
+
# The user-defined criteria that specifies when a job stops running.
|
458
|
+
#
|
459
|
+
# @option params [Hash<String,String>] :tags
|
460
|
+
# A tag object that consists of a key and an optional value, used to
|
461
|
+
# manage metadata for Amazon Braket resources.
|
462
|
+
#
|
463
|
+
# @return [Types::CreateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
464
|
+
#
|
465
|
+
# * {Types::CreateJobResponse#job_arn #job_arn} => String
|
466
|
+
#
|
467
|
+
# @example Request syntax with placeholder values
|
468
|
+
#
|
469
|
+
# resp = client.create_job({
|
470
|
+
# algorithm_specification: { # required
|
471
|
+
# container_image: {
|
472
|
+
# uri: "Uri", # required
|
473
|
+
# },
|
474
|
+
# script_mode_config: {
|
475
|
+
# compression_type: "NONE", # accepts NONE, GZIP
|
476
|
+
# entry_point: "String", # required
|
477
|
+
# s3_uri: "S3Path", # required
|
478
|
+
# },
|
479
|
+
# },
|
480
|
+
# checkpoint_config: {
|
481
|
+
# local_path: "String4096",
|
482
|
+
# s3_uri: "S3Path", # required
|
483
|
+
# },
|
484
|
+
# client_token: "String64", # required
|
485
|
+
# device_config: { # required
|
486
|
+
# device: "String256", # required
|
487
|
+
# },
|
488
|
+
# hyper_parameters: {
|
489
|
+
# "String256" => "HyperParametersValueString",
|
490
|
+
# },
|
491
|
+
# input_data_config: [
|
492
|
+
# {
|
493
|
+
# channel_name: "InputFileConfigChannelNameString", # required
|
494
|
+
# content_type: "String256",
|
495
|
+
# data_source: { # required
|
496
|
+
# s3_data_source: { # required
|
497
|
+
# s3_uri: "S3Path", # required
|
498
|
+
# },
|
499
|
+
# },
|
500
|
+
# },
|
501
|
+
# ],
|
502
|
+
# instance_config: { # required
|
503
|
+
# 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
|
504
|
+
# volume_size_in_gb: 1, # required
|
505
|
+
# },
|
506
|
+
# job_name: "CreateJobRequestJobNameString", # required
|
507
|
+
# output_data_config: { # required
|
508
|
+
# kms_key_id: "String2048",
|
509
|
+
# s3_path: "S3Path", # required
|
510
|
+
# },
|
511
|
+
# role_arn: "RoleArn", # required
|
512
|
+
# stopping_condition: {
|
513
|
+
# max_runtime_in_seconds: 1,
|
514
|
+
# },
|
515
|
+
# tags: {
|
516
|
+
# "String" => "String",
|
517
|
+
# },
|
518
|
+
# })
|
519
|
+
#
|
520
|
+
# @example Response structure
|
521
|
+
#
|
522
|
+
# resp.job_arn #=> String
|
523
|
+
#
|
524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateJob AWS API Documentation
|
525
|
+
#
|
526
|
+
# @overload create_job(params = {})
|
527
|
+
# @param [Hash] params ({})
|
528
|
+
def create_job(params = {}, options = {})
|
529
|
+
req = build_request(:create_job, params)
|
530
|
+
req.send_request(options)
|
531
|
+
end
|
532
|
+
|
367
533
|
# Creates a quantum task.
|
368
534
|
#
|
369
535
|
# @option params [required, String] :action
|
@@ -389,6 +555,10 @@ module Aws::Braket
|
|
389
555
|
# when the required value (Hash, Array, etc.) is provided according to
|
390
556
|
# the description.**
|
391
557
|
#
|
558
|
+
# @option params [String] :job_token
|
559
|
+
# The token for an Amazon Braket job that associates it with the quantum
|
560
|
+
# task.
|
561
|
+
#
|
392
562
|
# @option params [required, String] :output_s3_bucket
|
393
563
|
# The S3 bucket to store task result files in.
|
394
564
|
#
|
@@ -413,6 +583,7 @@ module Aws::Braket
|
|
413
583
|
# client_token: "String64", # required
|
414
584
|
# device_arn: "DeviceArn", # required
|
415
585
|
# device_parameters: "CreateQuantumTaskRequestDeviceParametersString",
|
586
|
+
# job_token: "JobToken",
|
416
587
|
# output_s3_bucket: "CreateQuantumTaskRequestOutputS3BucketString", # required
|
417
588
|
# output_s3_key_prefix: "CreateQuantumTaskRequestOutputS3KeyPrefixString", # required
|
418
589
|
# shots: 1, # required
|
@@ -472,6 +643,84 @@ module Aws::Braket
|
|
472
643
|
req.send_request(options)
|
473
644
|
end
|
474
645
|
|
646
|
+
# Retrieves the specified Amazon Braket job.
|
647
|
+
#
|
648
|
+
# @option params [required, String] :job_arn
|
649
|
+
# The ARN of the job to retrieve.
|
650
|
+
#
|
651
|
+
# @return [Types::GetJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
652
|
+
#
|
653
|
+
# * {Types::GetJobResponse#algorithm_specification #algorithm_specification} => Types::AlgorithmSpecification
|
654
|
+
# * {Types::GetJobResponse#billable_duration #billable_duration} => Integer
|
655
|
+
# * {Types::GetJobResponse#checkpoint_config #checkpoint_config} => Types::JobCheckpointConfig
|
656
|
+
# * {Types::GetJobResponse#created_at #created_at} => Time
|
657
|
+
# * {Types::GetJobResponse#device_config #device_config} => Types::DeviceConfig
|
658
|
+
# * {Types::GetJobResponse#ended_at #ended_at} => Time
|
659
|
+
# * {Types::GetJobResponse#events #events} => Array<Types::JobEventDetails>
|
660
|
+
# * {Types::GetJobResponse#failure_reason #failure_reason} => String
|
661
|
+
# * {Types::GetJobResponse#hyper_parameters #hyper_parameters} => Hash<String,String>
|
662
|
+
# * {Types::GetJobResponse#input_data_config #input_data_config} => Array<Types::InputFileConfig>
|
663
|
+
# * {Types::GetJobResponse#instance_config #instance_config} => Types::InstanceConfig
|
664
|
+
# * {Types::GetJobResponse#job_arn #job_arn} => String
|
665
|
+
# * {Types::GetJobResponse#job_name #job_name} => String
|
666
|
+
# * {Types::GetJobResponse#output_data_config #output_data_config} => Types::JobOutputDataConfig
|
667
|
+
# * {Types::GetJobResponse#role_arn #role_arn} => String
|
668
|
+
# * {Types::GetJobResponse#started_at #started_at} => Time
|
669
|
+
# * {Types::GetJobResponse#status #status} => String
|
670
|
+
# * {Types::GetJobResponse#stopping_condition #stopping_condition} => Types::JobStoppingCondition
|
671
|
+
# * {Types::GetJobResponse#tags #tags} => Hash<String,String>
|
672
|
+
#
|
673
|
+
# @example Request syntax with placeholder values
|
674
|
+
#
|
675
|
+
# resp = client.get_job({
|
676
|
+
# job_arn: "JobArn", # required
|
677
|
+
# })
|
678
|
+
#
|
679
|
+
# @example Response structure
|
680
|
+
#
|
681
|
+
# resp.algorithm_specification.container_image.uri #=> String
|
682
|
+
# resp.algorithm_specification.script_mode_config.compression_type #=> String, one of "NONE", "GZIP"
|
683
|
+
# resp.algorithm_specification.script_mode_config.entry_point #=> String
|
684
|
+
# resp.algorithm_specification.script_mode_config.s3_uri #=> String
|
685
|
+
# resp.billable_duration #=> Integer
|
686
|
+
# resp.checkpoint_config.local_path #=> String
|
687
|
+
# resp.checkpoint_config.s3_uri #=> String
|
688
|
+
# resp.created_at #=> Time
|
689
|
+
# resp.device_config.device #=> String
|
690
|
+
# resp.ended_at #=> Time
|
691
|
+
# resp.events #=> Array
|
692
|
+
# 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"
|
693
|
+
# resp.events[0].message #=> String
|
694
|
+
# resp.events[0].time_of_event #=> Time
|
695
|
+
# resp.failure_reason #=> String
|
696
|
+
# resp.hyper_parameters #=> Hash
|
697
|
+
# resp.hyper_parameters["String256"] #=> String
|
698
|
+
# resp.input_data_config #=> Array
|
699
|
+
# resp.input_data_config[0].channel_name #=> String
|
700
|
+
# resp.input_data_config[0].content_type #=> String
|
701
|
+
# resp.input_data_config[0].data_source.s3_data_source.s3_uri #=> String
|
702
|
+
# 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"
|
703
|
+
# resp.instance_config.volume_size_in_gb #=> Integer
|
704
|
+
# resp.job_arn #=> String
|
705
|
+
# resp.job_name #=> String
|
706
|
+
# resp.output_data_config.kms_key_id #=> String
|
707
|
+
# resp.output_data_config.s3_path #=> String
|
708
|
+
# resp.role_arn #=> String
|
709
|
+
# resp.started_at #=> Time
|
710
|
+
# resp.status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
|
711
|
+
# resp.stopping_condition.max_runtime_in_seconds #=> Integer
|
712
|
+
# resp.tags #=> Hash
|
713
|
+
# resp.tags["String"] #=> String
|
714
|
+
#
|
715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetJob AWS API Documentation
|
716
|
+
#
|
717
|
+
# @overload get_job(params = {})
|
718
|
+
# @param [Hash] params ({})
|
719
|
+
def get_job(params = {}, options = {})
|
720
|
+
req = build_request(:get_job, params)
|
721
|
+
req.send_request(options)
|
722
|
+
end
|
723
|
+
|
475
724
|
# Retrieves the specified quantum task.
|
476
725
|
#
|
477
726
|
# @option params [required, String] :quantum_task_arn
|
@@ -484,6 +733,7 @@ module Aws::Braket
|
|
484
733
|
# * {Types::GetQuantumTaskResponse#device_parameters #device_parameters} => String
|
485
734
|
# * {Types::GetQuantumTaskResponse#ended_at #ended_at} => Time
|
486
735
|
# * {Types::GetQuantumTaskResponse#failure_reason #failure_reason} => String
|
736
|
+
# * {Types::GetQuantumTaskResponse#job_arn #job_arn} => String
|
487
737
|
# * {Types::GetQuantumTaskResponse#output_s3_bucket #output_s3_bucket} => String
|
488
738
|
# * {Types::GetQuantumTaskResponse#output_s3_directory #output_s3_directory} => String
|
489
739
|
# * {Types::GetQuantumTaskResponse#quantum_task_arn #quantum_task_arn} => String
|
@@ -504,6 +754,7 @@ module Aws::Braket
|
|
504
754
|
# resp.device_parameters #=> String
|
505
755
|
# resp.ended_at #=> Time
|
506
756
|
# resp.failure_reason #=> String
|
757
|
+
# resp.job_arn #=> String
|
507
758
|
# resp.output_s3_bucket #=> String
|
508
759
|
# resp.output_s3_directory #=> String
|
509
760
|
# resp.quantum_task_arn #=> String
|
@@ -602,6 +853,64 @@ module Aws::Braket
|
|
602
853
|
req.send_request(options)
|
603
854
|
end
|
604
855
|
|
856
|
+
# Searches for Amazon Braket jobs that match the specified filter
|
857
|
+
# values.
|
858
|
+
#
|
859
|
+
# @option params [required, Array<Types::SearchJobsFilter>] :filters
|
860
|
+
# The filter values to use when searching for a job.
|
861
|
+
#
|
862
|
+
# @option params [Integer] :max_results
|
863
|
+
# The maximum number of results to return in the response.
|
864
|
+
#
|
865
|
+
# @option params [String] :next_token
|
866
|
+
# A token used for pagination of results returned in the response. Use
|
867
|
+
# the token returned from the previous request to continue results where
|
868
|
+
# the previous request ended.
|
869
|
+
#
|
870
|
+
# @return [Types::SearchJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
871
|
+
#
|
872
|
+
# * {Types::SearchJobsResponse#jobs #jobs} => Array<Types::JobSummary>
|
873
|
+
# * {Types::SearchJobsResponse#next_token #next_token} => String
|
874
|
+
#
|
875
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
876
|
+
#
|
877
|
+
# @example Request syntax with placeholder values
|
878
|
+
#
|
879
|
+
# resp = client.search_jobs({
|
880
|
+
# filters: [ # required
|
881
|
+
# {
|
882
|
+
# name: "String64", # required
|
883
|
+
# operator: "LT", # required, accepts LT, LTE, EQUAL, GT, GTE, BETWEEN, CONTAINS
|
884
|
+
# values: ["String256"], # required
|
885
|
+
# },
|
886
|
+
# ],
|
887
|
+
# max_results: 1,
|
888
|
+
# next_token: "String",
|
889
|
+
# })
|
890
|
+
#
|
891
|
+
# @example Response structure
|
892
|
+
#
|
893
|
+
# resp.jobs #=> Array
|
894
|
+
# resp.jobs[0].created_at #=> Time
|
895
|
+
# resp.jobs[0].device #=> String
|
896
|
+
# resp.jobs[0].ended_at #=> Time
|
897
|
+
# resp.jobs[0].job_arn #=> String
|
898
|
+
# resp.jobs[0].job_name #=> String
|
899
|
+
# resp.jobs[0].started_at #=> Time
|
900
|
+
# resp.jobs[0].status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
|
901
|
+
# resp.jobs[0].tags #=> Hash
|
902
|
+
# resp.jobs[0].tags["String"] #=> String
|
903
|
+
# resp.next_token #=> String
|
904
|
+
#
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchJobs AWS API Documentation
|
906
|
+
#
|
907
|
+
# @overload search_jobs(params = {})
|
908
|
+
# @param [Hash] params ({})
|
909
|
+
def search_jobs(params = {}, options = {})
|
910
|
+
req = build_request(:search_jobs, params)
|
911
|
+
req.send_request(options)
|
912
|
+
end
|
913
|
+
|
605
914
|
# Searches for tasks that match the specified filter values.
|
606
915
|
#
|
607
916
|
# @option params [required, Array<Types::SearchQuantumTasksFilter>] :filters
|
@@ -729,7 +1038,7 @@ module Aws::Braket
|
|
729
1038
|
params: params,
|
730
1039
|
config: config)
|
731
1040
|
context[:gem_name] = 'aws-sdk-braket'
|
732
|
-
context[:gem_version] = '1.
|
1041
|
+
context[:gem_version] = '1.15.0'
|
733
1042
|
Seahorse::Client::Request.new(handlers, context)
|
734
1043
|
end
|
735
1044
|
|