| 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.Lens
Description
Synopsis
- claimDevicesByClaimCode_claimCode :: Lens' ClaimDevicesByClaimCode Text
- claimDevicesByClaimCodeResponse_claimCode :: Lens' ClaimDevicesByClaimCodeResponse (Maybe Text)
- claimDevicesByClaimCodeResponse_total :: Lens' ClaimDevicesByClaimCodeResponse (Maybe Int)
- claimDevicesByClaimCodeResponse_httpStatus :: Lens' ClaimDevicesByClaimCodeResponse Int
- describeDevice_deviceId :: Lens' DescribeDevice Text
- describeDeviceResponse_deviceDescription :: Lens' DescribeDeviceResponse (Maybe DeviceDescription)
- describeDeviceResponse_httpStatus :: Lens' DescribeDeviceResponse Int
- finalizeDeviceClaim_tags :: Lens' FinalizeDeviceClaim (Maybe (HashMap Text Text))
- finalizeDeviceClaim_deviceId :: Lens' FinalizeDeviceClaim Text
- finalizeDeviceClaimResponse_state :: Lens' FinalizeDeviceClaimResponse (Maybe Text)
- finalizeDeviceClaimResponse_httpStatus :: Lens' FinalizeDeviceClaimResponse Int
- getDeviceMethods_deviceId :: Lens' GetDeviceMethods Text
- getDeviceMethodsResponse_deviceMethods :: Lens' GetDeviceMethodsResponse (Maybe [DeviceMethod])
- getDeviceMethodsResponse_httpStatus :: Lens' GetDeviceMethodsResponse Int
- initiateDeviceClaim_deviceId :: Lens' InitiateDeviceClaim Text
- initiateDeviceClaimResponse_state :: Lens' InitiateDeviceClaimResponse (Maybe Text)
- initiateDeviceClaimResponse_httpStatus :: Lens' InitiateDeviceClaimResponse Int
- invokeDeviceMethod_deviceMethod :: Lens' InvokeDeviceMethod (Maybe DeviceMethod)
- invokeDeviceMethod_deviceMethodParameters :: Lens' InvokeDeviceMethod (Maybe Text)
- invokeDeviceMethod_deviceId :: Lens' InvokeDeviceMethod Text
- invokeDeviceMethodResponse_deviceMethodResponse :: Lens' InvokeDeviceMethodResponse (Maybe Text)
- invokeDeviceMethodResponse_httpStatus :: Lens' InvokeDeviceMethodResponse Int
- listDeviceEvents_maxResults :: Lens' ListDeviceEvents (Maybe Natural)
- listDeviceEvents_nextToken :: Lens' ListDeviceEvents (Maybe Text)
- listDeviceEvents_deviceId :: Lens' ListDeviceEvents Text
- listDeviceEvents_fromTimeStamp :: Lens' ListDeviceEvents UTCTime
- listDeviceEvents_toTimeStamp :: Lens' ListDeviceEvents UTCTime
- listDeviceEventsResponse_events :: Lens' ListDeviceEventsResponse (Maybe [DeviceEvent])
- listDeviceEventsResponse_nextToken :: Lens' ListDeviceEventsResponse (Maybe Text)
- listDeviceEventsResponse_httpStatus :: Lens' ListDeviceEventsResponse Int
- listDevices_deviceType :: Lens' ListDevices (Maybe Text)
- listDevices_maxResults :: Lens' ListDevices (Maybe Natural)
- listDevices_nextToken :: Lens' ListDevices (Maybe Text)
- listDevicesResponse_devices :: Lens' ListDevicesResponse (Maybe [DeviceDescription])
- listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text)
- listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- unclaimDevice_deviceId :: Lens' UnclaimDevice Text
- unclaimDeviceResponse_state :: Lens' UnclaimDeviceResponse (Maybe Text)
- unclaimDeviceResponse_httpStatus :: Lens' UnclaimDeviceResponse Int
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResource_resourceArn :: Lens' UntagResource Text
- updateDeviceState_enabled :: Lens' UpdateDeviceState (Maybe Bool)
- updateDeviceState_deviceId :: Lens' UpdateDeviceState Text
- updateDeviceStateResponse_httpStatus :: Lens' UpdateDeviceStateResponse Int
- device_attributes :: Lens' Device (Maybe Attributes)
- device_deviceId :: Lens' Device (Maybe Text)
- device_type :: Lens' Device (Maybe Text)
- deviceDescription_arn :: Lens' DeviceDescription (Maybe Text)
- deviceDescription_attributes :: Lens' DeviceDescription (Maybe (HashMap Text Text))
- deviceDescription_deviceId :: Lens' DeviceDescription (Maybe Text)
- deviceDescription_enabled :: Lens' DeviceDescription (Maybe Bool)
- deviceDescription_remainingLife :: Lens' DeviceDescription (Maybe Double)
- deviceDescription_tags :: Lens' DeviceDescription (Maybe (HashMap Text Text))
- deviceDescription_type :: Lens' DeviceDescription (Maybe Text)
- deviceEvent_device :: Lens' DeviceEvent (Maybe Device)
- deviceEvent_stdEvent :: Lens' DeviceEvent (Maybe Text)
- deviceMethod_deviceType :: Lens' DeviceMethod (Maybe Text)
- deviceMethod_methodName :: Lens' DeviceMethod (Maybe Text)
Operations
ClaimDevicesByClaimCode
claimDevicesByClaimCode_claimCode :: Lens' ClaimDevicesByClaimCode Text Source #
The claim code, starting with "C-", as provided by the device manufacturer.
claimDevicesByClaimCodeResponse_claimCode :: Lens' ClaimDevicesByClaimCodeResponse (Maybe Text) Source #
The claim code provided by the device manufacturer.
claimDevicesByClaimCodeResponse_total :: Lens' ClaimDevicesByClaimCodeResponse (Maybe Int) Source #
The total number of devices associated with the claim code that has been processed in the claim request.
claimDevicesByClaimCodeResponse_httpStatus :: Lens' ClaimDevicesByClaimCodeResponse Int Source #
The response's http status code.
DescribeDevice
describeDevice_deviceId :: Lens' DescribeDevice Text Source #
The unique identifier of the device.
describeDeviceResponse_deviceDescription :: Lens' DescribeDeviceResponse (Maybe DeviceDescription) Source #
Device details.
describeDeviceResponse_httpStatus :: Lens' DescribeDeviceResponse Int Source #
The response's http status code.
FinalizeDeviceClaim
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.
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.
GetDeviceMethods
getDeviceMethods_deviceId :: Lens' GetDeviceMethods Text Source #
The unique identifier of the device.
getDeviceMethodsResponse_deviceMethods :: Lens' GetDeviceMethodsResponse (Maybe [DeviceMethod]) Source #
List of available device APIs.
getDeviceMethodsResponse_httpStatus :: Lens' GetDeviceMethodsResponse Int Source #
The response's http status code.
InitiateDeviceClaim
initiateDeviceClaim_deviceId :: Lens' InitiateDeviceClaim Text Source #
The unique identifier of the device.
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.
InvokeDeviceMethod
invokeDeviceMethod_deviceMethod :: Lens' InvokeDeviceMethod (Maybe DeviceMethod) Source #
The device method to invoke.
invokeDeviceMethod_deviceMethodParameters :: Lens' InvokeDeviceMethod (Maybe Text) Source #
A JSON encoded string containing the device method request parameters.
invokeDeviceMethod_deviceId :: Lens' InvokeDeviceMethod Text Source #
The unique identifier of the device.
invokeDeviceMethodResponse_deviceMethodResponse :: Lens' InvokeDeviceMethodResponse (Maybe Text) Source #
A JSON encoded string containing the device method response.
invokeDeviceMethodResponse_httpStatus :: Lens' InvokeDeviceMethodResponse Int Source #
The response's http status code.
ListDeviceEvents
listDeviceEvents_maxResults :: Lens' ListDeviceEvents (Maybe Natural) Source #
The maximum number of results to return per request. If not set, a default value of 100 is used.
listDeviceEvents_nextToken :: Lens' ListDeviceEvents (Maybe Text) Source #
The token to retrieve the next set of results.
listDeviceEvents_deviceId :: Lens' ListDeviceEvents Text Source #
The unique identifier of the device.
listDeviceEvents_fromTimeStamp :: Lens' ListDeviceEvents UTCTime Source #
The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z
listDeviceEvents_toTimeStamp :: Lens' ListDeviceEvents UTCTime Source #
The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z
listDeviceEventsResponse_events :: Lens' ListDeviceEventsResponse (Maybe [DeviceEvent]) Source #
An array of zero or more elements describing the event(s) associated with the device.
listDeviceEventsResponse_nextToken :: Lens' ListDeviceEventsResponse (Maybe Text) Source #
The token to retrieve the next set of results.
listDeviceEventsResponse_httpStatus :: Lens' ListDeviceEventsResponse Int Source #
The response's http status code.
ListDevices
listDevices_deviceType :: Lens' ListDevices (Maybe Text) Source #
The type of the device, such as "button".
listDevices_maxResults :: Lens' ListDevices (Maybe Natural) Source #
The maximum number of results to return per request. If not set, a default value of 100 is used.
listDevices_nextToken :: Lens' ListDevices (Maybe Text) Source #
The token to retrieve the next set of results.
listDevicesResponse_devices :: Lens' ListDevicesResponse (Maybe [DeviceDescription]) Source #
A list of devices.
listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text) Source #
The token to retrieve the next set of results.
listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The ARN of the resource.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (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.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The ARN of the resource.
tagResource_tags :: Lens' TagResource (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.
UnclaimDevice
unclaimDevice_deviceId :: Lens' UnclaimDevice Text Source #
The unique identifier of the device.
unclaimDeviceResponse_state :: Lens' UnclaimDeviceResponse (Maybe Text) Source #
The device's final claim state.
unclaimDeviceResponse_httpStatus :: Lens' UnclaimDeviceResponse Int Source #
The response's http status code.
UntagResource
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
A collections of tag keys. For example, {"key1","key2"}
untagResource_resourceArn :: Lens' UntagResource Text Source #
The ARN of the resource.
UpdateDeviceState
updateDeviceState_enabled :: Lens' UpdateDeviceState (Maybe Bool) Source #
If true, the device is enabled. If false, the device is disabled.
updateDeviceState_deviceId :: Lens' UpdateDeviceState Text Source #
The unique identifier of the device.
updateDeviceStateResponse_httpStatus :: Lens' UpdateDeviceStateResponse Int Source #
The response's http status code.
Types
Attributes
Device
device_attributes :: Lens' Device (Maybe Attributes) Source #
The user specified attributes associated with the device for an event.
DeviceDescription
deviceDescription_arn :: Lens' DeviceDescription (Maybe Text) Source #
The ARN of the device.
deviceDescription_attributes :: Lens' DeviceDescription (Maybe (HashMap Text Text)) Source #
An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
deviceDescription_deviceId :: Lens' DeviceDescription (Maybe Text) Source #
The unique identifier of the device.
deviceDescription_enabled :: Lens' DeviceDescription (Maybe Bool) Source #
A Boolean value indicating whether or not the device is enabled.
deviceDescription_remainingLife :: Lens' DeviceDescription (Maybe Double) Source #
A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
deviceDescription_tags :: Lens' DeviceDescription (Maybe (HashMap Text Text)) Source #
The tags currently associated with the AWS IoT 1-Click device.
deviceDescription_type :: Lens' DeviceDescription (Maybe Text) Source #
The type of the device, such as "button".
DeviceEvent
deviceEvent_device :: Lens' DeviceEvent (Maybe Device) Source #
An object representing the device associated with the event.
deviceEvent_stdEvent :: Lens' DeviceEvent (Maybe Text) Source #
A serialized JSON object representing the device-type specific event.
DeviceMethod
deviceMethod_deviceType :: Lens' DeviceMethod (Maybe Text) Source #
The type of the device, such as "button".
deviceMethod_methodName :: Lens' DeviceMethod (Maybe Text) Source #
The name of the method applicable to the deviceType.