AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetDevice and EndGetDevice.

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

Syntax

C#
public virtual Task<GetDeviceResponse> GetDeviceAsync(
         GetDeviceRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Braket.Model.GetDeviceRequest

Container for the necessary parameters to execute the GetDevice service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the GetDevice service method, as returned by Braket.

Exceptions

ExceptionCondition
AccessDeniedException You do not have sufficient access to perform this action.
InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException The specified resource was not found.
ThrottlingException The throttling rate limit is met.
ValidationException The input fails to satisfy the constraints specified by an AWS service.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also