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

InstancePatchState

Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.

Contents

BaselineId

The ID of the patch baseline used to patch the instance.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 128.

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

Required: Yes

FailedCount

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

Type: Integer

Required: No

InstalledCount

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

Type: Integer

Required: No

InstalledOtherCount

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

Type: Integer

Required: No

InstalledRejectedCount

The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected 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 InstalledRejectedCount will always be 0 (zero).

Type: Integer

Required: No

InstallOverrideList

An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon 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 SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.

Type: String

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

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

Required: No

InstanceId

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

Type: String

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

Required: Yes

MissingCount

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

Type: Integer

Required: No

NotApplicableCount

The number of patches from the patch baseline that aren't applicable for the instance and hence aren't installed on the instance.

Type: Integer

Required: No

Operation

The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

Type: String

Valid Values: Scan | Install

Required: Yes

OperationEndTime

The time the most recent patching operation completed on the instance.

Type: Timestamp

Required: Yes

OperationStartTime

The time the most recent patching operation was started on the instance.

Type: Timestamp

Required: Yes

OwnerInformation

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

Type: String

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

Required: No

PatchGroup

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

Type: String

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

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

Required: Yes

SnapshotId

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

Type: String

Length Constraints: Fixed length of 36.

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}$

Required: No

See Also

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

On this page: