AWS Cloud9

{'environments': {'lifecycle': {'status': {'CREATE_FAILED', 'CREATING'}}}}

Gets information about AWS Cloud9 development environments.

See also: AWS API Documentation

Request Syntax

client.describe_environments(
    environmentIds=[
        'string',
    ]
)

type environmentIds

list

param environmentIds

[REQUIRED]

The IDs of individual environments to get information about.

• (string) --

rtype

dict

returns

Response Syntax

{
    'environments': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'type': 'ssh'|'ec2',
            'arn': 'string',
            'ownerArn': 'string',
            'lifecycle': {
                'status': 'CREATING'|'CREATED'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED',
                'reason': 'string',
                'failureResource': 'string'
            }
        },
    ]
}

Response Structure

• (dict) --

  • environments (list) --

    Information about the environments that are returned.

    • (dict) --

      Information about an AWS Cloud9 development environment.

      • id (string) --

        The ID of the environment.

      • name (string) --

        The name of the environment.

      • description (string) --

        The description for the environment.

      • type (string) --

        The type of environment. Valid values include the following:

        • ec2 : An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.

        • ssh : Your own server connects to the environment.

      • arn (string) --

        The Amazon Resource Name (ARN) of the environment.

      • ownerArn (string) --

        The Amazon Resource Name (ARN) of the environment owner.

      • lifecycle (dict) --

        The state of the environment in its creation or deletion lifecycle.

        • status (string) --

          The current creation or deletion lifecycle state of the environment.

          • CREATING : The environment is in the process of being created.

          • CREATED : The environment was successfully created.

          • CREATE_FAILED : The environment failed to be created.

          • DELETING : The environment is in the process of being deleted.

          • DELETE_FAILED : The environment failed to delete.

        • reason (string) --

          Any informational message about the lifecycle state of the environment.

        • failureResource (string) --

          If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.