Class: Aws::Braket::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Braket::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-braket/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
476 477 478 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 476 def initialize(*args) super end |
Instance Method Details
#cancel_job(params = {}) ⇒ Types::CancelJobResponse
Cancels an Amazon Braket job.
507 508 509 510 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 507 def cancel_job(params = {}, = {}) req = build_request(:cancel_job, params) req.send_request() end |
#cancel_quantum_task(params = {}) ⇒ Types::CancelQuantumTaskResponse
Cancels the specified task.
544 545 546 547 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 544 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.
679 680 681 682 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 679 def create_job(params = {}, = {}) req = build_request(:create_job, params) req.send_request() end |
#create_quantum_task(params = {}) ⇒ Types::CreateQuantumTaskResponse
Creates a quantum task.
763 764 765 766 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 763 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.
818 819 820 821 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 818 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.
909 910 911 912 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 909 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.
973 974 975 976 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 973 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.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1002 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.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1054 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.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1112 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.
1170 1171 1172 1173 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1170 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.
1199 1200 1201 1202 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1199 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove tags from a resource.
1226 1227 1228 1229 |
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb', line 1226 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |