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


Adds an environment member to an AWS Cloud9 development environment.

Request Syntax

{ "environmentId": "string", "permissions": "string", "userArn": "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.


The ID of the environment that contains the environment member you want to add.

Type: String

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

Required: Yes


The type of environment member permissions you want to associate with this environment member. Available values include:

  • read-only: Has read-only access to the environment.

  • read-write: Has read-write access to the environment.

Type: String

Valid Values: read-write | read-only

Required: Yes


The Amazon Resource Name (ARN) of the environment member you want to add.

Type: String

Pattern: arn:aws:(iam|sts)::\d+:(root|user|federated-user|assumed-role)\/?\S*

Required: Yes

Response Syntax

{ "membership": { "environmentId": "string", "lastAccess": number, "permissions": "string", "userArn": "string", "userId": "string" } }

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.


Information about the environment member that was added.

Type: EnvironmentMember object


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


The target request is invalid.

HTTP Status Code: 400


A conflict occurred.

HTTP Status Code: 400


An access permissions issue occurred.

HTTP Status Code: 400


An internal server error occurred.

HTTP Status Code: 500


A service limit was exceeded.

HTTP Status Code: 400


The target resource cannot be found.

HTTP Status Code: 400


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

HTTP Status Code: 400


The following example adds the specified environment member to the specified AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Type: application/x-amz-json-1.1 X-Amz-Date: 20180123T231127Z User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Target: AWSCloud9WorkspaceManagementService.CreateEnvironmentMembership Content-Length: ... Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20180123/us-east-2/cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=bb140cb4EXAMPLE { "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", "permissions": "read-write", "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser" }

Sample Response

HTTP/1.1 200 OK Date: Tue, 23 Jan 2018 23:11:30 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 186 x-amzn-RequestId: beecb831-0092-11e8-84fe-c19e871c26EX Connection: Keep-alive { "membership": { "environmentId": "8d9967e2f0624182b74e7690ad69ebEX", "permissions": "read-write", "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "userId": "AIDAJ3BA6O2FMJWCWXHEX" } }

See Also

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