Sign In to the Console
AWS Systems Manager
API Reference (API Version 2014-11-06)

AWS Documentation » AWS Systems Manager » API Reference » Actions » DescribePatchGroupState
The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribePatchGroupState

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

Request Syntax

{
   "PatchGroup": "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.

PatchGroup

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

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

Required: Yes

Response Syntax

{
   "Instances": number,
   "InstancesWithFailedPatches": number,
   "InstancesWithInstalledOtherPatches": number,
   "InstancesWithInstalledPatches": number,
   "InstancesWithInstalledRejectedPatches": number,
   "InstancesWithMissingPatches": number,
   "InstancesWithNotApplicablePatches": number,
   "InstancesWithUnreportedNotApplicablePatches": number
}

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.

Instances

The number of instances in the patch group.

Type: Integer

InstancesWithFailedPatches

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

Type: Integer

InstancesWithInstalledOtherPatches

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

Type: Integer

InstancesWithInstalledPatches

The number of instances with installed patches.

Type: Integer

InstancesWithInstalledRejectedPatches

The number of instances 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.

Note

If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).

Type: Integer

InstancesWithMissingPatches

The number of instances with missing patches from the patch baseline.

Type: Integer

InstancesWithNotApplicablePatches

The number of instances with patches that aren't applicable.

Type: Integer

InstancesWithUnreportedNotApplicablePatches

The number of instances with NotApplicable patches beyond the supported limit, which are not reported by name to Systems Manager Inventory.

Type: Integer

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: 33
  X-Amz-Target: AmazonSSM.DescribePatchGroupState
  X-Amz-Date: 20180308T205757Z
  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
  
  {
    "PatchGroup": "mypatchgroup"
}

Sample Response

{
    "Instances": 12,
    "InstancesWithFailedPatches": 1,
    "InstancesWithInstalledOtherPatches": 10,
    "InstancesWithInstalledPatches": 11,
    "InstancesWithMissingPatches": 2,
    "InstancesWithNotApplicablePatches": 1
}

See Also

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