AWS Systems Manager
API Reference (API Version 2014-11-06)

DescribeInstancePatchStates

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.

InstanceIds

The ID of the instance whose 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

MaxResults

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

Type: Integer

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

Required: No

NextToken

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", "FailedCount": number, "InstalledCount": number, "InstalledOtherCount": number, "InstalledRejectedCount": number, "InstallOverrideList": "string", "InstanceId": "string", "MissingCount": number, "NotApplicableCount": number, "Operation": "string", "OperationEndTime": number, "OperationStartTime": number, "OwnerInformation": "string", "PatchGroup": "string", "SnapshotId": "string" } ], "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.

InstancePatchStates

The high-level patch state for the requested instances.

Type: Array of InstancePatchState objects

NextToken

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

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 is not valid.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com 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-0777569f58EXAMPLE" ] }

Sample Response

{ "InstancePatchStates": [ { "BaselineId": "pb-0c10e65780EXAMPLE", "FailedCount": 0, "InstalledCount": 17, "InstalledOtherCount": 378, "InstanceId": "i-0777569f58EXAMPLE", "MissingCount": 4, "NotApplicableCount": 396, "Operation": "Scan", "OperationEndTime": 1520534020, "OperationStartTime": 1520534019, "PatchGroup": "mypatchgroup", "SnapshotId": "a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE" } ] }

See Also

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