AlexaForBusiness / Client / register_avs_device

register_avs_device

AlexaForBusiness.Client.register_avs_device(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.register_avs_device(
    ClientId='string',
    UserCode='string',
    ProductId='string',
    DeviceSerialNumber='string',
    AmazonId='string',
    RoomArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• ClientId (string) –

  [REQUIRED]

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

• UserCode (string) –

  [REQUIRED]

  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 (string) –

  [REQUIRED]

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

• DeviceSerialNumber (string) – The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

• AmazonId (string) –

  [REQUIRED]

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

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

• Tags (list) –

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

  • (dict) –

    A key-value pair that can be associated with a resource.

    • Key (string) – [REQUIRED]

      The key of a tag. Tag keys are case-sensitive.

    • Value (string) – [REQUIRED]

      The value of a tag. Tag values are case sensitive and can be null.

Return type:

dict

Returns:

Response Syntax

{
    'DeviceArn': 'string'
}

Response Structure

• (dict) –

  • DeviceArn (string) –

    The ARN of the device.

Exceptions

• AlexaForBusiness.Client.exceptions.LimitExceededException

• AlexaForBusiness.Client.exceptions.ConcurrentModificationException

• AlexaForBusiness.Client.exceptions.NotFoundException

• AlexaForBusiness.Client.exceptions.InvalidDeviceException