Alexa For Business
Alexa for Business API (API Version 2017-11-09)

StartDeviceSync

Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:

  • Bluetooth - This unpairs all bluetooth devices paired with your echo device.

  • Volume - This resets the echo device's volume to the default value.

  • Notifications - This clears all notifications from your echo device.

  • Lists - This clears all to-do items from your echo device.

  • Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).

Request Syntax

{ "DeviceArn": "string", "Features": [ "string" ], "RoomArn": "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.

DeviceArn

The ARN of the device to sync. Required.

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

Features

Request structure to start the device sync. Required.

Type: Array of strings

Valid Values: BLUETOOTH | VOLUME | NOTIFICATIONS | LISTS | SKILLS | NETWORK_PROFILE | SETTINGS | ALL

Required: Yes

RoomArn

The ARN of the room with which the device to sync is associated. Required.

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

Response Elements

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

Errors

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

DeviceNotRegisteredException

The request failed because this device is no longer registered and therefore no longer managed by this account.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: