Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeEnvironments

Gets information about AWS Cloud9 development environments.

Important

AWS Cloud9 is no longer available to new customers. Existing customers of AWS Cloud9 can continue to use the service as normal. Learn more"

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.

environmentIds

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.

environments

Information about the environments that are returned.

Type: Array of Environment objects

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

Examples

Example

The following example gets information about the specified AWS Cloud9 development environments.

Sample Request


POST / HTTP/1.1
Host: cloud9.<region>.amazonaws.com
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"
    }
  ]
}