:doc:`Cloud9 <../../cloud9>` / Client / describe_environment_status

***************************
describe_environment_status
***************************



.. py:method:: Cloud9.Client.describe_environment_status(**kwargs)

  

  Gets status information for an Cloud9 development environment.

   

  .. warning::

     

    Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. `Learn more" <http://aws.amazon.com/blogs/devops/how-to-migrate-from-aws-cloud9-to-aws-ide-toolkits-or-aws-cloudshell/>`__

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloud9-2017-09-23/DescribeEnvironmentStatus>`_  


  **Request Syntax**
  ::

    response = client.describe_environment_status(
        environmentId='string'
    )
    
  :type environmentId: string
  :param environmentId: **[REQUIRED]** 

    The ID of the environment to get status information about.

    

  
  
  :rtype: 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**
  
  *   :py:class:`Cloud9.Client.exceptions.BadRequestException`

  
  *   :py:class:`Cloud9.Client.exceptions.ConflictException`

  
  *   :py:class:`Cloud9.Client.exceptions.NotFoundException`

  
  *   :py:class:`Cloud9.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Cloud9.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`Cloud9.Client.exceptions.LimitExceededException`

  
  *   :py:class:`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': {
            '...': '...',
        },
    }

  