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
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-patch-properties
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: Properties
describe-patch-properties
--operating-system <value>
--property <value>
[--patch-set <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--operating-system
(string)
The operating system type for which to list patches.
Possible values:
WINDOWS
AMAZON_LINUX
AMAZON_LINUX_2
UBUNTU
REDHAT_ENTERPRISE_LINUX
SUSE
CENTOS
ORACLE_LINUX
DEBIAN
MACOS
--property
(string)
The patch property for which you want to view patch details.
Possible values:
PRODUCT
PRODUCT_FAMILY
CLASSIFICATION
MSRC_SEVERITY
PRIORITY
SEVERITY
--patch-set
(string)
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.
Possible values:
OS
APPLICATION
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To list the Amazon Linux patch availability
The following describe-patch-properties
example displays a list of the Amazon Linux products for which patches are available in your AWS account.
aws ssm describe-patch-properties \
--operating-system AMAZON_LINUX \
--property PRODUCT
Output:
{
"Properties": [
{
"Name": "AmazonLinux2012.03"
},
{
"Name": "AmazonLinux2012.09"
},
{
"Name": "AmazonLinux2013.03"
},
{
"Name": "AmazonLinux2013.09"
},
{
"Name": "AmazonLinux2014.03"
},
{
"Name": "AmazonLinux2014.09"
},
{
"Name": "AmazonLinux2015.03"
},
{
"Name": "AmazonLinux2015.09"
},
{
"Name": "AmazonLinux2016.03"
},
{
"Name": "AmazonLinux2016.09"
},
{
"Name": "AmazonLinux2017.03"
},
{
"Name": "AmazonLinux2017.09"
},
{
"Name": "AmazonLinux2018.03"
}
]
}
For more information, see About Patch Baselines in the AWS Systems Manager User Guide.
Properties -> (list)
A list of the properties for patches matching the filter request parameters.
(map)
key -> (string)
value -> (string)
NextToken -> (string)
The token for the next set of items to return. (You use this token in the next call.)