SSM / Client / get_patch_baseline

get_patch_baseline#

SSM.Client.get_patch_baseline(**kwargs)#

Retrieves information about a patch baseline.

Request Syntax

response = client.get_patch_baseline(
    BaselineId='string'
)

Parameters:

BaselineId (string) –

[REQUIRED]

The ID of the patch baseline to retrieve.

Note

To retrieve information about an Amazon Web Services managed patch baseline, specify the full Amazon Resource Name (ARN) of the baseline. For example, for the baseline AWS-AmazonLinuxDefaultPatchBaseline, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7 instead of pb-0e392de35e7c563b7.

Return type:

dict

Returns:

Response Syntax

{
    'BaselineId': 'string',
    'Name': 'string',
    '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',
    'GlobalFilters': {
        'PatchFilters': [
            {
                'Key': 'ARCH'|'ADVISORY_ID'|'BUGZILLA_ID'|'PATCH_SET'|'PRODUCT'|'PRODUCT_FAMILY'|'CLASSIFICATION'|'CVE_ID'|'EPOCH'|'MSRC_SEVERITY'|'NAME'|'PATCH_ID'|'SECTION'|'PRIORITY'|'REPOSITORY'|'RELEASE'|'SEVERITY'|'SECURITY'|'VERSION',
                'Values': [
                    'string',
                ]
            },
        ]
    },
    'ApprovalRules': {
        'PatchRules': [
            {
                'PatchFilterGroup': {
                    'PatchFilters': [
                        {
                            'Key': 'ARCH'|'ADVISORY_ID'|'BUGZILLA_ID'|'PATCH_SET'|'PRODUCT'|'PRODUCT_FAMILY'|'CLASSIFICATION'|'CVE_ID'|'EPOCH'|'MSRC_SEVERITY'|'NAME'|'PATCH_ID'|'SECTION'|'PRIORITY'|'REPOSITORY'|'RELEASE'|'SEVERITY'|'SECURITY'|'VERSION',
                            'Values': [
                                'string',
                            ]
                        },
                    ]
                },
                'ComplianceLevel': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
                'ApproveAfterDays': 123,
                'ApproveUntilDate': 'string',
                'EnableNonSecurity': True|False
            },
        ]
    },
    'ApprovedPatches': [
        'string',
    ],
    'ApprovedPatchesComplianceLevel': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
    'ApprovedPatchesEnableNonSecurity': True|False,
    'RejectedPatches': [
        'string',
    ],
    'RejectedPatchesAction': 'ALLOW_AS_DEPENDENCY'|'BLOCK',
    'PatchGroups': [
        'string',
    ],
    'CreatedDate': datetime(2015, 1, 1),
    'ModifiedDate': datetime(2015, 1, 1),
    'Description': 'string',
    'Sources': [
        {
            'Name': 'string',
            'Products': [
                'string',
            ],
            'Configuration': 'string'
        },
    ]
}

Response Structure

(dict) –
- BaselineId (string) –
  
  The ID of the retrieved patch baseline.
- Name (string) –
  
  The name of the patch baseline.
- OperatingSystem (string) –
  
  Returns the operating system specified for the patch baseline.
- GlobalFilters (dict) –
  
  A set of global filters used to exclude patches from the baseline.
  - PatchFilters (list) –
    
    The set of patch filters that make up the group.
    - (dict) –
      
      Defines which patches should be included in a patch baseline.
      
      A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY.
      
      The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are ["Office 2013", "Office 2016"], then the filter accepts all patches where product name is either “Office 2013” or “Office 2016”. The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.
      
      You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.
      - Key (string) –
        
        The key for the filter.
        
        Run the DescribePatchProperties command to view lists of valid keys for each operating system type.
      - Values (list) –
        
        The value for the filter key.
        
        Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.
        
        (string) –
- ApprovalRules (dict) –
  
  A set of rules used to include patches in the baseline.
  - PatchRules (list) –
    
    The rules that make up the rule group.
    - (dict) –
      
      Defines an approval rule for a patch baseline.
      - PatchFilterGroup (dict) –
        
        The patch filter group that defines the criteria for the rule.
        
        PatchFilters (list) –
        
        The set of patch filters that make up the group.
        
        (dict) –
        
        Defines which patches should be included in a patch baseline.
        
        A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY.
        
        The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are ["Office 2013", "Office 2016"], then the filter accepts all patches where product name is either “Office 2013” or “Office 2016”. The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.
        
        You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.
        
        Key (string) –
        
        The key for the filter.
        
        Run the DescribePatchProperties command to view lists of valid keys for each operating system type.
        
        Values (list) –
        
        The value for the filter key.
        
        Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.
        
        (string) –
      - ComplianceLevel (string) –
        
        A compliance severity level for all approved patches in a patch baseline.
      - ApproveAfterDays (integer) –
        
        The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released.
        
        This parameter is marked as Required: No, but your request must include a value for either ApproveAfterDays or ApproveUntilDate.
        
        Not supported for Debian Server or Ubuntu Server.
        
        Warning
        Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide.
      - ApproveUntilDate (string) –
        
        The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically.
        
        Enter dates in the format YYYY-MM-DD. For example, 2024-12-31.
        
        This parameter is marked as Required: No, but your request must include a value for either ApproveUntilDate or ApproveAfterDays.
        
        Not supported for Debian Server or Ubuntu Server.
        
        Warning
        Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide.
      - EnableNonSecurity (boolean) –
        
        For managed nodes identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is false. Applies to Linux managed nodes only.
- ApprovedPatches (list) –
  
  A list of explicitly approved patches for the baseline.
  - (string) –
- ApprovedPatchesComplianceLevel (string) –
  
  Returns the specified compliance severity level for approved patches in the patch baseline.
- ApprovedPatchesEnableNonSecurity (boolean) –
  
  Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.
- RejectedPatches (list) –
  
  A list of explicitly rejected patches for the baseline.
  - (string) –
- RejectedPatchesAction (string) –
  
  The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
- PatchGroups (list) –
  
  Patch groups included in the patch baseline.
  - (string) –
- CreatedDate (datetime) –
  
  The date the patch baseline was created.
- ModifiedDate (datetime) –
  
  The date the patch baseline was last modified.
- Description (string) –
  
  A description of the patch baseline.
- Sources (list) –
  
  Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
  - (dict) –
    
    Information about the patches to use to update the managed nodes, including target operating systems and source repository. Applies to Linux managed nodes only.
    - Name (string) –
      
      The name specified to identify the patch source.
    - Products (list) –
      
      The specific operating system versions a patch repository applies to, such as “Ubuntu16.04”, “AmazonLinux2016.09”, “RedhatEnterpriseLinux7.2” or “Suse12.7”. For lists of supported product values, see PatchFilter.
      - (string) –
    - Configuration (string) –
      
      The value of the yum repo configuration. For example:
      
      [main]
      
      name=MyCustomRepository
      
      baseurl=https://my-custom-repository
      
      enabled=1
      
      Note
      For information about other options available for your yum repository configuration, see dnf.conf(5).

Exceptions

SSM.Client.exceptions.DoesNotExistException
SSM.Client.exceptions.InvalidResourceId
SSM.Client.exceptions.InternalServerError