/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Lists all patches eligible to be included in a patch baseline.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Filters": [],
    "MaxResults": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
    "Patches": [],
    "NextToken": "string"
}

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

Filters

array[object (PatchOrchestratorFilter) {2}]

optional

Each element in the array is a structure containing a key-value pair.

Windows Server

Supported keys for Windows Server managed node patches include the following:

PATCH_SET

Sample values: OS | APPLICATION
PRODUCT

Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus
PRODUCT_FAMILY

Sample values: Windows | Office
MSRC_SEVERITY

Sample values: ServicePacks | Important | Moderate
CLASSIFICATION

Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates
PATCH_ID

Sample values: KB123456 | KB4516046

Linux

Supported keys for Linux managed node patches include the following:

PRODUCT

Sample values: AmazonLinux2018.03 | AmazonLinux2.0
NAME

Sample values: kernel-headers | samba-python | php
SEVERITY

Sample values: Critical | Important | Medium | Low
EPOCH

Sample values: 0 | 1
VERSION

Sample values: 78.6.1 | 4.10.16
RELEASE

Sample values: 9.56.amzn1 | 1.amzn2
ARCH

Sample values: i686 | x86_64
REPOSITORY

Sample values: Core | Updates
ADVISORY_ID

Sample values: ALAS-2018-1058 | ALAS2-2021-1594
CVE_ID

Sample values: CVE-2018-3615 | CVE-2020-1472
BUGZILLA_ID

Sample values: 1463241

>= 0 items<= 5 items

Key

string

optional

The key for the filter.

>= 1 characters<= 128 characters

Values

array[string]

optional

The value for the filter.

MaxResults

integer

optional

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

>= 1<= 100

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

Patches

array[object (Patch) {23}]

optional

An array of patches. Each entry in the array is a patch structure.

string

optional

The ID of the patch. Applies to Windows patches only.

>= 1 characters<= 100 characters

ReleaseDate

string <date-time>

optional

The date the patch was released.

Title

string

optional

The title of the patch.

Description

string

optional

The description of the patch.

ContentUrl

string

optional

The URL where more information can be obtained about the patch.

Vendor

string

optional

The name of the vendor providing the patch.

ProductFamily

string

optional

The product family the patch is applicable for. For example, Windows or Amazon Linux 2.

Product

string

optional

The specific product the patch is applicable for. For example, WindowsServer2016 or AmazonLinux2018.03.

Classification

string

optional

The classification of the patch. For example, SecurityUpdates, Updates, or CriticalUpdates.

MsrcSeverity

string

optional

The severity of the patch, such as Critical, Important, or Moderate. Applies to Windows patches only.

KbNumber

string

optional

The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.

MsrcNumber

string

optional

The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to. For example, MS14-045. Applies to Windows patches only.

Language

string

optional

The language of the patch if it's language-specific.

AdvisoryIds

array[string]

optional

The Advisory ID of the patch. For example, RHSA-2020:3779. Applies to Linux-based managed nodes only.

BugzillaIds

array[string]

optional

The Bugzilla ID of the patch. For example, 1600646. Applies to Linux-based managed nodes only.

CVEIds

array[string]

optional

The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, CVE-2011-3192. Applies to Linux-based managed nodes only.

Name

string

optional

The name of the patch. Applies to Linux-based managed nodes only.

Epoch

integer

optional

The epoch of the patch. For example in pkg-example-EE-20180914-2.2.amzn1.noarch, the epoch value is 20180914-2. Applies to Linux-based managed nodes only.

Version

string

optional

The version number of the patch. For example, in example-pkg-1.710.10-2.7.abcd.x86_64, the version number is indicated by -1. Applies to Linux-based managed nodes only.

Release

string

optional

The particular release of a patch. For example, in pkg-example-EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1. Applies to Linux-based managed nodes only.

Arch

string

optional

The architecture of the patch. For example, in example-pkg-0.710.10-2.7.abcd.x86_64, the architecture is indicated by x86_64. Applies to Linux-based managed nodes only.

Severity

string

optional

The severity level of the patch. For example, CRITICAL or MODERATE.

Repository

string

optional

The source patch repository for the operating system and version, such as trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu Server 20.04 LTE. Applies to Linux-based managed nodes only.

NextToken

string

optional

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

🟠480InternalServerError