DescribePatchProperties
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
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
",
"OperatingSystem": "string
",
"PatchSet": "string
",
"Property": "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.
- MaxResults
-
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Required: No
- OperatingSystem
-
The operating system type for which to list patches.
Type: String
Valid Values:
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: Yes
- PatchSet
-
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.
Type: String
Valid Values:
OS | APPLICATION
Required: No
- Property
-
The patch property for which you want to view patch details.
Type: String
Valid Values:
PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY | PRIORITY | SEVERITY
Required: Yes
Response Syntax
{
"NextToken": "string",
"Properties": [
{
"string" : "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.
- NextToken
-
The token for the next set of items to return. (You use this token in the next call.)
Type: String
- Properties
-
A list of the properties for patches matching the filter request parameters.
Type: Array of string to string maps
Key Length Constraints: Minimum length of 1. Maximum length of 64.
Value Length Constraints: Minimum length of 0. Maximum length of 4096.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of DescribePatchProperties.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 95
X-Amz-Target: AmazonSSM.DescribePatchProperties
X-Amz-Date: 20240312T010204Z
User-Agent: aws-cli/1.16.96 Python/2.7.15 Windows/10 botocore/1.12.86
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
{
"OperatingSystem": "Windows",
"Property": "PRODUCT",
"PatchSet": "OS"
}
Sample Response
{
"Properties": [
{
"Name": "WindowsServer2012",
"ProductFamily": "Windows"
},
{
"Name": "WindowsServer2012R2",
"ProductFamily": "Windows"
},
{
"Name": "WindowsServer2016",
"ProductFamily": "Windows"
},
{
"Name": "WindowsServer2019",
"ProductFamily": "Windows"
}
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: