Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Braket.GetDevice

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data GetDevice = GetDevice' {
- deviceArn :: Text
}
newGetDevice :: Text -> GetDevice
getDevice_deviceArn :: Lens' GetDevice Text
data GetDeviceResponse = GetDeviceResponse' {
- httpStatus :: Int
- deviceArn :: Text
- deviceCapabilities :: Text
- deviceName :: Text
- deviceStatus :: DeviceStatus
- deviceType :: DeviceType
- providerName :: Text
}
newGetDeviceResponse :: Int -> Text -> Text -> Text -> DeviceStatus -> DeviceType -> Text -> GetDeviceResponse
getDeviceResponse_httpStatus :: Lens' GetDeviceResponse Int
getDeviceResponse_deviceArn :: Lens' GetDeviceResponse Text
getDeviceResponse_deviceCapabilities :: Lens' GetDeviceResponse Text
getDeviceResponse_deviceName :: Lens' GetDeviceResponse Text
getDeviceResponse_deviceStatus :: Lens' GetDeviceResponse DeviceStatus
getDeviceResponse_deviceType :: Lens' GetDeviceResponse DeviceType
getDeviceResponse_providerName :: Lens' GetDeviceResponse Text

Creating a Request

data GetDevice Source #

See: newGetDevice smart constructor.

Constructors

GetDevice'
Fields deviceArn :: Text The ARN of the device to retrieve.

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 Methods toPath :: GetDevice -> ByteString #
ToQuery GetDevice Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods toQuery :: GetDevice -> QueryString #
AWSRequest GetDevice Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods readsPrec :: Int -> ReadS GetDevice # readList :: ReadS [GetDevice] # readPrec :: ReadPrec GetDevice # readListPrec :: ReadPrec [GetDevice] #
Show GetDevice Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods showsPrec :: Int -> GetDevice -> ShowS # show :: GetDevice -> String # showList :: [GetDevice] -> ShowS #
NFData GetDevice Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods rnf :: GetDevice -> () #
Eq GetDevice Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods (==) :: GetDevice -> GetDevice -> Bool # (/=) :: GetDevice -> GetDevice -> Bool #
Hashable GetDevice Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods hashWithSalt :: Int -> GetDevice -> Int # hash :: GetDevice -> Int #
type AWSResponse GetDevice Source #
Instance details Defined in Amazonka.Braket.GetDevice type AWSResponse GetDevice = GetDeviceResponse
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 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

Instances details

Generic GetDeviceResponse Source #
Instance details 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 Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods readsPrec :: Int -> ReadS GetDeviceResponse # readList :: ReadS [GetDeviceResponse] # readPrec :: ReadPrec GetDeviceResponse # readListPrec :: ReadPrec [GetDeviceResponse] #
Show GetDeviceResponse Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods showsPrec :: Int -> GetDeviceResponse -> ShowS # show :: GetDeviceResponse -> String # showList :: [GetDeviceResponse] -> ShowS #
NFData GetDeviceResponse Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods rnf :: GetDeviceResponse -> () #
Eq GetDeviceResponse Source #
Instance details Defined in Amazonka.Braket.GetDevice Methods (==) :: GetDeviceResponse -> GetDeviceResponse -> Bool # (/=) :: GetDeviceResponse -> GetDeviceResponse -> Bool #
type Rep GetDeviceResponse Source #
Instance details 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 Source #

Arguments

:: Int	`$sel:httpStatus:GetDeviceResponse'`
-> Text	`GetDevice`
-> Text	`$sel:deviceCapabilities:GetDeviceResponse'`
-> Text	`GetDeviceResponse`
-> DeviceStatus	`GetDeviceResponse`
-> DeviceType	`GetDeviceResponse`
-> Text	`GetDeviceResponse`
-> GetDeviceResponse