/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "PatchGroup": "string"
}'

Response Example

200 - Example 1

{
    "Instances": 0,
    "InstancesWithInstalledPatches": 0,
    "InstancesWithInstalledOtherPatches": 0,
    "InstancesWithInstalledPendingRebootPatches": 0,
    "InstancesWithInstalledRejectedPatches": 0,
    "InstancesWithMissingPatches": 0,
    "InstancesWithFailedPatches": 0,
    "InstancesWithNotApplicablePatches": 0,
    "InstancesWithUnreportedNotApplicablePatches": 0,
    "InstancesWithCriticalNonCompliantPatches": 0,
    "InstancesWithSecurityNonCompliantPatches": 0,
    "InstancesWithOtherNonCompliantPatches": 0
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

PatchGroup

string

required

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

>= 1 characters<= 256 characters

Match pattern:

^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Examples

Responses

🟢200Success

application/json

Body

Instances

integer

optional

The number of managed nodes in the patch group.

InstancesWithInstalledPatches

integer

optional

The number of managed nodes with installed patches.

InstancesWithInstalledOtherPatches

integer

optional

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

InstancesWithInstalledPendingRebootPatches

integer

optional

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.

InstancesWithInstalledRejectedPatches

integer

optional

The number of managed nodes with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.

InstancesWithMissingPatches

integer

optional

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

InstancesWithFailedPatches

integer

optional

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

InstancesWithNotApplicablePatches

integer

optional

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

InstancesWithUnreportedNotApplicablePatches

integer

optional

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

InstancesWithCriticalNonCompliantPatches

integer

optional

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

InstancesWithSecurityNonCompliantPatches

integer

optional

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

InstancesWithOtherNonCompliantPatches

integer

optional

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

🟠480InternalServerError

🟠481InvalidNextToken