:doc:`CloudHSM <../../cloudhsm>` / Client / describe_hapg

*************
describe_hapg
*************



.. py:method:: CloudHSM.Client.describe_hapg(**kwargs)

  

  This is documentation for **AWS CloudHSM Classic**. For more information, see `AWS CloudHSM Classic FAQs <http://aws.amazon.com/cloudhsm/faqs-classic/>`__, the `AWS CloudHSM Classic User Guide <https://docs.aws.amazon.com/cloudhsm/classic/userguide/>`__, and the `AWS CloudHSM Classic API Reference <https://docs.aws.amazon.com/cloudhsm/classic/APIReference/>`__.

   

  **For information about the current version of AWS CloudHSM**, see `AWS CloudHSM <http://aws.amazon.com/cloudhsm/>`__, the `AWS CloudHSM User Guide <https://docs.aws.amazon.com/cloudhsm/latest/userguide/>`__, and the `AWS CloudHSM API Reference <https://docs.aws.amazon.com/cloudhsm/latest/APIReference/>`__.

   

  Retrieves information about a high-availability partition group.

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeHapg>`_  


  **Request Syntax**
  ::

    response = client.describe_hapg(
        HapgArn='string'
    )
    
  :type HapgArn: string
  :param HapgArn: **[REQUIRED]** 

    The ARN of the high-availability partition group to describe.

    

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

    
    ::

      {
          'HapgArn': 'string',
          'HapgSerial': 'string',
          'HsmsLastActionFailed': [
              'string',
          ],
          'HsmsPendingDeletion': [
              'string',
          ],
          'HsmsPendingRegistration': [
              'string',
          ],
          'Label': 'string',
          'LastModifiedTimestamp': 'string',
          'PartitionSerialList': [
              'string',
          ],
          'State': 'READY'|'UPDATING'|'DEGRADED'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Contains the output of the  DescribeHapg action.

      
      

      - **HapgArn** *(string) --* 

        The ARN of the high-availability partition group.

        
      

      - **HapgSerial** *(string) --* 

        The serial number of the high-availability partition group.

        
      

      - **HsmsLastActionFailed** *(list) --* 
        

        - *(string) --* 

          An ARN that identifies an HSM.

          
    
      

      - **HsmsPendingDeletion** *(list) --* 
        

        - *(string) --* 

          An ARN that identifies an HSM.

          
    
      

      - **HsmsPendingRegistration** *(list) --* 
        

        - *(string) --* 

          An ARN that identifies an HSM.

          
    
      

      - **Label** *(string) --* 

        The label for the high-availability partition group.

        
      

      - **LastModifiedTimestamp** *(string) --* 

        The date and time the high-availability partition group was last modified.

        
      

      - **PartitionSerialList** *(list) --* 

        The list of partition serial numbers that belong to the high-availability partition group.

        
        

        - *(string) --* 
    
      

      - **State** *(string) --* 

        The state of the high-availability partition group.

        
  
  **Exceptions**
  
  *   :py:class:`CloudHSM.Client.exceptions.CloudHsmServiceException`

  
  *   :py:class:`CloudHSM.Client.exceptions.CloudHsmInternalException`

  
  *   :py:class:`CloudHSM.Client.exceptions.InvalidRequestException`

  