Implementation for accessing Braket
The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.To learn about the permissions required to call an Amazon Braket API action, see Actions, resources, and condition keys for Amazon Braket. Amazon Braket Python SDK and the AWS Command Line Interface can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see What is Amazon Braket? and important terms and concepts in the Amazon Braket Developer Guide.
In this guide:
Available languages for AWS SDK:
Code examples from the Amazon Braket Tutorials GitHub repository:
Inheritance Hierarchy
Namespace: Amazon.Braket
Assembly: AWSSDK.Braket.dll
Version: 3.x.y.z
Syntax
public class AmazonBraketClient : AmazonServiceClient IAmazonBraket, IAmazonService, IDisposable
The AmazonBraketClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonBraketClient() |
Constructs AmazonBraketClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonBraketClient(RegionEndpoint) |
Constructs AmazonBraketClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonBraketClient(AmazonBraketConfig) |
Constructs AmazonBraketClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonBraketClient(AWSCredentials) |
Constructs AmazonBraketClient with AWS Credentials |
|
|
AmazonBraketClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonBraketClient with AWS Credentials |
|
|
AmazonBraketClient(AWSCredentials, AmazonBraketConfig) |
Constructs AmazonBraketClient with AWS Credentials and an AmazonBraketClient Configuration object. |
|
|
AmazonBraketClient(string, string) |
Constructs AmazonBraketClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonBraketClient(string, string, RegionEndpoint) |
Constructs AmazonBraketClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonBraketClient(string, string, AmazonBraketConfig) |
Constructs AmazonBraketClient with AWS Access Key ID, AWS Secret Key and an AmazonBraketClient Configuration object. |
|
|
AmazonBraketClient(string, string, string) |
Constructs AmazonBraketClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonBraketClient(string, string, string, RegionEndpoint) |
Constructs AmazonBraketClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonBraketClient(string, string, string, AmazonBraketConfig) |
Constructs AmazonBraketClient with AWS Access Key ID, AWS Secret Key and an AmazonBraketClient Configuration object. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
Paginators | Amazon.Braket.Model.IBraketPaginatorFactory |
Paginators for the service |
Methods
| Name | Description | |
|---|---|---|
|
|
CancelJob(CancelJobRequest) |
Cancels an Amazon Braket hybrid job. |
|
|
CancelJobAsync(CancelJobRequest, CancellationToken) |
Cancels an Amazon Braket hybrid job. |
|
|
CancelQuantumTask(CancelQuantumTaskRequest) |
Cancels the specified task. |
|
|
CancelQuantumTaskAsync(CancelQuantumTaskRequest, CancellationToken) |
Cancels the specified task. |
|
|
CreateJob(CreateJobRequest) |
Creates an Amazon Braket hybrid job. |
|
|
CreateJobAsync(CreateJobRequest, CancellationToken) |
Creates an Amazon Braket hybrid job. |
|
|
CreateQuantumTask(CreateQuantumTaskRequest) |
Creates a quantum task. |
|
|
CreateQuantumTaskAsync(CreateQuantumTaskRequest, CancellationToken) |
Creates a quantum task. |
|
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
GetDevice(GetDeviceRequest) |
Retrieves the devices available in Amazon Braket.
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.
|
|
|
GetDeviceAsync(GetDeviceRequest, CancellationToken) |
Retrieves the devices available in Amazon Braket.
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.
|
|
|
GetJob(GetJobRequest) |
Retrieves the specified Amazon Braket hybrid job. |
|
|
GetJobAsync(GetJobRequest, CancellationToken) |
Retrieves the specified Amazon Braket hybrid job. |
|
|
GetQuantumTask(GetQuantumTaskRequest) |
Retrieves the specified quantum task. |
|
|
GetQuantumTaskAsync(GetQuantumTaskRequest, CancellationToken) |
Retrieves the specified quantum task. |
|
|
ListTagsForResource(ListTagsForResourceRequest) |
Shows the tags associated with this resource. |
|
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Shows the tags associated with this resource. |
|
|
SearchDevices(SearchDevicesRequest) |
Searches for devices using the specified filters. |
|
|
SearchDevicesAsync(SearchDevicesRequest, CancellationToken) |
Searches for devices using the specified filters. |
|
|
SearchJobs(SearchJobsRequest) |
Searches for Amazon Braket hybrid jobs that match the specified filter values. |
|
|
SearchJobsAsync(SearchJobsRequest, CancellationToken) |
Searches for Amazon Braket hybrid jobs that match the specified filter values. |
|
|
SearchQuantumTasks(SearchQuantumTasksRequest) |
Searches for tasks that match the specified filter values. |
|
|
SearchQuantumTasksAsync(SearchQuantumTasksRequest, CancellationToken) |
Searches for tasks that match the specified filter values. |
|
|
TagResource(TagResourceRequest) |
Add a tag to the specified resource. |
|
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Add a tag to the specified resource. |
|
|
UntagResource(UntagResourceRequest) |
Remove tags from a resource. |
|
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Remove tags from a resource. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5