amazonka-iot1click-projects-2.0: Amazon IoT 1-Click Projects Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT1ClickProjects.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

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

Errors

DeviceTemplate

data DeviceTemplate Source #

An object representing a device for a placement template (see PlacementTemplate).

See: newDeviceTemplate smart constructor.

Constructors

DeviceTemplate' 

Fields

Instances

Instances details
FromJSON DeviceTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.DeviceTemplate

ToJSON DeviceTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.DeviceTemplate

Generic DeviceTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.DeviceTemplate

Associated Types

type Rep DeviceTemplate :: Type -> Type #

Read DeviceTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.DeviceTemplate

Show DeviceTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.DeviceTemplate

NFData DeviceTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.DeviceTemplate

Methods

rnf :: DeviceTemplate -> () #

Eq DeviceTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.DeviceTemplate

Hashable DeviceTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.DeviceTemplate

type Rep DeviceTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.DeviceTemplate

type Rep DeviceTemplate = D1 ('MetaData "DeviceTemplate" "Amazonka.IoT1ClickProjects.Types.DeviceTemplate" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "DeviceTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "callbackOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "deviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDeviceTemplate :: DeviceTemplate Source #

Create a value of DeviceTemplate 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:callbackOverrides:DeviceTemplate', deviceTemplate_callbackOverrides - An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.

$sel:deviceType:DeviceTemplate', deviceTemplate_deviceType - The device type, which currently must be "button".

deviceTemplate_callbackOverrides :: Lens' DeviceTemplate (Maybe (HashMap Text Text)) Source #

An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.

deviceTemplate_deviceType :: Lens' DeviceTemplate (Maybe Text) Source #

The device type, which currently must be "button".

PlacementDescription

data PlacementDescription Source #

An object describing a project's placement.

See: newPlacementDescription smart constructor.

Constructors

PlacementDescription' 

Fields

  • projectName :: Text

    The name of the project containing the placement.

  • placementName :: Text

    The name of the placement.

  • attributes :: HashMap Text Text

    The user-defined attributes associated with the placement.

  • createdDate :: POSIX

    The date when the placement was initially created, in UNIX epoch time format.

  • updatedDate :: POSIX

    The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

Instances

Instances details
FromJSON PlacementDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementDescription

Generic PlacementDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementDescription

Associated Types

type Rep PlacementDescription :: Type -> Type #

Read PlacementDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementDescription

Show PlacementDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementDescription

NFData PlacementDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementDescription

Methods

rnf :: PlacementDescription -> () #

Eq PlacementDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementDescription

Hashable PlacementDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementDescription

type Rep PlacementDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementDescription

type Rep PlacementDescription = D1 ('MetaData "PlacementDescription" "Amazonka.IoT1ClickProjects.Types.PlacementDescription" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "PlacementDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "placementName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "updatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newPlacementDescription Source #

Create a value of PlacementDescription 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:projectName:PlacementDescription', placementDescription_projectName - The name of the project containing the placement.

$sel:placementName:PlacementDescription', placementDescription_placementName - The name of the placement.

$sel:attributes:PlacementDescription', placementDescription_attributes - The user-defined attributes associated with the placement.

$sel:createdDate:PlacementDescription', placementDescription_createdDate - The date when the placement was initially created, in UNIX epoch time format.

$sel:updatedDate:PlacementDescription', placementDescription_updatedDate - The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

placementDescription_projectName :: Lens' PlacementDescription Text Source #

The name of the project containing the placement.

placementDescription_attributes :: Lens' PlacementDescription (HashMap Text Text) Source #

The user-defined attributes associated with the placement.

placementDescription_createdDate :: Lens' PlacementDescription UTCTime Source #

The date when the placement was initially created, in UNIX epoch time format.

placementDescription_updatedDate :: Lens' PlacementDescription UTCTime Source #

The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

PlacementSummary

data PlacementSummary Source #

An object providing summary information for a particular placement.

See: newPlacementSummary smart constructor.

Constructors

PlacementSummary' 

Fields

  • projectName :: Text

    The name of the project containing the placement.

  • placementName :: Text

    The name of the placement being summarized.

  • createdDate :: POSIX

    The date when the placement was originally created, in UNIX epoch time format.

  • updatedDate :: POSIX

    The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

Instances

Instances details
FromJSON PlacementSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementSummary

Generic PlacementSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementSummary

Associated Types

type Rep PlacementSummary :: Type -> Type #

Read PlacementSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementSummary

Show PlacementSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementSummary

NFData PlacementSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementSummary

Methods

rnf :: PlacementSummary -> () #

Eq PlacementSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementSummary

Hashable PlacementSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementSummary

type Rep PlacementSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementSummary

type Rep PlacementSummary = D1 ('MetaData "PlacementSummary" "Amazonka.IoT1ClickProjects.Types.PlacementSummary" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "PlacementSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "placementName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "updatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newPlacementSummary Source #

Create a value of PlacementSummary 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:projectName:PlacementSummary', placementSummary_projectName - The name of the project containing the placement.

$sel:placementName:PlacementSummary', placementSummary_placementName - The name of the placement being summarized.

$sel:createdDate:PlacementSummary', placementSummary_createdDate - The date when the placement was originally created, in UNIX epoch time format.

$sel:updatedDate:PlacementSummary', placementSummary_updatedDate - The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

placementSummary_projectName :: Lens' PlacementSummary Text Source #

The name of the project containing the placement.

placementSummary_placementName :: Lens' PlacementSummary Text Source #

The name of the placement being summarized.

placementSummary_createdDate :: Lens' PlacementSummary UTCTime Source #

The date when the placement was originally created, in UNIX epoch time format.

placementSummary_updatedDate :: Lens' PlacementSummary UTCTime Source #

The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

PlacementTemplate

data PlacementTemplate Source #

An object defining the template for a placement.

See: newPlacementTemplate smart constructor.

Constructors

PlacementTemplate' 

Fields

Instances

Instances details
FromJSON PlacementTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementTemplate

ToJSON PlacementTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementTemplate

Generic PlacementTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementTemplate

Associated Types

type Rep PlacementTemplate :: Type -> Type #

Read PlacementTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementTemplate

Show PlacementTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementTemplate

NFData PlacementTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementTemplate

Methods

rnf :: PlacementTemplate -> () #

Eq PlacementTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementTemplate

Hashable PlacementTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementTemplate

type Rep PlacementTemplate Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.PlacementTemplate

type Rep PlacementTemplate = D1 ('MetaData "PlacementTemplate" "Amazonka.IoT1ClickProjects.Types.PlacementTemplate" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "PlacementTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "defaultAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "deviceTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text DeviceTemplate)))))

newPlacementTemplate :: PlacementTemplate Source #

Create a value of PlacementTemplate 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:defaultAttributes:PlacementTemplate', placementTemplate_defaultAttributes - The default attributes (key/value pairs) to be applied to all placements using this template.

$sel:deviceTemplates:PlacementTemplate', placementTemplate_deviceTemplates - An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template.

placementTemplate_defaultAttributes :: Lens' PlacementTemplate (Maybe (HashMap Text Text)) Source #

The default attributes (key/value pairs) to be applied to all placements using this template.

placementTemplate_deviceTemplates :: Lens' PlacementTemplate (Maybe (HashMap Text DeviceTemplate)) Source #

An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template.

ProjectDescription

data ProjectDescription Source #

An object providing detailed information for a particular project associated with an AWS account and region.

See: newProjectDescription smart constructor.

Constructors

ProjectDescription' 

Fields

Instances

Instances details
FromJSON ProjectDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectDescription

Generic ProjectDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectDescription

Associated Types

type Rep ProjectDescription :: Type -> Type #

Read ProjectDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectDescription

Show ProjectDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectDescription

NFData ProjectDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectDescription

Methods

rnf :: ProjectDescription -> () #

Eq ProjectDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectDescription

Hashable ProjectDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectDescription

type Rep ProjectDescription Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectDescription

type Rep ProjectDescription = D1 ('MetaData "ProjectDescription" "Amazonka.IoT1ClickProjects.Types.ProjectDescription" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "ProjectDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "placementTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlacementTemplate)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "updatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newProjectDescription Source #

Create a value of ProjectDescription 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:ProjectDescription', projectDescription_arn - The ARN of the project.

$sel:description:ProjectDescription', projectDescription_description - The description of the project.

$sel:placementTemplate:ProjectDescription', projectDescription_placementTemplate - An object describing the project's placement specifications.

$sel:tags:ProjectDescription', projectDescription_tags - The tags (metadata key/value pairs) associated with the project.

$sel:projectName:ProjectDescription', projectDescription_projectName - The name of the project for which to obtain information from.

$sel:createdDate:ProjectDescription', projectDescription_createdDate - The date when the project was originally created, in UNIX epoch time format.

$sel:updatedDate:ProjectDescription', projectDescription_updatedDate - The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

projectDescription_placementTemplate :: Lens' ProjectDescription (Maybe PlacementTemplate) Source #

An object describing the project's placement specifications.

projectDescription_tags :: Lens' ProjectDescription (Maybe (HashMap Text Text)) Source #

The tags (metadata key/value pairs) associated with the project.

projectDescription_projectName :: Lens' ProjectDescription Text Source #

The name of the project for which to obtain information from.

projectDescription_createdDate :: Lens' ProjectDescription UTCTime Source #

The date when the project was originally created, in UNIX epoch time format.

projectDescription_updatedDate :: Lens' ProjectDescription UTCTime Source #

The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

ProjectSummary

data ProjectSummary Source #

An object providing summary information for a particular project for an associated AWS account and region.

See: newProjectSummary smart constructor.

Constructors

ProjectSummary' 

Fields

  • arn :: Maybe Text

    The ARN of the project.

  • tags :: Maybe (HashMap Text Text)

    The tags (metadata key/value pairs) associated with the project.

  • projectName :: Text

    The name of the project being summarized.

  • createdDate :: POSIX

    The date when the project was originally created, in UNIX epoch time format.

  • updatedDate :: POSIX

    The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

Instances

Instances details
FromJSON ProjectSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectSummary

Generic ProjectSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectSummary

Associated Types

type Rep ProjectSummary :: Type -> Type #

Read ProjectSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectSummary

Show ProjectSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectSummary

NFData ProjectSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectSummary

Methods

rnf :: ProjectSummary -> () #

Eq ProjectSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectSummary

Hashable ProjectSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectSummary

type Rep ProjectSummary Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.Types.ProjectSummary

type Rep ProjectSummary = D1 ('MetaData "ProjectSummary" "Amazonka.IoT1ClickProjects.Types.ProjectSummary" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "ProjectSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "updatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newProjectSummary Source #

Create a value of ProjectSummary 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:ProjectSummary', projectSummary_arn - The ARN of the project.

$sel:tags:ProjectSummary', projectSummary_tags - The tags (metadata key/value pairs) associated with the project.

$sel:projectName:ProjectSummary', projectSummary_projectName - The name of the project being summarized.

$sel:createdDate:ProjectSummary', projectSummary_createdDate - The date when the project was originally created, in UNIX epoch time format.

$sel:updatedDate:ProjectSummary', projectSummary_updatedDate - The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

projectSummary_tags :: Lens' ProjectSummary (Maybe (HashMap Text Text)) Source #

The tags (metadata key/value pairs) associated with the project.

projectSummary_projectName :: Lens' ProjectSummary Text Source #

The name of the project being summarized.

projectSummary_createdDate :: Lens' ProjectSummary UTCTime Source #

The date when the project was originally created, in UNIX epoch time format.

projectSummary_updatedDate :: Lens' ProjectSummary UTCTime Source #

The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.