AlexaForBusiness / Client / start_device_sync

start_device_sync#

AlexaForBusiness.Client.start_device_sync(**kwargs)#

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).

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.start_device_sync(
    RoomArn='string',
    DeviceArn='string',
    Features=[
        'BLUETOOTH'|'VOLUME'|'NOTIFICATIONS'|'LISTS'|'SKILLS'|'NETWORK_PROFILE'|'SETTINGS'|'ALL',
    ]
)
Parameters:

  • RoomArn (string) – The ARN of the room with which the device to sync is associated. Required.

  • DeviceArn (string) – The ARN of the device to sync. Required.

  • Features (list) –

    [REQUIRED]

    Request structure to start the device sync. Required.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • AlexaForBusiness.Client.exceptions.DeviceNotRegisteredException