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

ListPlacements

Lists the placement(s) of a project.

Request Syntax

GET /projects/projectName/placements?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

maxResults

The maximum number of results to return per request. If not set, a default value of 100 is used.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

The token to retrieve the next set of results.

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

projectName

The project containing the placements to be listed.

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 { "nextToken": "string", "placements": [ { "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.

nextToken

The token used to retrieve the next set of results - will be effectively empty if there are no further results.

Type: String

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

placements

An object listing the requested placements.

Type: Array of PlacementSummary objects

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: