AWS.IoT1ClickProjects — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The AWS IoT 1-Click Projects API Reference

Sending a Request Using IoT1ClickProjects

var iot1clickprojects = new AWS.IoT1ClickProjects();
iot1clickprojects.associateDeviceWithPlacement(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the IoT1ClickProjects object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var iot1clickprojects = new AWS.IoT1ClickProjects({apiVersion: '2018-05-14'});

You can also set the API version globally in AWS.config.apiVersions using the iot1clickprojects service identifier:

AWS.config.apiVersions = {
  iot1clickprojects: '2018-05-14',
  // other service API versions
};

var iot1clickprojects = new AWS.IoT1ClickProjects();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.IoT1ClickProjects(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateDeviceWithPlacement(params = {}, callback) ⇒ AWS.Request

Associates a physical device with a placement.

createPlacement(params = {}, callback) ⇒ AWS.Request

Creates an empty placement.

createProject(params = {}, callback) ⇒ AWS.Request

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.

deletePlacement(params = {}, callback) ⇒ AWS.Request

Deletes a placement. To delete a placement, it must not have any devices associated with it.

Note: When you delete a placement, all associated data becomes irretrievable.

deleteProject(params = {}, callback) ⇒ AWS.Request

Deletes a project. To delete a project, it must not have any placements associated with it.

Note: When you delete a project, all associated data becomes irretrievable.

describePlacement(params = {}, callback) ⇒ AWS.Request

Describes a placement in a project.

describeProject(params = {}, callback) ⇒ AWS.Request

Returns an object describing a project.

disassociateDeviceFromPlacement(params = {}, callback) ⇒ AWS.Request

Removes a physical device from a placement.

getDevicesInPlacement(params = {}, callback) ⇒ AWS.Request

Returns an object enumerating the devices in a placement.

listPlacements(params = {}, callback) ⇒ AWS.Request

Lists the placement(s) of a project.

listProjects(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

tagResource(params = {}, callback) ⇒ AWS.Request

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.

untagResource(params = {}, callback) ⇒ AWS.Request

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

updatePlacement(params = {}, callback) ⇒ AWS.Request

Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").

updateProject(params = {}, callback) ⇒ AWS.Request

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