describe_environment_status

Cloud9.Client.describe_environment_status(**kwargs)

Gets status information for an Cloud9 development environment.

See also: AWS API Documentation

Request Syntax

response = client.describe_environment_status(
    environmentId='string'
)

Parameters

environmentId (string) --

[REQUIRED]

The ID of the environment to get status information about.

Return type

dict

Returns

Response Syntax

{
    'status': 'error'|'creating'|'connecting'|'ready'|'stopping'|'stopped'|'deleting',
    'message': 'string'
}

Response Structure

• (dict) --
  • status (string) --

    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.
  • message (string) --

    Any informational message about the status of the environment.

Exceptions

• Cloud9.Client.exceptions.BadRequestException
• Cloud9.Client.exceptions.ConflictException
• Cloud9.Client.exceptions.NotFoundException
• Cloud9.Client.exceptions.ForbiddenException
• Cloud9.Client.exceptions.TooManyRequestsException
• Cloud9.Client.exceptions.LimitExceededException
• Cloud9.Client.exceptions.InternalServerErrorException

Examples

response = client.describe_environment_status(
    environmentId='8d9967e2f0624182b74e7690ad69ebEX',
)

print(response)

Expected Output:

{
    'message': 'Environment is ready to use',
    'status': 'ready',
    'ResponseMetadata': {
        '...': '...',
    },
}