/

The Amazon SSM multi-region endpoint

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

POST

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

AMAZON_LINUX: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
AMAZON_LINUX_2: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
CENTOS: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
DEBIAN: Valid properties: PRODUCT | PRIORITY
MACOS: Valid properties: PRODUCT | CLASSIFICATION
ORACLE_LINUX: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
REDHAT_ENTERPRISE_LINUX: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
SUSE: Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
UBUNTU: Valid properties: PRODUCT | PRIORITY
WINDOWS: Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY

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 '{
    "OperatingSystem": "WINDOWS",
    "Property": "PRODUCT",
    "PatchSet": "OS",
    "MaxResults": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
    "Properties": [],
    "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

OperatingSystem

enum<string>

required

The operating system type for which to list patches.

Allowed values:

WINDOWSAMAZON_LINUXAMAZON_LINUX_2AMAZON_LINUX_2022UBUNTUREDHAT_ENTERPRISE_LINUXSUSECENTOSORACLE_LINUXDEBIANMACOSRASPBIANROCKY_LINUXALMA_LINUXAMAZON_LINUX_2023

Property

enum<string>

required

The patch property for which you want to view patch details.

Allowed values:

PRODUCTPRODUCT_FAMILYCLASSIFICATIONMSRC_SEVERITYPRIORITYSEVERITY

PatchSet

enum<string>

optional

Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.

Allowed values:

OSAPPLICATION

MaxResults

integer

optional

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

>= 1<= 50

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

Properties

array[object (PatchPropertyEntry)]

optional

A list of the properties for patches matching the filter request parameters.

NextToken

string

optional

The token for the next set of items to return. (You use this token in the next call.)

🟠480InternalServerError