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

UpdateProject

Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., "").

Request Syntax


PUT /projects/projectName HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "placementTemplate": { 
      "defaultAttributes": { 
         "string" : "string" 
      },
      "deviceTemplates": { 
         "string" : { 
            "callbackOverrides": { 
               "string" : "string" 
            },
            "deviceType": "string"
         }
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

projectName

The name of the project to be updated.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

An optional user-defined description for the project.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

placementTemplate

An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given placementTemplate, you can update the associated callbackOverrides for the device definition using this API.

Type: PlacementTemplate object

Required: No

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

ResourceNotFoundException

HTTP Status Code: 404

TooManyRequestsException

HTTP Status Code: 429