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

Description

 
Synopsis

Operations

AssociateDeviceWithPlacement

associateDeviceWithPlacement_projectName :: Lens' AssociateDeviceWithPlacement Text Source #

The name of the project containing the placement in which to associate the device.

associateDeviceWithPlacement_placementName :: Lens' AssociateDeviceWithPlacement Text Source #

The name of the placement in which to associate the device.

associateDeviceWithPlacement_deviceId :: Lens' AssociateDeviceWithPlacement Text Source #

The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all deviceId values.

associateDeviceWithPlacement_deviceTemplateName :: Lens' AssociateDeviceWithPlacement Text Source #

The device template name to associate with the device ID.

CreatePlacement

createPlacement_attributes :: Lens' CreatePlacement (Maybe (HashMap Text Text)) Source #

Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.

createPlacement_placementName :: Lens' CreatePlacement Text Source #

The name of the placement to be created.

createPlacement_projectName :: Lens' CreatePlacement Text Source #

The name of the project in which to create the placement.

CreateProject

createProject_description :: Lens' CreateProject (Maybe Text) Source #

An optional description for the project.

createProject_placementTemplate :: Lens' CreateProject (Maybe PlacementTemplate) Source #

The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API.

createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text)) Source #

Optional tags (metadata key/value pairs) to be associated with the project. For example, { {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.

createProject_projectName :: Lens' CreateProject Text Source #

The name of the project to create.

DeletePlacement

deletePlacement_placementName :: Lens' DeletePlacement Text Source #

The name of the empty placement to delete.

deletePlacement_projectName :: Lens' DeletePlacement Text Source #

The project containing the empty placement to delete.

DeleteProject

deleteProject_projectName :: Lens' DeleteProject Text Source #

The name of the empty project to delete.

DescribePlacement

describePlacement_placementName :: Lens' DescribePlacement Text Source #

The name of the placement within a project.

describePlacement_projectName :: Lens' DescribePlacement Text Source #

The project containing the placement to be described.

DescribeProject

describeProject_projectName :: Lens' DescribeProject Text Source #

The name of the project to be described.

DisassociateDeviceFromPlacement

disassociateDeviceFromPlacement_projectName :: Lens' DisassociateDeviceFromPlacement Text Source #

The name of the project that contains the placement.

disassociateDeviceFromPlacement_placementName :: Lens' DisassociateDeviceFromPlacement Text Source #

The name of the placement that the device should be removed from.

GetDevicesInPlacement

getDevicesInPlacement_projectName :: Lens' GetDevicesInPlacement Text Source #

The name of the project containing the placement.

getDevicesInPlacement_placementName :: Lens' GetDevicesInPlacement Text Source #

The name of the placement to get the devices from.

getDevicesInPlacementResponse_devices :: Lens' GetDevicesInPlacementResponse (HashMap Text Text) Source #

An object containing the devices (zero or more) within the placement.

ListPlacements

listPlacements_maxResults :: Lens' ListPlacements (Maybe Natural) Source #

The maximum number of results to return per request. If not set, a default value of 100 is used.

listPlacements_nextToken :: Lens' ListPlacements (Maybe Text) Source #

The token to retrieve the next set of results.

listPlacements_projectName :: Lens' ListPlacements Text Source #

The project containing the placements to be listed.

listPlacementsResponse_nextToken :: Lens' ListPlacementsResponse (Maybe Text) Source #

The token used to retrieve the next set of results - will be effectively empty if there are no further results.

ListProjects

listProjects_maxResults :: Lens' ListProjects (Maybe Natural) Source #

The maximum number of results to return per request. If not set, a default value of 100 is used.

listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #

The token to retrieve the next set of results.

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #

The token used to retrieve the next set of results - will be effectively empty if there are no further results.

listProjectsResponse_projects :: Lens' ListProjectsResponse [ProjectSummary] Source #

An object containing the list of projects.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The ARN of the resource whose tags you want to list.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The tags (metadata key/value pairs) which you have assigned to the resource.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The ARN of the resouce for which tag(s) should be added or modified.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The ARN of the resource whose tag you want to remove.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The keys of those tags which you want to remove.

UpdatePlacement

updatePlacement_attributes :: Lens' UpdatePlacement (Maybe (HashMap Text Text)) Source #

The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.

updatePlacement_placementName :: Lens' UpdatePlacement Text Source #

The name of the placement to update.

updatePlacement_projectName :: Lens' UpdatePlacement Text Source #

The name of the project containing the placement to be updated.

UpdateProject

updateProject_description :: Lens' UpdateProject (Maybe Text) Source #

An optional user-defined description for the project.

updateProject_placementTemplate :: Lens' UpdateProject (Maybe PlacementTemplate) Source #

An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given placementTemplate, you can update the associated callbackOverrides for the device definition using this API.

updateProject_projectName :: Lens' UpdateProject Text Source #

The name of the project to be updated.

Types

DeviceTemplate

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

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

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

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

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

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.