SSM / Client / describe_patch_groups

describe_patch_groups#

SSM.Client.describe_patch_groups(**kwargs)#

Lists all patch groups that have been registered with patch baselines.

See also: AWS API Documentation

Request Syntax

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

  • MaxResults (integer) – The maximum number of patch groups to return (per page).

  • Filters (list) –

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

    Supported keys for DescribePatchGroups include the following:

    • NAME_PREFIX Sample values: AWS- | My-.

    • 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) –

  • 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

{
    'Mappings': [
        {
            'PatchGroup': 'string',
            'BaselineIdentity': {
                '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'|'ALMA_LINUX'|'AMAZON_LINUX_2023',
                'BaselineDescription': 'string',
                'DefaultBaseline': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Mappings (list) –

      Each entry in the array contains:

      • PatchGroup: string (between 1 and 256 characters. Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$)

      • PatchBaselineIdentity: A PatchBaselineIdentity element.

      • (dict) –

        The mapping between a patch group and the patch baseline the patch group is registered with.

        • PatchGroup (string) –

          The name of the patch group registered with the patch baseline.

        • BaselineIdentity (dict) –

          The patch baseline the patch group is registered with.

          • 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