Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AlexaBusiness.StartDeviceSync

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data StartDeviceSync Source #

See: newStartDeviceSync smart constructor.

Constructors

StartDeviceSync'
Fields deviceArn :: Maybe Text The ARN of the device to sync. Required. roomArn :: Maybe Text The ARN of the room with which the device to sync is associated. Required. features :: [Feature] Request structure to start the device sync. Required.

Instances

Instances details

Eq StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods (==) :: StartDeviceSync -> StartDeviceSync -> Bool # (/=) :: StartDeviceSync -> StartDeviceSync -> Bool #
Read StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods readsPrec :: Int -> ReadS StartDeviceSync # readList :: ReadS [StartDeviceSync] # readPrec :: ReadPrec StartDeviceSync # readListPrec :: ReadPrec [StartDeviceSync] #
Show StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods showsPrec :: Int -> StartDeviceSync -> ShowS # show :: StartDeviceSync -> String # showList :: [StartDeviceSync] -> ShowS #
Generic StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Associated Types type Rep StartDeviceSync :: Type -> Type # Methods from :: StartDeviceSync -> Rep StartDeviceSync x # to :: Rep StartDeviceSync x -> StartDeviceSync #
NFData StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods rnf :: StartDeviceSync -> () #
Hashable StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods hashWithSalt :: Int -> StartDeviceSync -> Int # hash :: StartDeviceSync -> Int #
ToJSON StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods toJSON :: StartDeviceSync -> Value # toEncoding :: StartDeviceSync -> Encoding # toJSONList :: [StartDeviceSync] -> Value # toEncodingList :: [StartDeviceSync] -> Encoding #
AWSRequest StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Associated Types type AWSResponse StartDeviceSync # Methods request :: StartDeviceSync -> Request StartDeviceSync # response :: MonadResource m => Logger -> Service -> Proxy StartDeviceSync -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartDeviceSync))) #
ToHeaders StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods toHeaders :: StartDeviceSync -> [Header] #
ToPath StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods toPath :: StartDeviceSync -> ByteString #
ToQuery StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods toQuery :: StartDeviceSync -> QueryString #
type Rep StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync type Rep StartDeviceSync = D1 ('MetaData "StartDeviceSync" "Amazonka.AlexaBusiness.StartDeviceSync" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "StartDeviceSync'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "roomArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "features") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Feature]))))
type AWSResponse StartDeviceSync Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync type AWSResponse StartDeviceSync = StartDeviceSyncResponse

newStartDeviceSync :: StartDeviceSync Source #

Create a value of StartDeviceSync with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deviceArn:StartDeviceSync', startDeviceSync_deviceArn - The ARN of the device to sync. Required.

$sel:roomArn:StartDeviceSync', startDeviceSync_roomArn - The ARN of the room with which the device to sync is associated. Required.

$sel:features:StartDeviceSync', startDeviceSync_features - Request structure to start the device sync. Required.

Request Lenses

startDeviceSync_deviceArn :: Lens' StartDeviceSync (Maybe Text) Source #

The ARN of the device to sync. Required.

startDeviceSync_roomArn :: Lens' StartDeviceSync (Maybe Text) Source #

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

startDeviceSync_features :: Lens' StartDeviceSync [Feature] Source #

Request structure to start the device sync. Required.

Destructuring the Response

data StartDeviceSyncResponse Source #

See: newStartDeviceSyncResponse smart constructor.

Constructors

StartDeviceSyncResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartDeviceSyncResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods (==) :: StartDeviceSyncResponse -> StartDeviceSyncResponse -> Bool # (/=) :: StartDeviceSyncResponse -> StartDeviceSyncResponse -> Bool #
Read StartDeviceSyncResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods readsPrec :: Int -> ReadS StartDeviceSyncResponse # readList :: ReadS [StartDeviceSyncResponse] # readPrec :: ReadPrec StartDeviceSyncResponse # readListPrec :: ReadPrec [StartDeviceSyncResponse] #
Show StartDeviceSyncResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods showsPrec :: Int -> StartDeviceSyncResponse -> ShowS # show :: StartDeviceSyncResponse -> String # showList :: [StartDeviceSyncResponse] -> ShowS #
Generic StartDeviceSyncResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Associated Types type Rep StartDeviceSyncResponse :: Type -> Type # Methods from :: StartDeviceSyncResponse -> Rep StartDeviceSyncResponse x # to :: Rep StartDeviceSyncResponse x -> StartDeviceSyncResponse #
NFData StartDeviceSyncResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync Methods rnf :: StartDeviceSyncResponse -> () #
type Rep StartDeviceSyncResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.StartDeviceSync type Rep StartDeviceSyncResponse = D1 ('MetaData "StartDeviceSyncResponse" "Amazonka.AlexaBusiness.StartDeviceSync" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "StartDeviceSyncResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartDeviceSyncResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartDeviceSyncResponse'`
-> StartDeviceSyncResponse

Create a value of StartDeviceSyncResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:StartDeviceSyncResponse', startDeviceSyncResponse_httpStatus - The response's http status code.

Response Lenses

startDeviceSyncResponse_httpStatus :: Lens' StartDeviceSyncResponse Int Source #

The response's http status code.