Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeProject

Returns an object describing a project.

Request Syntax


GET /projects/projectName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

projectName

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.

project

An object describing the project.

Type: ProjectDescription 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