Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

RegisterAVSDevice

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

Request Syntax


{
   "AmazonId": "string",
   "ClientId": "string",
   "DeviceSerialNumber": "string",
   "ProductId": "string",
   "RoomArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "UserCode": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AmazonId

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

Type: String

Pattern: [a-zA-Z0-9]{1,18}

Required: Yes

ClientId

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

Type: String

Pattern: ^\S+{1,256}$

Required: Yes

DeviceSerialNumber

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

Type: String

Pattern: ^[a-zA-Z0-9]{1,50}$

Required: No

ProductId

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

Type: String

Pattern: ^[a-zA-Z0-9_]{1,256}$

Required: Yes

RoomArn

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

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

Tags

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

Type: Array of Tag objects

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Syntax


{
   "DeviceArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DeviceArn

The ARN of the device.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is a concurrent modification of resources.

HTTP Status Code: 400

InvalidDeviceException

The device is in an invalid state.

HTTP Status Code: 400

LimitExceededException

You are performing an action that would put you beyond your account's limits.

HTTP Status Code: 400

NotFoundException

The resource is not found.

HTTP Status Code: 400