:doc:`OpenSearchService <../../opensearch>` / Client / get_upgrade_history

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



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

  

  Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-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 existing domain.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use ``nextToken`` to get the next page of results.

    

  
  :type NextToken: string
  :param NextToken: 

    If your initial ``GetUpgradeHistory`` operation returns a ``nextToken``, you can include the returned ``nextToken`` in subsequent ``GetUpgradeHistory`` operations, which returns results in the next page.

    

  
  
  :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 the response returned by the ``GetUpgradeHistory`` operation.

      
      

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

        A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

        
        

        - *(dict) --* 

          History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

          
          

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

            A string that describes the upgrade.

            
          

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

            UTC timestamp at which the upgrade API call was made, in the format ``yyyy-MM-ddTHH:mm:ssZ``.

            
          

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

            The current status of the upgrade. The status can take one of the following values:

             

            
            * In Progress
             
            * Succeeded
             
            * Succeeded with Issues
             
            * Failed
            

            
          

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

            A list of each step performed as part of a specific upgrade or upgrade eligibility check.

            
            

            - *(dict) --* 

              Represents a single step of an upgrade or upgrade eligibility check workflow.

              
              

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

                One of three steps that an upgrade or upgrade eligibility check goes through:

                 

                
                * PreUpgradeCheck
                 
                * Snapshot
                 
                * Upgrade
                

                
              

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

                The current status of the 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 the progress percentage of a particular step.

                
          
        
      
    
      

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

        When ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

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

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

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

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

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

  