Menu
AWS CodeBuild
API Reference (API Version 2016-10-06)

UpdateProject

Changes the settings of a build project.

Request Syntax

Copy
{ "artifacts": { "location": "string", "name": "string", "namespaceType": "string", "packaging": "string", "path": "string", "type": "string" }, "description": "string", "encryptionKey": "string", "environment": { "computeType": "string", "environmentVariables": [ { "name": "string", "value": "string" } ], "image": "string", "privilegedMode": boolean, "type": "string" }, "name": "string", "serviceRole": "string", "source": { "auth": { "resource": "string", "type": "string" }, "buildspec": "string", "location": "string", "type": "string" }, "tags": [ { "key": "string", "value": "string" } ], "timeoutInMinutes": number }

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.

Note

In the following list, the required parameters are described first.

name

The name of the build project.

Note

You cannot change a build project's name.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

artifacts

Information to be changed about the build output artifacts for the build project.

Type: ProjectArtifacts object

Required: No

description

A new or replacement description of the build project.

Type: String

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

Required: No

encryptionKey

The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format alias/alias-name ).

Type: String

Length Constraints: Minimum length of 1.

Required: No

environment

Information to be changed about the build environment for the build project.

Type: ProjectEnvironment object

Required: No

serviceRole

The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

Type: String

Length Constraints: Minimum length of 1.

Required: No

source

Information to be changed about the build input source code for the build project.

Type: ProjectSource object

Required: No

tags

The replacement set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

timeoutInMinutes

The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 480.

Required: No

Response Syntax

Copy
{ "project": { "arn": "string", "artifacts": { "location": "string", "name": "string", "namespaceType": "string", "packaging": "string", "path": "string", "type": "string" }, "created": number, "description": "string", "encryptionKey": "string", "environment": { "computeType": "string", "environmentVariables": [ { "name": "string", "value": "string" } ], "image": "string", "privilegedMode": boolean, "type": "string" }, "lastModified": number, "name": "string", "serviceRole": "string", "source": { "auth": { "resource": "string", "type": "string" }, "buildspec": "string", "location": "string", "type": "string" }, "tags": [ { "key": "string", "value": "string" } ], "timeoutInMinutes": 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

Information about the build project that was changed.

Type: Project object

Errors

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

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified AWS resource cannot be found.

HTTP Status Code: 400

See Also

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