IAmazonBraket Interface | AWS SDK for .NET V3

Interface for accessing Braket

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

Additional Resources:

Amazon Braket Developer Guide

Inheritance Hierarchy

Amazon.Braket.IAmazonBraket

Namespace: Amazon.Braket
Assembly: AWSSDK.Braket.dll
Version: 3.x.y.z

Syntax

public interface IAmazonBraket
         IAmazonService, IDisposable

The IAmazonBraket type exposes the following members

Properties

	Name	Type	Description
	Paginators	Amazon.Braket.Model.IBraketPaginatorFactory	Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

	Name	Description
	CancelJob(CancelJobRequest)	Cancels an Amazon Braket job.
	CancelJobAsync(CancelJobRequest, CancellationToken)	Cancels an Amazon Braket job.
	CancelQuantumTask(CancelQuantumTaskRequest)	Cancels the specified task.
	CancelQuantumTaskAsync(CancelQuantumTaskRequest, CancellationToken)	Cancels the specified task.
	CreateJob(CreateJobRequest)	Creates an Amazon Braket job.
	CreateJobAsync(CreateJobRequest, CancellationToken)	Creates an Amazon Braket 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.
	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 job.
	GetJobAsync(GetJobRequest, CancellationToken)	Retrieves the specified Amazon Braket 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 jobs that match the specified filter values.
	SearchJobsAsync(SearchJobsRequest, CancellationToken)	Searches for Amazon Braket 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5