[ aws . alexaforbusiness ]
register-avs-device¶
Description¶
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
register-avs-device
--client-id <value>
--user-code <value>
--product-id <value>
[--device-serial-number <value>]
--amazon-id <value>
[--room-arn <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--client-id (string)
The client ID of the OEM used for code-based linking authorization on an AVS device.
--user-code (string)
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.
--product-id (string)
The product ID used to identify your AVS device during authorization.
--device-serial-number (string)
The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
--amazon-id (string)
The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon’s Developer Console.
--room-arn (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.
(structure)
A key-value pair that can be associated with a resource.
Key -> (string)
The key of a tag. Tag keys are case-sensitive.
Value -> (string)
The value of a tag. Tag values are case sensitive and can be null.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.