Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

UpdatePatchBaseline

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

Note

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

Request Syntax


{
   "ApprovalRules": { 
      "PatchRules": [ 
         { 
            "ApproveAfterDays": number,
            "ApproveUntilDate": "string",
            "ComplianceLevel": "string",
            "EnableNonSecurity": boolean,
            "PatchFilterGroup": { 
               "PatchFilters": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         }
      ]
   },
   "ApprovedPatches": [ "string" ],
   "ApprovedPatchesComplianceLevel": "string",
   "ApprovedPatchesEnableNonSecurity": boolean,
   "BaselineId": "string",
   "Description": "string",
   "GlobalFilters": { 
      "PatchFilters": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "Name": "string",
   "RejectedPatches": [ "string" ],
   "RejectedPatchesAction": "string",
   "Replace": boolean,
   "Sources": [ 
      { 
         "Configuration": "string",
         "Name": "string",
         "Products": [ "string" ]
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ApprovalRules

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

Type: PatchRuleGroup object

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

ApprovedPatchesComplianceLevel

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

Type: String

Required: No

ApprovedPatchesEnableNonSecurity

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

Type: Boolean

Required: No

BaselineId

The ID of the patch baseline to update.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$

Required: Yes

Description

A description of the patch baseline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

GlobalFilters

A set of global filters used to include patches in the baseline.

Important

The GlobalFilters parameter can be configured only by using the AWS CLI or an AWS SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.

Type: PatchFilterGroup object

Required: No

Name

The name of the patch baseline.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

RejectedPatchesAction

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

ALLOW_AS_DEPENDENCY

Linux and macOS: 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 INSTALLED_OTHER. This is the default action if no option is specified.

Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified.

BLOCK

All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED.

Type: String

Valid Values: ALLOW_AS_DEPENDENCY | BLOCK

Required: No

Replace

If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.

Type: Boolean

Required: No

Sources

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

Type: Array of PatchSource objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

Response Syntax


{
   "ApprovalRules": { 
      "PatchRules": [ 
         { 
            "ApproveAfterDays": number,
            "ApproveUntilDate": "string",
            "ComplianceLevel": "string",
            "EnableNonSecurity": boolean,
            "PatchFilterGroup": { 
               "PatchFilters": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         }
      ]
   },
   "ApprovedPatches": [ "string" ],
   "ApprovedPatchesComplianceLevel": "string",
   "ApprovedPatchesEnableNonSecurity": boolean,
   "BaselineId": "string",
   "CreatedDate": number,
   "Description": "string",
   "GlobalFilters": { 
      "PatchFilters": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "ModifiedDate": number,
   "Name": "string",
   "OperatingSystem": "string",
   "RejectedPatches": [ "string" ],
   "RejectedPatchesAction": "string",
   "Sources": [ 
      { 
         "Configuration": "string",
         "Name": "string",
         "Products": [ "string" ]
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApprovalRules

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

Type: PatchRuleGroup object

ApprovedPatches

A list of explicitly approved patches for the baseline.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

ApprovedPatchesComplianceLevel

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

Type: String

ApprovedPatchesEnableNonSecurity

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

Type: Boolean

BaselineId

The ID of the deleted patch baseline.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$

CreatedDate

The date when the patch baseline was created.

Type: Timestamp

Description

A description of the patch baseline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

GlobalFilters

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

Type: PatchFilterGroup object

ModifiedDate

The date when the patch baseline was last modified.

Type: Timestamp

Name

The name of the patch baseline.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

OperatingSystem

The operating system rule used by the updated patch baseline.

Type: String

RejectedPatches

A list of explicitly rejected patches for the baseline.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

RejectedPatchesAction

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.

Type: String

Valid Values: ALLOW_AS_DEPENDENCY | BLOCK

Sources

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

Type: Array of PatchSource objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

DoesNotExistException

Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

Examples

Example

This example illustrates one usage of UpdatePatchBaseline.

Sample Request


POST / HTTP/1.1
   Host: ssm.us-east-2.amazonaws.com
   Accept-Encoding: identity
   Content-Length: 306
   X-Amz-Target: AmazonSSM.UpdatePatchBaseline
   X-Amz-Date: 20240309T023346Z
   User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
   Content-Type: application/x-amz-json-1.1
   Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
   SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
  
  {
    "ApprovalRules": {
        "PatchRules": [
            {
                "PatchFilterGroup": {
                    "PatchFilters": [
                        {
                            "Values": [
                                "Critical",
                                "Important"
                            ],
                            "Key": "MSRC_SEVERITY"
                        },
                        {
                            "Values": [
                                "SecurityUpdates",
                                "Updates",
                                "UpdateRollups",
                                "CriticalUpdates"
                            ],
                            "Key": "CLASSIFICATION"
                        }
                    ]
                },
                "ApproveAfterDays": 3
            }
        ]
    },
    "BaselineId": "pb-0c10e65780EXAMPLE"
}

Sample Response


{
    "ApprovalRules": {
        "PatchRules": [
            {
                "ApproveAfterDays": 3,
                "ComplianceLevel": "UNSPECIFIED",
                "EnableNonSecurity": false,
                "PatchFilterGroup": {
                    "PatchFilters": [
                        {
                            "Key": "MSRC_SEVERITY",
                            "Values": [
                                "Critical",
                                "Important"
                            ]
                        },
                        {
                            "Key": "CLASSIFICATION",
                            "Values": [
                                "SecurityUpdates",
                                "Updates",
                                "UpdateRollups",
                                "CriticalUpdates"
                            ]
                        }
                    ]
                }
            }
        ]
    },
    "ApprovedPatches": [],
    "ApprovedPatchesComplianceLevel": "UNSPECIFIED",
    "ApprovedPatchesEnableNonSecurity": false,
    "BaselineId": "pb-0c10e65780EXAMPLE",
    "Description": "Baseline containing all updates approved for production systems",
    "GlobalFilters": {
        "PatchFilters": []
    },
    "CreatedDate": 1520562237.968,
    "ModifiedDate": 1520562239.765,
    "Name": "my-Windows-Server-patch-baseline",
    "OperatingSystem": "WINDOWS",
    "RejectedPatches": [],
    "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY",
    "Sources": []
}