Menu
AWS Cloud9
API Reference (API Version 2017-09-23)

UpdateEnvironment

Changes the settings of an existing AWS Cloud9 development environment.

Request Syntax

{ "description": "string", "environmentId": "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

Any new or replacement description for the environment.

Type: String

Length Constraints: Maximum length of 200.

Required: No

environmentId

The ID of the environment to change settings.

Type: String

Pattern: ^[a-zA-Z0-9]{8,32}$

Required: Yes

name

A replacement name for the environment.

Type: String

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

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.

BadRequestException

The target request is invalid.

HTTP Status Code: 400

ConflictException

A conflict occurred.

HTTP Status Code: 400

ForbiddenException

An access permissions issue occurred.

HTTP Status Code: 400

InternalServerErrorException

An internal server error occurred.

HTTP Status Code: 500

LimitExceededException

A service limit was exceeded.

HTTP Status Code: 400

NotFoundException

The target resource cannot be found.

HTTP Status Code: 400

TooManyRequestsException

Too many service requests were made over the given time period.

HTTP Status Code: 400

Example

The following example changes information about the specified AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1 Host: cloud9.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 140 X-Amz-Date: 20180123T232132Z User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Target: AWSCloud9WorkspaceManagementService.UpdateEnvironment Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20180123/us-east-2/cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=280d6dbaEXAMPLE Content-Type: application/x-amz-json-1.1 { "name": "my-changed-demo-environment", "description": "This is my changed demonstration environment.", "environmentId": "8d9967e2f0624182b74e7690ad69ebEX" }

Sample Response

HTTP/1.1 200 OK Date: Tue, 23 Jan 2018 23:21:33 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 2 x-amzn-RequestId: 26985f72-0094-11e8-abf2-0b9c8171c5EX Connection: Keep-alive {}

See Also

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