DescribeEnvironmentStatus
Gets status information for an AWS Cloud9 development environment.
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
{
"environmentId": "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.
- environmentId
-
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
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- message
-
Any informational message about the status of the environment.
Type: String
- status
-
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. -
ready: The environment is ready. -
stopped: The environment is stopped. -
stopping: The environment is stopping.
Type: String
Valid Values:
error | creating | connecting | ready | stopping | stopped | deleting -
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 status information about the specified AWS Cloud9 development environment.
Sample Request
POST / HTTP/1.1
Host: cloud9.<region>.amazonaws.com
Accept-Encoding: identity
X-Amz-Date: <Date>
X-Amz-Target: AWSCloud9WorkspaceManagementService.DescribeEnvironmentStatus
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
Content-Type: application/x-amz-json-1.1
{
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
}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
{
"message": "Environment is ready to use",
"status": "ready"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
