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

CreatePlacement

Creates an empty placement.

Request Syntax

POST /projects/projectName/placements HTTP/1.1 Content-type: application/json { "attributes": { "string" : "string" }, "placementName": "string" }

URI Request Parameters

The request requires the following URI parameters.

projectName

The name of the project in which to create the placement.

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

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

Request Body

The request accepts the following data in JSON format.

attributes

Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.

Type: String to string map

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

Value Length Constraints: Maximum length of 800.

Required: No

placementName

The name of the placement to be created.

Type: String

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

Pattern: ^[a-zA-Z0-9_-]+$

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

ResourceNotFoundException

HTTP Status Code: 404

See Also

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