SSM / Paginator / DescribePatchBaselines

DescribePatchBaselines

class SSM.Paginator.DescribePatchBaselines

paginator = client.get_paginator('describe_patch_baselines')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.describe_patch_baselines().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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'|'ALMA_LINUX'|'AMAZON_LINUX_2023',
            'BaselineDescription': 'string',
            'DefaultBaseline': True|False
        },
    ],

}

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

        Indicates 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.