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

DescribePlacement

Describes a placement in a project.

Request Syntax

GET /projects/projectName/placements/placementName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

placementName

The name of the placement within a project.

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

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

projectName

The project containing the placement to be described.

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

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "placement": { "attributes": { "string" : "string" }, "createdDate": number, "placementName": "string", "projectName": "string", "updatedDate": number } }

Response Elements

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

The following data is returned in JSON format by the service.

placement

An object describing the placement.

Type: PlacementDescription object

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

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: