amazonka-braket-2.0: Amazon Braket SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Braket.GetDevice

Description

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.

Synopsis

Creating a Request

data GetDevice Source #

See: newGetDevice smart constructor.

Constructors

GetDevice' 

Fields

Instances

Instances details
ToHeaders GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

Methods

toHeaders :: GetDevice -> [Header] #

ToPath GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

ToQuery GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

AWSRequest GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

Associated Types

type AWSResponse GetDevice #

Generic GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

Associated Types

type Rep GetDevice :: Type -> Type #

Read GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

Show GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

NFData GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

Methods

rnf :: GetDevice -> () #

Eq GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

Hashable GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

type AWSResponse GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

type Rep GetDevice Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

type Rep GetDevice = D1 ('MetaData "GetDevice" "Amazonka.Braket.GetDevice" "amazonka-braket-2.0-K4GTd9RbB3VBh6Qg8rMHaZ" 'False) (C1 ('MetaCons "GetDevice'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDevice Source #

Arguments

:: Text

GetDevice

-> GetDevice 

Create a value of GetDevice with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDevice, getDevice_deviceArn - The ARN of the device to retrieve.

Request Lenses

getDevice_deviceArn :: Lens' GetDevice Text Source #

The ARN of the device to retrieve.

Destructuring the Response

data GetDeviceResponse Source #

See: newGetDeviceResponse smart constructor.

Constructors

GetDeviceResponse' 

Fields

Instances

Instances details
Generic GetDeviceResponse Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

Associated Types

type Rep GetDeviceResponse :: Type -> Type #

Read GetDeviceResponse Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

Show GetDeviceResponse Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

NFData GetDeviceResponse Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

Methods

rnf :: GetDeviceResponse -> () #

Eq GetDeviceResponse Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

type Rep GetDeviceResponse Source # 
Instance details

Defined in Amazonka.Braket.GetDevice

newGetDeviceResponse Source #

Create a value of GetDeviceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:GetDeviceResponse', getDeviceResponse_httpStatus - The response's http status code.

GetDevice, getDeviceResponse_deviceArn - The ARN of the device.

$sel:deviceCapabilities:GetDeviceResponse', getDeviceResponse_deviceCapabilities - Details about the capabilities of the device.

GetDeviceResponse, getDeviceResponse_deviceName - The name of the device.

GetDeviceResponse, getDeviceResponse_deviceStatus - The status of the device.

GetDeviceResponse, getDeviceResponse_deviceType - The type of the device.

GetDeviceResponse, getDeviceResponse_providerName - The name of the partner company for the device.

Response Lenses

getDeviceResponse_httpStatus :: Lens' GetDeviceResponse Int Source #

The response's http status code.

getDeviceResponse_deviceCapabilities :: Lens' GetDeviceResponse Text Source #

Details about the capabilities of the device.

getDeviceResponse_providerName :: Lens' GetDeviceResponse Text Source #

The name of the partner company for the device.