Skip to content

ComplianceItem

Source code in docs_src/capo_ssm/types/compliance_item.py
class ComplianceItem(TypedDict, closed=True):
    compliance_type: NotRequired[
        "capo_ssm.types.compliance_type_name.ComplianceTypeName"
    ]
    """<p>The compliance type. For example, Association (for a State Manager association), Patch, or Custom:<code>string</code> are all valid compliance types.</p>"""
    resource_type: NotRequired[
        "capo_ssm.types.compliance_resource_type.ComplianceResourceType"
    ]
    """<p>The type of resource. <code>ManagedInstance</code> is currently the only supported resource type.</p>"""
    resource_id: NotRequired[
        "capo_ssm.types.compliance_resource_id.ComplianceResourceId"
    ]
    """<p>An ID for the resource. For a managed node, this is the node ID.</p>"""
    id: NotRequired["capo_ssm.types.compliance_item_id.ComplianceItemId"]
    """<p>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.</p>"""
    title: NotRequired["capo_ssm.types.compliance_item_title.ComplianceItemTitle"]
    """<p>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.</p>"""
    status: NotRequired["capo_ssm.types.compliance_status.ComplianceStatus"]
    """<p>The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).</p>"""
    severity: NotRequired["capo_ssm.types.compliance_severity.ComplianceSeverity"]
    """<p>The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.</p>"""
    execution_summary: NotRequired[
        "capo_ssm.types.compliance_execution_summary.ComplianceExecutionSummary"
    ]
    """<p>A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.</p> <important> <p>For State Manager associations, the <code>ExecutionTime</code> 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.</p> </important>"""
    details: NotRequired["capo_ssm.types.compliance_item_details.ComplianceItemDetails"]
    """<p>A "Key": "Value" tag combination for the compliance item.</p>"""

compliance_type instance-attribute

compliance_type: NotRequired[ComplianceTypeName]

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

details instance-attribute

details: NotRequired[ComplianceItemDetails]

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

execution_summary instance-attribute

execution_summary: NotRequired[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.

id instance-attribute

id: NotRequired[ComplianceItemId]

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.

resource_id instance-attribute

resource_id: NotRequired[ComplianceResourceId]

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

resource_type instance-attribute

resource_type: NotRequired[ComplianceResourceType]

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

severity instance-attribute

severity: NotRequired[ComplianceSeverity]

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

status instance-attribute

status: NotRequired[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 instance-attribute

title: NotRequired[ComplianceItemTitle]

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.