:doc:`ElasticsearchService <../../es>` / Client / get_upgrade_status

******************
get_upgrade_status
******************



.. py:method:: ElasticsearchService.Client.get_upgrade_status(**kwargs)

  

  Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/es-2015-01-01/GetUpgradeStatus>`_  


  **Request Syntax**
  ::

    response = client.get_upgrade_status(
        DomainName='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
          'StepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
          'UpgradeName': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Container for response returned by ``GetUpgradeStatus`` operation.

      
      

      - **UpgradeStep** *(string) --* 

        Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: 

        
        * PreUpgradeCheck
         
        * Snapshot
         
        * Upgrade
        

        

        
      

      - **StepStatus** *(string) --* 

        One of 4 statuses that a step can go through returned as part of the ``GetUpgradeStatusResponse`` object. The status can take one of the following values: 

        
        * In Progress
         
        * Succeeded
         
        * Succeeded with Issues
         
        * Failed
        

        

        
      

      - **UpgradeName** *(string) --* 

        A string that describes the update briefly

        
  
  **Exceptions**
  
  *   :py:class:`ElasticsearchService.Client.exceptions.BaseException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.DisabledOperationException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.ValidationException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.InternalException`

  