Amazonka.Braket.GetDevice

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.

Creating a Request

data GetDevice

See: newGetDevice smart constructor.

Constructors

GetDevice'

Fields

• deviceArn :: Text

  The ARN of the device to retrieve.

Instances

ToHeaders GetDevice

Defined in Amazonka.Braket.GetDevice

Methods

toHeaders :: GetDevice -> [Header]

ToPath GetDevice

Defined in Amazonka.Braket.GetDevice

Methods

toPath :: GetDevice -> ByteString

ToQuery GetDevice

Defined in Amazonka.Braket.GetDevice

Methods

toQuery :: GetDevice -> QueryString

AWSRequest GetDevice

Defined in Amazonka.Braket.GetDevice

Associated Types

type AWSResponse GetDevice

Methods

request :: (Service -> Service) -> GetDevice -> Request GetDevice

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDevice -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDevice)))

Generic GetDevice

Defined in Amazonka.Braket.GetDevice

Associated Types

type Rep GetDevice :: Type -> Type

Methods

from :: GetDevice -> Rep GetDevice x

to :: Rep GetDevice x -> GetDevice

Read GetDevice

Defined in Amazonka.Braket.GetDevice

Methods

readsPrec :: Int -> ReadS GetDevice

readList :: ReadS [GetDevice]

readPrec :: ReadPrec GetDevice

readListPrec :: ReadPrec [GetDevice]

Show GetDevice

Defined in Amazonka.Braket.GetDevice

Methods

showsPrec :: Int -> GetDevice -> ShowS

show :: GetDevice -> String

showList :: [GetDevice] -> ShowS

NFData GetDevice

Defined in Amazonka.Braket.GetDevice

Methods

rnf :: GetDevice -> ()

Eq GetDevice

Defined in Amazonka.Braket.GetDevice

Methods

(==) :: GetDevice -> GetDevice -> Bool

(/=) :: GetDevice -> GetDevice -> Bool

Hashable GetDevice

Defined in Amazonka.Braket.GetDevice

Methods

hashWithSalt :: Int -> GetDevice -> Int

hash :: GetDevice -> Int

type AWSResponse GetDevice

Defined in Amazonka.Braket.GetDevice

type AWSResponse GetDevice = GetDeviceResponse

type Rep GetDevice

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

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

The ARN of the device to retrieve.

Destructuring the Response

data GetDeviceResponse

See: newGetDeviceResponse smart constructor.

Constructors

GetDeviceResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• deviceArn :: Text

  The ARN of the device.

• deviceCapabilities :: Text

  Details about the capabilities of the device.

• deviceName :: Text

  The name of the device.

• deviceStatus :: DeviceStatus

  The status of the device.

• deviceType :: DeviceType

  The type of the device.

• providerName :: Text

  The name of the partner company for the device.

Instances

Generic GetDeviceResponse

Defined in Amazonka.Braket.GetDevice

Associated Types

type Rep GetDeviceResponse :: Type -> Type

Methods

from :: GetDeviceResponse -> Rep GetDeviceResponse x

to :: Rep GetDeviceResponse x -> GetDeviceResponse

Read GetDeviceResponse

Defined in Amazonka.Braket.GetDevice

Methods

readsPrec :: Int -> ReadS GetDeviceResponse

readList :: ReadS [GetDeviceResponse]

readPrec :: ReadPrec GetDeviceResponse

readListPrec :: ReadPrec [GetDeviceResponse]

Show GetDeviceResponse

Defined in Amazonka.Braket.GetDevice

Methods

showsPrec :: Int -> GetDeviceResponse -> ShowS

show :: GetDeviceResponse -> String

showList :: [GetDeviceResponse] -> ShowS

NFData GetDeviceResponse

Defined in Amazonka.Braket.GetDevice

Methods

rnf :: GetDeviceResponse -> ()

Eq GetDeviceResponse

Defined in Amazonka.Braket.GetDevice

Methods

(==) :: GetDeviceResponse -> GetDeviceResponse -> Bool

(/=) :: GetDeviceResponse -> GetDeviceResponse -> Bool

type Rep GetDeviceResponse

Defined in Amazonka.Braket.GetDevice

type Rep GetDeviceResponse = D1 ('MetaData "GetDeviceResponse" "Amazonka.Braket.GetDevice" "amazonka-braket-2.0-K4GTd9RbB3VBh6Qg8rMHaZ" 'False) (C1 ('MetaCons "GetDeviceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "deviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deviceCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "deviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deviceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceStatus)) :*: (S1 ('MetaSel ('Just "deviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceType) :*: S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetDeviceResponse

Arguments

:: Int

$sel:httpStatus:GetDeviceResponse'

-> Text

GetDevice

-> Text

$sel:deviceCapabilities:GetDeviceResponse'

-> Text

GetDeviceResponse

-> DeviceStatus

GetDeviceResponse

-> DeviceType

GetDeviceResponse

-> Text

GetDeviceResponse

-> GetDeviceResponse

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

The response's http status code.

getDeviceResponse_deviceArn :: Lens' GetDeviceResponse Text

The ARN of the device.

getDeviceResponse_deviceCapabilities :: Lens' GetDeviceResponse Text

Details about the capabilities of the device.

getDeviceResponse_deviceName :: Lens' GetDeviceResponse Text

The name of the device.

getDeviceResponse_deviceStatus :: Lens' GetDeviceResponse DeviceStatus

The status of the device.

getDeviceResponse_deviceType :: Lens' GetDeviceResponse DeviceType

The type of the device.

getDeviceResponse_providerName :: Lens' GetDeviceResponse Text

The name of the partner company for the device.