Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141381,185842.7 KB

Returns high-level aggregated patch compliance state information for a patch group.

post/#X-Amz-Target=AmazonSSM.DescribePatchGroupState

Headers

X-Amz-Target'AmazonSSM.DescribePatchGroupState' required

Request body

PatchGroupstring required

The name of the patch group whose patch snapshot should be retrieved.

Response

Success

Instancesinteger

The number of managed nodes in the patch group.

InstancesWithInstalledPatchesinteger

The number of managed nodes with installed patches.

InstancesWithInstalledOtherPatchesinteger

The number of managed nodes with patches installed that aren't defined in the patch baseline.

InstancesWithInstalledPendingRebootPatchesinteger

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 <code>NON_COMPLIANT</code>.

InstancesWithInstalledRejectedPatchesinteger
<p>The number of managed nodes with patches installed that are specified in a <code>RejectedPatches</code> list. Patches with a status of <code>INSTALLED_REJECTED</code> were typically installed before they were added to a <code>RejectedPatches</code> list.</p> <note> <p>If <code>ALLOW_AS_DEPENDENCY</code> is the specified option for <code>RejectedPatchesAction</code>, the value of <code>InstancesWithInstalledRejectedPatches</code> will always be <code>0</code> (zero).</p> </note>
InstancesWithMissingPatchesinteger

The number of managed nodes with missing patches from the patch baseline.

InstancesWithFailedPatchesinteger

The number of managed nodes with patches from the patch baseline that failed to install.

InstancesWithNotApplicablePatchesinteger

The number of managed nodes with patches that aren't applicable.

InstancesWithUnreportedNotApplicablePatchesinteger

The number of managed nodes with <code>NotApplicable</code> patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

InstancesWithCriticalNonCompliantPatchesinteger

The number of managed nodes where patches that are specified as <code>Critical</code> for 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 is <code>NON_COMPLIANT</code>.

InstancesWithSecurityNonCompliantPatchesinteger

The number of managed nodes where patches that are specified as <code>Security</code> in 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 is <code>NON_COMPLIANT</code>.

InstancesWithOtherNonCompliantPatchesinteger

The number of managed nodes with patches installed that are specified as other than <code>Critical</code> or <code>Security</code> but aren't compliant with the patch baseline. The status of these managed nodes is <code>NON_COMPLIANT</code>.