:doc:`SSM <../../ssm>` / Client / describe_patch_properties

*************************
describe_patch_properties
*************************



.. py:method:: SSM.Client.describe_patch_properties(**kwargs)

  

  Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as  CreatePatchBaseline,  UpdatePatchBaseline,  DescribeAvailablePatches, and  DescribePatchBaselines.

   

  The following section lists the properties that can be used in filters for each major operating system type:

    AMAZON_LINUX  

  Valid properties: ``PRODUCT`` | ``CLASSIFICATION`` | ``SEVERITY``

    AMAZON_LINUX_2  

  Valid properties: ``PRODUCT`` | ``CLASSIFICATION`` | ``SEVERITY``

    AMAZON_LINUX_2023  

  Valid properties: ``PRODUCT`` | ``CLASSIFICATION`` | ``SEVERITY``

    CENTOS  

  Valid properties: ``PRODUCT`` | ``CLASSIFICATION`` | ``SEVERITY``

    DEBIAN  

  Valid properties: ``PRODUCT`` | ``PRIORITY``

    MACOS  

  Valid properties: ``PRODUCT`` | ``CLASSIFICATION``

    ORACLE_LINUX  

  Valid properties: ``PRODUCT`` | ``CLASSIFICATION`` | ``SEVERITY``

    REDHAT_ENTERPRISE_LINUX  

  Valid properties: ``PRODUCT`` | ``CLASSIFICATION`` | ``SEVERITY``

    SUSE  

  Valid properties: ``PRODUCT`` | ``CLASSIFICATION`` | ``SEVERITY``

    UBUNTU  

  Valid properties: ``PRODUCT`` | ``PRIORITY``

    WINDOWS  

  Valid properties: ``PRODUCT`` | ``PRODUCT_FAMILY`` | ``CLASSIFICATION`` | ``MSRC_SEVERITY``

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchProperties>`_  


  **Request Syntax**
  ::

    response = client.describe_patch_properties(
        OperatingSystem='WINDOWS'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'AMAZON_LINUX_2022'|'UBUNTU'|'REDHAT_ENTERPRISE_LINUX'|'SUSE'|'CENTOS'|'ORACLE_LINUX'|'DEBIAN'|'MACOS'|'RASPBIAN'|'ROCKY_LINUX'|'ALMA_LINUX'|'AMAZON_LINUX_2023',
        Property='PRODUCT'|'PRODUCT_FAMILY'|'CLASSIFICATION'|'MSRC_SEVERITY'|'PRIORITY'|'SEVERITY',
        PatchSet='OS'|'APPLICATION',
        MaxResults=123,
        NextToken='string'
    )
    
  :type OperatingSystem: string
  :param OperatingSystem: **[REQUIRED]** 

    The operating system type for which to list patches.

    

  
  :type Property: string
  :param Property: **[REQUIRED]** 

    The patch property for which you want to view patch details.

    

  
  :type PatchSet: string
  :param PatchSet: 

    Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of items to return. (You received this token from a previous call.)

    

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

    
    ::

      {
          'Properties': [
              {
                  'string': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Properties** *(list) --* 

        A list of the properties for patches matching the filter request parameters.

        
        

        - *(dict) --* 
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
      

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

        The token for the next set of items to return. (You use this token in the next call.)

        
  
  **Exceptions**
  
  *   :py:class:`SSM.Client.exceptions.InternalServerError`

  