Struct ComplianceItem

#[non_exhaustive]
pub struct ComplianceItem {
    pub compliance_type: Option<String>,
    pub resource_type: Option<String>,
    pub resource_id: Option<String>,
    pub id: Option<String>,
    pub title: Option<String>,
    pub status: Option<ComplianceStatus>,
    pub severity: Option<ComplianceSeverity>,
    pub execution_summary: Option<ComplianceExecutionSummary>,
    pub details: Option<HashMap<String, String>>,
}

Information about the compliance as defined by the resource type. For example, for a patch resource type, Items includes information about the PatchSeverity, Classification, and so on.

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.

compliance_type: Option<String>

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

resource_type: Option<String>

The type of resource. ManagedInstance is currently the only supported resource type.

resource_id: Option<String>

An ID for the resource. For a managed node, this is the node ID.

id: Option<String>

An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.

title: Option<String>

A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

status: Option<ComplianceStatus>

The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).

severity: Option<ComplianceSeverity>

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

execution_summary: Option<ComplianceExecutionSummary>

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

For State Manager associations, the ExecutionTime value represents when the compliance status was captured and aggregated by the Systems Manager service, not necessarily when the underlying association was executed on the managed node. State Manager updates compliance status for all associations on an instance whenever any association executes, which means multiple associations may show the same execution time even if they were executed at different times.

details: Option<HashMap<String, String>>

A "Key": "Value" tag combination for the compliance item.

Implementations

impl ComplianceItem

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

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

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

The type of resource. ManagedInstance is currently the only supported resource type.

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

An ID for the resource. For a managed node, this is the node ID.

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

An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.

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

A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

pub fn status(&self) -> Option<&ComplianceStatus>

The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).

pub fn severity(&self) -> Option<&ComplianceSeverity>

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

pub fn execution_summary(&self) -> Option<&ComplianceExecutionSummary>

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

For State Manager associations, the ExecutionTime value represents when the compliance status was captured and aggregated by the Systems Manager service, not necessarily when the underlying association was executed on the managed node. State Manager updates compliance status for all associations on an instance whenever any association executes, which means multiple associations may show the same execution time even if they were executed at different times.

pub fn details(&self) -> Option<&HashMap<String, String>>

A "Key": "Value" tag combination for the compliance item.

impl ComplianceItem

pub fn builder() -> ComplianceItemBuilder

Creates a new builder-style object to manufacture ComplianceItem.

Trait Implementations

impl Clone for ComplianceItem

fn clone(&self) -> ComplianceItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComplianceItem

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

Formats the value using the given formatter.

impl PartialEq for ComplianceItem

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ComplianceItem