/

The Amazon SSM multi-region endpoint

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

POST

Retrieves the high-level patch state of one or more managed nodes.

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 '{
    "InstanceIds": [],
    "NextToken": "string",
    "MaxResults": 0
}'

Response Example

200 - Example 1

{
    "InstancePatchStates": [],
    "NextToken": "string"
}

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

InstanceIds

array[string]

required

The ID of the managed node for which patch state information should be retrieved.

>= 0 items<= 50 items

NextToken

string

optional

The token for the next set of items to return. (You received this token from a previous call.)

MaxResults

integer

optional

The maximum number of managed nodes to return (per page).

>= 10<= 100

Examples

Responses

🟢200Success

application/json

Body

InstancePatchStates

array[object (InstancePatchState) {22}]

optional

The high-level patch state for the requested managed nodes.

InstanceId

string

required

The ID of the managed node the high-level patch compliance information was collected for.

Match pattern:

(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

PatchGroup

string

required

The name of the patch group the managed node belongs to.

>= 1 characters<= 256 characters

Match pattern:

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

BaselineId

string

required

The ID of the patch baseline used to patch the managed node.

>= 20 characters<= 128 characters

Match pattern:

^[a-zA-Z0-9_\-:/]{20,128}$

SnapshotId

string

optional

The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

>= 36 characters<= 36 characters

Match pattern:

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

InstallOverrideList

string

optional

An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

For more information about the InstallOverrideList parameter, see About the AWS-RunPatchBaseline SSM document in the Amazon Web Services Systems Manager User Guide.

>= 1 characters<= 256 characters

Match pattern:

^https://.+$|^s3://([^/]+)/(.*?([^/]+))$

OwnerInformation

string <password>

optional

Placeholder information. This field will always be empty in the current release of the service.

>= 1 characters<= 128 characters

InstalledCount

integer

optional

The number of patches from the patch baseline that are installed on the managed node.

InstalledOtherCount

integer

optional

The number of patches not specified in the patch baseline that are installed on the managed node.

InstalledPendingRebootCount

integer

optional

The number of patches installed by Patch Manager since the last time the managed node was rebooted.

InstalledRejectedCount

integer

optional

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

MissingCount

integer

optional

The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.

FailedCount

integer

optional

The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

UnreportedNotApplicableCount

integer

optional

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

NotApplicableCount

integer

optional

The number of patches from the patch baseline that aren't applicable for the managed node and therefore aren't installed on the node. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.

OperationStartTime

string <date-time>

required

The time the most recent patching operation was started on the managed node.

OperationEndTime

string <date-time>

required

The time the most recent patching operation completed on the managed node.

Operation

enum<string>

required

The type of patching operation that was performed: or

SCAN assesses the patch compliance state.
INSTALL installs missing patches.

Allowed values:

ScanInstall

LastNoRebootInstallOperationTime

string <date-time>

optional

The time of the last attempt to patch the managed node with NoReboot specified as the reboot option.

RebootOption

enum<string>

optional

Indicates the reboot option specified in the patch baseline.

RebootIfNeeded: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.
NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.

Allowed values:

RebootIfNeededNoReboot

CriticalNonCompliantCount

integer

optional

The number of patches per node 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.

SecurityNonCompliantCount

integer

optional

The number of patches per node 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.

OtherNonCompliantCount

integer

optional

The number of patches per node 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.

NextToken

string

optional

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

🟠480InternalServerError

🟠481InvalidNextToken