@datafire/amazonaws_iot1click_projects v5.0.0

@datafire/amazonaws_iot1click_projects

Client library for AWS IoT 1-Click Projects Service

Installation and Usage

npm install --save @datafire/amazonaws_iot1click_projects

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

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

Description

The AWS IoT 1-Click Project API Reference

Actions

ListProjects

amazonaws_iot1click_projects.ListProjects({}, context)

Input

• input object

Output

• output ListProjectsResponse

CreateProject

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

Input

• input object
  • description Description
  • placementTemplate PlacementTemplate
  • projectName required ProjectName

Output

• output CreateProjectResponse

DeleteProject

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

Input

• input object
  • projectName required string

Output

• output DeleteProjectResponse

DescribeProject

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

Input

• input object
  • projectName required string

Output

• output DescribeProjectResponse

UpdateProject

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

Input

• input object
  • projectName required string
  • description Description
  • placementTemplate PlacementTemplate

Output

• output UpdateProjectResponse

ListPlacements

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

Input

• input object
  • projectName required string

Output

• output ListPlacementsResponse

CreatePlacement

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

Input

• input object
  • projectName required string
  • attributes PlacementAttributeMap
  • placementName required PlacementName

Output

• output CreatePlacementResponse

DeletePlacement

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

Input

• input object
  • projectName required string
  • placementName required string

Output

• output DeletePlacementResponse

DescribePlacement

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

Input

• input object
  • projectName required string
  • placementName required string

Output

• output DescribePlacementResponse

UpdatePlacement

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

Input

• input object
  • projectName required string
  • placementName required string
  • attributes PlacementAttributeMap

Output

• output UpdatePlacementResponse

GetDevicesInPlacement

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

Input

• input object
  • projectName required string
  • placementName required string

Output

• output GetDevicesInPlacementResponse

DisassociateDeviceFromPlacement

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

Input

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

Output

• output DisassociateDeviceFromPlacementResponse

AssociateDeviceWithPlacement

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

Input

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

Output

• output AssociateDeviceWithPlacementResponse

Definitions

AssociateDeviceWithPlacementRequest

• AssociateDeviceWithPlacementRequest object
  • deviceId required DeviceId

AssociateDeviceWithPlacementResponse

• AssociateDeviceWithPlacementResponse object

AttributeDefaultValue

• AttributeDefaultValue string

AttributeName

• AttributeName string

AttributeValue

• AttributeValue string

Code

• Code string

CreatePlacementRequest

• CreatePlacementRequest object
  • attributes PlacementAttributeMap
  • placementName required PlacementName

CreatePlacementResponse

• CreatePlacementResponse object

CreateProjectRequest

• CreateProjectRequest object
  • description Description
  • placementTemplate PlacementTemplate
  • projectName required ProjectName

CreateProjectResponse

• CreateProjectResponse object

DefaultPlacementAttributeMap

• DefaultPlacementAttributeMap array
  • items object
    • key AttributeName
    • value AttributeDefaultValue

DeletePlacementRequest

• DeletePlacementRequest object

DeletePlacementResponse

• DeletePlacementResponse object

DeleteProjectRequest

• DeleteProjectRequest object

DeleteProjectResponse

• DeleteProjectResponse object

DescribePlacementRequest

• DescribePlacementRequest object

DescribePlacementResponse

• DescribePlacementResponse object
  • placement required PlacementDescription

DescribeProjectRequest

• DescribeProjectRequest object

DescribeProjectResponse

• DescribeProjectResponse object
  • project required ProjectDescription

Description

• Description string

DeviceCallbackKey

• DeviceCallbackKey string

DeviceCallbackOverrideMap

• DeviceCallbackOverrideMap array
  • items object
    • key DeviceCallbackKey
    • value DeviceCallbackValue

DeviceCallbackValue

• DeviceCallbackValue string

DeviceId

• DeviceId string

DeviceMap

• DeviceMap array
  • items object
    • key DeviceTemplateName
    • value DeviceId

DeviceTemplate

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

DeviceTemplateMap

• DeviceTemplateMap array
  • items object
    • key DeviceTemplateName
    • value DeviceTemplate

DeviceTemplateName

• DeviceTemplateName string

DeviceType

• DeviceType string

DisassociateDeviceFromPlacementRequest

• DisassociateDeviceFromPlacementRequest object

DisassociateDeviceFromPlacementResponse

• DisassociateDeviceFromPlacementResponse object

GetDevicesInPlacementRequest

• GetDevicesInPlacementRequest object

GetDevicesInPlacementResponse

• GetDevicesInPlacementResponse object
  • devices required DeviceMap

InternalFailureException

• InternalFailureException object:
  • code required Code
  • message required Message

InvalidRequestException

• InvalidRequestException object:
  • code required Code
  • message required Message

ListPlacementsRequest

• ListPlacementsRequest object

ListPlacementsResponse

• ListPlacementsResponse object
  • nextToken NextToken
  • placements required PlacementSummaryList

ListProjectsRequest

• ListProjectsRequest object

ListProjectsResponse

• ListProjectsResponse object
  • nextToken NextToken
  • projects required ProjectSummaryList

MaxResults

• MaxResults integer

Message

• Message string

NextToken

• NextToken string

PlacementAttributeMap

• PlacementAttributeMap array
  • items object
    • key AttributeName
    • value AttributeValue

PlacementDescription

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

PlacementName

• PlacementName string

PlacementSummary

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

PlacementSummaryList

• PlacementSummaryList array
  • items PlacementSummary

PlacementTemplate

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

ProjectDescription

• ProjectDescription object: An object providing detailed information for a particular project associated with an AWS account and region.
  • createdDate required Time
  • description Description
  • placementTemplate PlacementTemplate
  • projectName required ProjectName
  • updatedDate required Time

ProjectName

• ProjectName string

ProjectSummary

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

ProjectSummaryList

• ProjectSummaryList array
  • items ProjectSummary

ResourceConflictException

• ResourceConflictException object:
  • code required Code
  • message required Message

ResourceNotFoundException

• ResourceNotFoundException object:
  • code required Code
  • message required Message

Time

• Time string

TooManyRequestsException

• TooManyRequestsException object:
  • code required Code
  • message required Message

UpdatePlacementRequest

• UpdatePlacementRequest object
  • attributes PlacementAttributeMap

UpdatePlacementResponse

• UpdatePlacementResponse object

UpdateProjectRequest

• UpdateProjectRequest object
  • description Description
  • placementTemplate PlacementTemplate

UpdateProjectResponse

• UpdateProjectResponse object