View Source AWS.IoT1ClickProjects (aws-elixir v1.0.4)
The AWS IoT 1-Click Projects API Reference
Link to this section Summary
Functions
Associates a physical device with a placement.
Creates an empty placement.
Creates an empty project with a placement template.
Deletes a placement.
Deletes a project.
Describes a placement in a project.
Returns an object describing a project.
Removes a physical device from a placement.
Returns an object enumerating the devices in a placement.
Lists the placement(s) of a project.
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
Lists the tags (metadata key/value pairs) which you have assigned to the resource.
Creates or modifies tags for a resource.
Removes one or more tags (metadata key/value pairs) from a resource.
Updates a placement with the given attributes.
Updates a project associated with your AWS account and region.
Link to this section Functions
associate_device_with_placement(client, device_template_name, placement_name, project_name, input, options \\ [])
View SourceAssociates a physical device with a placement.
Creates an empty placement.
Creates an empty project with a placement template.
A project contains zero or more placements that adhere to the placement template defined in the project.
delete_placement(client, placement_name, project_name, input, options \\ [])
View SourceDeletes a placement.
To delete a placement, it must not have any devices associated with it.
When you delete a placement, all associated data becomes irretrievable.
Deletes a project.
To delete a project, it must not have any placements associated with it.
When you delete a project, all associated data becomes irretrievable.
describe_placement(client, placement_name, project_name, options \\ [])
View SourceDescribes a placement in a project.
Returns an object describing a project.
disassociate_device_from_placement(client, device_template_name, placement_name, project_name, input, options \\ [])
View SourceRemoves a physical device from a placement.
get_devices_in_placement(client, placement_name, project_name, options \\ [])
View SourceReturns an object enumerating the devices in a placement.
list_placements(client, project_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the placement(s) of a project.
list_projects(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the AWS IoT 1-Click project(s) associated with your AWS account and region.
Lists the tags (metadata key/value pairs) which you have assigned to the resource.
Creates or modifies tags for a resource.
Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies.
Removes one or more tags (metadata key/value pairs) from a resource.
update_placement(client, placement_name, project_name, input, options \\ [])
View SourceUpdates a placement with the given attributes.
To clear an attribute, pass an empty value (i.e., "").
Updates a project associated with your AWS account and region.
With the exception of
device template names, you can pass just the values that need to be updated
because the update
request will change only the values that are provided. To clear a value, pass
the empty string
(i.e., "").