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 |
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
Synopsis
- data RegisterAVSDevice = RegisterAVSDevice' {}
- newRegisterAVSDevice :: Text -> Text -> Text -> Text -> RegisterAVSDevice
- registerAVSDevice_deviceSerialNumber :: Lens' RegisterAVSDevice (Maybe Text)
- registerAVSDevice_roomArn :: Lens' RegisterAVSDevice (Maybe Text)
- registerAVSDevice_tags :: Lens' RegisterAVSDevice (Maybe [Tag])
- registerAVSDevice_clientId :: Lens' RegisterAVSDevice Text
- registerAVSDevice_userCode :: Lens' RegisterAVSDevice Text
- registerAVSDevice_productId :: Lens' RegisterAVSDevice Text
- registerAVSDevice_amazonId :: Lens' RegisterAVSDevice Text
- data RegisterAVSDeviceResponse = RegisterAVSDeviceResponse' {
- deviceArn :: Maybe Text
- httpStatus :: Int
- newRegisterAVSDeviceResponse :: Int -> RegisterAVSDeviceResponse
- registerAVSDeviceResponse_deviceArn :: Lens' RegisterAVSDeviceResponse (Maybe Text)
- registerAVSDeviceResponse_httpStatus :: Lens' RegisterAVSDeviceResponse Int
Creating a Request
data RegisterAVSDevice Source #
See: newRegisterAVSDevice
smart constructor.
RegisterAVSDevice' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> RegisterAVSDevice |
Create a value of RegisterAVSDevice
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:
RegisterAVSDevice
, registerAVSDevice_deviceSerialNumber
- The key generated by the OEM that uniquely identifies a specified
instance of your AVS device.
RegisterAVSDevice
, registerAVSDevice_roomArn
- The Amazon Resource Name (ARN) of the room with which to associate your
AVS device.
$sel:tags:RegisterAVSDevice'
, registerAVSDevice_tags
- The tags to be added to the specified resource. Do not provide system
tags.
$sel:clientId:RegisterAVSDevice'
, registerAVSDevice_clientId
- The client ID of the OEM used for code-based linking authorization on an
AVS device.
$sel:userCode:RegisterAVSDevice'
, registerAVSDevice_userCode
- The code that is obtained after your AVS device has made a POST request
to LWA as a part of the Device Authorization Request component of the
OAuth code-based linking specification.
$sel:productId:RegisterAVSDevice'
, registerAVSDevice_productId
- The product ID used to identify your AVS device during authorization.
$sel:amazonId:RegisterAVSDevice'
, registerAVSDevice_amazonId
- The device type ID for your AVS device generated by Amazon when the OEM
creates a new product on Amazon's Developer Console.
Request Lenses
registerAVSDevice_deviceSerialNumber :: Lens' RegisterAVSDevice (Maybe Text) Source #
The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
registerAVSDevice_roomArn :: Lens' RegisterAVSDevice (Maybe Text) Source #
The Amazon Resource Name (ARN) of the room with which to associate your AVS device.
registerAVSDevice_tags :: Lens' RegisterAVSDevice (Maybe [Tag]) Source #
The tags to be added to the specified resource. Do not provide system tags.
registerAVSDevice_clientId :: Lens' RegisterAVSDevice Text Source #
The client ID of the OEM used for code-based linking authorization on an AVS device.
registerAVSDevice_userCode :: Lens' RegisterAVSDevice Text Source #
The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.
registerAVSDevice_productId :: Lens' RegisterAVSDevice Text Source #
The product ID used to identify your AVS device during authorization.
registerAVSDevice_amazonId :: Lens' RegisterAVSDevice Text Source #
The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
Destructuring the Response
data RegisterAVSDeviceResponse Source #
See: newRegisterAVSDeviceResponse
smart constructor.
RegisterAVSDeviceResponse' | |
|
Instances
newRegisterAVSDeviceResponse Source #
Create a value of RegisterAVSDeviceResponse
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:
RegisterAVSDeviceResponse
, registerAVSDeviceResponse_deviceArn
- The ARN of the device.
$sel:httpStatus:RegisterAVSDeviceResponse'
, registerAVSDeviceResponse_httpStatus
- The response's http status code.
Response Lenses
registerAVSDeviceResponse_deviceArn :: Lens' RegisterAVSDeviceResponse (Maybe Text) Source #
The ARN of the device.
registerAVSDeviceResponse_httpStatus :: Lens' RegisterAVSDeviceResponse Int Source #
The response's http status code.