DescribePatchPropertiesCommand

Suggest an Edit

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

AMAZON_LINUX_2023

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SSMClient, DescribePatchPropertiesCommand } from "@aws-sdk/client-ssm"; // ES Modules import
// const { SSMClient, DescribePatchPropertiesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
const client = new SSMClient(config);
const input = { // DescribePatchPropertiesRequest
  OperatingSystem: "WINDOWS" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "AMAZON_LINUX_2022" || "UBUNTU" || "REDHAT_ENTERPRISE_LINUX" || "SUSE" || "CENTOS" || "ORACLE_LINUX" || "DEBIAN" || "MACOS" || "RASPBIAN" || "ROCKY_LINUX" || "ALMA_LINUX" || "AMAZON_LINUX_2023", // required
  Property: "PRODUCT" || "PRODUCT_FAMILY" || "CLASSIFICATION" || "MSRC_SEVERITY" || "PRIORITY" || "SEVERITY", // required
  PatchSet: "OS" || "APPLICATION",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribePatchPropertiesCommand(input);
const response = await client.send(command);
// { // DescribePatchPropertiesResult
//   Properties: [ // PatchPropertiesList
//     { // PatchPropertyEntry
//       "<keys>": "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribePatchPropertiesCommand Input

See DescribePatchPropertiesCommandInput for more details

Parameter
Type
Description
OperatingSystem
Required
OperatingSystem | undefined

The operating system type for which to list patches.

Property
Required
PatchProperty | undefined

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

MaxResults
number | undefined

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.

NextToken
string | undefined

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

PatchSet
PatchSet | undefined

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.

DescribePatchPropertiesCommand Output

See DescribePatchPropertiesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

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

Properties
Record<string, string>[] | undefined

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

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

SSMServiceException
Base exception class for all service exceptions from SSM service.