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

*******************
get_upgrade_history
*******************



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

  

  Retrieves the complete history of the last 10 upgrades that were performed on the domain.

  

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


  **Request Syntax**
  ::

    response = client.get_upgrade_history(
        DomainName='string',
        MaxResults=123,
        NextToken='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).

    

  
  :type MaxResults: integer
  :param MaxResults: 

    Set this value to limit the number of results returned.

    

  
  :type NextToken: string
  :param NextToken: 

    Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

    

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

    
    ::

      {
          'UpgradeHistories': [
              {
                  'UpgradeName': 'string',
                  'StartTimestamp': datetime(2015, 1, 1),
                  'UpgradeStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
                  'StepsList': [
                      {
                          'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
                          'UpgradeStepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
                          'Issues': [
                              'string',
                          ],
                          'ProgressPercent': 123.0
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

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

      
      

      - **UpgradeHistories** *(list) --* 

        A list of ``UpgradeHistory`` objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of ``GetUpgradeHistoryResponse`` object.

        
        

        - *(dict) --* 

          History of the last 10 Upgrades and Upgrade Eligibility Checks.

          
          

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

            A string that describes the update briefly

            
          

          - **StartTimestamp** *(datetime) --* 

            UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.

            
          

          - **UpgradeStatus** *(string) --* 

            The overall status of the update. The status can take one of the following values: 

            
            * In Progress
             
            * Succeeded
             
            * Succeeded with Issues
             
            * Failed
            

            

            
          

          - **StepsList** *(list) --* 

            A list of ``UpgradeStepItem`` s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.

            
            

            - *(dict) --* 

              Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

              
              

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

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

                
                * PreUpgradeCheck
                 
                * Snapshot
                 
                * Upgrade
                

                

                
              

              - **UpgradeStepStatus** *(string) --* 

                The status of a particular step during an upgrade. The status can take one of the following values: 

                
                * In Progress
                 
                * Succeeded
                 
                * Succeeded with Issues
                 
                * Failed
                

                

                
              

              - **Issues** *(list) --* 

                A list of strings containing detailed information about the errors encountered in a particular step.

                
                

                - *(string) --* 
            
              

              - **ProgressPercent** *(float) --* 

                The Floating point value representing progress percentage of a particular step.

                
          
        
      
    
      

      - **NextToken** *(string) --* 

        Pagination token that needs to be supplied to the next call to get the next page of results

        
  
  **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`

  