Amazon Simple Systems Manager (SSM)

2018/10/04 - Amazon Simple Systems Manager (SSM) - 7 updated api methods

Changes  Adds RejectedPatchesAction to baseline to enable stricted validation of the rejected Patches List ; Add InstalledRejected and InstallOverrideList to compliance reporting

CreatePatchBaseline (updated) Link ¶
Changes (request)
{'RejectedPatchesAction': 'ALLOW_AS_DEPENDENCY | BLOCK'}

Creates a patch baseline.

Note

For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter .

See also: AWS API Documentation

Request Syntax

client.create_patch_baseline(
    OperatingSystem='WINDOWS'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'UBUNTU'|'REDHAT_ENTERPRISE_LINUX'|'SUSE'|'CENTOS',
    Name='string',
    GlobalFilters={
        'PatchFilters': [
            {
                'Key': 'PRODUCT'|'CLASSIFICATION'|'MSRC_SEVERITY'|'PATCH_ID'|'SECTION'|'PRIORITY'|'SEVERITY',
                'Values': [
                    'string',
                ]
            },
        ]
    },
    ApprovalRules={
        'PatchRules': [
            {
                'PatchFilterGroup': {
                    'PatchFilters': [
                        {
                            'Key': 'PRODUCT'|'CLASSIFICATION'|'MSRC_SEVERITY'|'PATCH_ID'|'SECTION'|'PRIORITY'|'SEVERITY',
                            'Values': [
                                'string',
                            ]
                        },
                    ]
                },
                'ComplianceLevel': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
                'ApproveAfterDays': 123,
                'EnableNonSecurity': True|False
            },
        ]
    },
    ApprovedPatches=[
        'string',
    ],
    ApprovedPatchesComplianceLevel='CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
    ApprovedPatchesEnableNonSecurity=True|False,
    RejectedPatches=[
        'string',
    ],
    RejectedPatchesAction='ALLOW_AS_DEPENDENCY'|'BLOCK',
    Description='string',
    Sources=[
        {
            'Name': 'string',
            'Products': [
                'string',
            ],
            'Configuration': 'string'
        },
    ],
    ClientToken='string'
)
type OperatingSystem

string

param OperatingSystem

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

type Name

string

param Name

[REQUIRED]

The name of the patch baseline.

type GlobalFilters

dict

param GlobalFilters

A set of global filters used to exclude patches from the baseline.

  • PatchFilters (list) -- [REQUIRED]

    The set of patch filters that make up the group.

    • (dict) --

      Defines a patch filter.

      A patch filter consists of key/value pairs, but not all keys are valid for all operating system types. For example, the key PRODUCT is valid for all supported operating system types. The key MSRC_SEVERITY , however, is valid only for Windows operating systems, and the key SECTION is valid only for Ubuntu operating systems.

      Refer to the following sections for information about which keys may be used with each major operating system, and which values are valid for each key.

      Windows Operating Systems

      The supported keys for Windows operating systems are PRODUCT , CLASSIFICATION , and MSRC_SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • Windows7

      • Windows8

      • Windows8.1

      • Windows8Embedded

      • Windows10

      • Windows10LTSB

      • WindowsServer2008

      • WindowsServer2008R2

      • WindowsServer2012

      • WindowsServer2012R2

      • WindowsServer2016

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • CriticalUpdates

      • DefinitionUpdates

      • Drivers

      • FeaturePacks

      • SecurityUpdates

      • ServicePacks

      • Tools

      • UpdateRollups

      • Updates

      • Upgrades

      Supported key: MSRC_SEVERITY

      Supported values:

      • Critical

      • Important

      • Moderate

      • Low

      • Unspecified

      Ubuntu Operating Systems

      The supported keys for Ubuntu operating systems are PRODUCT , PRIORITY , and SECTION . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • Ubuntu14.04

      • Ubuntu16.04

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: PRIORITY

      Supported values:

      • Required

      • Important

      • Standard

      • Optional

      • Extra

      Supported key: SECTION

      Only the length of the key value is validated. Minimum length is 1. Maximum length is 64.

      Amazon Linux Operating Systems

      The supported keys for Amazon Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • AmazonLinux2012.03

      • AmazonLinux2012.09

      • AmazonLinux2013.03

      • AmazonLinux2013.09

      • AmazonLinux2014.03

      • AmazonLinux2014.09

      • AmazonLinux2015.03

      • AmazonLinux2015.09

      • AmazonLinux2016.03

      • AmazonLinux2016.09

      • AmazonLinux2017.03

      • AmazonLinux2017.09

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Bugfix

      • Enhancement

      • Recommended

      • Newpackage

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Medium

      • Low

      Amazon Linux 2 Operating Systems

      The supported keys for Amazon Linux 2 operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • AmazonLinux2

      • AmazonLinux2.0

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Bugfix

      • Enhancement

      • Recommended

      • Newpackage

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Medium

      • Low

      RedHat Enterprise Linux (RHEL) Operating Systems

      The supported keys for RedHat Enterprise Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • RedhatEnterpriseLinux6.5

      • RedhatEnterpriseLinux6.6

      • RedhatEnterpriseLinux6.7

      • RedhatEnterpriseLinux6.8

      • RedhatEnterpriseLinux6.9

      • RedhatEnterpriseLinux7.0

      • RedhatEnterpriseLinux7.1

      • RedhatEnterpriseLinux7.2

      • RedhatEnterpriseLinux7.3

      • RedhatEnterpriseLinux7.4

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Bugfix

      • Enhancement

      • Recommended

      • Newpackage

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Medium

      • Low

      SUSE Linux Enterprise Server (SLES) Operating Systems

      The supported keys for SLES operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • Suse12.0

      • Suse12.1

      • Suse12.2

      • Suse12.3

      • Suse12.4

      • Suse12.5

      • Suse12.6

      • Suse12.7

      • Suse12.8

      • Suse12.9

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Recommended

      • Optional

      • Feature

      • Document

      • Yast

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Moderate

      • Low

      CentOS Operating Systems

      The supported keys for CentOS operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • CentOS6.5

      • CentOS6.6

      • CentOS6.7

      • CentOS6.8

      • CentOS6.9

      • CentOS7.0

      • CentOS7.1

      • CentOS7.2

      • CentOS7.3

      • CentOS7.4

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Bugfix

      • Enhancement

      • Recommended

      • Newpackage

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Medium

      • Low

      • Key (string) -- [REQUIRED]

        The key for the filter.

        See PatchFilter for lists of valid keys for each operating system type.

      • Values (list) -- [REQUIRED]

        The value for the filter key.

        See PatchFilter for lists of valid values for each key based on operating system type.

        • (string) --

type ApprovalRules

dict

param ApprovalRules

A set of rules used to include patches in the baseline.

  • PatchRules (list) -- [REQUIRED]

    The rules that make up the rule group.

    • (dict) --

      Defines an approval rule for a patch baseline.

      • PatchFilterGroup (dict) -- [REQUIRED]

        The patch filter group that defines the criteria for the rule.

        • PatchFilters (list) -- [REQUIRED]

          The set of patch filters that make up the group.

          • (dict) --

            Defines a patch filter.

            A patch filter consists of key/value pairs, but not all keys are valid for all operating system types. For example, the key PRODUCT is valid for all supported operating system types. The key MSRC_SEVERITY , however, is valid only for Windows operating systems, and the key SECTION is valid only for Ubuntu operating systems.

            Refer to the following sections for information about which keys may be used with each major operating system, and which values are valid for each key.

            Windows Operating Systems

            The supported keys for Windows operating systems are PRODUCT , CLASSIFICATION , and MSRC_SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • Windows7

            • Windows8

            • Windows8.1

            • Windows8Embedded

            • Windows10

            • Windows10LTSB

            • WindowsServer2008

            • WindowsServer2008R2

            • WindowsServer2012

            • WindowsServer2012R2

            • WindowsServer2016

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • CriticalUpdates

            • DefinitionUpdates

            • Drivers

            • FeaturePacks

            • SecurityUpdates

            • ServicePacks

            • Tools

            • UpdateRollups

            • Updates

            • Upgrades

            Supported key: MSRC_SEVERITY

            Supported values:

            • Critical

            • Important

            • Moderate

            • Low

            • Unspecified

            Ubuntu Operating Systems

            The supported keys for Ubuntu operating systems are PRODUCT , PRIORITY , and SECTION . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • Ubuntu14.04

            • Ubuntu16.04

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: PRIORITY

            Supported values:

            • Required

            • Important

            • Standard

            • Optional

            • Extra

            Supported key: SECTION

            Only the length of the key value is validated. Minimum length is 1. Maximum length is 64.

            Amazon Linux Operating Systems

            The supported keys for Amazon Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • AmazonLinux2012.03

            • AmazonLinux2012.09

            • AmazonLinux2013.03

            • AmazonLinux2013.09

            • AmazonLinux2014.03

            • AmazonLinux2014.09

            • AmazonLinux2015.03

            • AmazonLinux2015.09

            • AmazonLinux2016.03

            • AmazonLinux2016.09

            • AmazonLinux2017.03

            • AmazonLinux2017.09

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Bugfix

            • Enhancement

            • Recommended

            • Newpackage

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Medium

            • Low

            Amazon Linux 2 Operating Systems

            The supported keys for Amazon Linux 2 operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • AmazonLinux2

            • AmazonLinux2.0

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Bugfix

            • Enhancement

            • Recommended

            • Newpackage

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Medium

            • Low

            RedHat Enterprise Linux (RHEL) Operating Systems

            The supported keys for RedHat Enterprise Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • RedhatEnterpriseLinux6.5

            • RedhatEnterpriseLinux6.6

            • RedhatEnterpriseLinux6.7

            • RedhatEnterpriseLinux6.8

            • RedhatEnterpriseLinux6.9

            • RedhatEnterpriseLinux7.0

            • RedhatEnterpriseLinux7.1

            • RedhatEnterpriseLinux7.2

            • RedhatEnterpriseLinux7.3

            • RedhatEnterpriseLinux7.4

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Bugfix

            • Enhancement

            • Recommended

            • Newpackage

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Medium

            • Low

            SUSE Linux Enterprise Server (SLES) Operating Systems

            The supported keys for SLES operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • Suse12.0

            • Suse12.1

            • Suse12.2

            • Suse12.3

            • Suse12.4

            • Suse12.5

            • Suse12.6

            • Suse12.7

            • Suse12.8

            • Suse12.9

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Recommended

            • Optional

            • Feature

            • Document

            • Yast

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Moderate

            • Low

            CentOS Operating Systems

            The supported keys for CentOS operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • CentOS6.5

            • CentOS6.6

            • CentOS6.7

            • CentOS6.8

            • CentOS6.9

            • CentOS7.0

            • CentOS7.1

            • CentOS7.2

            • CentOS7.3

            • CentOS7.4

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Bugfix

            • Enhancement

            • Recommended

            • Newpackage

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Medium

            • Low

            • Key (string) -- [REQUIRED]

              The key for the filter.

              See PatchFilter for lists of valid keys for each operating system type.

            • Values (list) -- [REQUIRED]

              The value for the filter key.

              See PatchFilter for 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. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.

      • ApproveAfterDays (integer) -- [REQUIRED]

        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.

      • EnableNonSecurity (boolean) --

        For instances 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 instances only.

type ApprovedPatches

list

param ApprovedPatches

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide .

  • (string) --

type ApprovedPatchesComplianceLevel

string

param ApprovedPatchesComplianceLevel

Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.

type ApprovedPatchesEnableNonSecurity

boolean

param ApprovedPatchesEnableNonSecurity

Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

type RejectedPatches

list

param RejectedPatches

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide .

  • (string) --

type RejectedPatchesAction

string

param RejectedPatchesAction

The action for Patch Manager to take on patches included in the RejectedPackages list.

  • ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther . This is the default action if no option is specified.

  • BLOCK : Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected .

type Description

string

param Description

A description of the patch baseline.

type Sources

list

param Sources

Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

  • (dict) --

    Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.

    • Name (string) -- [REQUIRED]

      The name specified to identify the patch source.

    • Products (list) -- [REQUIRED]

      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) -- [REQUIRED]

      The value of the yum repo configuration. For example:

      cachedir=/var/cache/yum/$basesearch

      $releasever

      keepcache=0

      debuglevel=2

type ClientToken

string

param ClientToken

User-provided idempotency token.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'BaselineId': 'string'
}

Response Structure

  • (dict) --

    • BaselineId (string) --

      The ID of the created patch baseline.

DescribeInstancePatchStates (updated) Link ¶
Changes (response)
{'InstancePatchStates': {'InstallOverrideList': 'string',
                         'InstalledRejectedCount': 'integer'}}

Retrieves the high-level patch state of one or more instances.

See also: AWS API Documentation

Request Syntax

client.describe_instance_patch_states(
    InstanceIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
type InstanceIds

list

param InstanceIds

[REQUIRED]

The ID of the instance whose patch state information should be retrieved.

  • (string) --

type NextToken

string

param NextToken

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

type MaxResults

integer

param MaxResults

The maximum number of instances to return (per page).

rtype

dict

returns

Response Syntax

{
    'InstancePatchStates': [
        {
            'InstanceId': 'string',
            'PatchGroup': 'string',
            'BaselineId': 'string',
            'SnapshotId': 'string',
            'InstallOverrideList': 'string',
            'OwnerInformation': 'string',
            'InstalledCount': 123,
            'InstalledOtherCount': 123,
            'InstalledRejectedCount': 123,
            'MissingCount': 123,
            'FailedCount': 123,
            'NotApplicableCount': 123,
            'OperationStartTime': datetime(2015, 1, 1),
            'OperationEndTime': datetime(2015, 1, 1),
            'Operation': 'Scan'|'Install'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InstancePatchStates (list) --

      The high-level patch state for the requested instances.

      • (dict) --

        Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.

        • InstanceId (string) --

          The ID of the managed instance the high-level patch compliance information was collected for.

        • PatchGroup (string) --

          The name of the patch group the managed instance belongs to.

        • BaselineId (string) --

          The ID of the patch baseline used to patch the instance.

        • SnapshotId (string) --

          The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

        • InstallOverrideList (string) --

          An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline , overrides the patches specified by the default patch baseline.

          For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide .

        • OwnerInformation (string) --

          Placeholder information. This field will always be empty in the current release of the service.

        • InstalledCount (integer) --

          The number of patches from the patch baseline that are installed on the instance.

        • InstalledOtherCount (integer) --

          The number of patches not specified in the patch baseline that are installed on the instance.

        • InstalledRejectedCount (integer) --

          The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

          Note

          If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).

        • MissingCount (integer) --

          The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.

        • FailedCount (integer) --

          The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

        • NotApplicableCount (integer) --

          The number of patches from the patch baseline that aren't applicable for the instance and hence aren't installed on the instance.

        • OperationStartTime (datetime) --

          The time the most recent patching operation was started on the instance.

        • OperationEndTime (datetime) --

          The time the most recent patching operation completed on the instance.

        • Operation (string) --

          The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

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

DescribeInstancePatchStatesForPatchGroup (updated) Link ¶
Changes (response)
{'InstancePatchStates': {'InstallOverrideList': 'string',
                         'InstalledRejectedCount': 'integer'}}

Retrieves the high-level patch state for the instances in the specified patch group.

See also: AWS API Documentation

Request Syntax

client.describe_instance_patch_states_for_patch_group(
    PatchGroup='string',
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'Type': 'Equal'|'NotEqual'|'LessThan'|'GreaterThan'
        },
    ],
    NextToken='string',
    MaxResults=123
)
type PatchGroup

string

param PatchGroup

[REQUIRED]

The name of the patch group for which the patch state information should be retrieved.

type Filters

list

param Filters

Each entry in the array is a structure containing:

Key (string between 1 and 200 characters)

Values (array containing a single string)

Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")

  • (dict) --

    Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to scope down the information returned by the API.

    • Key (string) -- [REQUIRED]

      The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.

    • Values (list) -- [REQUIRED]

      The value for the filter, must be an integer greater than or equal to 0.

      • (string) --

    • Type (string) -- [REQUIRED]

      The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.

type NextToken

string

param NextToken

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

type MaxResults

integer

param MaxResults

The maximum number of patches to return (per page).

rtype

dict

returns

Response Syntax

{
    'InstancePatchStates': [
        {
            'InstanceId': 'string',
            'PatchGroup': 'string',
            'BaselineId': 'string',
            'SnapshotId': 'string',
            'InstallOverrideList': 'string',
            'OwnerInformation': 'string',
            'InstalledCount': 123,
            'InstalledOtherCount': 123,
            'InstalledRejectedCount': 123,
            'MissingCount': 123,
            'FailedCount': 123,
            'NotApplicableCount': 123,
            'OperationStartTime': datetime(2015, 1, 1),
            'OperationEndTime': datetime(2015, 1, 1),
            'Operation': 'Scan'|'Install'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InstancePatchStates (list) --

      The high-level patch state for the requested instances.

      • (dict) --

        Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.

        • InstanceId (string) --

          The ID of the managed instance the high-level patch compliance information was collected for.

        • PatchGroup (string) --

          The name of the patch group the managed instance belongs to.

        • BaselineId (string) --

          The ID of the patch baseline used to patch the instance.

        • SnapshotId (string) --

          The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

        • InstallOverrideList (string) --

          An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline , overrides the patches specified by the default patch baseline.

          For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide .

        • OwnerInformation (string) --

          Placeholder information. This field will always be empty in the current release of the service.

        • InstalledCount (integer) --

          The number of patches from the patch baseline that are installed on the instance.

        • InstalledOtherCount (integer) --

          The number of patches not specified in the patch baseline that are installed on the instance.

        • InstalledRejectedCount (integer) --

          The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

          Note

          If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).

        • MissingCount (integer) --

          The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.

        • FailedCount (integer) --

          The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

        • NotApplicableCount (integer) --

          The number of patches from the patch baseline that aren't applicable for the instance and hence aren't installed on the instance.

        • OperationStartTime (datetime) --

          The time the most recent patching operation was started on the instance.

        • OperationEndTime (datetime) --

          The time the most recent patching operation completed on the instance.

        • Operation (string) --

          The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

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

DescribeInstancePatches (updated) Link ¶
Changes (response)
{'Patches': {'State': ['INSTALLED_REJECTED']}}

Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

See also: AWS API Documentation

Request Syntax

client.describe_instance_patches(
    InstanceId='string',
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
type InstanceId

string

param InstanceId

[REQUIRED]

The ID of the instance whose patch state information should be retrieved.

type Filters

list

param Filters

Each entry in the array is a structure containing:

Key (string, between 1 and 128 characters)

Values (array of strings, each string between 1 and 256 characters)

  • (dict) --

    Defines a filter used in Patch Manager APIs.

    • Key (string) --

      The key for the filter.

    • Values (list) --

      The value for the filter.

      • (string) --

type NextToken

string

param NextToken

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

type MaxResults

integer

param MaxResults

The maximum number of patches to return (per page).

rtype

dict

returns

Response Syntax

{
    'Patches': [
        {
            'Title': 'string',
            'KBId': 'string',
            'Classification': 'string',
            'Severity': 'string',
            'State': 'INSTALLED'|'INSTALLED_OTHER'|'INSTALLED_REJECTED'|'MISSING'|'NOT_APPLICABLE'|'FAILED',
            'InstalledTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Patches (list) --

      Each entry in the array is a structure containing:

      Title (string)

      KBId (string)

      Classification (string)

      Severity (string)

      State (string: "INSTALLED", "INSTALLED OTHER", "MISSING", "NOT APPLICABLE", "FAILED")

      InstalledTime (DateTime)

      InstalledBy (string)

      • (dict) --

        Information about the state of a patch on a particular instance as it relates to the patch baseline used to patch the instance.

        • Title (string) --

          The title of the patch.

        • KBId (string) --

          The operating system-specific ID of the patch.

        • Classification (string) --

          The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).

        • Severity (string) --

          The severity of the patch (for example, Critical, Important, Moderate).

        • State (string) --

          The state of the patch on the instance (INSTALLED, INSTALLED_OTHER, MISSING, NOT_APPLICABLE or FAILED).

        • InstalledTime (datetime) --

          The date/time the patch was installed on the instance. Note that not all operating systems provide this level of information.

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

DescribePatchGroupState (updated) Link ¶
Changes (response)
{'InstancesWithInstalledRejectedPatches': 'integer'}

Returns high-level aggregated patch compliance state for a patch group.

See also: AWS API Documentation

Request Syntax

client.describe_patch_group_state(
    PatchGroup='string'
)
type PatchGroup

string

param PatchGroup

[REQUIRED]

The name of the patch group whose patch snapshot should be retrieved.

rtype

dict

returns

Response Syntax

{
    'Instances': 123,
    'InstancesWithInstalledPatches': 123,
    'InstancesWithInstalledOtherPatches': 123,
    'InstancesWithInstalledRejectedPatches': 123,
    'InstancesWithMissingPatches': 123,
    'InstancesWithFailedPatches': 123,
    'InstancesWithNotApplicablePatches': 123
}

Response Structure

  • (dict) --

    • Instances (integer) --

      The number of instances in the patch group.

    • InstancesWithInstalledPatches (integer) --

      The number of instances with installed patches.

    • InstancesWithInstalledOtherPatches (integer) --

      The number of instances with patches installed that aren't defined in the patch baseline.

    • InstancesWithInstalledRejectedPatches (integer) --

      The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

      Note

      If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).

    • InstancesWithMissingPatches (integer) --

      The number of instances with missing patches from the patch baseline.

    • InstancesWithFailedPatches (integer) --

      The number of instances with patches from the patch baseline that failed to install.

    • InstancesWithNotApplicablePatches (integer) --

      The number of instances with patches that aren't applicable.

GetPatchBaseline (updated) Link ¶
Changes (response)
{'RejectedPatchesAction': 'ALLOW_AS_DEPENDENCY | BLOCK'}

Retrieves information about a patch baseline.

See also: AWS API Documentation

Request Syntax

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

string

param BaselineId

[REQUIRED]

The ID of the patch baseline to retrieve.

rtype

dict

returns

Response Syntax

{
    'BaselineId': 'string',
    'Name': 'string',
    'OperatingSystem': 'WINDOWS'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'UBUNTU'|'REDHAT_ENTERPRISE_LINUX'|'SUSE'|'CENTOS',
    'GlobalFilters': {
        'PatchFilters': [
            {
                'Key': 'PRODUCT'|'CLASSIFICATION'|'MSRC_SEVERITY'|'PATCH_ID'|'SECTION'|'PRIORITY'|'SEVERITY',
                'Values': [
                    'string',
                ]
            },
        ]
    },
    'ApprovalRules': {
        'PatchRules': [
            {
                'PatchFilterGroup': {
                    'PatchFilters': [
                        {
                            'Key': 'PRODUCT'|'CLASSIFICATION'|'MSRC_SEVERITY'|'PATCH_ID'|'SECTION'|'PRIORITY'|'SEVERITY',
                            'Values': [
                                'string',
                            ]
                        },
                    ]
                },
                'ComplianceLevel': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
                'ApproveAfterDays': 123,
                '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 a patch filter.

          A patch filter consists of key/value pairs, but not all keys are valid for all operating system types. For example, the key PRODUCT is valid for all supported operating system types. The key MSRC_SEVERITY , however, is valid only for Windows operating systems, and the key SECTION is valid only for Ubuntu operating systems.

          Refer to the following sections for information about which keys may be used with each major operating system, and which values are valid for each key.

          Windows Operating Systems

          The supported keys for Windows operating systems are PRODUCT , CLASSIFICATION , and MSRC_SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • Windows7

          • Windows8

          • Windows8.1

          • Windows8Embedded

          • Windows10

          • Windows10LTSB

          • WindowsServer2008

          • WindowsServer2008R2

          • WindowsServer2012

          • WindowsServer2012R2

          • WindowsServer2016

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • CriticalUpdates

          • DefinitionUpdates

          • Drivers

          • FeaturePacks

          • SecurityUpdates

          • ServicePacks

          • Tools

          • UpdateRollups

          • Updates

          • Upgrades

          Supported key: MSRC_SEVERITY

          Supported values:

          • Critical

          • Important

          • Moderate

          • Low

          • Unspecified

          Ubuntu Operating Systems

          The supported keys for Ubuntu operating systems are PRODUCT , PRIORITY , and SECTION . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • Ubuntu14.04

          • Ubuntu16.04

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: PRIORITY

          Supported values:

          • Required

          • Important

          • Standard

          • Optional

          • Extra

          Supported key: SECTION

          Only the length of the key value is validated. Minimum length is 1. Maximum length is 64.

          Amazon Linux Operating Systems

          The supported keys for Amazon Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • AmazonLinux2012.03

          • AmazonLinux2012.09

          • AmazonLinux2013.03

          • AmazonLinux2013.09

          • AmazonLinux2014.03

          • AmazonLinux2014.09

          • AmazonLinux2015.03

          • AmazonLinux2015.09

          • AmazonLinux2016.03

          • AmazonLinux2016.09

          • AmazonLinux2017.03

          • AmazonLinux2017.09

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Bugfix

          • Enhancement

          • Recommended

          • Newpackage

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Medium

          • Low

          Amazon Linux 2 Operating Systems

          The supported keys for Amazon Linux 2 operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • AmazonLinux2

          • AmazonLinux2.0

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Bugfix

          • Enhancement

          • Recommended

          • Newpackage

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Medium

          • Low

          RedHat Enterprise Linux (RHEL) Operating Systems

          The supported keys for RedHat Enterprise Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • RedhatEnterpriseLinux6.5

          • RedhatEnterpriseLinux6.6

          • RedhatEnterpriseLinux6.7

          • RedhatEnterpriseLinux6.8

          • RedhatEnterpriseLinux6.9

          • RedhatEnterpriseLinux7.0

          • RedhatEnterpriseLinux7.1

          • RedhatEnterpriseLinux7.2

          • RedhatEnterpriseLinux7.3

          • RedhatEnterpriseLinux7.4

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Bugfix

          • Enhancement

          • Recommended

          • Newpackage

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Medium

          • Low

          SUSE Linux Enterprise Server (SLES) Operating Systems

          The supported keys for SLES operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • Suse12.0

          • Suse12.1

          • Suse12.2

          • Suse12.3

          • Suse12.4

          • Suse12.5

          • Suse12.6

          • Suse12.7

          • Suse12.8

          • Suse12.9

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Recommended

          • Optional

          • Feature

          • Document

          • Yast

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Moderate

          • Low

          CentOS Operating Systems

          The supported keys for CentOS operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • CentOS6.5

          • CentOS6.6

          • CentOS6.7

          • CentOS6.8

          • CentOS6.9

          • CentOS7.0

          • CentOS7.1

          • CentOS7.2

          • CentOS7.3

          • CentOS7.4

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Bugfix

          • Enhancement

          • Recommended

          • Newpackage

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Medium

          • Low

          • Key (string) --

            The key for the filter.

            See PatchFilter for lists of valid keys for each operating system type.

          • Values (list) --

            The value for the filter key.

            See PatchFilter for 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 a patch filter.

                A patch filter consists of key/value pairs, but not all keys are valid for all operating system types. For example, the key PRODUCT is valid for all supported operating system types. The key MSRC_SEVERITY , however, is valid only for Windows operating systems, and the key SECTION is valid only for Ubuntu operating systems.

                Refer to the following sections for information about which keys may be used with each major operating system, and which values are valid for each key.

                Windows Operating Systems

                The supported keys for Windows operating systems are PRODUCT , CLASSIFICATION , and MSRC_SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • Windows7

                • Windows8

                • Windows8.1

                • Windows8Embedded

                • Windows10

                • Windows10LTSB

                • WindowsServer2008

                • WindowsServer2008R2

                • WindowsServer2012

                • WindowsServer2012R2

                • WindowsServer2016

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • CriticalUpdates

                • DefinitionUpdates

                • Drivers

                • FeaturePacks

                • SecurityUpdates

                • ServicePacks

                • Tools

                • UpdateRollups

                • Updates

                • Upgrades

                Supported key: MSRC_SEVERITY

                Supported values:

                • Critical

                • Important

                • Moderate

                • Low

                • Unspecified

                Ubuntu Operating Systems

                The supported keys for Ubuntu operating systems are PRODUCT , PRIORITY , and SECTION . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • Ubuntu14.04

                • Ubuntu16.04

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: PRIORITY

                Supported values:

                • Required

                • Important

                • Standard

                • Optional

                • Extra

                Supported key: SECTION

                Only the length of the key value is validated. Minimum length is 1. Maximum length is 64.

                Amazon Linux Operating Systems

                The supported keys for Amazon Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • AmazonLinux2012.03

                • AmazonLinux2012.09

                • AmazonLinux2013.03

                • AmazonLinux2013.09

                • AmazonLinux2014.03

                • AmazonLinux2014.09

                • AmazonLinux2015.03

                • AmazonLinux2015.09

                • AmazonLinux2016.03

                • AmazonLinux2016.09

                • AmazonLinux2017.03

                • AmazonLinux2017.09

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Bugfix

                • Enhancement

                • Recommended

                • Newpackage

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Medium

                • Low

                Amazon Linux 2 Operating Systems

                The supported keys for Amazon Linux 2 operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • AmazonLinux2

                • AmazonLinux2.0

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Bugfix

                • Enhancement

                • Recommended

                • Newpackage

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Medium

                • Low

                RedHat Enterprise Linux (RHEL) Operating Systems

                The supported keys for RedHat Enterprise Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • RedhatEnterpriseLinux6.5

                • RedhatEnterpriseLinux6.6

                • RedhatEnterpriseLinux6.7

                • RedhatEnterpriseLinux6.8

                • RedhatEnterpriseLinux6.9

                • RedhatEnterpriseLinux7.0

                • RedhatEnterpriseLinux7.1

                • RedhatEnterpriseLinux7.2

                • RedhatEnterpriseLinux7.3

                • RedhatEnterpriseLinux7.4

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Bugfix

                • Enhancement

                • Recommended

                • Newpackage

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Medium

                • Low

                SUSE Linux Enterprise Server (SLES) Operating Systems

                The supported keys for SLES operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • Suse12.0

                • Suse12.1

                • Suse12.2

                • Suse12.3

                • Suse12.4

                • Suse12.5

                • Suse12.6

                • Suse12.7

                • Suse12.8

                • Suse12.9

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Recommended

                • Optional

                • Feature

                • Document

                • Yast

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Moderate

                • Low

                CentOS Operating Systems

                The supported keys for CentOS operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • CentOS6.5

                • CentOS6.6

                • CentOS6.7

                • CentOS6.8

                • CentOS6.9

                • CentOS7.0

                • CentOS7.1

                • CentOS7.2

                • CentOS7.3

                • CentOS7.4

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Bugfix

                • Enhancement

                • Recommended

                • Newpackage

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Medium

                • Low

                • Key (string) --

                  The key for the filter.

                  See PatchFilter for lists of valid keys for each operating system type.

                • Values (list) --

                  The value for the filter key.

                  See PatchFilter for 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. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.

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

          • EnableNonSecurity (boolean) --

            For instances 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 instances 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 instances. The default value is 'false'. Applies to Linux instances 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 instances, including target operating systems and source repositories. Applies to Linux instances only.

      • (dict) --

        Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances 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:

          cachedir=/var/cache/yum/$basesearch

          $releasever

          keepcache=0

          debuglevel=2

UpdatePatchBaseline (updated) Link ¶
Changes (both)
{'RejectedPatchesAction': 'ALLOW_AS_DEPENDENCY | BLOCK'}

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

Note

For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter .

See also: AWS API Documentation

Request Syntax

client.update_patch_baseline(
    BaselineId='string',
    Name='string',
    GlobalFilters={
        'PatchFilters': [
            {
                'Key': 'PRODUCT'|'CLASSIFICATION'|'MSRC_SEVERITY'|'PATCH_ID'|'SECTION'|'PRIORITY'|'SEVERITY',
                'Values': [
                    'string',
                ]
            },
        ]
    },
    ApprovalRules={
        'PatchRules': [
            {
                'PatchFilterGroup': {
                    'PatchFilters': [
                        {
                            'Key': 'PRODUCT'|'CLASSIFICATION'|'MSRC_SEVERITY'|'PATCH_ID'|'SECTION'|'PRIORITY'|'SEVERITY',
                            'Values': [
                                'string',
                            ]
                        },
                    ]
                },
                'ComplianceLevel': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
                'ApproveAfterDays': 123,
                'EnableNonSecurity': True|False
            },
        ]
    },
    ApprovedPatches=[
        'string',
    ],
    ApprovedPatchesComplianceLevel='CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
    ApprovedPatchesEnableNonSecurity=True|False,
    RejectedPatches=[
        'string',
    ],
    RejectedPatchesAction='ALLOW_AS_DEPENDENCY'|'BLOCK',
    Description='string',
    Sources=[
        {
            'Name': 'string',
            'Products': [
                'string',
            ],
            'Configuration': 'string'
        },
    ],
    Replace=True|False
)
type BaselineId

string

param BaselineId

[REQUIRED]

The ID of the patch baseline to update.

type Name

string

param Name

The name of the patch baseline.

type GlobalFilters

dict

param GlobalFilters

A set of global filters used to exclude patches from the baseline.

  • PatchFilters (list) -- [REQUIRED]

    The set of patch filters that make up the group.

    • (dict) --

      Defines a patch filter.

      A patch filter consists of key/value pairs, but not all keys are valid for all operating system types. For example, the key PRODUCT is valid for all supported operating system types. The key MSRC_SEVERITY , however, is valid only for Windows operating systems, and the key SECTION is valid only for Ubuntu operating systems.

      Refer to the following sections for information about which keys may be used with each major operating system, and which values are valid for each key.

      Windows Operating Systems

      The supported keys for Windows operating systems are PRODUCT , CLASSIFICATION , and MSRC_SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • Windows7

      • Windows8

      • Windows8.1

      • Windows8Embedded

      • Windows10

      • Windows10LTSB

      • WindowsServer2008

      • WindowsServer2008R2

      • WindowsServer2012

      • WindowsServer2012R2

      • WindowsServer2016

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • CriticalUpdates

      • DefinitionUpdates

      • Drivers

      • FeaturePacks

      • SecurityUpdates

      • ServicePacks

      • Tools

      • UpdateRollups

      • Updates

      • Upgrades

      Supported key: MSRC_SEVERITY

      Supported values:

      • Critical

      • Important

      • Moderate

      • Low

      • Unspecified

      Ubuntu Operating Systems

      The supported keys for Ubuntu operating systems are PRODUCT , PRIORITY , and SECTION . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • Ubuntu14.04

      • Ubuntu16.04

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: PRIORITY

      Supported values:

      • Required

      • Important

      • Standard

      • Optional

      • Extra

      Supported key: SECTION

      Only the length of the key value is validated. Minimum length is 1. Maximum length is 64.

      Amazon Linux Operating Systems

      The supported keys for Amazon Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • AmazonLinux2012.03

      • AmazonLinux2012.09

      • AmazonLinux2013.03

      • AmazonLinux2013.09

      • AmazonLinux2014.03

      • AmazonLinux2014.09

      • AmazonLinux2015.03

      • AmazonLinux2015.09

      • AmazonLinux2016.03

      • AmazonLinux2016.09

      • AmazonLinux2017.03

      • AmazonLinux2017.09

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Bugfix

      • Enhancement

      • Recommended

      • Newpackage

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Medium

      • Low

      Amazon Linux 2 Operating Systems

      The supported keys for Amazon Linux 2 operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • AmazonLinux2

      • AmazonLinux2.0

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Bugfix

      • Enhancement

      • Recommended

      • Newpackage

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Medium

      • Low

      RedHat Enterprise Linux (RHEL) Operating Systems

      The supported keys for RedHat Enterprise Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • RedhatEnterpriseLinux6.5

      • RedhatEnterpriseLinux6.6

      • RedhatEnterpriseLinux6.7

      • RedhatEnterpriseLinux6.8

      • RedhatEnterpriseLinux6.9

      • RedhatEnterpriseLinux7.0

      • RedhatEnterpriseLinux7.1

      • RedhatEnterpriseLinux7.2

      • RedhatEnterpriseLinux7.3

      • RedhatEnterpriseLinux7.4

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Bugfix

      • Enhancement

      • Recommended

      • Newpackage

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Medium

      • Low

      SUSE Linux Enterprise Server (SLES) Operating Systems

      The supported keys for SLES operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • Suse12.0

      • Suse12.1

      • Suse12.2

      • Suse12.3

      • Suse12.4

      • Suse12.5

      • Suse12.6

      • Suse12.7

      • Suse12.8

      • Suse12.9

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Recommended

      • Optional

      • Feature

      • Document

      • Yast

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Moderate

      • Low

      CentOS Operating Systems

      The supported keys for CentOS operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

      Supported key: PRODUCT

      Supported values:

      • CentOS6.5

      • CentOS6.6

      • CentOS6.7

      • CentOS6.8

      • CentOS6.9

      • CentOS7.0

      • CentOS7.1

      • CentOS7.2

      • CentOS7.3

      • CentOS7.4

      • * Use a wildcard character () to target all supported operating system versions.*

      Supported key: CLASSIFICATION

      Supported values:

      • Security

      • Bugfix

      • Enhancement

      • Recommended

      • Newpackage

      Supported key: SEVERITY

      Supported values:

      • Critical

      • Important

      • Medium

      • Low

      • Key (string) -- [REQUIRED]

        The key for the filter.

        See PatchFilter for lists of valid keys for each operating system type.

      • Values (list) -- [REQUIRED]

        The value for the filter key.

        See PatchFilter for lists of valid values for each key based on operating system type.

        • (string) --

type ApprovalRules

dict

param ApprovalRules

A set of rules used to include patches in the baseline.

  • PatchRules (list) -- [REQUIRED]

    The rules that make up the rule group.

    • (dict) --

      Defines an approval rule for a patch baseline.

      • PatchFilterGroup (dict) -- [REQUIRED]

        The patch filter group that defines the criteria for the rule.

        • PatchFilters (list) -- [REQUIRED]

          The set of patch filters that make up the group.

          • (dict) --

            Defines a patch filter.

            A patch filter consists of key/value pairs, but not all keys are valid for all operating system types. For example, the key PRODUCT is valid for all supported operating system types. The key MSRC_SEVERITY , however, is valid only for Windows operating systems, and the key SECTION is valid only for Ubuntu operating systems.

            Refer to the following sections for information about which keys may be used with each major operating system, and which values are valid for each key.

            Windows Operating Systems

            The supported keys for Windows operating systems are PRODUCT , CLASSIFICATION , and MSRC_SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • Windows7

            • Windows8

            • Windows8.1

            • Windows8Embedded

            • Windows10

            • Windows10LTSB

            • WindowsServer2008

            • WindowsServer2008R2

            • WindowsServer2012

            • WindowsServer2012R2

            • WindowsServer2016

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • CriticalUpdates

            • DefinitionUpdates

            • Drivers

            • FeaturePacks

            • SecurityUpdates

            • ServicePacks

            • Tools

            • UpdateRollups

            • Updates

            • Upgrades

            Supported key: MSRC_SEVERITY

            Supported values:

            • Critical

            • Important

            • Moderate

            • Low

            • Unspecified

            Ubuntu Operating Systems

            The supported keys for Ubuntu operating systems are PRODUCT , PRIORITY , and SECTION . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • Ubuntu14.04

            • Ubuntu16.04

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: PRIORITY

            Supported values:

            • Required

            • Important

            • Standard

            • Optional

            • Extra

            Supported key: SECTION

            Only the length of the key value is validated. Minimum length is 1. Maximum length is 64.

            Amazon Linux Operating Systems

            The supported keys for Amazon Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • AmazonLinux2012.03

            • AmazonLinux2012.09

            • AmazonLinux2013.03

            • AmazonLinux2013.09

            • AmazonLinux2014.03

            • AmazonLinux2014.09

            • AmazonLinux2015.03

            • AmazonLinux2015.09

            • AmazonLinux2016.03

            • AmazonLinux2016.09

            • AmazonLinux2017.03

            • AmazonLinux2017.09

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Bugfix

            • Enhancement

            • Recommended

            • Newpackage

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Medium

            • Low

            Amazon Linux 2 Operating Systems

            The supported keys for Amazon Linux 2 operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • AmazonLinux2

            • AmazonLinux2.0

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Bugfix

            • Enhancement

            • Recommended

            • Newpackage

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Medium

            • Low

            RedHat Enterprise Linux (RHEL) Operating Systems

            The supported keys for RedHat Enterprise Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • RedhatEnterpriseLinux6.5

            • RedhatEnterpriseLinux6.6

            • RedhatEnterpriseLinux6.7

            • RedhatEnterpriseLinux6.8

            • RedhatEnterpriseLinux6.9

            • RedhatEnterpriseLinux7.0

            • RedhatEnterpriseLinux7.1

            • RedhatEnterpriseLinux7.2

            • RedhatEnterpriseLinux7.3

            • RedhatEnterpriseLinux7.4

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Bugfix

            • Enhancement

            • Recommended

            • Newpackage

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Medium

            • Low

            SUSE Linux Enterprise Server (SLES) Operating Systems

            The supported keys for SLES operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • Suse12.0

            • Suse12.1

            • Suse12.2

            • Suse12.3

            • Suse12.4

            • Suse12.5

            • Suse12.6

            • Suse12.7

            • Suse12.8

            • Suse12.9

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Recommended

            • Optional

            • Feature

            • Document

            • Yast

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Moderate

            • Low

            CentOS Operating Systems

            The supported keys for CentOS operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

            Supported key: PRODUCT

            Supported values:

            • CentOS6.5

            • CentOS6.6

            • CentOS6.7

            • CentOS6.8

            • CentOS6.9

            • CentOS7.0

            • CentOS7.1

            • CentOS7.2

            • CentOS7.3

            • CentOS7.4

            • * Use a wildcard character () to target all supported operating system versions.*

            Supported key: CLASSIFICATION

            Supported values:

            • Security

            • Bugfix

            • Enhancement

            • Recommended

            • Newpackage

            Supported key: SEVERITY

            Supported values:

            • Critical

            • Important

            • Medium

            • Low

            • Key (string) -- [REQUIRED]

              The key for the filter.

              See PatchFilter for lists of valid keys for each operating system type.

            • Values (list) -- [REQUIRED]

              The value for the filter key.

              See PatchFilter for 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. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.

      • ApproveAfterDays (integer) -- [REQUIRED]

        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.

      • EnableNonSecurity (boolean) --

        For instances 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 instances only.

type ApprovedPatches

list

param ApprovedPatches

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide .

  • (string) --

type ApprovedPatchesComplianceLevel

string

param ApprovedPatchesComplianceLevel

Assigns a new compliance severity level to an existing patch baseline.

type ApprovedPatchesEnableNonSecurity

boolean

param ApprovedPatchesEnableNonSecurity

Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

type RejectedPatches

list

param RejectedPatches

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide .

  • (string) --

type RejectedPatchesAction

string

param RejectedPatchesAction

The action for Patch Manager to take on patches included in the RejectedPackages list.

  • ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther . This is the default action if no option is specified.

  • BLOCK : Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected .

type Description

string

param Description

A description of the patch baseline.

type Sources

list

param Sources

Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

  • (dict) --

    Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.

    • Name (string) -- [REQUIRED]

      The name specified to identify the patch source.

    • Products (list) -- [REQUIRED]

      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) -- [REQUIRED]

      The value of the yum repo configuration. For example:

      cachedir=/var/cache/yum/$basesearch

      $releasever

      keepcache=0

      debuglevel=2

type Replace

boolean

param Replace

If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null.

rtype

dict

returns

Response Syntax

{
    'BaselineId': 'string',
    'Name': 'string',
    'OperatingSystem': 'WINDOWS'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'UBUNTU'|'REDHAT_ENTERPRISE_LINUX'|'SUSE'|'CENTOS',
    'GlobalFilters': {
        'PatchFilters': [
            {
                'Key': 'PRODUCT'|'CLASSIFICATION'|'MSRC_SEVERITY'|'PATCH_ID'|'SECTION'|'PRIORITY'|'SEVERITY',
                'Values': [
                    'string',
                ]
            },
        ]
    },
    'ApprovalRules': {
        'PatchRules': [
            {
                'PatchFilterGroup': {
                    'PatchFilters': [
                        {
                            'Key': 'PRODUCT'|'CLASSIFICATION'|'MSRC_SEVERITY'|'PATCH_ID'|'SECTION'|'PRIORITY'|'SEVERITY',
                            'Values': [
                                'string',
                            ]
                        },
                    ]
                },
                'ComplianceLevel': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
                'ApproveAfterDays': 123,
                'EnableNonSecurity': True|False
            },
        ]
    },
    'ApprovedPatches': [
        'string',
    ],
    'ApprovedPatchesComplianceLevel': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
    'ApprovedPatchesEnableNonSecurity': True|False,
    'RejectedPatches': [
        'string',
    ],
    'RejectedPatchesAction': 'ALLOW_AS_DEPENDENCY'|'BLOCK',
    '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 deleted patch baseline.

    • Name (string) --

      The name of the patch baseline.

    • OperatingSystem (string) --

      The operating system rule used by the updated 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 a patch filter.

          A patch filter consists of key/value pairs, but not all keys are valid for all operating system types. For example, the key PRODUCT is valid for all supported operating system types. The key MSRC_SEVERITY , however, is valid only for Windows operating systems, and the key SECTION is valid only for Ubuntu operating systems.

          Refer to the following sections for information about which keys may be used with each major operating system, and which values are valid for each key.

          Windows Operating Systems

          The supported keys for Windows operating systems are PRODUCT , CLASSIFICATION , and MSRC_SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • Windows7

          • Windows8

          • Windows8.1

          • Windows8Embedded

          • Windows10

          • Windows10LTSB

          • WindowsServer2008

          • WindowsServer2008R2

          • WindowsServer2012

          • WindowsServer2012R2

          • WindowsServer2016

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • CriticalUpdates

          • DefinitionUpdates

          • Drivers

          • FeaturePacks

          • SecurityUpdates

          • ServicePacks

          • Tools

          • UpdateRollups

          • Updates

          • Upgrades

          Supported key: MSRC_SEVERITY

          Supported values:

          • Critical

          • Important

          • Moderate

          • Low

          • Unspecified

          Ubuntu Operating Systems

          The supported keys for Ubuntu operating systems are PRODUCT , PRIORITY , and SECTION . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • Ubuntu14.04

          • Ubuntu16.04

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: PRIORITY

          Supported values:

          • Required

          • Important

          • Standard

          • Optional

          • Extra

          Supported key: SECTION

          Only the length of the key value is validated. Minimum length is 1. Maximum length is 64.

          Amazon Linux Operating Systems

          The supported keys for Amazon Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • AmazonLinux2012.03

          • AmazonLinux2012.09

          • AmazonLinux2013.03

          • AmazonLinux2013.09

          • AmazonLinux2014.03

          • AmazonLinux2014.09

          • AmazonLinux2015.03

          • AmazonLinux2015.09

          • AmazonLinux2016.03

          • AmazonLinux2016.09

          • AmazonLinux2017.03

          • AmazonLinux2017.09

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Bugfix

          • Enhancement

          • Recommended

          • Newpackage

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Medium

          • Low

          Amazon Linux 2 Operating Systems

          The supported keys for Amazon Linux 2 operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • AmazonLinux2

          • AmazonLinux2.0

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Bugfix

          • Enhancement

          • Recommended

          • Newpackage

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Medium

          • Low

          RedHat Enterprise Linux (RHEL) Operating Systems

          The supported keys for RedHat Enterprise Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • RedhatEnterpriseLinux6.5

          • RedhatEnterpriseLinux6.6

          • RedhatEnterpriseLinux6.7

          • RedhatEnterpriseLinux6.8

          • RedhatEnterpriseLinux6.9

          • RedhatEnterpriseLinux7.0

          • RedhatEnterpriseLinux7.1

          • RedhatEnterpriseLinux7.2

          • RedhatEnterpriseLinux7.3

          • RedhatEnterpriseLinux7.4

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Bugfix

          • Enhancement

          • Recommended

          • Newpackage

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Medium

          • Low

          SUSE Linux Enterprise Server (SLES) Operating Systems

          The supported keys for SLES operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • Suse12.0

          • Suse12.1

          • Suse12.2

          • Suse12.3

          • Suse12.4

          • Suse12.5

          • Suse12.6

          • Suse12.7

          • Suse12.8

          • Suse12.9

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Recommended

          • Optional

          • Feature

          • Document

          • Yast

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Moderate

          • Low

          CentOS Operating Systems

          The supported keys for CentOS operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

          Supported key: PRODUCT

          Supported values:

          • CentOS6.5

          • CentOS6.6

          • CentOS6.7

          • CentOS6.8

          • CentOS6.9

          • CentOS7.0

          • CentOS7.1

          • CentOS7.2

          • CentOS7.3

          • CentOS7.4

          • * Use a wildcard character () to target all supported operating system versions.*

          Supported key: CLASSIFICATION

          Supported values:

          • Security

          • Bugfix

          • Enhancement

          • Recommended

          • Newpackage

          Supported key: SEVERITY

          Supported values:

          • Critical

          • Important

          • Medium

          • Low

          • Key (string) --

            The key for the filter.

            See PatchFilter for lists of valid keys for each operating system type.

          • Values (list) --

            The value for the filter key.

            See PatchFilter for 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 a patch filter.

                A patch filter consists of key/value pairs, but not all keys are valid for all operating system types. For example, the key PRODUCT is valid for all supported operating system types. The key MSRC_SEVERITY , however, is valid only for Windows operating systems, and the key SECTION is valid only for Ubuntu operating systems.

                Refer to the following sections for information about which keys may be used with each major operating system, and which values are valid for each key.

                Windows Operating Systems

                The supported keys for Windows operating systems are PRODUCT , CLASSIFICATION , and MSRC_SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • Windows7

                • Windows8

                • Windows8.1

                • Windows8Embedded

                • Windows10

                • Windows10LTSB

                • WindowsServer2008

                • WindowsServer2008R2

                • WindowsServer2012

                • WindowsServer2012R2

                • WindowsServer2016

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • CriticalUpdates

                • DefinitionUpdates

                • Drivers

                • FeaturePacks

                • SecurityUpdates

                • ServicePacks

                • Tools

                • UpdateRollups

                • Updates

                • Upgrades

                Supported key: MSRC_SEVERITY

                Supported values:

                • Critical

                • Important

                • Moderate

                • Low

                • Unspecified

                Ubuntu Operating Systems

                The supported keys for Ubuntu operating systems are PRODUCT , PRIORITY , and SECTION . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • Ubuntu14.04

                • Ubuntu16.04

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: PRIORITY

                Supported values:

                • Required

                • Important

                • Standard

                • Optional

                • Extra

                Supported key: SECTION

                Only the length of the key value is validated. Minimum length is 1. Maximum length is 64.

                Amazon Linux Operating Systems

                The supported keys for Amazon Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • AmazonLinux2012.03

                • AmazonLinux2012.09

                • AmazonLinux2013.03

                • AmazonLinux2013.09

                • AmazonLinux2014.03

                • AmazonLinux2014.09

                • AmazonLinux2015.03

                • AmazonLinux2015.09

                • AmazonLinux2016.03

                • AmazonLinux2016.09

                • AmazonLinux2017.03

                • AmazonLinux2017.09

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Bugfix

                • Enhancement

                • Recommended

                • Newpackage

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Medium

                • Low

                Amazon Linux 2 Operating Systems

                The supported keys for Amazon Linux 2 operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • AmazonLinux2

                • AmazonLinux2.0

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Bugfix

                • Enhancement

                • Recommended

                • Newpackage

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Medium

                • Low

                RedHat Enterprise Linux (RHEL) Operating Systems

                The supported keys for RedHat Enterprise Linux operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • RedhatEnterpriseLinux6.5

                • RedhatEnterpriseLinux6.6

                • RedhatEnterpriseLinux6.7

                • RedhatEnterpriseLinux6.8

                • RedhatEnterpriseLinux6.9

                • RedhatEnterpriseLinux7.0

                • RedhatEnterpriseLinux7.1

                • RedhatEnterpriseLinux7.2

                • RedhatEnterpriseLinux7.3

                • RedhatEnterpriseLinux7.4

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Bugfix

                • Enhancement

                • Recommended

                • Newpackage

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Medium

                • Low

                SUSE Linux Enterprise Server (SLES) Operating Systems

                The supported keys for SLES operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • Suse12.0

                • Suse12.1

                • Suse12.2

                • Suse12.3

                • Suse12.4

                • Suse12.5

                • Suse12.6

                • Suse12.7

                • Suse12.8

                • Suse12.9

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Recommended

                • Optional

                • Feature

                • Document

                • Yast

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Moderate

                • Low

                CentOS Operating Systems

                The supported keys for CentOS operating systems are PRODUCT , CLASSIFICATION , and SEVERITY . See the following lists for valid values for each of these keys.

                Supported key: PRODUCT

                Supported values:

                • CentOS6.5

                • CentOS6.6

                • CentOS6.7

                • CentOS6.8

                • CentOS6.9

                • CentOS7.0

                • CentOS7.1

                • CentOS7.2

                • CentOS7.3

                • CentOS7.4

                • * Use a wildcard character () to target all supported operating system versions.*

                Supported key: CLASSIFICATION

                Supported values:

                • Security

                • Bugfix

                • Enhancement

                • Recommended

                • Newpackage

                Supported key: SEVERITY

                Supported values:

                • Critical

                • Important

                • Medium

                • Low

                • Key (string) --

                  The key for the filter.

                  See PatchFilter for lists of valid keys for each operating system type.

                • Values (list) --

                  The value for the filter key.

                  See PatchFilter for 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. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.

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

          • EnableNonSecurity (boolean) --

            For instances 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 instances only.

    • ApprovedPatches (list) --

      A list of explicitly approved patches for the baseline.

      • (string) --

    • ApprovedPatchesComplianceLevel (string) --

      The compliance severity level assigned to the patch baseline after the update completed.

    • ApprovedPatchesEnableNonSecurity (boolean) --

      Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances 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.

    • CreatedDate (datetime) --

      The date when the patch baseline was created.

    • ModifiedDate (datetime) --

      The date when 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 instances, including target operating systems and source repositories. Applies to Linux instances only.

      • (dict) --

        Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances 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:

          cachedir=/var/cache/yum/$basesearch

          $releasever

          keepcache=0

          debuglevel=2