Lists all patches eligible to be included in a patch baseline.
Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.
Parameters:
-
filters
(Optional[PatchOrchestratorFilterList], default:
None
)
–
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
When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the Command Line Interface (CLI), the following command fails:
aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615
However, the following command succeeds:
aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615
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
-
max_results
(Optional[PatchBaselineMaxResults], default:
None
)
–
The maximum number of patches to return (per page).
-
next_token
(Optional[NextToken], default:
None
)
–
The token for the next set of items to return. (You received this token from a previous call.)
Raises:
Source code in docs_src/capo_ssm/_services/ssm.py
| def describe_available_patches(
self,
*,
config_overrides: Optional[SSMClientConfig] = None,
filters: Optional[
"capo_ssm.types.patch_orchestrator_filter_list.PatchOrchestratorFilterList"
] = None,
max_results: Optional[
"capo_ssm.types.patch_baseline_max_results.PatchBaselineMaxResults"
] = None,
next_token: Optional["capo_ssm.types.next_token.NextToken"] = None,
) -> "capo_ssm.types.describe_available_patches_result.DescribeAvailablePatchesResult":
"""<p>Lists all patches eligible to be included in a patch baseline.</p> <note> <p>Currently, <code>DescribeAvailablePatches</code> supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.</p> </note>
Args:
filters: <p>Each element in the array is a structure containing a key-value pair.</p> <p> <b>Windows Server</b> </p> <p>Supported keys for Windows Server managed node patches include the following:</p> <ul> <li> <p> <b> <code>PATCH_SET</code> </b> </p> <p>Sample values: <code>OS</code> | <code>APPLICATION</code> </p> </li> <li> <p> <b> <code>PRODUCT</code> </b> </p> <p>Sample values: <code>WindowsServer2012</code> | <code>Office 2010</code> | <code>MicrosoftDefenderAntivirus</code> </p> </li> <li> <p> <b> <code>PRODUCT_FAMILY</code> </b> </p> <p>Sample values: <code>Windows</code> | <code>Office</code> </p> </li> <li> <p> <b> <code>MSRC_SEVERITY</code> </b> </p> <p>Sample values: <code>ServicePacks</code> | <code>Important</code> | <code>Moderate</code> </p> </li> <li> <p> <b> <code>CLASSIFICATION</code> </b> </p> <p>Sample values: <code>ServicePacks</code> | <code>SecurityUpdates</code> | <code>DefinitionUpdates</code> </p> </li> <li> <p> <b> <code>PATCH_ID</code> </b> </p> <p>Sample values: <code>KB123456</code> | <code>KB4516046</code> </p> </li> </ul> <p> <b>Linux</b> </p> <important> <p>When specifying filters for Linux patches, you must specify a key-pair for <code>PRODUCT</code>. For example, using the Command Line Interface (CLI), the following command fails:</p> <p> <code>aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615</code> </p> <p>However, the following command succeeds:</p> <p> <code>aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615</code> </p> </important> <p>Supported keys for Linux managed node patches include the following:</p> <ul> <li> <p> <b> <code>PRODUCT</code> </b> </p> <p>Sample values: <code>AmazonLinux2018.03</code> | <code>AmazonLinux2.0</code> </p> </li> <li> <p> <b> <code>NAME</code> </b> </p> <p>Sample values: <code>kernel-headers</code> | <code>samba-python</code> | <code>php</code> </p> </li> <li> <p> <b> <code>SEVERITY</code> </b> </p> <p>Sample values: <code>Critical</code> | <code>Important</code> | <code>Medium</code> | <code>Low</code> </p> </li> <li> <p> <b> <code>EPOCH</code> </b> </p> <p>Sample values: <code>0</code> | <code>1</code> </p> </li> <li> <p> <b> <code>VERSION</code> </b> </p> <p>Sample values: <code>78.6.1</code> | <code>4.10.16</code> </p> </li> <li> <p> <b> <code>RELEASE</code> </b> </p> <p>Sample values: <code>9.56.amzn1</code> | <code>1.amzn2</code> </p> </li> <li> <p> <b> <code>ARCH</code> </b> </p> <p>Sample values: <code>i686</code> | <code>x86_64</code> </p> </li> <li> <p> <b> <code>REPOSITORY</code> </b> </p> <p>Sample values: <code>Core</code> | <code>Updates</code> </p> </li> <li> <p> <b> <code>ADVISORY_ID</code> </b> </p> <p>Sample values: <code>ALAS-2018-1058</code> | <code>ALAS2-2021-1594</code> </p> </li> <li> <p> <b> <code>CVE_ID</code> </b> </p> <p>Sample values: <code>CVE-2018-3615</code> | <code>CVE-2020-1472</code> </p> </li> <li> <p> <b> <code>BUGZILLA_ID</code> </b> </p> <p>Sample values: <code>1463241</code> </p> </li> </ul>
max_results: <p>The maximum number of patches to return (per page).</p>
next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
Raises:
capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_ssm.types.describe_available_patches_request.DescribeAvailablePatchesRequest]",
) -> OperationResponse[
"capo_ssm.types.describe_available_patches_result.DescribeAvailablePatchesResult"
]:
import capo_ssm._operations.amazon_ssm.describe_available_patches
output, http_response = (
capo_ssm._operations.amazon_ssm.describe_available_patches.describe_available_patches(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeAvailablePatches")
)
input_: capo_ssm.types.describe_available_patches_request.DescribeAvailablePatchesRequest = {}
if filters is not None:
input_["filters"] = filters
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|