Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14136955.8 KB

Gets status information for an Cloud9 development environment.

post/#X-Amz-Target=AWSCloud9WorkspaceManagementService.DescribeEnvironmentStatus

Headers

X-Amz-Target'AWSCloud9WorkspaceManagementService.DescribeEnvironmentStatus' required

Request body

environmentIdstring required

The ID of the environment to get status information about.

Response

Success

status'error' | 'creating' | 'connecting' | 'ready' | 'stopping' | 'stopped' | 'deleting' required
<p>The status of the environment. Available values include:</p> <ul> <li> <p> <code>connecting</code>: The environment is connecting.</p> </li> <li> <p> <code>creating</code>: The environment is being created.</p> </li> <li> <p> <code>deleting</code>: The environment is being deleted.</p> </li> <li> <p> <code>error</code>: The environment is in an error state.</p> </li> <li> <p> <code>ready</code>: The environment is ready.</p> </li> <li> <p> <code>stopped</code>: The environment is stopped.</p> </li> <li> <p> <code>stopping</code>: The environment is stopping.</p> </li> </ul>
messagestring required

Any informational message about the status of the environment.

Example response

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