AWS IoT 1-Click Projects Service
Projects API Reference (API Version 2018-05-14)

CreateProject

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.

Request Syntax

POST /projects HTTP/1.1 Content-type: application/json { "description": "string", "placementTemplate": { "defaultAttributes": { "string" : "string" }, "deviceTemplates": { "string" : { "callbackOverrides": { "string" : "string" }, "deviceType": "string" } } }, "projectName": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

description

An optional description for the project.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

placementTemplate

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.

Type: PlacementTemplate object

Required: No

projectName

The name of the project to create.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[0-9A-Za-z_-]+$

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

HTTP Status Code: 500

InvalidRequestException

HTTP Status Code: 400

ResourceConflictException

HTTP Status Code: 409

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: