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.Types

Contents

Service Configuration
Errors
Attributes
Device
DeviceDescription
DeviceEvent
DeviceMethod

Description

Synopsis

defaultService :: Service
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
_PreconditionFailedException :: AsError a => Getting (First ServiceError) a ServiceError
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError
_RangeNotSatisfiableException :: AsError a => Getting (First ServiceError) a ServiceError
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceConflictException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
data Attributes = Attributes' {
}
newAttributes :: Attributes
data Device = Device' {
- attributes :: Maybe Attributes
- deviceId :: Maybe Text
- type' :: Maybe Text
}
newDevice :: Device
device_attributes :: Lens' Device (Maybe Attributes)
device_deviceId :: Lens' Device (Maybe Text)
device_type :: Lens' Device (Maybe Text)
data DeviceDescription = DeviceDescription' {
- remainingLife :: Maybe Double
- enabled :: Maybe Bool
- arn :: Maybe Text
- attributes :: Maybe (HashMap Text Text)
- deviceId :: Maybe Text
- type' :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newDeviceDescription :: DeviceDescription
deviceDescription_remainingLife :: Lens' DeviceDescription (Maybe Double)
deviceDescription_enabled :: Lens' DeviceDescription (Maybe Bool)
deviceDescription_arn :: Lens' DeviceDescription (Maybe Text)
deviceDescription_attributes :: Lens' DeviceDescription (Maybe (HashMap Text Text))
deviceDescription_deviceId :: Lens' DeviceDescription (Maybe Text)
deviceDescription_type :: Lens' DeviceDescription (Maybe Text)
deviceDescription_tags :: Lens' DeviceDescription (Maybe (HashMap Text Text))
data DeviceEvent = DeviceEvent' {
- stdEvent :: Maybe Text
- device :: Maybe Device
}
newDeviceEvent :: DeviceEvent
deviceEvent_stdEvent :: Lens' DeviceEvent (Maybe Text)
deviceEvent_device :: Lens' DeviceEvent (Maybe Device)
data DeviceMethod = DeviceMethod' {
- methodName :: Maybe Text
- deviceType :: Maybe Text
}
newDeviceMethod :: DeviceMethod
deviceMethod_methodName :: Lens' DeviceMethod (Maybe Text)
deviceMethod_deviceType :: Lens' DeviceMethod (Maybe Text)

Service Configuration

defaultService :: Service Source #

API version 2018-05-14 of the Amazon IoT 1-Click Devices Service SDK configuration.

Errors

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Prism for InvalidRequestException' errors.

_PreconditionFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Prism for PreconditionFailedException' errors.

_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Prism for ForbiddenException' errors.

_RangeNotSatisfiableException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Prism for RangeNotSatisfiableException' errors.

_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Prism for InternalFailureException' errors.

_ResourceConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Prism for ResourceConflictException' errors.

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Prism for ResourceNotFoundException' errors.

Attributes

data Attributes Source #

See: newAttributes smart constructor.

Constructors

Attributes'

Instances

Instances details

Eq Attributes Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Attributes Methods (==) :: Attributes -> Attributes -> Bool # (/=) :: Attributes -> Attributes -> Bool #
Read Attributes Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Attributes Methods readsPrec :: Int -> ReadS Attributes # readList :: ReadS [Attributes] # readPrec :: ReadPrec Attributes # readListPrec :: ReadPrec [Attributes] #
Show Attributes Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Attributes Methods showsPrec :: Int -> Attributes -> ShowS # show :: Attributes -> String # showList :: [Attributes] -> ShowS #
Generic Attributes Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Attributes Associated Types type Rep Attributes :: Type -> Type # Methods from :: Attributes -> Rep Attributes x # to :: Rep Attributes x -> Attributes #
NFData Attributes Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Attributes Methods rnf :: Attributes -> () #
Hashable Attributes Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Attributes Methods hashWithSalt :: Int -> Attributes -> Int # hash :: Attributes -> Int #
FromJSON Attributes Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Attributes Methods parseJSON :: Value -> Parser Attributes # parseJSONList :: Value -> Parser [Attributes] #
type Rep Attributes Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Attributes type Rep Attributes = D1 ('MetaData "Attributes" "Amazonka.IoT1ClickDevices.Types.Attributes" "libZSservicesZSamazonka-iot1click-devicesZSamazonka-iot1click-devices" 'False) (C1 ('MetaCons "Attributes'" 'PrefixI 'False) (U1 :: Type -> Type))

newAttributes :: Attributes Source #

Create a value of Attributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Device

data Device Source #

See: newDevice smart constructor.

Constructors

Device'
Fields attributes :: Maybe Attributes The user specified attributes associated with the device for an event. deviceId :: Maybe Text The unique identifier of the device. type' :: Maybe Text The device type, such as "button".

Instances

Instances details

Eq Device Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Device Methods (==) :: Device -> Device -> Bool # (/=) :: Device -> Device -> Bool #
Read Device Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Device Methods readsPrec :: Int -> ReadS Device # readList :: ReadS [Device] # readPrec :: ReadPrec Device # readListPrec :: ReadPrec [Device] #
Show Device Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Device Methods showsPrec :: Int -> Device -> ShowS # show :: Device -> String # showList :: [Device] -> ShowS #
Generic Device Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Device Associated Types type Rep Device :: Type -> Type # Methods from :: Device -> Rep Device x # to :: Rep Device x -> Device #
NFData Device Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Device Methods rnf :: Device -> () #
Hashable Device Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Device Methods hashWithSalt :: Int -> Device -> Int # hash :: Device -> Int #
FromJSON Device Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Device Methods parseJSON :: Value -> Parser Device # parseJSONList :: Value -> Parser [Device] #
type Rep Device Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.Device type Rep Device = D1 ('MetaData "Device" "Amazonka.IoT1ClickDevices.Types.Device" "libZSservicesZSamazonka-iot1click-devicesZSamazonka-iot1click-devices" '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)))))

newDevice :: Device Source #

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".

device_attributes :: Lens' Device (Maybe Attributes) Source #

The user specified attributes associated with the device for an event.

device_deviceId :: Lens' Device (Maybe Text) Source #

The unique identifier of the device.

device_type :: Lens' Device (Maybe Text) Source #

The device type, such as "button".

DeviceDescription

data DeviceDescription Source #

See: newDeviceDescription smart constructor.

Constructors

DeviceDescription'

Fields

remainingLife :: Maybe Double
A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
enabled :: Maybe Bool
A Boolean value indicating whether or not the device is enabled.
arn :: Maybe Text
The ARN of the device.
attributes :: Maybe (HashMap Text Text)
An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
deviceId :: Maybe Text
The unique identifier of the device.
type' :: Maybe Text
The type of the device, such as "button".
tags :: Maybe (HashMap Text Text)
The tags currently associated with the AWS IoT 1-Click device.

Instances

Instances details

Eq DeviceDescription Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription Methods (==) :: DeviceDescription -> DeviceDescription -> Bool # (/=) :: DeviceDescription -> DeviceDescription -> Bool #
Read DeviceDescription Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription Methods readsPrec :: Int -> ReadS DeviceDescription # readList :: ReadS [DeviceDescription] # readPrec :: ReadPrec DeviceDescription # readListPrec :: ReadPrec [DeviceDescription] #
Show DeviceDescription Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription Methods showsPrec :: Int -> DeviceDescription -> ShowS # show :: DeviceDescription -> String # showList :: [DeviceDescription] -> ShowS #
Generic DeviceDescription Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription Associated Types type Rep DeviceDescription :: Type -> Type # Methods from :: DeviceDescription -> Rep DeviceDescription x # to :: Rep DeviceDescription x -> DeviceDescription #
NFData DeviceDescription Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription Methods rnf :: DeviceDescription -> () #
Hashable DeviceDescription Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription Methods hashWithSalt :: Int -> DeviceDescription -> Int # hash :: DeviceDescription -> Int #
FromJSON DeviceDescription Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription Methods parseJSON :: Value -> Parser DeviceDescription # parseJSONList :: Value -> Parser [DeviceDescription] #
type Rep DeviceDescription Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription type Rep DeviceDescription = D1 ('MetaData "DeviceDescription" "Amazonka.IoT1ClickDevices.Types.DeviceDescription" "libZSservicesZSamazonka-iot1click-devicesZSamazonka-iot1click-devices" 'False) (C1 ('MetaCons "DeviceDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "remainingLife") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

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:remainingLife:DeviceDescription', deviceDescription_remainingLife - A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.

$sel:enabled:DeviceDescription', deviceDescription_enabled - A Boolean value indicating whether or not the device is enabled.

$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:type':DeviceDescription', deviceDescription_type - The type of the device, such as "button".

$sel:tags:DeviceDescription', deviceDescription_tags - The tags currently associated with the AWS IoT 1-Click device.

deviceDescription_remainingLife :: Lens' DeviceDescription (Maybe Double) Source #

A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.

deviceDescription_enabled :: Lens' DeviceDescription (Maybe Bool) Source #

A Boolean value indicating whether or not the device is enabled.

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_type :: Lens' DeviceDescription (Maybe Text) Source #

The type of the device, such as "button".

deviceDescription_tags :: Lens' DeviceDescription (Maybe (HashMap Text Text)) Source #

The tags currently associated with the AWS IoT 1-Click device.

DeviceEvent

data DeviceEvent Source #

See: newDeviceEvent smart constructor.

Constructors

DeviceEvent'
Fields stdEvent :: Maybe Text A serialized JSON object representing the device-type specific event. device :: Maybe Device An object representing the device associated with the event.

Instances

Instances details

Eq DeviceEvent Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent Methods (==) :: DeviceEvent -> DeviceEvent -> Bool # (/=) :: DeviceEvent -> DeviceEvent -> Bool #
Read DeviceEvent Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent Methods readsPrec :: Int -> ReadS DeviceEvent # readList :: ReadS [DeviceEvent] # readPrec :: ReadPrec DeviceEvent # readListPrec :: ReadPrec [DeviceEvent] #
Show DeviceEvent Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent Methods showsPrec :: Int -> DeviceEvent -> ShowS # show :: DeviceEvent -> String # showList :: [DeviceEvent] -> ShowS #
Generic DeviceEvent Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent Associated Types type Rep DeviceEvent :: Type -> Type # Methods from :: DeviceEvent -> Rep DeviceEvent x # to :: Rep DeviceEvent x -> DeviceEvent #
NFData DeviceEvent Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent Methods rnf :: DeviceEvent -> () #
Hashable DeviceEvent Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent Methods hashWithSalt :: Int -> DeviceEvent -> Int # hash :: DeviceEvent -> Int #
FromJSON DeviceEvent Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent Methods parseJSON :: Value -> Parser DeviceEvent # parseJSONList :: Value -> Parser [DeviceEvent] #
type Rep DeviceEvent Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent type Rep DeviceEvent = D1 ('MetaData "DeviceEvent" "Amazonka.IoT1ClickDevices.Types.DeviceEvent" "libZSservicesZSamazonka-iot1click-devicesZSamazonka-iot1click-devices" 'False) (C1 ('MetaCons "DeviceEvent'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stdEvent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "device") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Device))))

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:stdEvent:DeviceEvent', deviceEvent_stdEvent - A serialized JSON object representing the device-type specific event.

$sel:device:DeviceEvent', deviceEvent_device - 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.

deviceEvent_device :: Lens' DeviceEvent (Maybe Device) Source #

An object representing the device associated with the event.

DeviceMethod

data DeviceMethod Source #

See: newDeviceMethod smart constructor.

Constructors

DeviceMethod'
Fields methodName :: Maybe Text The name of the method applicable to the deviceType. deviceType :: Maybe Text The type of the device, such as "button".

Instances

Instances details

Eq DeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod Methods (==) :: DeviceMethod -> DeviceMethod -> Bool # (/=) :: DeviceMethod -> DeviceMethod -> Bool #
Read DeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod Methods readsPrec :: Int -> ReadS DeviceMethod # readList :: ReadS [DeviceMethod] # readPrec :: ReadPrec DeviceMethod # readListPrec :: ReadPrec [DeviceMethod] #
Show DeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod Methods showsPrec :: Int -> DeviceMethod -> ShowS # show :: DeviceMethod -> String # showList :: [DeviceMethod] -> ShowS #
Generic DeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod Associated Types type Rep DeviceMethod :: Type -> Type # Methods from :: DeviceMethod -> Rep DeviceMethod x # to :: Rep DeviceMethod x -> DeviceMethod #
NFData DeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod Methods rnf :: DeviceMethod -> () #
Hashable DeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod Methods hashWithSalt :: Int -> DeviceMethod -> Int # hash :: DeviceMethod -> Int #
ToJSON DeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod Methods toJSON :: DeviceMethod -> Value # toEncoding :: DeviceMethod -> Encoding # toJSONList :: [DeviceMethod] -> Value # toEncodingList :: [DeviceMethod] -> Encoding #
FromJSON DeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod Methods parseJSON :: Value -> Parser DeviceMethod # parseJSONList :: Value -> Parser [DeviceMethod] #
type Rep DeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod type Rep DeviceMethod = D1 ('MetaData "DeviceMethod" "Amazonka.IoT1ClickDevices.Types.DeviceMethod" "libZSservicesZSamazonka-iot1click-devicesZSamazonka-iot1click-devices" 'False) (C1 ('MetaCons "DeviceMethod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "methodName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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:methodName:DeviceMethod', deviceMethod_methodName - The name of the method applicable to the deviceType.

$sel:deviceType:DeviceMethod', deviceMethod_deviceType - The type of the device, such as "button".

deviceMethod_methodName :: Lens' DeviceMethod (Maybe Text) Source #

The name of the method applicable to the deviceType.

deviceMethod_deviceType :: Lens' DeviceMethod (Maybe Text) Source #

The type of the device, such as "button".