Client library for AWS IoT 1-Click Projects Service

npm install --save @datafire/amazonaws_iot1click_projects

let amazonaws_iot1click_projects = require('@datafire/amazonaws_iot1click_projects').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

The AWS IoT 1-Click Projects API Reference

amazonaws_iot1click_projects.ListProjects({}, context)

• input object
  • nextToken string
  • maxResults integer

• output ListProjectsResponse

amazonaws_iot1click_projects.CreateProject({
  "projectName": ""
}, context)

• input object
  • tags object: 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.
  • description string: An optional description for the project.
  • placementTemplate object: An object defining the template for a placement.
    • defaultAttributes
    • deviceTemplates
  • projectName required string: The name of the project to create.

• output CreateProjectResponse

amazonaws_iot1click_projects.DeleteProject({
  "projectName": ""
}, context)

• input object
  • projectName required string

• output DeleteProjectResponse

amazonaws_iot1click_projects.DescribeProject({
  "projectName": ""
}, context)

• input object
  • projectName required string

• output DescribeProjectResponse

amazonaws_iot1click_projects.UpdateProject({
  "projectName": ""
}, context)

• input object
  • projectName required string
  • description string: An optional user-defined description for the project.
  • placementTemplate object: An object defining the template for a placement.
    • defaultAttributes
    • deviceTemplates

• output UpdateProjectResponse

amazonaws_iot1click_projects.ListPlacements({
  "projectName": ""
}, context)

• input object
  • projectName required string
  • nextToken string
  • maxResults integer

• output ListPlacementsResponse

amazonaws_iot1click_projects.CreatePlacement({
  "projectName": "",
  "placementName": ""
}, context)

• input object
  • projectName required string
  • attributes object: Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.
  • placementName required string: The name of the placement to be created.

• output CreatePlacementResponse

amazonaws_iot1click_projects.DeletePlacement({
  "placementName": "",
  "projectName": ""
}, context)

• input object
  • placementName required string
  • projectName required string

• output DeletePlacementResponse

amazonaws_iot1click_projects.DescribePlacement({
  "placementName": "",
  "projectName": ""
}, context)

• input object
  • placementName required string
  • projectName required string

• output DescribePlacementResponse

amazonaws_iot1click_projects.UpdatePlacement({
  "placementName": "",
  "projectName": ""
}, context)

• input object
  • placementName required string
  • projectName required string
  • attributes object: The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.

• output UpdatePlacementResponse

amazonaws_iot1click_projects.GetDevicesInPlacement({
  "projectName": "",
  "placementName": ""
}, context)

• input object
  • projectName required string
  • placementName required string

• output GetDevicesInPlacementResponse

amazonaws_iot1click_projects.DisassociateDeviceFromPlacement({
  "projectName": "",
  "placementName": "",
  "deviceTemplateName": ""
}, context)

• input object
  • projectName required string
  • placementName required string
  • deviceTemplateName required string

• output DisassociateDeviceFromPlacementResponse

amazonaws_iot1click_projects.AssociateDeviceWithPlacement({
  "projectName": "",
  "placementName": "",
  "deviceTemplateName": "",
  "deviceId": ""
}, context)

• input object
  • projectName required string
  • placementName required string
  • deviceTemplateName required string
  • deviceId required 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.

• output AssociateDeviceWithPlacementResponse

amazonaws_iot1click_projects.ListTagsForResource({
  "resourceArn": ""
}, context)

• input object
  • resourceArn required string

• output ListTagsForResourceResponse

amazonaws_iot1click_projects.TagResource({
  "resourceArn": "",
  "tags": {}
}, context)

• input object
  • resourceArn required string
  • tags required object: 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.

• output TagResourceResponse

amazonaws_iot1click_projects.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

• input object
  • resourceArn required string
  • tagKeys required array

• output UntagResourceResponse

• AssociateDeviceWithPlacementRequest object
  • deviceId required

• AssociateDeviceWithPlacementResponse object

• AttributeDefaultValue string

• AttributeName string

• AttributeValue string

• CreatePlacementRequest object
  • attributes
  • placementName required

• CreatePlacementResponse object

• CreateProjectRequest object
  • tags
  • description
  • placementTemplate
    • defaultAttributes
    • deviceTemplates
  • projectName required

• CreateProjectResponse object

• DefaultPlacementAttributeMap object

• DeletePlacementRequest object

• DeletePlacementResponse object

• DeleteProjectRequest object

• DeleteProjectResponse object

• DescribePlacementRequest object

• DescribePlacementResponse object
  • placement required
    • attributes required
    • createdDate required
    • placementName required
    • projectName required
    • updatedDate required

• DescribeProjectRequest object

• DescribeProjectResponse object
  • project required
    • tags
    • arn
    • createdDate required
    • description
    • placementTemplate
      • defaultAttributes
      • deviceTemplates
    • projectName required
    • updatedDate required

• Description string

• DeviceCallbackKey string

• DeviceCallbackOverrideMap object

• DeviceCallbackValue string

• DeviceId string

• DeviceMap object

• DeviceTemplate object: An object representing a device for a placement template (see PlacementTemplate).
  • callbackOverrides
  • deviceType

• DeviceTemplateMap object

• DeviceTemplateName string

• DeviceType string

• DisassociateDeviceFromPlacementRequest object

• DisassociateDeviceFromPlacementResponse object

• GetDevicesInPlacementRequest object

• GetDevicesInPlacementResponse object
  • devices required

• ListPlacementsRequest object

• ListPlacementsResponse object
  • nextToken
  • placements required
    • items PlacementSummary

• ListProjectsRequest object

• ListProjectsResponse object
  • nextToken
  • projects required
    • items ProjectSummary

• ListTagsForResourceRequest object

• ListTagsForResourceResponse object
  • tags

• MaxResults integer

• NextToken string

• PlacementAttributeMap object

• PlacementDescription object: An object describing a project's placement.
  • attributes required
  • createdDate required
  • placementName required
  • projectName required
  • updatedDate required

• PlacementName string

• PlacementSummary object: An object providing summary information for a particular placement.
  • createdDate required
  • placementName required
  • projectName required
  • updatedDate required

• PlacementSummaryList array
  • items PlacementSummary

• PlacementTemplate object: An object defining the template for a placement.
  • defaultAttributes
  • deviceTemplates

• ProjectArn string

• ProjectDescription object: An object providing detailed information for a particular project associated with an AWS account and region.
  • tags
  • arn
  • createdDate required
  • description
  • placementTemplate
    • defaultAttributes
    • deviceTemplates
  • projectName required
  • updatedDate required

• ProjectName string

• ProjectSummary object: An object providing summary information for a particular project for an associated AWS account and region.
  • tags
  • arn
  • createdDate required
  • projectName required
  • updatedDate required

• ProjectSummaryList array
  • items ProjectSummary

• TagKey string

• TagKeyList array
  • items TagKey

• TagMap object

• TagResourceRequest object
  • tags required

• TagResourceResponse object

• TagValue string

• Time string

• UntagResourceRequest object

• UntagResourceResponse object

• UpdatePlacementRequest object
  • attributes

• UpdatePlacementResponse object

• UpdateProjectRequest object
  • description
  • placementTemplate
    • defaultAttributes
    • deviceTemplates

• UpdateProjectResponse object