DescribeInstancePatchStates - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.


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

Request Syntax

{ "InstanceIds": [ "string" ], "MaxResults": number, "NextToken": "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.


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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

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

Required: Yes


The maximum number of instances to return (per page).

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 100.

Required: No


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

Type: String

Required: No

Response Syntax

{ "InstancePatchStates": [ { "BaselineId": "string", "CriticalNonCompliantCount": number, "FailedCount": number, "InstalledCount": number, "InstalledOtherCount": number, "InstalledPendingRebootCount": number, "InstalledRejectedCount": number, "InstallOverrideList": "string", "InstanceId": "string", "LastNoRebootInstallOperationTime": number, "MissingCount": number, "NotApplicableCount": number, "Operation": "string", "OperationEndTime": number, "OperationStartTime": number, "OtherNonCompliantCount": number, "OwnerInformation": "string", "PatchGroup": "string", "RebootOption": "string", "SecurityNonCompliantCount": number, "SnapshotId": "string", "UnreportedNotApplicableCount": number } ], "NextToken": "string" }

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.


The high-level patch state for the requested instances.

Type: Array of InstancePatchState objects


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

Type: String


For information about the errors that are common to all actions, see Common Errors.


An error occurred on the server side.

HTTP Status Code: 500


The specified token isn't valid.

HTTP Status Code: 400



This example illustrates one usage of DescribeInstancePatchStates.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 40 X-Amz-Target: AmazonSSM.DescribeInstancePatchStates X-Amz-Date: 20180308T202310Z 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/20180308/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "InstanceIds": [ "i-02573cafcfEXAMPLE" ] }

Sample Response

{ "InstancePatchStates": [ { "InstanceId": "i-02573cafcfEXAMPLE", "PatchGroup": "mypatchgroup", "BaselineId": "pb-0c10e65780EXAMPLE", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE", "CriticalNonCompliantCount": 2, "SecurityNonCompliantCount": 2, "OtherNonCompliantCount": 1, "InstalledCount": 123, "InstalledOtherCount": 334, "InstalledPendingRebootCount": 0, "InstalledRejectedCount": 0, "MissingCount": 1, "FailedCount": 2, "UnreportedNotApplicableCount": 11, "NotApplicableCount": 2063, "OperationStartTime": "2021-05-03T11:00:56-07:00", "OperationEndTime": "2021-05-03T11:01:09-07:00", "Operation": "Scan", "LastNoRebootInstallOperationTime": "2020-06-14T12:17:41-07:00", "RebootOption": "RebootIfNeeded" } ] }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: