Class: Aws::Braket::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Braket::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-braket/client.rb
Overview
An API client for Braket. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Braket::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#cancel_job(params = {}) ⇒ Types::CancelJobResponse
Cancels an Amazon Braket job.
-
#cancel_quantum_task(params = {}) ⇒ Types::CancelQuantumTaskResponse
Cancels the specified task.
-
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates an Amazon Braket job.
-
#create_quantum_task(params = {}) ⇒ Types::CreateQuantumTaskResponse
Creates a quantum task.
-
#get_device(params = {}) ⇒ Types::GetDeviceResponse
Retrieves the devices available in Amazon Braket.
-
#get_job(params = {}) ⇒ Types::GetJobResponse
Retrieves the specified Amazon Braket job.
-
#get_quantum_task(params = {}) ⇒ Types::GetQuantumTaskResponse
Retrieves the specified quantum task.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Shows the tags associated with this resource.
-
#search_devices(params = {}) ⇒ Types::SearchDevicesResponse
Searches for devices using the specified filters.
-
#search_jobs(params = {}) ⇒ Types::SearchJobsResponse
Searches for Amazon Braket jobs that match the specified filter values.
-
#search_quantum_tasks(params = {}) ⇒ Types::SearchQuantumTasksResponse
Searches for tasks that match the specified filter values.
-
#tag_resource(params = {}) ⇒ Struct
Add a tag to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Remove tags from a resource.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'lib/aws-sdk-braket/client.rb', line 410 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1191 1192 1193 |
# File 'lib/aws-sdk-braket/client.rb', line 1191 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1194 1195 1196 |
# File 'lib/aws-sdk-braket/client.rb', line 1194 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 |
# File 'lib/aws-sdk-braket/client.rb', line 1169 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-braket' context[:gem_version] = '1.36.0' Seahorse::Client::Request.new(handlers, context) end |
#cancel_job(params = {}) ⇒ Types::CancelJobResponse
Cancels an Amazon Braket job.
441 442 443 444 |
# File 'lib/aws-sdk-braket/client.rb', line 441 def cancel_job(params = {}, = {}) req = build_request(:cancel_job, params) req.send_request() end |
#cancel_quantum_task(params = {}) ⇒ Types::CancelQuantumTaskResponse
Cancels the specified task.
478 479 480 481 |
# File 'lib/aws-sdk-braket/client.rb', line 478 def cancel_quantum_task(params = {}, = {}) req = build_request(:cancel_quantum_task, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates an Amazon Braket job.
613 614 615 616 |
# File 'lib/aws-sdk-braket/client.rb', line 613 def create_job(params = {}, = {}) req = build_request(:create_job, params) req.send_request() end |
#create_quantum_task(params = {}) ⇒ Types::CreateQuantumTaskResponse
Creates a quantum task.
697 698 699 700 |
# File 'lib/aws-sdk-braket/client.rb', line 697 def create_quantum_task(params = {}, = {}) req = build_request(:create_quantum_task, params) req.send_request() end |
#get_device(params = {}) ⇒ Types::GetDeviceResponse
Retrieves the devices available in Amazon Braket.
<note markdown=“1”> For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.
</note>
752 753 754 755 |
# File 'lib/aws-sdk-braket/client.rb', line 752 def get_device(params = {}, = {}) req = build_request(:get_device, params) req.send_request() end |
#get_job(params = {}) ⇒ Types::GetJobResponse
Retrieves the specified Amazon Braket job.
843 844 845 846 |
# File 'lib/aws-sdk-braket/client.rb', line 843 def get_job(params = {}, = {}) req = build_request(:get_job, params) req.send_request() end |
#get_quantum_task(params = {}) ⇒ Types::GetQuantumTaskResponse
Retrieves the specified quantum task.
907 908 909 910 |
# File 'lib/aws-sdk-braket/client.rb', line 907 def get_quantum_task(params = {}, = {}) req = build_request(:get_quantum_task, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Shows the tags associated with this resource.
936 937 938 939 |
# File 'lib/aws-sdk-braket/client.rb', line 936 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#search_devices(params = {}) ⇒ Types::SearchDevicesResponse
Searches for devices using the specified filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
988 989 990 991 |
# File 'lib/aws-sdk-braket/client.rb', line 988 def search_devices(params = {}, = {}) req = build_request(:search_devices, params) req.send_request() end |
#search_jobs(params = {}) ⇒ Types::SearchJobsResponse
Searches for Amazon Braket jobs that match the specified filter values.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1046 1047 1048 1049 |
# File 'lib/aws-sdk-braket/client.rb', line 1046 def search_jobs(params = {}, = {}) req = build_request(:search_jobs, params) req.send_request() end |
#search_quantum_tasks(params = {}) ⇒ Types::SearchQuantumTasksResponse
Searches for tasks that match the specified filter values.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1104 1105 1106 1107 |
# File 'lib/aws-sdk-braket/client.rb', line 1104 def search_quantum_tasks(params = {}, = {}) req = build_request(:search_quantum_tasks, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Add a tag to the specified resource.
1133 1134 1135 1136 |
# File 'lib/aws-sdk-braket/client.rb', line 1133 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove tags from a resource.
1160 1161 1162 1163 |
# File 'lib/aws-sdk-braket/client.rb', line 1160 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1184 1185 1186 |
# File 'lib/aws-sdk-braket/client.rb', line 1184 def waiter_names [] end |