DescribeEnvironments - AWS Cloud9


Gets information about AWS Cloud9 development environments.

Request Syntax

{ "environmentIds": [ "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 IDs of individual environments to get information about.

Type: Array of strings

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

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 environments that are returned.

Type: Array of Environment objects


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 gets information about the specified AWS Cloud9 development environments.

Sample Request

POST / HTTP/1.1 Host: cloud9.<region> Accept-Encoding: identity X-Amz-Date: <Date> Content-Length: <PayloadSizeBytes> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature> Content-Length: <PayloadSizeBytes> Content-Type: application/x-amz-json-1.1 X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironments User-Agent: <UserAgentString> { "environmentIds": [ "8d9967e2f0624182b74e7690ad69ebEX", "349c86d4579e4e7298d500ff57a6b2EX" ] }

Sample Response

HTTP/1.1 200 OK Date: <Date> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> x-amzn-RequestId: <RequestId> Connection: Keep-alive { "environments": [ { "arn": "arn:aws:cloud9:eu-west-1:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX", "description": "foo", "id": "8d9967e2f0624182b74e7690ad69ebEX", "lifecycle": { "reasonCode": "CREATE_SUCCESS", "status": "CREATED" }, "managedCredentialsStatus": "DISABLED_BY_COLLABORATOR", "name": "foo", "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", "type": "ec2" }, { "arn": "arn:aws:cloud9:eu-west-1:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX", "description": "", "id": "349c86d4579e4e7298d500ff57a6b2EX", "lifecycle": { "reasonCode": "CREATE_SUCCESS", "status": "CREATED" }, "name": "TestEnv", "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", "managedCredentialsStatus": "ENABLED_BY_OWNER", "type": "ec2" } ] }

See Also

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