Menu
AWS CodeStar
API Reference (API Version 2017-04-19)

UpdateProject

Updates a project in AWS CodeStar.

Request Syntax

{
   "description": "string",
   "id": "string",
   "name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

description

The description of the project, if any.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^$|^\S(.*\S)?$

Required: No

id

The ID of the project you want to update.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 15.

Pattern: ^[a-z][a-z0-9-]+$

Required: Yes

name

The name of the project you want to update.

Type: String

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

Pattern: ^\S(.*\S)?$

Required: No

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.

ProjectNotFoundException

The specified AWS CodeStar project was not found.

HTTP Status Code: 400

ValidationException

The specified input is either not valid, or it could not be validated.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1
Host: codestar.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 88
X-Amz-Target: CodeStar_20170419.UpdateProject
X-Amz-Date: 20170406T003323Z
User-Agent: aws-cli/1.11.36 Python/2.7.9 Windows/7 botocore/1.4.93
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AIDACKCEVSQ6C2EXAMPLE/20170406/us-east-1/codestar/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=c25ddcd5EXAMPLE

{"id": "my-first-projec", "description": "Updating the project by adding a description"}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: a5afbdc6-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Thu, 06 Apr 2017 00:33:25 GMT

{}

See Also

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