| 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.FinalizeDeviceClaim
Description
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.
Synopsis
- data FinalizeDeviceClaim = FinalizeDeviceClaim' {}
- newFinalizeDeviceClaim :: Text -> FinalizeDeviceClaim
- finalizeDeviceClaim_tags :: Lens' FinalizeDeviceClaim (Maybe (HashMap Text Text))
- finalizeDeviceClaim_deviceId :: Lens' FinalizeDeviceClaim Text
- data FinalizeDeviceClaimResponse = FinalizeDeviceClaimResponse' {
- state :: Maybe Text
- httpStatus :: Int
- newFinalizeDeviceClaimResponse :: Int -> FinalizeDeviceClaimResponse
- finalizeDeviceClaimResponse_state :: Lens' FinalizeDeviceClaimResponse (Maybe Text)
- finalizeDeviceClaimResponse_httpStatus :: Lens' FinalizeDeviceClaimResponse Int
Creating a Request
data FinalizeDeviceClaim Source #
See: newFinalizeDeviceClaim smart constructor.
Constructors
| FinalizeDeviceClaim' | |
Instances
newFinalizeDeviceClaim Source #
Arguments
| :: Text | |
| -> 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)) Source #
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 Source #
The unique identifier of the device.
Destructuring the Response
data FinalizeDeviceClaimResponse Source #
See: newFinalizeDeviceClaimResponse smart constructor.
Constructors
| FinalizeDeviceClaimResponse' | |
Fields
| |
Instances
newFinalizeDeviceClaimResponse Source #
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) Source #
The device's final claim state.
finalizeDeviceClaimResponse_httpStatus :: Lens' FinalizeDeviceClaimResponse Int Source #
The response's http status code.