libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AlexaBusiness.RegisterAVSDevice

Description

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

Synopsis

Creating a Request

data RegisterAVSDevice Source #

See: newRegisterAVSDevice smart constructor.

Constructors

RegisterAVSDevice' 

Fields

  • roomArn :: Maybe Text

    The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

  • deviceSerialNumber :: Maybe Text

    The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

  • tags :: Maybe [Tag]

    The tags to be added to the specified resource. Do not provide system tags.

  • clientId :: Text

    The client ID of the OEM used for code-based linking authorization on an AVS device.

  • userCode :: Text

    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.

  • productId :: Text

    The product ID used to identify your AVS device during authorization.

  • amazonId :: Text

    The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

Instances

Instances details
Eq RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Read RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Show RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Generic RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Associated Types

type Rep RegisterAVSDevice :: Type -> Type #

NFData RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Methods

rnf :: RegisterAVSDevice -> () #

Hashable RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

ToJSON RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

AWSRequest RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Associated Types

type AWSResponse RegisterAVSDevice #

ToHeaders RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

ToPath RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

ToQuery RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

type Rep RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

type Rep RegisterAVSDevice = D1 ('MetaData "RegisterAVSDevice" "Amazonka.AlexaBusiness.RegisterAVSDevice" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "RegisterAVSDevice'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "roomArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deviceSerialNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "productId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "amazonId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse RegisterAVSDevice Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

newRegisterAVSDevice Source #

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:

$sel:roomArn:RegisterAVSDevice', registerAVSDevice_roomArn - The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

$sel:deviceSerialNumber:RegisterAVSDevice', registerAVSDevice_deviceSerialNumber - The key generated by the OEM that uniquely identifies a specified instance of 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_roomArn :: Lens' RegisterAVSDevice (Maybe Text) Source #

The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

registerAVSDevice_deviceSerialNumber :: Lens' RegisterAVSDevice (Maybe Text) Source #

The key generated by the OEM that uniquely identifies a specified instance of 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.

Constructors

RegisterAVSDeviceResponse' 

Fields

Instances

Instances details
Eq RegisterAVSDeviceResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Read RegisterAVSDeviceResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Show RegisterAVSDeviceResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Generic RegisterAVSDeviceResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

Associated Types

type Rep RegisterAVSDeviceResponse :: Type -> Type #

NFData RegisterAVSDeviceResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

type Rep RegisterAVSDeviceResponse Source # 
Instance details

Defined in Amazonka.AlexaBusiness.RegisterAVSDevice

type Rep RegisterAVSDeviceResponse = D1 ('MetaData "RegisterAVSDeviceResponse" "Amazonka.AlexaBusiness.RegisterAVSDevice" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "RegisterAVSDeviceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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:

$sel:deviceArn:RegisterAVSDeviceResponse', registerAVSDeviceResponse_deviceArn - The ARN of the device.

$sel:httpStatus:RegisterAVSDeviceResponse', registerAVSDeviceResponse_httpStatus - The response's http status code.

Response Lenses