describe_patch_baselines

SSM.Client.describe_patch_baselines(**kwargs)

Lists the patch baselines in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.describe_patch_baselines(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters

• Filters (list) --

  Each element in the array is a structure containing a key-value pair.

  Supported keys for DescribePatchBaselines include the following:

  • NAME_PREFIX Sample values: AWS- | My-
  • OWNER Sample values: AWS | Self
  • OPERATING_SYSTEM Sample values: AMAZON_LINUX | SUSE | WINDOWS
  • (dict) --

    Defines a filter used in Patch Manager APIs. Supported filter keys depend on the API operation that includes the filter. Patch Manager API operations that use PatchOrchestratorFilter include the following:

    • DescribeAvailablePatches
    • DescribeInstancePatches
    • DescribePatchBaselines
    • DescribePatchGroups
    • Key (string) --

      The key for the filter.

    • Values (list) --

      The value for the filter.

      • (string) --
• MaxResults (integer) -- The maximum number of patch baselines to return (per page).
• NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)

Return type

dict

Returns

Response Syntax

{
    'BaselineIdentities': [
        {
            'BaselineId': 'string',
            'BaselineName': 'string',
            'OperatingSystem': 'WINDOWS'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'AMAZON_LINUX_2022'|'UBUNTU'|'REDHAT_ENTERPRISE_LINUX'|'SUSE'|'CENTOS'|'ORACLE_LINUX'|'DEBIAN'|'MACOS'|'RASPBIAN'|'ROCKY_LINUX',
            'BaselineDescription': 'string',
            'DefaultBaseline': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • BaselineIdentities (list) --

    An array of PatchBaselineIdentity elements.

    • (dict) --

      Defines the basic information about a patch baseline.

      • BaselineId (string) --

        The ID of the patch baseline.

      • BaselineName (string) --

        The name of the patch baseline.

      • OperatingSystem (string) --

        Defines the operating system the patch baseline applies to. The default value is WINDOWS .

      • BaselineDescription (string) --

        The description of the patch baseline.

      • DefaultBaseline (boolean) --

        Whether this is the default baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

  • NextToken (string) --

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Exceptions

• SSM.Client.exceptions.InternalServerError