You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.IoT1ClickProjects

Inherits:

AWS.Service

Object
AWS.Service
AWS.IoT1ClickProjects

show all

Identifier:: iot1clickprojects

API Version:: 2018-05-14

Defined in:: (unknown)

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();

Version:

2018-05-14

Constructor Summary collapse

new AWS.IoT1ClickProjects(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.
deletePlacement(params = {}, callback) ⇒ AWS.Request
Deletes a placement.
deleteProject(params = {}, callback) ⇒ AWS.Request
Deletes a project.
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.
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.
updateProject(params = {}, callback) ⇒ AWS.Request
Updates a project associated with your AWS account and region.

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.

Examples:

Constructing a IoT1ClickProjects object

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

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.IoT1ClickProjects.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.IoT1ClickProjects.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.IoT1ClickProjects.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Associates a physical device with a placement.

Service Reference:

AssociateDeviceWithPlacement

Examples:

Calling the associateDeviceWithPlacement operation

var params = {
  deviceId: 'STRING_VALUE', /* required */
  deviceTemplateName: 'STRING_VALUE', /* required */
  placementName: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE' /* required */
};
iot1clickprojects.associateDeviceWithPlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- projectName — (String)
  The name of the project containing the placement in which to associate the device.
- placementName — (String)
  The name of the placement in which to associate the device.
- deviceId — (String)
  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.
- deviceTemplateName — (String)
  The device template name to associate with the device ID.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Creates an empty placement.

Service Reference:

CreatePlacement

Examples:

Calling the createPlacement operation

var params = {
  placementName: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  attributes: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  }
};
iot1clickprojects.createPlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- placementName — (String)
  The name of the placement to be created.
- projectName — (String)
  The name of the project in which to create the placement.
- attributes — (map<String>)
  Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

CreateProject

Examples:

Calling the createProject operation

var params = {
  projectName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  placementTemplate: {
    defaultAttributes: {
      '<AttributeName>': 'STRING_VALUE',
      /* '<AttributeName>': ... */
    },
    deviceTemplates: {
      '<DeviceTemplateName>': {
        callbackOverrides: {
          '<DeviceCallbackKey>': 'STRING_VALUE',
          /* '<DeviceCallbackKey>': ... */
        },
        deviceType: 'STRING_VALUE'
      },
      /* '<DeviceTemplateName>': ... */
    }
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iot1clickprojects.createProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- projectName — (String)
  The name of the project to create.
- description — (String)
  An optional description for the project.
- placementTemplate — (map)
  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.
  - defaultAttributes — (map<String>)
    The default attributes (key/value pairs) to be applied to all placements using this template.
  - deviceTemplates — (map<map>)
    An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template.
    - deviceType — (String)
      The device type, which currently must be "button".
    - callbackOverrides — (map<String>)
      An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.
- tags — (map<String>)
  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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

DeletePlacement

Examples:

Calling the deletePlacement operation

var params = {
  placementName: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE' /* required */
};
iot1clickprojects.deletePlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- placementName — (String)
  The name of the empty placement to delete.
- projectName — (String)
  The project containing the empty placement to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

DeleteProject

Examples:

Calling the deleteProject operation

var params = {
  projectName: 'STRING_VALUE' /* required */
};
iot1clickprojects.deleteProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- projectName — (String)
  The name of the empty project to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Describes a placement in a project.

Service Reference:

DescribePlacement

Examples:

Calling the describePlacement operation

var params = {
  placementName: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE' /* required */
};
iot1clickprojects.describePlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- placementName — (String)
  The name of the placement within a project.
- projectName — (String)
  The project containing the placement to be described.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - placement — (map)
    An object describing the placement.
    
    projectName — required — (String)
    The name of the project containing the placement.
    
    placementName — required — (String)
    The name of the placement.
    
    attributes — required — (map<String>)
    The user-defined attributes associated with the placement.
    
    createdDate — required — (Date)
    The date when the placement was initially created, in UNIX epoch time format.
    
    updatedDate — required — (Date)
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns an object describing a project.

Service Reference:

DescribeProject

Examples:

Calling the describeProject operation

var params = {
  projectName: 'STRING_VALUE' /* required */
};
iot1clickprojects.describeProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- projectName — (String)
  The name of the project to be described.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - project — (map)
    An object describing the project.
    
    arn — (String)
    The ARN of the project.
    
    projectName — required — (String)
    The name of the project for which to obtain information from.
    
    description — (String)
    The description of the project.
    
    createdDate — required — (Date)
    The date when the project was originally created, in UNIX epoch time format.
    
    updatedDate — required — (Date)
    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.
    
    placementTemplate — (map)
    An object describing the project's placement specifications.
    
    defaultAttributes — (map<String>)
    The default attributes (key/value pairs) to be applied to all placements using this template.
    
    deviceTemplates — (map<map>)
    An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template.
    
    deviceType — (String)
    The device type, which currently must be "button".
    
    callbackOverrides — (map<String>)
    An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.
    
    tags — (map<String>)
    The tags (metadata key/value pairs) associated with the project.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Removes a physical device from a placement.

Service Reference:

DisassociateDeviceFromPlacement

Examples:

Calling the disassociateDeviceFromPlacement operation

var params = {
  deviceTemplateName: 'STRING_VALUE', /* required */
  placementName: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE' /* required */
};
iot1clickprojects.disassociateDeviceFromPlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- projectName — (String)
  The name of the project that contains the placement.
- placementName — (String)
  The name of the placement that the device should be removed from.
- deviceTemplateName — (String)
  The device ID that should be removed from the placement.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns an object enumerating the devices in a placement.

Service Reference:

GetDevicesInPlacement

Examples:

Calling the getDevicesInPlacement operation

var params = {
  placementName: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE' /* required */
};
iot1clickprojects.getDevicesInPlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- projectName — (String)
  The name of the project containing the placement.
- placementName — (String)
  The name of the placement to get the devices from.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - devices — (map<String>)
    An object containing the devices (zero or more) within the placement.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Lists the placement(s) of a project.

Service Reference:

ListPlacements

Examples:

Calling the listPlacements operation

var params = {
  projectName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iot1clickprojects.listPlacements(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- projectName — (String)
  The project containing the placements to be listed.
- nextToken — (String)
  The token to retrieve the next set of results.
- maxResults — (Integer)
  The maximum number of results to return per request. If not set, a default value of 100 is used.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - placements — (Array<map>)
    An object listing the requested placements.
    
    projectName — required — (String)
    The name of the project containing the placement.
    
    placementName — required — (String)
    The name of the placement being summarized.
    
    createdDate — required — (Date)
    The date when the placement was originally created, in UNIX epoch time format.
    
    updatedDate — required — (Date)
    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.
  - nextToken — (String)
    The token used to retrieve the next set of results - will be effectively empty if there are no further results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

ListProjects

Examples:

Calling the listProjects operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iot1clickprojects.listProjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- nextToken — (String)
  The token to retrieve the next set of results.
- maxResults — (Integer)
  The maximum number of results to return per request. If not set, a default value of 100 is used.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - projects — (Array<map>)
    An object containing the list of projects.
    
    arn — (String)
    The ARN of the project.
    
    projectName — required — (String)
    The name of the project being summarized.
    
    createdDate — required — (Date)
    The date when the project was originally created, in UNIX epoch time format.
    
    updatedDate — required — (Date)
    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.
    
    tags — (map<String>)
    The tags (metadata key/value pairs) associated with the project.
  - nextToken — (String)
    The token used to retrieve the next set of results - will be effectively empty if there are no further results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

ListTagsForResource

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
iot1clickprojects.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArn — (String)
  The ARN of the resource whose tags you want to list.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - tags — (map<String>)
    The tags (metadata key/value pairs) which you have assigned to the resource.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

TagResource

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
iot1clickprojects.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArn — (String)
  The ARN of the resouce for which tag(s) should be added or modified.
- tags — (map<String>)
  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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

UntagResource

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
iot1clickprojects.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArn — (String)
  The ARN of the resource whose tag you want to remove.
- tagKeys — (Array<String>)
  The keys of those tags which you want to remove.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

UpdatePlacement

Examples:

Calling the updatePlacement operation

var params = {
  placementName: 'STRING_VALUE', /* required */
  projectName: 'STRING_VALUE', /* required */
  attributes: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  }
};
iot1clickprojects.updatePlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- placementName — (String)
  The name of the placement to update.
- projectName — (String)
  The name of the project containing the placement to be updated.
- attributes — (map<String>)
  The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Service Reference:

UpdateProject

Examples:

Calling the updateProject operation

var params = {
  projectName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  placementTemplate: {
    defaultAttributes: {
      '<AttributeName>': 'STRING_VALUE',
      /* '<AttributeName>': ... */
    },
    deviceTemplates: {
      '<DeviceTemplateName>': {
        callbackOverrides: {
          '<DeviceCallbackKey>': 'STRING_VALUE',
          /* '<DeviceCallbackKey>': ... */
        },
        deviceType: 'STRING_VALUE'
      },
      /* '<DeviceTemplateName>': ... */
    }
  }
};
iot1clickprojects.updateProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- projectName — (String)
  The name of the project to be updated.
- description — (String)
  An optional user-defined description for the project.
- placementTemplate — (map)
  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.
  - defaultAttributes — (map<String>)
    The default attributes (key/value pairs) to be applied to all placements using this template.
  - deviceTemplates — (map<map>)
    An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template.
    - deviceType — (String)
      The device type, which currently must be "button".
    - callbackOverrides — (map<String>)
      An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.IoT1ClickProjects

Overview

Service Description

Sending a Request Using IoT1ClickProjects

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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