libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.Types.ComplianceItem

Description

 
Synopsis

Documentation

data ComplianceItem Source #

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.

See: newComplianceItem smart constructor.

Constructors

ComplianceItem' 

Fields

  • status :: Maybe 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).

  • resourceId :: Maybe Text

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

  • resourceType :: Maybe Text

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

  • severity :: Maybe ComplianceSeverity

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

  • executionSummary :: Maybe ComplianceExecutionSummary

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

  • details :: Maybe (HashMap Text Text)

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

  • id :: Maybe Text

    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.

  • complianceType :: Maybe Text

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

  • title :: Maybe Text

    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.

Instances

Instances details
Eq ComplianceItem Source # 
Instance details

Defined in Amazonka.SSM.Types.ComplianceItem

Read ComplianceItem Source # 
Instance details

Defined in Amazonka.SSM.Types.ComplianceItem

Show ComplianceItem Source # 
Instance details

Defined in Amazonka.SSM.Types.ComplianceItem

Generic ComplianceItem Source # 
Instance details

Defined in Amazonka.SSM.Types.ComplianceItem

Associated Types

type Rep ComplianceItem :: Type -> Type #

NFData ComplianceItem Source # 
Instance details

Defined in Amazonka.SSM.Types.ComplianceItem

Methods

rnf :: ComplianceItem -> () #

Hashable ComplianceItem Source # 
Instance details

Defined in Amazonka.SSM.Types.ComplianceItem

FromJSON ComplianceItem Source # 
Instance details

Defined in Amazonka.SSM.Types.ComplianceItem

type Rep ComplianceItem Source # 
Instance details

Defined in Amazonka.SSM.Types.ComplianceItem

newComplianceItem :: ComplianceItem Source #

Create a value of ComplianceItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:resourceId:ComplianceItem', complianceItem_resourceId - An ID for the resource. For a managed instance, this is the instance ID.

$sel:resourceType:ComplianceItem', complianceItem_resourceType - The type of resource. ManagedInstance is currently the only supported resource type.

$sel:severity:ComplianceItem', complianceItem_severity - The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

$sel:executionSummary:ComplianceItem', complianceItem_executionSummary - A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

$sel:details:ComplianceItem', complianceItem_details - A "Key": "Value" tag combination for the compliance item.

$sel:id:ComplianceItem', complianceItem_id - 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.

$sel:complianceType:ComplianceItem', complianceItem_complianceType - The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

$sel:title:ComplianceItem', complianceItem_title - 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.

complianceItem_status :: Lens' ComplianceItem (Maybe ComplianceStatus) Source #

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

complianceItem_resourceId :: Lens' ComplianceItem (Maybe Text) Source #

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

complianceItem_resourceType :: Lens' ComplianceItem (Maybe Text) Source #

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

complianceItem_severity :: Lens' ComplianceItem (Maybe ComplianceSeverity) Source #

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

complianceItem_executionSummary :: Lens' ComplianceItem (Maybe ComplianceExecutionSummary) Source #

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

complianceItem_details :: Lens' ComplianceItem (Maybe (HashMap Text Text)) Source #

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

complianceItem_id :: Lens' ComplianceItem (Maybe Text) Source #

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.

complianceItem_complianceType :: Lens' ComplianceItem (Maybe Text) Source #

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

complianceItem_title :: Lens' ComplianceItem (Maybe Text) Source #

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.