Struct aws_sdk_ssm::types::InstancePatchState

#[non_exhaustive]
pub struct InstancePatchState {

    pub instance_id: String,
    pub patch_group: String,
    pub baseline_id: String,
    pub snapshot_id: Option<String>,
    pub install_override_list: Option<String>,
    pub owner_information: Option<String>,
    pub installed_count: i32,
    pub installed_other_count: i32,
    pub installed_pending_reboot_count: Option<i32>,
    pub installed_rejected_count: Option<i32>,
    pub missing_count: i32,
    pub failed_count: i32,
    pub unreported_not_applicable_count: Option<i32>,
    pub not_applicable_count: i32,
    pub operation_start_time: DateTime,
    pub operation_end_time: DateTime,
    pub operation: PatchOperationType,
    pub last_no_reboot_install_operation_time: Option<DateTime>,
    pub reboot_option: Option<RebootOption>,
    pub critical_non_compliant_count: Option<i32>,
    pub security_non_compliant_count: Option<i32>,
    pub other_non_compliant_count: Option<i32>,
}

Defines the high-level patch compliance state for a managed node, 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 managed node.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

instance_id: String

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

patch_group: String

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

baseline_id: String

The ID of the patch baseline used to patch the managed node.

snapshot_id: Option<String>

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

install_override_list: Option<String>

An https URL or an Amazon Simple Storage Service (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 AWS-RunPatchBaseline SSM document in the Amazon Web Services Systems Manager User Guide.

owner_information: Option<String>

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

installed_count: i32

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

installed_other_count: i32

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

installed_pending_reboot_count: Option<i32>

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

installed_rejected_count: Option<i32>

The number of patches installed on a managed node 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).

missing_count: i32

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

failed_count: i32

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

unreported_not_applicable_count: Option<i32>

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

not_applicable_count: i32

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

operation_start_time: DateTime

The time the most recent patching operation was started on the managed node.

operation_end_time: DateTime

The time the most recent patching operation completed on the managed node.

operation: PatchOperationType

The type of patching operation that was performed: or

• SCAN assesses the patch compliance state.

• INSTALL installs missing patches.

last_no_reboot_install_operation_time: Option<DateTime>

The time of the last attempt to patch the managed node with NoReboot specified as the reboot option.

reboot_option: Option<RebootOption>

Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

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

critical_non_compliant_count: Option<i32>

The number of patches per node that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

security_non_compliant_count: Option<i32>

The number of patches per node that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

other_non_compliant_count: Option<i32>

The number of patches per node that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT.

Implementations

impl InstancePatchState

pub fn instance_id(&self) -> &str

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

pub fn patch_group(&self) -> &str

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

pub fn baseline_id(&self) -> &str

The ID of the patch baseline used to patch the managed node.

pub fn snapshot_id(&self) -> Option<&str>

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

pub fn install_override_list(&self) -> Option<&str>

An https URL or an Amazon Simple Storage Service (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 AWS-RunPatchBaseline SSM document in the Amazon Web Services Systems Manager User Guide.

pub fn owner_information(&self) -> Option<&str>

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

pub fn installed_count(&self) -> i32

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

pub fn installed_other_count(&self) -> i32

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

pub fn installed_pending_reboot_count(&self) -> Option<i32>

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

pub fn installed_rejected_count(&self) -> Option<i32>

The number of patches installed on a managed node 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).

pub fn missing_count(&self) -> i32

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

pub fn failed_count(&self) -> i32

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

pub fn unreported_not_applicable_count(&self) -> Option<i32>

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

pub fn not_applicable_count(&self) -> i32

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

pub fn operation_start_time(&self) -> &DateTime

The time the most recent patching operation was started on the managed node.

pub fn operation_end_time(&self) -> &DateTime

The time the most recent patching operation completed on the managed node.

pub fn operation(&self) -> &PatchOperationType

The type of patching operation that was performed: or

• SCAN assesses the patch compliance state.

• INSTALL installs missing patches.

pub fn last_no_reboot_install_operation_time(&self) -> Option<&DateTime>

The time of the last attempt to patch the managed node with NoReboot specified as the reboot option.

pub fn reboot_option(&self) -> Option<&RebootOption>

Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

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

pub fn critical_non_compliant_count(&self) -> Option<i32>

The number of patches per node that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

pub fn security_non_compliant_count(&self) -> Option<i32>

The number of patches per node that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

pub fn other_non_compliant_count(&self) -> Option<i32>

The number of patches per node that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT.

impl InstancePatchState

pub fn builder() -> InstancePatchStateBuilder

Creates a new builder-style object to manufacture InstancePatchState.

Trait Implementations

impl Clone for InstancePatchState

fn clone(&self) -> InstancePatchState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InstancePatchState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for InstancePatchState

fn eq(&self, other: &InstancePatchState) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InstancePatchState