AWS.IoT1ClickProjects (aws-elixir v0.8.0) View Source

The AWS IoT 1-Click Projects API Reference

Link to this section Summary

Functions

Creates an empty project with a placement template.

Returns an object describing a project.

Returns an object enumerating the devices in a placement.

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 project associated with your AWS account and region.

Link to this section Functions

Link to this function

associate_device_with_placement(client, device_template_name, placement_name, project_name, input, options \\ [])

View Source

Associates a physical device with a placement.

Link to this function

create_placement(client, project_name, input, options \\ [])

View Source

Creates an empty placement.

Link to this function

create_project(client, input, options \\ [])

View Source

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.

Link to this function

delete_placement(client, placement_name, project_name, input, options \\ [])

View Source

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

Link to this function

delete_project(client, project_name, input, options \\ [])

View Source

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.

Link to this function

describe_placement(client, placement_name, project_name, options \\ [])

View Source

Describes a placement in a project.

Link to this function

describe_project(client, project_name, options \\ [])

View Source

Returns an object describing a project.

Link to this function

disassociate_device_from_placement(client, device_template_name, placement_name, project_name, input, options \\ [])

View Source

Removes a physical device from a placement.

Link to this function

get_devices_in_placement(client, placement_name, project_name, options \\ [])

View Source

Returns an object enumerating the devices in a placement.

Link to this function

list_placements(client, project_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the placement(s) of a project.

Link to this function

list_projects(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes one or more tags (metadata key/value pairs) from a resource.

Link to this function

update_placement(client, placement_name, project_name, input, options \\ [])

View Source

Updates a placement with the given attributes.

To clear an attribute, pass an empty value (i.e., "").

Link to this function

update_project(client, project_name, input, options \\ [])

View Source

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