:doc:`ElasticsearchService <../../es>` / Paginator / GetUpgradeHistory

*****************
GetUpgradeHistory
*****************



.. py:class:: ElasticsearchService.Paginator.GetUpgradeHistory

  ::

    
    paginator = client.get_paginator('get_upgrade_history')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElasticsearchService.Client.get_upgrade_history`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DomainName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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
                        },
                    ]
                },
            ],
            
        }
        
      **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.

                  
            
          
        
      
    