| 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
Description
Derived from API version 2018-05-14 of the AWS service descriptions, licensed under Apache 2.0.
Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web services protocols.
Synopsis
- defaultService :: Service
- _ForbiddenException :: AsError a => Fold a ServiceError
- _InternalFailureException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _PreconditionFailedException :: AsError a => Fold a ServiceError
- _RangeNotSatisfiableException :: AsError a => Fold a ServiceError
- _ResourceConflictException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- data ClaimDevicesByClaimCode = ClaimDevicesByClaimCode' Text
- newClaimDevicesByClaimCode :: Text -> ClaimDevicesByClaimCode
- data ClaimDevicesByClaimCodeResponse = ClaimDevicesByClaimCodeResponse' (Maybe Text) (Maybe Int) Int
- newClaimDevicesByClaimCodeResponse :: Int -> ClaimDevicesByClaimCodeResponse
- data DescribeDevice = DescribeDevice' Text
- newDescribeDevice :: Text -> DescribeDevice
- data DescribeDeviceResponse = DescribeDeviceResponse' (Maybe DeviceDescription) Int
- newDescribeDeviceResponse :: Int -> DescribeDeviceResponse
- data FinalizeDeviceClaim = FinalizeDeviceClaim' (Maybe (HashMap Text Text)) Text
- newFinalizeDeviceClaim :: Text -> FinalizeDeviceClaim
- data FinalizeDeviceClaimResponse = FinalizeDeviceClaimResponse' (Maybe Text) Int
- newFinalizeDeviceClaimResponse :: Int -> FinalizeDeviceClaimResponse
- data GetDeviceMethods = GetDeviceMethods' Text
- newGetDeviceMethods :: Text -> GetDeviceMethods
- data GetDeviceMethodsResponse = GetDeviceMethodsResponse' (Maybe [DeviceMethod]) Int
- newGetDeviceMethodsResponse :: Int -> GetDeviceMethodsResponse
- data InitiateDeviceClaim = InitiateDeviceClaim' Text
- newInitiateDeviceClaim :: Text -> InitiateDeviceClaim
- data InitiateDeviceClaimResponse = InitiateDeviceClaimResponse' (Maybe Text) Int
- newInitiateDeviceClaimResponse :: Int -> InitiateDeviceClaimResponse
- data InvokeDeviceMethod = InvokeDeviceMethod' (Maybe DeviceMethod) (Maybe Text) Text
- newInvokeDeviceMethod :: Text -> InvokeDeviceMethod
- data InvokeDeviceMethodResponse = InvokeDeviceMethodResponse' (Maybe Text) Int
- newInvokeDeviceMethodResponse :: Int -> InvokeDeviceMethodResponse
- data ListDeviceEvents = ListDeviceEvents' (Maybe Natural) (Maybe Text) Text ISO8601 ISO8601
- newListDeviceEvents :: Text -> UTCTime -> UTCTime -> ListDeviceEvents
- data ListDeviceEventsResponse = ListDeviceEventsResponse' (Maybe [DeviceEvent]) (Maybe Text) Int
- newListDeviceEventsResponse :: Int -> ListDeviceEventsResponse
- data ListDevices = ListDevices' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListDevices :: ListDevices
- data ListDevicesResponse = ListDevicesResponse' (Maybe [DeviceDescription]) (Maybe Text) Int
- newListDevicesResponse :: Int -> ListDevicesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data UnclaimDevice = UnclaimDevice' Text
- newUnclaimDevice :: Text -> UnclaimDevice
- data UnclaimDeviceResponse = UnclaimDeviceResponse' (Maybe Text) Int
- newUnclaimDeviceResponse :: Int -> UnclaimDeviceResponse
- data UntagResource = UntagResource' [Text] Text
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateDeviceState = UpdateDeviceState' (Maybe Bool) Text
- newUpdateDeviceState :: Text -> UpdateDeviceState
- data UpdateDeviceStateResponse = UpdateDeviceStateResponse' Int
- newUpdateDeviceStateResponse :: Int -> UpdateDeviceStateResponse
- data Attributes = Attributes' {
- newAttributes :: Attributes
- data Device = Device' (Maybe Attributes) (Maybe Text) (Maybe Text)
- newDevice :: Device
- data DeviceDescription = DeviceDescription' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe (HashMap Text Text)) (Maybe Text)
- newDeviceDescription :: DeviceDescription
- data DeviceEvent = DeviceEvent' (Maybe Device) (Maybe Text)
- newDeviceEvent :: DeviceEvent
- data DeviceMethod = DeviceMethod' (Maybe Text) (Maybe Text)
- newDeviceMethod :: DeviceMethod
Service Configuration
defaultService :: Service Source #
API version 2018-05-14 of the Amazon IoT 1-Click Devices Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoT1ClickDevices.
ForbiddenException
_ForbiddenException :: AsError a => Fold a ServiceError Source #
Prism for ForbiddenException' errors.
InternalFailureException
_InternalFailureException :: AsError a => Fold a ServiceError Source #
Prism for InternalFailureException' errors.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
Prism for InvalidRequestException' errors.
PreconditionFailedException
_PreconditionFailedException :: AsError a => Fold a ServiceError Source #
Prism for PreconditionFailedException' errors.
RangeNotSatisfiableException
_RangeNotSatisfiableException :: AsError a => Fold a ServiceError Source #
Prism for RangeNotSatisfiableException' errors.
ResourceConflictException
_ResourceConflictException :: AsError a => Fold a ServiceError Source #
Prism for ResourceConflictException' errors.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Prism for ResourceNotFoundException' errors.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ClaimDevicesByClaimCode
data ClaimDevicesByClaimCode Source #
See: newClaimDevicesByClaimCode smart constructor.
Constructors
| ClaimDevicesByClaimCode' Text |
Instances
newClaimDevicesByClaimCode Source #
Arguments
| :: Text | |
| -> ClaimDevicesByClaimCode |
Create a value of ClaimDevicesByClaimCode 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:
ClaimDevicesByClaimCode, claimDevicesByClaimCode_claimCode - The claim code, starting with "C-", as provided by the device
manufacturer.
data ClaimDevicesByClaimCodeResponse Source #
See: newClaimDevicesByClaimCodeResponse smart constructor.
Instances
newClaimDevicesByClaimCodeResponse Source #
Create a value of ClaimDevicesByClaimCodeResponse 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:
ClaimDevicesByClaimCode, claimDevicesByClaimCodeResponse_claimCode - The claim code provided by the device manufacturer.
$sel:total:ClaimDevicesByClaimCodeResponse', claimDevicesByClaimCodeResponse_total - The total number of devices associated with the claim code that has been
processed in the claim request.
$sel:httpStatus:ClaimDevicesByClaimCodeResponse', claimDevicesByClaimCodeResponse_httpStatus - The response's http status code.
DescribeDevice
data DescribeDevice Source #
See: newDescribeDevice smart constructor.
Constructors
| DescribeDevice' Text |
Instances
Arguments
| :: Text | |
| -> DescribeDevice |
Create a value of DescribeDevice 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:
DescribeDevice, describeDevice_deviceId - The unique identifier of the device.
data DescribeDeviceResponse Source #
See: newDescribeDeviceResponse smart constructor.
Constructors
| DescribeDeviceResponse' (Maybe DeviceDescription) Int |
Instances
newDescribeDeviceResponse Source #
Create a value of DescribeDeviceResponse 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:deviceDescription:DescribeDeviceResponse', describeDeviceResponse_deviceDescription - Device details.
$sel:httpStatus:DescribeDeviceResponse', describeDeviceResponse_httpStatus - The response's http status code.
FinalizeDeviceClaim
data FinalizeDeviceClaim Source #
See: newFinalizeDeviceClaim smart constructor.
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.
data FinalizeDeviceClaimResponse Source #
See: newFinalizeDeviceClaimResponse smart constructor.
Constructors
| FinalizeDeviceClaimResponse' (Maybe Text) Int |
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.
GetDeviceMethods
data GetDeviceMethods Source #
See: newGetDeviceMethods smart constructor.
Constructors
| GetDeviceMethods' Text |
Instances
Arguments
| :: Text | |
| -> GetDeviceMethods |
Create a value of GetDeviceMethods 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:
GetDeviceMethods, getDeviceMethods_deviceId - The unique identifier of the device.
data GetDeviceMethodsResponse Source #
See: newGetDeviceMethodsResponse smart constructor.
Constructors
| GetDeviceMethodsResponse' (Maybe [DeviceMethod]) Int |
Instances
newGetDeviceMethodsResponse Source #
Create a value of GetDeviceMethodsResponse 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:deviceMethods:GetDeviceMethodsResponse', getDeviceMethodsResponse_deviceMethods - List of available device APIs.
$sel:httpStatus:GetDeviceMethodsResponse', getDeviceMethodsResponse_httpStatus - The response's http status code.
InitiateDeviceClaim
data InitiateDeviceClaim Source #
See: newInitiateDeviceClaim smart constructor.
Constructors
| InitiateDeviceClaim' Text |
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:
InitiateDeviceClaim, initiateDeviceClaim_deviceId - The unique identifier of the device.
data InitiateDeviceClaimResponse Source #
See: newInitiateDeviceClaimResponse smart constructor.
Constructors
| InitiateDeviceClaimResponse' (Maybe Text) Int |
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.
InvokeDeviceMethod
data InvokeDeviceMethod Source #
See: newInvokeDeviceMethod smart constructor.
Constructors
| InvokeDeviceMethod' (Maybe DeviceMethod) (Maybe Text) Text |
Instances
newInvokeDeviceMethod Source #
Arguments
| :: Text | |
| -> InvokeDeviceMethod |
Create a value of InvokeDeviceMethod 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:deviceMethod:InvokeDeviceMethod', invokeDeviceMethod_deviceMethod - The device method to invoke.
$sel:deviceMethodParameters:InvokeDeviceMethod', invokeDeviceMethod_deviceMethodParameters - A JSON encoded string containing the device method request parameters.
InvokeDeviceMethod, invokeDeviceMethod_deviceId - The unique identifier of the device.
data InvokeDeviceMethodResponse Source #
See: newInvokeDeviceMethodResponse smart constructor.
Constructors
| InvokeDeviceMethodResponse' (Maybe Text) Int |
Instances
newInvokeDeviceMethodResponse Source #
Create a value of InvokeDeviceMethodResponse 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:deviceMethodResponse:InvokeDeviceMethodResponse', invokeDeviceMethodResponse_deviceMethodResponse - A JSON encoded string containing the device method response.
$sel:httpStatus:InvokeDeviceMethodResponse', invokeDeviceMethodResponse_httpStatus - The response's http status code.
ListDeviceEvents (Paginated)
data ListDeviceEvents Source #
See: newListDeviceEvents smart constructor.
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> ListDeviceEvents |
Create a value of ListDeviceEvents 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:maxResults:ListDeviceEvents', listDeviceEvents_maxResults - The maximum number of results to return per request. If not set, a
default value of 100 is used.
ListDeviceEvents, listDeviceEvents_nextToken - The token to retrieve the next set of results.
ListDeviceEvents, listDeviceEvents_deviceId - The unique identifier of the device.
$sel:fromTimeStamp:ListDeviceEvents', listDeviceEvents_fromTimeStamp - The start date for the device event query, in ISO8061 format. For
example, 2018-03-28T15:45:12.880Z
$sel:toTimeStamp:ListDeviceEvents', listDeviceEvents_toTimeStamp - The end date for the device event query, in ISO8061 format. For example,
2018-03-28T15:45:12.880Z
data ListDeviceEventsResponse Source #
See: newListDeviceEventsResponse smart constructor.
Constructors
| ListDeviceEventsResponse' (Maybe [DeviceEvent]) (Maybe Text) Int |
Instances
newListDeviceEventsResponse Source #
Create a value of ListDeviceEventsResponse 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:events:ListDeviceEventsResponse', listDeviceEventsResponse_events - An array of zero or more elements describing the event(s) associated
with the device.
ListDeviceEvents, listDeviceEventsResponse_nextToken - The token to retrieve the next set of results.
$sel:httpStatus:ListDeviceEventsResponse', listDeviceEventsResponse_httpStatus - The response's http status code.
ListDevices (Paginated)
data ListDevices Source #
See: newListDevices smart constructor.
Instances
newListDevices :: ListDevices Source #
Create a value of ListDevices 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:
ListDevices, listDevices_deviceType - The type of the device, such as "button".
$sel:maxResults:ListDevices', listDevices_maxResults - The maximum number of results to return per request. If not set, a
default value of 100 is used.
ListDevices, listDevices_nextToken - The token to retrieve the next set of results.
data ListDevicesResponse Source #
See: newListDevicesResponse smart constructor.
Constructors
| ListDevicesResponse' (Maybe [DeviceDescription]) (Maybe Text) Int |
Instances
newListDevicesResponse Source #
Arguments
| :: Int | |
| -> ListDevicesResponse |
Create a value of ListDevicesResponse 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:devices:ListDevicesResponse', listDevicesResponse_devices - A list of devices.
ListDevices, listDevicesResponse_nextToken - The token to retrieve the next set of results.
$sel:httpStatus:ListDevicesResponse', listDevicesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The ARN of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:
ListTagsForResourceResponse, listTagsForResourceResponse_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.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The ARN of the resource.
TagResource, tagResource_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.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' | |
Instances
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UnclaimDevice
data UnclaimDevice Source #
See: newUnclaimDevice smart constructor.
Constructors
| UnclaimDevice' Text |
Instances
Arguments
| :: Text | |
| -> UnclaimDevice |
Create a value of UnclaimDevice 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:
UnclaimDevice, unclaimDevice_deviceId - The unique identifier of the device.
data UnclaimDeviceResponse Source #
See: newUnclaimDeviceResponse smart constructor.
Constructors
| UnclaimDeviceResponse' (Maybe Text) Int |
Instances
newUnclaimDeviceResponse Source #
Create a value of UnclaimDeviceResponse 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:UnclaimDeviceResponse', unclaimDeviceResponse_state - The device's final claim state.
$sel:httpStatus:UnclaimDeviceResponse', unclaimDeviceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' [Text] Text |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:tagKeys:UntagResource', untagResource_tagKeys - A collections of tag keys. For example, {"key1","key2"}
$sel:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' | |
Instances
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateDeviceState
data UpdateDeviceState Source #
See: newUpdateDeviceState smart constructor.
Constructors
| UpdateDeviceState' (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> UpdateDeviceState |
Create a value of UpdateDeviceState 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:
UpdateDeviceState, updateDeviceState_enabled - If true, the device is enabled. If false, the device is disabled.
UpdateDeviceState, updateDeviceState_deviceId - The unique identifier of the device.
data UpdateDeviceStateResponse Source #
See: newUpdateDeviceStateResponse smart constructor.
Constructors
| UpdateDeviceStateResponse' Int |
Instances
newUpdateDeviceStateResponse Source #
Create a value of UpdateDeviceStateResponse 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:httpStatus:UpdateDeviceStateResponse', updateDeviceStateResponse_httpStatus - The response's http status code.
Types
Attributes
data Attributes Source #
See: newAttributes smart constructor.
Constructors
| Attributes' | |
Instances
| FromJSON Attributes Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Attributes | |
| Generic Attributes Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Attributes Associated Types type Rep Attributes :: Type -> Type # | |
| Read Attributes Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Attributes Methods readsPrec :: Int -> ReadS Attributes # readList :: ReadS [Attributes] # readPrec :: ReadPrec Attributes # readListPrec :: ReadPrec [Attributes] # | |
| Show Attributes Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Attributes Methods showsPrec :: Int -> Attributes -> ShowS # show :: Attributes -> String # showList :: [Attributes] -> ShowS # | |
| NFData Attributes Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Attributes Methods rnf :: Attributes -> () # | |
| Eq Attributes Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Attributes | |
| Hashable Attributes Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Attributes | |
| type Rep Attributes Source # | |
newAttributes :: Attributes Source #
Create a value of Attributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Device
See: newDevice smart constructor.
Instances
| FromJSON Device Source # | |
| Generic Device Source # | |
| Read Device Source # | |
| Show Device Source # | |
| NFData Device Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Device | |
| Eq Device Source # | |
| Hashable Device Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Device | |
| type Rep Device Source # | |
Defined in Amazonka.IoT1ClickDevices.Types.Device type Rep Device = D1 ('MetaData "Device" "Amazonka.IoT1ClickDevices.Types.Device" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "Device'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Attributes)) :*: (S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
Create a value of Device 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:attributes:Device', device_attributes - The user specified attributes associated with the device for an event.
$sel:deviceId:Device', device_deviceId - The unique identifier of the device.
$sel:type':Device', device_type - The device type, such as "button".
DeviceDescription
data DeviceDescription Source #
See: newDeviceDescription smart constructor.
Constructors
| DeviceDescription' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Bool) (Maybe Double) (Maybe (HashMap Text Text)) (Maybe Text) |
Instances
newDeviceDescription :: DeviceDescription Source #
Create a value of DeviceDescription 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:arn:DeviceDescription', deviceDescription_arn - The ARN of the device.
$sel:attributes:DeviceDescription', deviceDescription_attributes - An array of zero or more elements of DeviceAttribute objects providing
user specified device attributes.
$sel:deviceId:DeviceDescription', deviceDescription_deviceId - The unique identifier of the device.
$sel:enabled:DeviceDescription', deviceDescription_enabled - A Boolean value indicating whether or not the device is enabled.
$sel:remainingLife:DeviceDescription', deviceDescription_remainingLife - A value between 0 and 1 inclusive, representing the fraction of life
remaining for the device.
$sel:tags:DeviceDescription', deviceDescription_tags - The tags currently associated with the AWS IoT 1-Click device.
$sel:type':DeviceDescription', deviceDescription_type - The type of the device, such as "button".
DeviceEvent
data DeviceEvent Source #
See: newDeviceEvent smart constructor.
Constructors
| DeviceEvent' (Maybe Device) (Maybe Text) |
Instances
newDeviceEvent :: DeviceEvent Source #
Create a value of DeviceEvent 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:device:DeviceEvent', deviceEvent_device - An object representing the device associated with the event.
$sel:stdEvent:DeviceEvent', deviceEvent_stdEvent - A serialized JSON object representing the device-type specific event.
DeviceMethod
data DeviceMethod Source #
See: newDeviceMethod smart constructor.
Constructors
| DeviceMethod' (Maybe Text) (Maybe Text) |
Instances
newDeviceMethod :: DeviceMethod Source #
Create a value of DeviceMethod 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:deviceType:DeviceMethod', deviceMethod_deviceType - The type of the device, such as "button".
$sel:methodName:DeviceMethod', deviceMethod_methodName - The name of the method applicable to the deviceType.