Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoT1ClickDevices.InitiateDeviceClaim

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Given a device ID, initiates a claim request for the associated device.

Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.

Creating a Request

data InitiateDeviceClaim Source #

See: newInitiateDeviceClaim smart constructor.

Constructors

InitiateDeviceClaim'
Fields deviceId :: Text The unique identifier of the device.

Instances

Instances details

ToJSON InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods toJSON :: InitiateDeviceClaim -> Value # toEncoding :: InitiateDeviceClaim -> Encoding # toJSONList :: [InitiateDeviceClaim] -> Value # toEncodingList :: [InitiateDeviceClaim] -> Encoding #
ToHeaders InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods toHeaders :: InitiateDeviceClaim -> [Header] #
ToPath InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods toPath :: InitiateDeviceClaim -> ByteString #
ToQuery InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods toQuery :: InitiateDeviceClaim -> QueryString #
AWSRequest InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Associated Types type AWSResponse InitiateDeviceClaim # Methods request :: (Service -> Service) -> InitiateDeviceClaim -> Request InitiateDeviceClaim # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy InitiateDeviceClaim -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InitiateDeviceClaim))) #
Generic InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Associated Types type Rep InitiateDeviceClaim :: Type -> Type # Methods from :: InitiateDeviceClaim -> Rep InitiateDeviceClaim x # to :: Rep InitiateDeviceClaim x -> InitiateDeviceClaim #
Read InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods readsPrec :: Int -> ReadS InitiateDeviceClaim # readList :: ReadS [InitiateDeviceClaim] # readPrec :: ReadPrec InitiateDeviceClaim # readListPrec :: ReadPrec [InitiateDeviceClaim] #
Show InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods showsPrec :: Int -> InitiateDeviceClaim -> ShowS # show :: InitiateDeviceClaim -> String # showList :: [InitiateDeviceClaim] -> ShowS #
NFData InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods rnf :: InitiateDeviceClaim -> () #
Eq InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods (==) :: InitiateDeviceClaim -> InitiateDeviceClaim -> Bool # (/=) :: InitiateDeviceClaim -> InitiateDeviceClaim -> Bool #
Hashable InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods hashWithSalt :: Int -> InitiateDeviceClaim -> Int # hash :: InitiateDeviceClaim -> Int #
type AWSResponse InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim type AWSResponse InitiateDeviceClaim = InitiateDeviceClaimResponse
type Rep InitiateDeviceClaim Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim type Rep InitiateDeviceClaim = D1 ('MetaData "InitiateDeviceClaim" "Amazonka.IoT1ClickDevices.InitiateDeviceClaim" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "InitiateDeviceClaim'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newInitiateDeviceClaim Source #

Arguments

:: Text	`InitiateDeviceClaim`
-> InitiateDeviceClaim

Create a value of InitiateDeviceClaim 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:

InitiateDeviceClaim, initiateDeviceClaim_deviceId - The unique identifier of the device.

Request Lenses

initiateDeviceClaim_deviceId :: Lens' InitiateDeviceClaim Text Source #

The unique identifier of the device.

Destructuring the Response

data InitiateDeviceClaimResponse Source #

See: newInitiateDeviceClaimResponse smart constructor.

Constructors

InitiateDeviceClaimResponse'
Fields state :: Maybe Text The device's final claim state. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic InitiateDeviceClaimResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Associated Types type Rep InitiateDeviceClaimResponse :: Type -> Type # Methods from :: InitiateDeviceClaimResponse -> Rep InitiateDeviceClaimResponse x # to :: Rep InitiateDeviceClaimResponse x -> InitiateDeviceClaimResponse #
Read InitiateDeviceClaimResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods readsPrec :: Int -> ReadS InitiateDeviceClaimResponse # readList :: ReadS [InitiateDeviceClaimResponse] # readPrec :: ReadPrec InitiateDeviceClaimResponse # readListPrec :: ReadPrec [InitiateDeviceClaimResponse] #
Show InitiateDeviceClaimResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods showsPrec :: Int -> InitiateDeviceClaimResponse -> ShowS # show :: InitiateDeviceClaimResponse -> String # showList :: [InitiateDeviceClaimResponse] -> ShowS #
NFData InitiateDeviceClaimResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods rnf :: InitiateDeviceClaimResponse -> () #
Eq InitiateDeviceClaimResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim Methods (==) :: InitiateDeviceClaimResponse -> InitiateDeviceClaimResponse -> Bool # (/=) :: InitiateDeviceClaimResponse -> InitiateDeviceClaimResponse -> Bool #
type Rep InitiateDeviceClaimResponse Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InitiateDeviceClaim type Rep InitiateDeviceClaimResponse = D1 ('MetaData "InitiateDeviceClaimResponse" "Amazonka.IoT1ClickDevices.InitiateDeviceClaim" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "InitiateDeviceClaimResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newInitiateDeviceClaimResponse Source #

Arguments

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

Create a value of InitiateDeviceClaimResponse 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:state:InitiateDeviceClaimResponse', initiateDeviceClaimResponse_state - The device's final claim state.

$sel:httpStatus:InitiateDeviceClaimResponse', initiateDeviceClaimResponse_httpStatus - The response's http status code.

Response Lenses

initiateDeviceClaimResponse_state :: Lens' InitiateDeviceClaimResponse (Maybe Text) Source #

The device's final claim state.

initiateDeviceClaimResponse_httpStatus :: Lens' InitiateDeviceClaimResponse Int Source #

The response's http status code.