| 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.IoT1ClickDevices.InitiateDeviceClaim
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.
Synopsis
- data InitiateDeviceClaim = InitiateDeviceClaim' {}
- newInitiateDeviceClaim :: Text -> InitiateDeviceClaim
- initiateDeviceClaim_deviceId :: Lens' InitiateDeviceClaim Text
- data InitiateDeviceClaimResponse = InitiateDeviceClaimResponse' {
- state :: Maybe Text
- httpStatus :: Int
- newInitiateDeviceClaimResponse :: Int -> InitiateDeviceClaimResponse
- initiateDeviceClaimResponse_state :: Lens' InitiateDeviceClaimResponse (Maybe Text)
- initiateDeviceClaimResponse_httpStatus :: Lens' InitiateDeviceClaimResponse Int
Creating a Request
data InitiateDeviceClaim Source #
See: newInitiateDeviceClaim smart constructor.
Constructors
| InitiateDeviceClaim' | |
Instances
newInitiateDeviceClaim Source #
Arguments
| :: Text | |
| -> 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:
$sel:deviceId: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
| |
Instances
newInitiateDeviceClaimResponse Source #
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.