libZSservicesZSamazonka-iot1click-devicesZSamazonka-iot1click-devices
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT1ClickDevices.Types

Description

 
Synopsis

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

Read Attributes Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.Attributes

Show Attributes Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.Attributes

Generic Attributes Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.Attributes

Associated Types

type Rep Attributes :: Type -> Type #

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

FromJSON Attributes Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.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

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

Show Device Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.Device

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

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

Instances

Instances details
Eq DeviceDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription

Read DeviceDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription

Show DeviceDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription

Generic DeviceDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceDescription

Associated Types

type Rep DeviceDescription :: Type -> Type #

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

FromJSON DeviceDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.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_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

Read DeviceEvent Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent

Show DeviceEvent Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent

Generic DeviceEvent Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceEvent

Associated Types

type Rep DeviceEvent :: Type -> Type #

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

FromJSON DeviceEvent Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.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

Instances

Instances details
Eq DeviceMethod Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod

Read DeviceMethod Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod

Show DeviceMethod Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod

Generic DeviceMethod Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod

Associated Types

type Rep DeviceMethod :: Type -> Type #

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

ToJSON DeviceMethod Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.DeviceMethod

FromJSON DeviceMethod Source # 
Instance details

Defined in Amazonka.IoT1ClickDevices.Types.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".