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

GetPatchBaseline

Retrieves information about a patch baseline.

Request Syntax

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

BaselineId

The ID of the patch baseline to retrieve.

Type: String

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

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

Required: Yes

Response Syntax

{
   "ApprovalRules": { 
      "PatchRules": [ 
         { 
            "ApproveAfterDays": number,
            "ComplianceLevel": "string",
            "PatchFilterGroup": { 
               "PatchFilters": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         }
      ]
   },
   "ApprovedPatches": [ "string" ],
   "ApprovedPatchesComplianceLevel": "string",
   "BaselineId": "string",
   "CreatedDate": number,
   "Description": "string",
   "GlobalFilters": { 
      "PatchFilters": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "ModifiedDate": number,
   "Name": "string",
   "OperatingSystem": "string",
   "PatchGroups": [ "string" ],
   "RejectedPatches": [ "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

Returns the specified compliance severity level for approved patches in the patch baseline.

Type: String

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

BaselineId

The ID of the retrieved patch baseline.

Type: String

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

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

CreatedDate

The date 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 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

Returns the operating system specified for the patch baseline.

Type: String

Valid Values: WINDOWS | AMAZON_LINUX | UBUNTU | REDHAT_ENTERPRISE_LINUX

PatchGroups

Patch groups included in the patch baseline.

Type: Array of strings

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

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

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.

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 (e.g. a Maintenance Window) doesn't exist.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

InvalidResourceId

The resource ID is not valid. Verify that you entered the correct ID and try again.

HTTP Status Code: 400

See Also

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