AWS Cloud9

(1)

AWS Cloud9

API Reference

API Version 2017-09-23

(2)

AWS Cloud9: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

For more information about AWS Cloud9, see the AWS Cloud9 User Guide.

AWS Cloud9 supports these operations:

• CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.

• CreateEnvironmentMembership: Adds an environment member to an environment.

• DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

• DeleteEnvironmentMembership: Deletes an environment member from an environment.

• DescribeEnvironmentMemberships: Gets information about environment members for an environment.

• DescribeEnvironments: Gets information about environments.

• DescribeEnvironmentStatus: Gets status information for an environment.

• ListEnvironments: Gets a list of environment identiﬁers.

• ListTagsForResource: Gets the tags for an environment.

• TagResource: Adds tags to an environment.

• UntagResource: Removes tags from an environment.

• UpdateEnvironment: Changes the settings of an existing environment.

• UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.

This document was last published on March 6, 2022.

(7)

Actions

The following actions are supported:

• CreateEnvironmentEC2 (p. 3)

• CreateEnvironmentMembership (p. 9)

• DeleteEnvironment (p. 13)

• DeleteEnvironmentMembership (p. 16)

• DescribeEnvironmentMemberships (p. 19)

• DescribeEnvironments (p. 25)

• DescribeEnvironmentStatus (p. 29)

• ListEnvironments (p. 32)

• ListTagsForResource (p. 35)

• TagResource (p. 38)

• UntagResource (p. 41)

• UpdateEnvironment (p. 44)

• UpdateEnvironmentMembership (p. 47)

(8)

CreateEnvironmentEC2

Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

Request Syntax

{

"automaticStopTimeMinutes": number, "clientRequestToken": "string", "connectionType": "string", "description": "string", "dryRun": boolean, "imageId": "string", "instanceType": "string", "name": "string",

"ownerArn": "string", "subnetId": "string", "tags": [

{

"Key": "string", "Value": "string"

} ]}

Request Parameters

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

The request accepts the following data in JSON format.

automaticStopTimeMinutes (p. 3)

The number of minutes until the running instance is shut down after the environment has last been used.

Type: Integer

Valid Range: Maximum value of 20160.

Required: No

clientRequestToken (p. 3)

A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.

For more information, see Client Tokens in the Amazon EC2 API Reference.

Type: String

Pattern: [\x20-\x7E]{10,128}

Required: No connectionType (p. 3)

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).

(9)

Request Parameters

For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the AWS Cloud9 User Guide.

Type: String

Valid Values: CONNECT_SSH | CONNECT_SSM Required: No

description (p. 3)

The description of the environment to create.

Type: String

Length Constraints: Maximum length of 200.

Required: No dryRun (p. 3)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean Required: No imageId (p. 3)

The identiﬁer for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path.

The default Amazon Linux AMI is currently used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.

From July 1, 2022, the parameter for Amazon Linux will no longer be available when you specify an AMI for your instance. Amazon Linux 2 will then become the default AMI, which is used to launch your instance if no parameter is explicity deﬁned.

AMI aliases

• Amazon Linux (default): amazonlinux-1-x86_64

• Amazon Linux 2: amazonlinux-2-x86_64

• Ubuntu 18.04: ubuntu-18.04-x86_64 SSM paths

• Amazon Linux (default): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1- x86_64

• Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64

• Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64 Type: String

Required: No instanceType (p. 3)

The type of instance to connect to the environment (for example, t2.micro).

(10)

Response Syntax

Type: String

Length Constraints: Minimum length of 5. Maximum length of 20.

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

Required: Yes name (p. 3)

The name of the environment to create.

This name is visible to other IAM users in the same AWS account.

Type: String

Required: Yes ownerArn (p. 3)

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any IAM principal. If this value is not speciﬁed, the ARN defaults to this environment's creator.

Type: String

(user\/[\w+=/:,.@-]{1,64}|federated-user\/[\w+=/:,.@-]{2,32}|assumed-role\/

[\w+=:,.@-]{1,64}\/[\w+=,.@-]{1,64}))$

Required: No subnetId (p. 3)

The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.

Type: String

Pattern: ^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$

Required: No tags (p. 3)

An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.

Type: Array of Tag (p. 57) objects

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

Required: No

Response Syntax

{ "environmentId": "string"

(11)

Response Elements

}

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.

environmentId (p. 5)

The ID of the environment that was created.

Type: String

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

Errors

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

BadRequestException

The target request is invalid.

HTTP Status Code: 400 ConﬂictException

A conﬂict 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

(12)

Examples

Example

The following example creates an AWS Cloud9 development environment with the speciﬁed settings.

Sample Request

POST / HTTP/1.1

Host: cloud9.us-east-2.amazonaws.com Accept-Encoding: identity

Content-Type: application/x-amz-json-1.1

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Date: 20180123T224817Z

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=6d4c1a32EXAMPLE

X-Amz-Target: AWSCloud9WorkspaceManagementService.CreateEnvironmentEC2 { "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser",

"name": "my-demo-environment", "automaticStopTimeMinutes": 60,

"description": "This is my demonstration environment.", "instanceType": "t2.micro",

"imageId": "resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64", "subnetId": "subnet-6300cd1b"

}

Sample Response

HTTP/1.1 200 OK

Date: Tue, 23 Jan 2018 22:48:20 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 52

x-amzn-RequestId: 814f962e-008f-11e8-9a37-1ba143abb2EX Connection: Keep-alive

{ "environmentId": "8d9967e2f0624182b74e7690ad69ebEX"

}

CreateEnvironmentMembership

Adds an environment member to an AWS Cloud9 development environment.

Request Syntax

{

"environmentId": "string", "permissions": "string", "userArn": "string"

}

Request Parameters

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 permissions (p. 9)

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

userArn (p. 9)

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

Type: String

[\w+=:,.@-]{1,64}\/[\w+=,.@-]{1,64}))$

Required: Yes

Response Syntax

{

(15)

Response Elements

"membership": {

"environmentId": "string", "lastAccess": number, "permissions": "string", "userArn": "string", "userId": "string"

}}

Response Elements

membership (p. 9)

Information about the environment member that was added.

Type: EnvironmentMember (p. 55) object

Errors

(16)

Examples

Example

The following example adds the speciﬁed environment member to the speciﬁed AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

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: ...

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

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"

} }

DeleteEnvironment

Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

Request Syntax

{

"environmentId": "string"

}

Request Parameters

The ID of the environment to delete.

Type: String

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

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

(19)

Examples

Example

The following example deletes the speciﬁed AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=25619c96EXAMPLE

X-Amz-Target: AWSCloud9WorkspaceManagementService.DeleteEnvironment User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Date: 20180123T232227Z

Content-Type: application/x-amz-json-1.1 Content-Length: 53

{

"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"

}

Sample Response

HTTP/1.1 200 OK

x-amzn-RequestId: 47682ed5-0094-11e8-9118-55255722b4EX Connection: Keep-alive

{}

DeleteEnvironmentMembership

Deletes an environment member from a development environment.

Request Syntax

{

"environmentId": "string", "userArn": "string"

}

Request Parameters

The ID of the environment to delete the environment member from.

Type: String

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

Required: Yes userArn (p. 16)

The Amazon Resource Name (ARN) of the environment member to delete from the environment.

Type: String

[\w+=:,.@-]{1,64}\/[\w+=,.@-]{1,64}))$

Required: Yes

Response Elements

Errors

(22)

Examples

Example

The following example deletes the speciﬁed environment member from the speciﬁed AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

X-Amz-Target: AWSCloud9WorkspaceManagementService.DeleteEnvironmentMembership User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=3c6bbcb8EXAMPLE

Content-Length: ...

{ "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "environmentId": "8d9967e2f0624182b74e7690ad69ebEX"

}

Sample Response

HTTP/1.1 200 OK

Date: Tue, 23 Jan 2018 23:20:00 GMT

(23)

See Also

Content-Type: application/x-amz-json-1.1 Content-Length: 2

x-amzn-RequestId: eef3d67a-0093-11e8-a800-95fabd28ffEX Connection: Keep-alive

{}

DescribeEnvironmentMemberships

Gets information about environment members for an AWS Cloud9 development environment.

Request Syntax

{ "environmentId": "string", "maxResults": number, "nextToken": "string", "permissions": [ "string" ], "userArn": "string"

}

Request Parameters

The ID of the environment to get environment member information about.

Type: String

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

Required: No maxResults (p. 19)

The maximum number of environment members to get information about.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 25.

Required: No nextToken (p. 19)

During a previous call, if there are more than 25 items in the list, only the ﬁrst 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Type: String Required: No permissions (p. 19)

The type of environment member permissions to get information about. Available values include:

• owner: Owns the environment.

(25)

Response Syntax

If no value is speciﬁed, information about all environment members are returned.

Type: Array of strings

Valid Values: owner | read-write | read-only Required: No

userArn (p. 19)

The Amazon Resource Name (ARN) of an individual environment member to get information about.

If no value is speciﬁed, information about all environment members are returned.

Type: String

[\w+=:,.@-]{1,64}\/[\w+=,.@-]{1,64}))$

Required: No

Response Syntax

{

"memberships": [ {

} ],

"nextToken": "string"

}

Response Elements

memberships (p. 20)

Information about the environment members for the environment.

Type: Array of EnvironmentMember (p. 55) objects nextToken (p. 20)

If there are more than 25 items in the list, only the ﬁrst 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

Type: String

Errors

(26)

Examples

Get environment members for a development environment

The following example gets information about all of the environment members for the speciﬁed AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironmentMemberships Content-Type: application/x-amz-json-1.1

X-Amz-Date: 20180123T231253Z

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=50dbf72dEXAMPLE

Content-Length: 53

(27)

Examples

{

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa"

}

Sample Response

HTTP/1.1 200 OK

x-amzn-RequestId: f1680001-0092-11e8-a65b-093e8a557dEX connection: Keep-alive

{ "memberships": [ {

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa", "permissions": "read-write",

"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "userId": "ABCDEFGHIJKLMNOPQRSTU"

}, {

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa", "permissions": "owner",

"userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "userId": "ABCDEFGHIJKLMNOPQRSTU"

} ]}

Get the owner of a development environment

The following example gets information about the owner of the speciﬁed AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Date: 20180123T231350Z

X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironmentMemberships Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20180123/us-east-2/

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=94ccc4d0EXAMPLE

Content-Length: 79 { "permissions": [ "owner"

],

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa"

}

Sample Response

HTTP/1.1 200 OK

Date: Tue, 23 Jan 2018 23:13:51 GMT

(28)

Examples

Content-Type: application/x-amz-json-1.1 Content-Length: ...

x-amzn-RequestId: 13328344-0093-11e8-9118-55255722b4EX Connection: Keep-alive

{

"memberships": [ {

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa", "permissions": "owner",

"userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "userId": "ABCDEFGHIJKLMNOPQRSTU"

} ] }

Get Development Environment Memberships for a User

The following example gets AWS Cloud9 development environment membership information for the speciﬁed user.

Sample Request

POST / HTTP/1.1

X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironmentMemberships X-Amz-Date: 20180123T231447Z

Authorization: AWS4-HMAC-SHA256 Credential=XXXXXXXXEXAMPLE/XXXXXXXX/us-east-2/

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=XXXXXXXXEXAMPLE

Content-Length: 55

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 { "userArn": "arn:aws:iam::123456789012:user/MyDemoUser"

}

Sample Response

HTTP/1.1 200 OK

x-amzn-RequestId: 34d50be5-0093-11e8-a7e1-d3b8935decEX Connection: Keep-alive

{ "memberships": [ {

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa", "lastAccess": 1.516403173E9,

"permissions": "owner",

"userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "userId": "XXXXXXXXXXXXXXXXXX"

}, {

"environmentId": "9999aaaa9999aaaa9999aaaa9999aaaa", "lastAccess": 1.516405159E9,

"permissions": "owner",

"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",

(29)

See Also

"userId": "ABCDEFGHIJKLMNOPQRSTUV"

} ]}

DescribeEnvironments

Gets information about AWS Cloud9 development environments.

Request Syntax

{

"environmentIds": [ "string" ] }

Request Parameters

environmentIds (p. 25)

The IDs of individual environments to get information about.

Array Members: Minimum number of 1 item. Maximum number of 25 items.

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

Required: Yes

Response Syntax

{ "environments": [ {

"arn": "string",

"connectionType": "string", "description": "string", "id": "string",

"lifecycle": {

"failureResource": "string", "reason": "string",

"status": "string"

},

"managedCredentialsStatus": "string", "name": "string",

"ownerArn": "string", "type": "string"

} ] }

Response Elements

(31)

Errors

environments (p. 25)

Information about the environments that are returned.

Type: Array of Environment (p. 52) objects

Errors

Examples

Example

The following example gets information about the speciﬁed AWS Cloud9 development environments.

Sample Request

POST / HTTP/1.1

(32)

See Also

X-Amz-Date: 20180123T225030Z Content-Length: 92

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=ca32a303EXAMPLE

X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironments User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 { "environmentIds": [

"8d9967e2f0624182b74e7690ad69ebEX", "349c86d4579e4e7298d500ff57a6b2EX"

] }

Sample Response

HTTP/1.1 200 OK

Date: Tue, 23 Jan 2018 22:50:31 GMT Content-Type: application/x-amz-json-1.1 Content-Length: ...

x-amzn-RequestId: d06763f8-008f-11e8-801f-9b144f0315EX Connection: Keep-alive

{"environments":

[ {"arn": "arn:aws:cloud9:eu-

west-1:5***********:environment:d27b18648f174491be6cc6777f1ee66c", "description": "foo",

"id": "d27b18648f174491be6cc6777f1ee66c",

"ideTemplateId": "cee38068079f4d399cbab9ecc9f955c2", "lifecycle":

{"reasonCode": "CREATE_SUCCESS", "status": "CREATED"},

"managedCredentialsStatus": "DISABLED_BY_COLLABORATOR", "name": "foo",

"ownerArn": "arn:aws:iam::5***********:user/usname", "type": "ec2"},

{"arn": "arn:aws:cloud9:eu-

west-1:516690746032:environment:588b0e9bc3134815a4f090b4cca49e84", "description": "",

"id": "588b0e9bc3134815a4f090b4cca49e84",

"ideTemplateId": "cee38068079f4d399cbab9ecc9f955c2", "lifecycle":

{"reasonCode": "CREATE_SUCCESS", "status": "CREATED"},

"name": "TestEnv",

"ownerArn": "arn:aws:iam::XXXXXXXXXXXX:user/USERNAME", "managedCredentialsStatus": "ENABLED_BY_OWNER", "type": "ec2"}

]}

DescribeEnvironmentStatus

Gets status information for an AWS Cloud9 development environment.

Request Syntax

{ "environmentId": "string"

}

Request Parameters

The ID of the environment to get status information about.

Type: String

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

Required: Yes

Response Syntax

{ "message": "string", "status": "string"

}

Response Elements

message (p. 29)

Any informational message about the status of the environment.

Type: String status (p. 29)

The status of the environment. Available values include:

• connecting: The environment is connecting.

• creating: The environment is being created.

• deleting: The environment is being deleted.

• error: The environment is in an error state.

(35)

Errors

• ready: The environment is ready.

• stopped: The environment is stopped.

• stopping: The environment is stopping.

Type: String

Errors

Examples

Example

The following example gets status information about the speciﬁed AWS Cloud9 development environment.

(36)

See Also

Sample Request

POST / HTTP/1.1

X-Amz-Date: 20180123T225304Z

X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironmentStatus User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=5e458ca5EXAMPLE

Content-Length: 53

Content-Type: application/x-amz-json-1.1 {

}

Sample Response

HTTP/1.1 200 OK

x-amzn-RequestId: 2cd6dfae-0090-11e8-a542-51fd7a14e1EX Connection: Keep-alive

{

"message": "Environment is ready to use", "status": "ready"

}

ListEnvironments

Gets a list of AWS Cloud9 development environment identiﬁers.

Request Syntax

{

"maxResults": number, "nextToken": "string"

}

Request Parameters

maxResults (p. 32)

The maximum number of environments to get identiﬁers for.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 25.

Required: No nextToken (p. 32)

During a previous call, if there are more than 25 items in the list, only the ﬁrst 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Type: String Required: No

Response Syntax

{ "environmentIds": [ "string" ], "nextToken": "string"

}

Response Elements

environmentIds (p. 32)

The list of environment identiﬁers.

(38)

Errors

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

nextToken (p. 32)

If there are more than 25 items in the list, only the ﬁrst 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

Type: String

Errors

Examples

Example

The following example gets the IDs of available AWS Cloud9 development environments.

(39)

See Also

Sample Request

POST / HTTP/1.1

X-Amz-Target: AWSCloud9WorkspaceManagementService.ListEnvironments

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=17a00c64EXAMPLE

X-Amz-Date: 20180123T223531Z

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 Content-Type: application/x-amz-json-1.1

Content-Length: 2 {}

Sample Response

HTTP/1.1 200 OK

x-amzn-RequestId: b9b13fd3-008d-11e8-a65b-093e8a557dEX Connection: Keep-alive

{

"environmentIds": [

"349c86d4579e4e7298d500ff57a6b2EX", "45a3da47af0840f2b0c0824f5ee232EX"

]}

ListTagsForResource

Gets a list of the tags associated with an AWS Cloud9 development environment.

Request Syntax

{

"ResourceARN": "string"

}

Request Parameters

ResourceARN (p. 35)

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to get the tags for.

Type: String

Pattern: arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):cloud9:([a-z]{2}-[a- z]+-\d{1}):[0-9]{12}:environment:[a-zA-Z0-9]{8,32}

Required: Yes

Response Syntax

{ "Tags": [ {

} ] }

Response Elements

Tags (p. 35)

The list of tags associated with the AWS Cloud9 development environment.

(41)

Errors

Examples

Example

The following example shows now to get a list of the tags that are associated with an AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

Host: cloud9.eu-west-1.amazonaws.com Accept-Encoding: identity

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Target: AWSCloud9WorkspaceManagementService.ListTagsForResource Content-Length: ...

Authorization: AWS4-HMAC-SHA256 Credential=AKIAJ32OEXAMPLE/20191218/eu-west-1/

{ "ResourceARN": "arn:aws:cloud9:eu-

west-1:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", }

Sample Response

HTTP/1.1 200 OK

Date: Wed, 18 Dec 2019 23:11:30 GMT Content-Type: application/x-amz-json-1.1 Content-Length: ...

{ "Tags":

[ {"Key": "key",

(42)

See Also

"Value": "orange"}

]}

TagResource

Adds tags to an AWS Cloud9 development environment.

Important

Tags that you add to an AWS Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.

Request Syntax

{ "ResourceARN": "string", "Tags": [

{

} ] }

Request Parameters

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to add tags to.

Type: String

Required: Yes Tags (p. 38)

The list of tags to add to the given AWS Cloud9 development environment.

Required: Yes

Response Elements

Errors

(44)

Examples

HTTP Status Code: 400 ConcurrentAccessException

A concurrent access issue occurred.

Examples

Example

The following example shows how to add tags to an AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Target: AWSCloud9WorkspaceManagementService.TagResource Content-Length: ...

west-1:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", "Tags":

[

{"Key": "key", "Value": "orange"}

]}

Sample Response

HTTP/1.1 200 OK

(45)

See Also

{}

UntagResource

Removes tags from an AWS Cloud9 development environment.

Request Syntax

{

"ResourceARN": "string", "TagKeys": [ "string" ] }

Request Parameters

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.

Type: String

Required: Yes TagKeys (p. 41)

The tag names of the tags to remove from the given AWS Cloud9 development environment.

Required: Yes

Response Elements

Errors

(47)

Examples

ConcurrentAccessException

A concurrent access issue occurred.

Examples

Example

The following example shows how to remove tags from an AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 X-Amz-Target: AWSCloud9WorkspaceManagementService.UntagResource Content-Length: ...

west-1:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", "TagKeys":

["key"]

}

Sample Response

HTTP/1.1 200 OK

{}

UpdateEnvironment

Changes the settings of an existing AWS Cloud9 development environment.

Request Syntax

{ "description": "string", "environmentId": "string",

"managedCredentialsAction": "string", "name": "string"

}

Request Parameters

description (p. 44)

Any new or replacement description for the environment.

Type: String

Required: No environmentId (p. 44)

The ID of the environment to change settings.

Type: String

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

Required: Yes

managedCredentialsAction (p. 44)

Allows the environment owner to turn on or turn oﬀ the AWS managed temporary credentials for an AWS Cloud9 environment by using one of the following values:

• ENABLE

• DISABLE

NoteOnly the environment owner can change the status of managed temporary credentials.

An AccessDeniedException is thrown if an attempt to turn on or turn oﬀ managed temporary credentials is made by an account that's not the environment owner.

Type: String

Valid Values: ENABLE | DISABLE Required: No

name (p. 44)

A replacement name for the environment.

(50)

Response Elements

Type: String

Required: No

Response Elements

Errors

Examples

Example

The following example changes information about the speciﬁed AWS Cloud9 development environment.

(51)

See Also

Sample Request

POST / HTTP/1.1

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

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

x-amzn-RequestId: 26985f72-0094-11e8-abf2-0b9c8171c5EX Connection: Keep-alive

{}

UpdateEnvironmentMembership

Changes the settings of an existing environment member for an AWS Cloud9 development environment.

Request Syntax

{

"environmentId": "string", "permissions": "string", "userArn": "string"

}

Request Parameters

The ID of the environment for the environment member whose settings you want to change.

Type: String

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

Required: Yes permissions (p. 47)

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

Type: String

Valid Values: read-write | read-only Required: Yes

userArn (p. 47)

The Amazon Resource Name (ARN) of the environment member whose settings you want to change.

Type: String

[\w+=:,.@-]{1,64}\/[\w+=,.@-]{1,64}))$

Required: Yes

Response Syntax

{

(53)

Response Elements

"membership": {

}}

Response Elements

membership (p. 47)

Information about the environment member whose settings were changed.

Type: EnvironmentMember (p. 55) object

Errors

(54)

Examples

Example

The following example changes membership status of the speciﬁed environment member for the speciﬁed AWS Cloud9 development environment.

Sample Request

POST / HTTP/1.1

cloud9/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=f65b7aadEXAMPLE

User-Agent: aws-cli/1.14.29 Python/3.5.2 Windows/10 botocore/1.8.33 Content-Length: 142

X-Amz-Target: AWSCloud9WorkspaceManagementService.UpdateEnvironmentMembership X-Amz-Date: 20180123T231840Z

{ "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "permissions": "read-only",

}

Sample Response

HTTP/1.1 200 OK

x-amzn-RequestId: c015da39-0093-11e8-87b5-3915a8b12eEX Connection: Keep-alive

{ "membership": {

"environmentId": "8d9967e2f0624182b74e7690ad69eb31", "permissions": "read-only",

"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "userId": "AIDAJ3BA6O2FMJWCWXHEX"

} }

Data Types

The AWS Cloud9 API contains several data types that various actions use. This section describes each data type in detail.

Note

The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:

• Environment (p. 52)

• EnvironmentLifecycle (p. 54)

• EnvironmentMember (p. 55)

• Tag (p. 57)

(57)

Environment

Information about an AWS Cloud9 development environment.

AWS Cloud9

AWS Cloud9

API Reference

API Version 2017-09-23

AWS Cloud9: API Reference

Table of Contents

Welcome

Actions

CreateEnvironmentEC2

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

CreateEnvironmentMembership

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

DeleteEnvironment

Request Syntax

Request Parameters

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

DeleteEnvironmentMembership

Request Syntax

Request Parameters

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

DescribeEnvironmentMemberships

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Get environment members for a development environment

Sample Request

Sample Response

Get the owner of a development environment

Sample Request

Sample Response

Get Development Environment Memberships for a User

Sample Request

Sample Response

See Also

DescribeEnvironments

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Example

Sample Request

Sample Response

See Also

DescribeEnvironmentStatus

Request Syntax