aws-sdk-braket 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '049818fa4f74da1acbb7ed24b5a7a60c316d3e1a218ee74b4a941c8a5a941fa3'
-  data.tar.gz: 8a0b6b086a0369aae048a0b61f0a2d8818b4a402321c9c4c16140f803358d534
+  metadata.gz: 800ffd346cd3ef47fa5950b43368a81c8c8f70da301df99e6b20d1fbd5009a9e
+  data.tar.gz: 401e021c9bdb4099fcc14f07b43f13a7f3d41e61a06e5d7d7e56552b52c7373f
 SHA512:
-  metadata.gz: 22e87a736ddc9d698a0b63b59c927c8a3f129cab42ad79b75a5488c48eea12fb1e58eb4ad89c6d4375ef596780adb5dc15f03cb1c38454a74f74c4e1691527e7
-  data.tar.gz: 41c8319b410094f74bbc66cd5d0afaec3892912aea2ef2c10046462b9a48ca4e4f8f63d15fc4374b1f3bf6a4318b65f8902468ab275ea42ae322c5092fcd619d
+  metadata.gz: c7c966f729b290d6f9dda54254aec12006800331715876ed1e446f995063b859b5926115295335c3a4e91ab454edacc0418170b662453d6a9f1a857849d78311
+  data.tar.gz: 3950af3d3e9aef731519a3663d1d4eb425410ac339944cf02a3d5e2db3bcfa7352417856dfe7ead9d77e93607923750cfaa06076c50a0ded31cfd5dadc3e403e

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.14.0 (2021-11-22)
+------------------
+
+* Feature - This release adds support for Amazon Braket Hybrid Jobs.
+
 1.13.0 (2021-11-04)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.13.0
+1.14.0

data/lib/aws-sdk-braket/client.rb

@@ -336,6 +336,36 @@ module Aws::Braket
 
     # @!group API Operations
 
+    # Cancels an Amazon Braket job.
+    #
+    # @option params [required, String] :job_arn
+    #   The ARN of the Amazon Braket job to cancel.
+    #
+    # @return [Types::CancelJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CancelJobResponse#cancellation_status #cancellation_status} => String
+    #   * {Types::CancelJobResponse#job_arn #job_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.cancel_job({
+    #     job_arn: "JobArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.cancellation_status #=> String, one of "CANCELLING", "CANCELLED"
+    #   resp.job_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CancelJob AWS API Documentation
+    #
+    # @overload cancel_job(params = {})
+    # @param [Hash] params ({})
+    def cancel_job(params = {}, options = {})
+      req = build_request(:cancel_job, params)
+      req.send_request(options)
+    end
+
     # Cancels the specified task.
     #
     # @option params [required, String] :client_token
@@ -373,6 +403,131 @@ module Aws::Braket
       req.send_request(options)
     end
 
+    # Creates an Amazon Braket job.
+    #
+    # @option params [required, Types::AlgorithmSpecification] :algorithm_specification
+    #   Definition of the Amazon Braket job to be created. Specifies the
+    #   container image the job uses and information about the Python scripts
+    #   used for entry and training.
+    #
+    # @option params [Types::JobCheckpointConfig] :checkpoint_config
+    #   Information about the output locations for job checkpoint data.
+    #
+    # @option params [required, String] :client_token
+    #   A unique token that guarantees that the call to this API is
+    #   idempotent.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @option params [required, Types::DeviceConfig] :device_config
+    #   The quantum processing unit (QPU) or simulator used to create an
+    #   Amazon Braket job.
+    #
+    # @option params [Hash<String,String>] :hyper_parameters
+    #   Algorithm-specific parameters used by an Amazon Braket job that
+    #   influence the quality of the training job. The values are set with a
+    #   string of JSON key:value pairs, where the key is the name of the
+    #   hyperparameter and the value is the value of th hyperparameter.
+    #
+    # @option params [Array<Types::InputFileConfig>] :input_data_config
+    #   A list of parameters that specify the name and type of input data and
+    #   where it is located.
+    #
+    # @option params [required, Types::InstanceConfig] :instance_config
+    #   Configuration of the resource instances to use while running the
+    #   hybrid job on Amazon Braket.
+    #
+    # @option params [required, String] :job_name
+    #   The name of the Amazon Braket job.
+    #
+    # @option params [required, Types::JobOutputDataConfig] :output_data_config
+    #   The path to the S3 location where you want to store job artifacts and
+    #   the encryption key used to store them.
+    #
+    # @option params [required, String] :role_arn
+    #   The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can
+    #   assume to perform tasks on behalf of a user. It can access user
+    #   resources, run an Amazon Braket job container on behalf of user, and
+    #   output resources to the users' s3 buckets.
+    #
+    # @option params [Types::JobStoppingCondition] :stopping_condition
+    #   The user-defined criteria that specifies when a job stops running.
+    #
+    # @option params [Hash<String,String>] :tags
+    #   A tag object that consists of a key and an optional value, used to
+    #   manage metadata for Amazon Braket resources.
+    #
+    # @return [Types::CreateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateJobResponse#job_arn #job_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_job({
+    #     algorithm_specification: { # required
+    #       container_image: {
+    #         uri: "Uri", # required
+    #       },
+    #       script_mode_config: {
+    #         compression_type: "NONE", # accepts NONE, GZIP
+    #         entry_point: "String", # required
+    #         s3_uri: "S3Path", # required
+    #       },
+    #     },
+    #     checkpoint_config: {
+    #       local_path: "String4096",
+    #       s3_uri: "S3Path", # required
+    #     },
+    #     client_token: "String64", # required
+    #     device_config: { # required
+    #       device: "String256", # required
+    #     },
+    #     hyper_parameters: {
+    #       "String256" => "HyperParametersValueString",
+    #     },
+    #     input_data_config: [
+    #       {
+    #         channel_name: "InputFileConfigChannelNameString", # required
+    #         content_type: "String256",
+    #         data_source: { # required
+    #           s3_data_source: { # required
+    #             s3_uri: "S3Path", # required
+    #           },
+    #         },
+    #       },
+    #     ],
+    #     instance_config: { # required
+    #       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
+    #       volume_size_in_gb: 1, # required
+    #     },
+    #     job_name: "CreateJobRequestJobNameString", # required
+    #     output_data_config: { # required
+    #       kms_key_id: "String2048",
+    #       s3_path: "S3Path", # required
+    #     },
+    #     role_arn: "RoleArn", # required
+    #     stopping_condition: {
+    #       max_runtime_in_seconds: 1,
+    #     },
+    #     tags: {
+    #       "String" => "String",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.job_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateJob AWS API Documentation
+    #
+    # @overload create_job(params = {})
+    # @param [Hash] params ({})
+    def create_job(params = {}, options = {})
+      req = build_request(:create_job, params)
+      req.send_request(options)
+    end
+
     # Creates a quantum task.
     #
     # @option params [required, String] :action
@@ -398,6 +553,10 @@ module Aws::Braket
     #   when the required value (Hash, Array, etc.) is provided according to
     #   the description.**
     #
+    # @option params [String] :job_token
+    #   The token for an Amazon Braket job that associates it with the quantum
+    #   task.
+    #
     # @option params [required, String] :output_s3_bucket
     #   The S3 bucket to store task result files in.
     #
@@ -422,6 +581,7 @@ module Aws::Braket
     #     client_token: "String64", # required
     #     device_arn: "DeviceArn", # required
     #     device_parameters: "CreateQuantumTaskRequestDeviceParametersString",
+    #     job_token: "JobToken",
     #     output_s3_bucket: "CreateQuantumTaskRequestOutputS3BucketString", # required
     #     output_s3_key_prefix: "CreateQuantumTaskRequestOutputS3KeyPrefixString", # required
     #     shots: 1, # required
@@ -481,6 +641,84 @@ module Aws::Braket
       req.send_request(options)
     end
 
+    # Retrieves the specified Amazon Braket job.
+    #
+    # @option params [required, String] :job_arn
+    #   The ARN of the job to retrieve.
+    #
+    # @return [Types::GetJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetJobResponse#algorithm_specification #algorithm_specification} => Types::AlgorithmSpecification
+    #   * {Types::GetJobResponse#billable_duration #billable_duration} => Integer
+    #   * {Types::GetJobResponse#checkpoint_config #checkpoint_config} => Types::JobCheckpointConfig
+    #   * {Types::GetJobResponse#created_at #created_at} => Time
+    #   * {Types::GetJobResponse#device_config #device_config} => Types::DeviceConfig
+    #   * {Types::GetJobResponse#ended_at #ended_at} => Time
+    #   * {Types::GetJobResponse#events #events} => Array&lt;Types::JobEventDetails&gt;
+    #   * {Types::GetJobResponse#failure_reason #failure_reason} => String
+    #   * {Types::GetJobResponse#hyper_parameters #hyper_parameters} => Hash&lt;String,String&gt;
+    #   * {Types::GetJobResponse#input_data_config #input_data_config} => Array&lt;Types::InputFileConfig&gt;
+    #   * {Types::GetJobResponse#instance_config #instance_config} => Types::InstanceConfig
+    #   * {Types::GetJobResponse#job_arn #job_arn} => String
+    #   * {Types::GetJobResponse#job_name #job_name} => String
+    #   * {Types::GetJobResponse#output_data_config #output_data_config} => Types::JobOutputDataConfig
+    #   * {Types::GetJobResponse#role_arn #role_arn} => String
+    #   * {Types::GetJobResponse#started_at #started_at} => Time
+    #   * {Types::GetJobResponse#status #status} => String
+    #   * {Types::GetJobResponse#stopping_condition #stopping_condition} => Types::JobStoppingCondition
+    #   * {Types::GetJobResponse#tags #tags} => Hash&lt;String,String&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_job({
+    #     job_arn: "JobArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.algorithm_specification.container_image.uri #=> String
+    #   resp.algorithm_specification.script_mode_config.compression_type #=> String, one of "NONE", "GZIP"
+    #   resp.algorithm_specification.script_mode_config.entry_point #=> String
+    #   resp.algorithm_specification.script_mode_config.s3_uri #=> String
+    #   resp.billable_duration #=> Integer
+    #   resp.checkpoint_config.local_path #=> String
+    #   resp.checkpoint_config.s3_uri #=> String
+    #   resp.created_at #=> Time
+    #   resp.device_config.device #=> String
+    #   resp.ended_at #=> Time
+    #   resp.events #=> Array
+    #   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"
+    #   resp.events[0].message #=> String
+    #   resp.events[0].time_of_event #=> Time
+    #   resp.failure_reason #=> String
+    #   resp.hyper_parameters #=> Hash
+    #   resp.hyper_parameters["String256"] #=> String
+    #   resp.input_data_config #=> Array
+    #   resp.input_data_config[0].channel_name #=> String
+    #   resp.input_data_config[0].content_type #=> String
+    #   resp.input_data_config[0].data_source.s3_data_source.s3_uri #=> String
+    #   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"
+    #   resp.instance_config.volume_size_in_gb #=> Integer
+    #   resp.job_arn #=> String
+    #   resp.job_name #=> String
+    #   resp.output_data_config.kms_key_id #=> String
+    #   resp.output_data_config.s3_path #=> String
+    #   resp.role_arn #=> String
+    #   resp.started_at #=> Time
+    #   resp.status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
+    #   resp.stopping_condition.max_runtime_in_seconds #=> Integer
+    #   resp.tags #=> Hash
+    #   resp.tags["String"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/GetJob AWS API Documentation
+    #
+    # @overload get_job(params = {})
+    # @param [Hash] params ({})
+    def get_job(params = {}, options = {})
+      req = build_request(:get_job, params)
+      req.send_request(options)
+    end
+
     # Retrieves the specified quantum task.
     #
     # @option params [required, String] :quantum_task_arn
@@ -493,6 +731,7 @@ module Aws::Braket
     #   * {Types::GetQuantumTaskResponse#device_parameters #device_parameters} => String
     #   * {Types::GetQuantumTaskResponse#ended_at #ended_at} => Time
     #   * {Types::GetQuantumTaskResponse#failure_reason #failure_reason} => String
+    #   * {Types::GetQuantumTaskResponse#job_arn #job_arn} => String
     #   * {Types::GetQuantumTaskResponse#output_s3_bucket #output_s3_bucket} => String
     #   * {Types::GetQuantumTaskResponse#output_s3_directory #output_s3_directory} => String
     #   * {Types::GetQuantumTaskResponse#quantum_task_arn #quantum_task_arn} => String
@@ -513,6 +752,7 @@ module Aws::Braket
     #   resp.device_parameters #=> String
     #   resp.ended_at #=> Time
     #   resp.failure_reason #=> String
+    #   resp.job_arn #=> String
     #   resp.output_s3_bucket #=> String
     #   resp.output_s3_directory #=> String
     #   resp.quantum_task_arn #=> String
@@ -611,6 +851,64 @@ module Aws::Braket
       req.send_request(options)
     end
 
+    # Searches for Amazon Braket jobs that match the specified filter
+    # values.
+    #
+    # @option params [required, Array<Types::SearchJobsFilter>] :filters
+    #   The filter values to use when searching for a job.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return in the response.
+    #
+    # @option params [String] :next_token
+    #   A token used for pagination of results returned in the response. Use
+    #   the token returned from the previous request to continue results where
+    #   the previous request ended.
+    #
+    # @return [Types::SearchJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::SearchJobsResponse#jobs #jobs} => Array&lt;Types::JobSummary&gt;
+    #   * {Types::SearchJobsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.search_jobs({
+    #     filters: [ # required
+    #       {
+    #         name: "String64", # required
+    #         operator: "LT", # required, accepts LT, LTE, EQUAL, GT, GTE, BETWEEN, CONTAINS
+    #         values: ["String256"], # required
+    #       },
+    #     ],
+    #     max_results: 1,
+    #     next_token: "String",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.jobs #=> Array
+    #   resp.jobs[0].created_at #=> Time
+    #   resp.jobs[0].device #=> String
+    #   resp.jobs[0].ended_at #=> Time
+    #   resp.jobs[0].job_arn #=> String
+    #   resp.jobs[0].job_name #=> String
+    #   resp.jobs[0].started_at #=> Time
+    #   resp.jobs[0].status #=> String, one of "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
+    #   resp.jobs[0].tags #=> Hash
+    #   resp.jobs[0].tags["String"] #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchJobs AWS API Documentation
+    #
+    # @overload search_jobs(params = {})
+    # @param [Hash] params ({})
+    def search_jobs(params = {}, options = {})
+      req = build_request(:search_jobs, params)
+      req.send_request(options)
+    end
+
     # Searches for tasks that match the specified filter values.
     #
     # @option params [required, Array<Types::SearchQuantumTasksFilter>] :filters
@@ -738,7 +1036,7 @@ module Aws::Braket
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-braket'
-      context[:gem_version] = '1.13.0'
+      context[:gem_version] = '1.14.0'
       Seahorse::Client::Request.new(handlers, context)
     end