NAME

Paws::SSM::InstancePatchState

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::SSM::InstancePatchState object:

  $service_obj->Method(Att1 => { BaselineId => $value, ..., UnreportedNotApplicableCount => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::InstancePatchState object:

  $result = $service_obj->Method(...);
  $result->Att1->BaselineId

DESCRIPTION

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.

ATTRIBUTES

REQUIRED BaselineId => Str

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

CriticalNonCompliantCount => Int

The number of instances where patches that are specified as "Critical" for compliance reporting in the patch baseline are not installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is "NON_COMPLIANT".

FailedCount => Int

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

InstalledCount => Int

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

InstalledOtherCount => Int

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

InstalledPendingRebootCount => Int

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

InstalledRejectedCount => Int

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

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

InstallOverrideList => Str

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 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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html) in the AWS Systems Manager User Guide.

REQUIRED InstanceId => Str

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

LastNoRebootInstallOperationTime => Str

The time of the last attempt to patch the instance with "NoReboot" specified as the reboot option.

MissingCount => Int

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

NotApplicableCount => Int

The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. 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".

REQUIRED Operation => Str

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

REQUIRED OperationEndTime => Str

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

REQUIRED OperationStartTime => Str

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

OtherNonCompliantCount => Int

The number of instances with patches installed that are specified as other than "Critical" or "Security" but are not compliant with the patch baseline. The status of these instances is NON_COMPLIANT.

OwnerInformation => Str

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

REQUIRED PatchGroup => Str

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

RebootOption => Str

Indicates the reboot option specified in the patch baseline.

Reboot options apply to "Install" operations only. Reboots are not attempted for Patch Manager "Scan" operations.

RebootIfNeeded: Patch Manager tries to reboot the instance 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.

SecurityNonCompliantCount => Int

The number of instances where patches that are specified as "Security" in a patch advisory are not installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is "NON_COMPLIANT".

SnapshotId => Str

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

UnreportedNotApplicableCount => Int

The number of patches beyond the supported limit of "NotApplicableCount" that are not reported by name to Systems Manager Inventory.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>