Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Given a device ID, finalizes the 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 FinalizeDeviceClaim

See: newFinalizeDeviceClaim smart constructor.

Constructors

FinalizeDeviceClaim'

Fields

• tags :: Maybe (HashMap Text Text)

  A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.

• deviceId :: Text

  The unique identifier of the device.

Instances

ToJSON FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

toJSON :: FinalizeDeviceClaim -> Value

toEncoding :: FinalizeDeviceClaim -> Encoding

toJSONList :: [FinalizeDeviceClaim] -> Value

toEncodingList :: [FinalizeDeviceClaim] -> Encoding

ToHeaders FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

toHeaders :: FinalizeDeviceClaim -> [Header]

ToPath FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

toPath :: FinalizeDeviceClaim -> ByteString

ToQuery FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

toQuery :: FinalizeDeviceClaim -> QueryString

AWSRequest FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Associated Types

type AWSResponse FinalizeDeviceClaim

Methods

request :: (Service -> Service) -> FinalizeDeviceClaim -> Request FinalizeDeviceClaim

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy FinalizeDeviceClaim -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse FinalizeDeviceClaim)))

Generic FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Associated Types

type Rep FinalizeDeviceClaim :: Type -> Type

Methods

from :: FinalizeDeviceClaim -> Rep FinalizeDeviceClaim x

to :: Rep FinalizeDeviceClaim x -> FinalizeDeviceClaim

Read FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

readsPrec :: Int -> ReadS FinalizeDeviceClaim

readList :: ReadS [FinalizeDeviceClaim]

readPrec :: ReadPrec FinalizeDeviceClaim

readListPrec :: ReadPrec [FinalizeDeviceClaim]

Show FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

showsPrec :: Int -> FinalizeDeviceClaim -> ShowS

show :: FinalizeDeviceClaim -> String

showList :: [FinalizeDeviceClaim] -> ShowS

NFData FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

rnf :: FinalizeDeviceClaim -> ()

Eq FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

(==) :: FinalizeDeviceClaim -> FinalizeDeviceClaim -> Bool

(/=) :: FinalizeDeviceClaim -> FinalizeDeviceClaim -> Bool

Hashable FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

hashWithSalt :: Int -> FinalizeDeviceClaim -> Int

hash :: FinalizeDeviceClaim -> Int

type AWSResponse FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

type AWSResponse FinalizeDeviceClaim = FinalizeDeviceClaimResponse

type Rep FinalizeDeviceClaim

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

type Rep FinalizeDeviceClaim = D1 ('MetaData "FinalizeDeviceClaim" "Amazonka.IoT1ClickDevices.FinalizeDeviceClaim" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "FinalizeDeviceClaim'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newFinalizeDeviceClaim

Arguments

:: Text

FinalizeDeviceClaim

-> FinalizeDeviceClaim

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

FinalizeDeviceClaim, finalizeDeviceClaim_tags - A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.

FinalizeDeviceClaim, finalizeDeviceClaim_deviceId - The unique identifier of the device.

Request Lenses

finalizeDeviceClaim_tags :: Lens' FinalizeDeviceClaim (Maybe (HashMap Text Text))

A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.

finalizeDeviceClaim_deviceId :: Lens' FinalizeDeviceClaim Text

The unique identifier of the device.

Destructuring the Response

data FinalizeDeviceClaimResponse

See: newFinalizeDeviceClaimResponse smart constructor.

Constructors

FinalizeDeviceClaimResponse'

Fields

• state :: Maybe Text

  The device's final claim state.

• httpStatus :: Int

  The response's http status code.

Instances

Generic FinalizeDeviceClaimResponse

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Associated Types

type Rep FinalizeDeviceClaimResponse :: Type -> Type

Methods

from :: FinalizeDeviceClaimResponse -> Rep FinalizeDeviceClaimResponse x

to :: Rep FinalizeDeviceClaimResponse x -> FinalizeDeviceClaimResponse

Read FinalizeDeviceClaimResponse

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

readsPrec :: Int -> ReadS FinalizeDeviceClaimResponse

readList :: ReadS [FinalizeDeviceClaimResponse]

readPrec :: ReadPrec FinalizeDeviceClaimResponse

readListPrec :: ReadPrec [FinalizeDeviceClaimResponse]

Show FinalizeDeviceClaimResponse

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

showsPrec :: Int -> FinalizeDeviceClaimResponse -> ShowS

show :: FinalizeDeviceClaimResponse -> String

showList :: [FinalizeDeviceClaimResponse] -> ShowS

NFData FinalizeDeviceClaimResponse

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

rnf :: FinalizeDeviceClaimResponse -> ()

Eq FinalizeDeviceClaimResponse

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

Methods

(==) :: FinalizeDeviceClaimResponse -> FinalizeDeviceClaimResponse -> Bool

(/=) :: FinalizeDeviceClaimResponse -> FinalizeDeviceClaimResponse -> Bool

type Rep FinalizeDeviceClaimResponse

Defined in Amazonka.IoT1ClickDevices.FinalizeDeviceClaim

type Rep FinalizeDeviceClaimResponse = D1 ('MetaData "FinalizeDeviceClaimResponse" "Amazonka.IoT1ClickDevices.FinalizeDeviceClaim" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "FinalizeDeviceClaimResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newFinalizeDeviceClaimResponse

Arguments

:: Int

$sel:httpStatus:FinalizeDeviceClaimResponse'

-> FinalizeDeviceClaimResponse

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

$sel:httpStatus:FinalizeDeviceClaimResponse', finalizeDeviceClaimResponse_httpStatus - The response's http status code.

Response Lenses

finalizeDeviceClaimResponse_state :: Lens' FinalizeDeviceClaimResponse (Maybe Text)

The device's final claim state.

finalizeDeviceClaimResponse_httpStatus :: Lens' FinalizeDeviceClaimResponse Int

The response's http status code.