DescribeProject - AWS IoT 1-Click


Returns an object describing a project.

Request Syntax

GET /projects/projectName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The name of the project to be described.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "project": { "arn": "string", "createdDate": number, "description": "string", "placementTemplate": { "defaultAttributes": { "string" : "string" }, "deviceTemplates": { "string" : { "callbackOverrides": { "string" : "string" }, "deviceType": "string" } } }, "projectName": "string", "tags": { "string" : "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.


An object describing the project.

Type: ProjectDescription object


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


HTTP Status Code: 500


HTTP Status Code: 400


HTTP Status Code: 404

See Also

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