DescribePatchGroupState
Returns high-level aggregated patch compliance state information for a patch group.
Request Syntax
{
"PatchGroup": "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.
- PatchGroup
-
The name of the patch group whose patch snapshot should be retrieved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$Required: Yes
Response Syntax
{
"Instances": number,
"InstancesWithCriticalNonCompliantPatches": number,
"InstancesWithFailedPatches": number,
"InstancesWithInstalledOtherPatches": number,
"InstancesWithInstalledPatches": number,
"InstancesWithInstalledPendingRebootPatches": number,
"InstancesWithInstalledRejectedPatches": number,
"InstancesWithMissingPatches": number,
"InstancesWithNotApplicablePatches": number,
"InstancesWithOtherNonCompliantPatches": number,
"InstancesWithSecurityNonCompliantPatches": number,
"InstancesWithUnreportedNotApplicablePatches": number
}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.
- Instances
-
The number of managed nodes in the patch group.
Type: Integer
- InstancesWithCriticalNonCompliantPatches
-
The number of managed nodes where patches that are specified as
Criticalfor compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes isNON_COMPLIANT.Type: Integer
- InstancesWithFailedPatches
-
The number of managed nodes with patches from the patch baseline that failed to install.
Type: Integer
- InstancesWithInstalledOtherPatches
-
The number of managed nodes with patches installed that aren't defined in the patch baseline.
Type: Integer
- InstancesWithInstalledPatches
-
The number of managed nodes with installed patches.
Type: Integer
- InstancesWithInstalledPendingRebootPatches
-
The number of managed nodes with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these managed nodes is
NON_COMPLIANT.Type: Integer
- InstancesWithInstalledRejectedPatches
-
The number of managed nodes with patches installed that are specified in a
RejectedPatcheslist. Patches with a status ofINSTALLED_REJECTEDwere typically installed before they were added to aRejectedPatcheslist.Note
If
ALLOW_AS_DEPENDENCYis the specified option forRejectedPatchesAction, the value ofInstancesWithInstalledRejectedPatcheswill always be0(zero).Type: Integer
- InstancesWithMissingPatches
-
The number of managed nodes with missing patches from the patch baseline.
Type: Integer
- InstancesWithNotApplicablePatches
-
The number of managed nodes with patches that aren't applicable.
Type: Integer
- InstancesWithOtherNonCompliantPatches
-
The number of managed nodes with patches installed that are specified as other than
CriticalorSecuritybut aren't compliant with the patch baseline. The status of these managed nodes isNON_COMPLIANT.Type: Integer
- InstancesWithSecurityNonCompliantPatches
-
The number of managed nodes where patches that are specified as
Securityin a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes isNON_COMPLIANT.Type: Integer
- InstancesWithUnreportedNotApplicablePatches
-
The number of managed nodes with
NotApplicablepatches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a tool in AWS Systems Manager.Type: Integer
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
- InvalidNextToken
-
The specified token isn't valid.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribePatchGroupState.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 33
X-Amz-Target: AmazonSSM.DescribePatchGroupState
X-Amz-Date: 20240308T205757Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240308/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
{
"PatchGroup": "mypatchgroup"
}Sample Response
{
"Instances": 12,
"InstancesWithCriticalNonCompliantPatches": 1,
"InstancesWithFailedPatches": 2,
"InstancesWithInstalledOtherPatches": 3,
"InstancesWithInstalledPatches": 12,
"InstancesWithInstalledPendingRebootPatches": 2,
"InstancesWithInstalledRejectedPatches": 1,
"InstancesWithMissingPatches": 3,
"InstancesWithNotApplicablePatches": 0,
"InstancesWithOtherNonCompliantPatches": 0,
"InstancesWithSecurityNonCompliantPatches": 1,
"InstancesWithUnreportedNotApplicablePatches": 0
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
