AWS Systems Manager
API Reference (API Version 2014-11-06)

CreatePatchBaseline

Creates a patch baseline.

Note

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

Request Syntax

{ "ApprovalRules": { "PatchRules": [ { "ApproveAfterDays": number, "ComplianceLevel": "string", "EnableNonSecurity": boolean, "PatchFilterGroup": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] } ] } } ] }, "ApprovedPatches": [ "string" ], "ApprovedPatchesComplianceLevel": "string", "ApprovedPatchesEnableNonSecurity": boolean, "ClientToken": "string", "Description": "string", "GlobalFilters": { "PatchFilters": [ { "Key": "string", "Values": [ "string" ] } ] }, "Name": "string", "OperatingSystem": "string", "RejectedPatches": [ "string" ], "RejectedPatchesAction": "string", "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

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: String

Valid Values: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED

Required: No

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: Boolean

Required: No

ClientToken

User-provided idempotency token.

Type: String

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

Required: No

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 exclude patches from the baseline.

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: Yes

OperatingSystem

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

Type: String

Valid Values: WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS

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: 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: String

Valid Values: ALLOW_AS_DEPENDENCY | BLOCK

Required: No

Sources

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

Type: Array of PatchSource objects

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

Required: No

Response Syntax

{ "BaselineId": "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.

BaselineId

The ID of the created patch baseline.

Type: String

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

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

Errors

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

IdempotentParameterMismatch

Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

ResourceLimitExceededException

Error returned when the caller has exceeded the default resource limits. For example, too many Maintenance Windows or Patch baselines have been created.

For information about resource limits in Systems Manager, see AWS Systems Manager Limits.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 461 X-Amz-Target: AmazonSSM.CreatePatchBaseline X-Amz-Date: 20180309T022356Z 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/20180309/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Description": "Baseline containing all updates approved for production systems", "ApprovalRules": { "PatchRules": [ { "PatchFilterGroup": { "PatchFilters": [ { "Values": [ "Critical", "Important", "Moderate" ], "Key": "MSRC_SEVERITY" }, { "Values": [ "SecurityUpdates", "Updates", "UpdateRollups", "CriticalUpdates" ], "Key": "CLASSIFICATION" } ] }, "ApproveAfterDays": 7 } ] }, "Name": "my-Windows-Server-patch-baseline", "OperatingSystem": "WINDOWS", "ClientToken": "9cd0e9f5-f8a7-4f1a-876e-db937EXAMPLE" }

Sample Response

{ "BaselineId": "pb-0c10e65780EXAMPLE" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: