Amazonka.SSM.Types.ComplianceItem

Documentation

data ComplianceItem

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

• complianceType :: Maybe Text

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

• details :: Maybe (HashMap Text Text)

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

• 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.

• 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.

• resourceId :: Maybe Text

  An ID for the resource. For a managed node, this is the node 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.

• 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).

• 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

FromJSON ComplianceItem

Defined in Amazonka.SSM.Types.ComplianceItem

Methods

parseJSON :: Value -> Parser ComplianceItem

parseJSONList :: Value -> Parser [ComplianceItem]

Generic ComplianceItem

Defined in Amazonka.SSM.Types.ComplianceItem

Associated Types

type Rep ComplianceItem :: Type -> Type

Methods

from :: ComplianceItem -> Rep ComplianceItem x

to :: Rep ComplianceItem x -> ComplianceItem

Read ComplianceItem

Defined in Amazonka.SSM.Types.ComplianceItem

Methods

readsPrec :: Int -> ReadS ComplianceItem

readList :: ReadS [ComplianceItem]

readPrec :: ReadPrec ComplianceItem

readListPrec :: ReadPrec [ComplianceItem]

Show ComplianceItem

Defined in Amazonka.SSM.Types.ComplianceItem

Methods

showsPrec :: Int -> ComplianceItem -> ShowS

show :: ComplianceItem -> String

showList :: [ComplianceItem] -> ShowS

NFData ComplianceItem

Defined in Amazonka.SSM.Types.ComplianceItem

Methods

rnf :: ComplianceItem -> ()

Eq ComplianceItem

Defined in Amazonka.SSM.Types.ComplianceItem

Methods

(==) :: ComplianceItem -> ComplianceItem -> Bool

(/=) :: ComplianceItem -> ComplianceItem -> Bool

Hashable ComplianceItem

Defined in Amazonka.SSM.Types.ComplianceItem

Methods

hashWithSalt :: Int -> ComplianceItem -> Int

hash :: ComplianceItem -> Int

type Rep ComplianceItem

Defined in Amazonka.SSM.Types.ComplianceItem

type Rep ComplianceItem = D1 ('MetaData "ComplianceItem" "Amazonka.SSM.Types.ComplianceItem" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ComplianceItem'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "complianceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "executionSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComplianceExecutionSummary)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComplianceSeverity)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComplianceStatus)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newComplianceItem :: ComplianceItem

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: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:details:ComplianceItem', complianceItem_details - A "Key": "Value" tag combination for the compliance item.

$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: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:resourceId:ComplianceItem', complianceItem_resourceId - An ID for the resource. For a managed node, this is the node 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: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: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_complianceType :: Lens' ComplianceItem (Maybe Text)

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

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

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

complianceItem_executionSummary :: Lens' ComplianceItem (Maybe ComplianceExecutionSummary)

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

complianceItem_id :: Lens' ComplianceItem (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.

complianceItem_resourceId :: Lens' ComplianceItem (Maybe Text)

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

complianceItem_resourceType :: Lens' ComplianceItem (Maybe Text)

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

complianceItem_severity :: Lens' ComplianceItem (Maybe ComplianceSeverity)

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

complianceItem_status :: Lens' ComplianceItem (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).

complianceItem_title :: Lens' ComplianceItem (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.