Skip to content

Framework

Source code in docs_src/capo_auditmanager/types/framework.py
class Framework(TypedDict, closed=True):
    arn: NotRequired["capo_auditmanager.types.audit_manager_arn.AuditManagerArn"]
    """<p> The Amazon Resource Name (ARN) of the framework. </p>"""
    id: NotRequired["capo_auditmanager.types.uuid.UUID"]
    """<p> The unique identifier for the framework. </p>"""
    name: NotRequired["capo_auditmanager.types.framework_name.FrameworkName"]
    """<p> The name of the framework. </p>"""
    type: NotRequired["capo_auditmanager.types.framework_type.FrameworkType"]
    """<p> Specifies whether the framework is a standard framework or a custom framework.</p>"""
    compliance_type: NotRequired[
        "capo_auditmanager.types.compliance_type.ComplianceType"
    ]
    """<p> The compliance type that the framework supports, such as CIS or HIPAA. </p>"""
    description: NotRequired[
        "capo_auditmanager.types.framework_description.FrameworkDescription"
    ]
    """<p> The description of the framework. </p>"""
    logo: NotRequired["capo_auditmanager.types.filename.Filename"]
    """<p> The logo that's associated with the framework. </p>"""
    control_sources: NotRequired[
        "capo_auditmanager.types.control_sources.ControlSources"
    ]
    """<p> The control data sources where Audit Manager collects evidence from.</p> <important> <p>This API parameter is no longer supported.</p> </important>"""
    control_sets: NotRequired["capo_auditmanager.types.control_sets.ControlSets"]
    """<p> The control sets that are associated with the framework. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>"""
    created_at: NotRequired["capo_auditmanager.types.timestamp.Timestamp"]
    """<p> The time when the framework was created. </p>"""
    last_updated_at: NotRequired["capo_auditmanager.types.timestamp.Timestamp"]
    """<p> The time when the framework was most recently updated. </p>"""
    created_by: NotRequired["capo_auditmanager.types.created_by.CreatedBy"]
    """<p> The user or role that created the framework. </p>"""
    last_updated_by: NotRequired[
        "capo_auditmanager.types.last_updated_by.LastUpdatedBy"
    ]
    """<p> The user or role that most recently updated the framework. </p>"""
    tags: NotRequired["capo_auditmanager.types.tag_map.TagMap"]
    """<p> The tags that are associated with the framework. </p>"""

arn instance-attribute

arn: NotRequired[AuditManagerArn]

The Amazon Resource Name (ARN) of the framework.

compliance_type instance-attribute

compliance_type: NotRequired[ComplianceType]

The compliance type that the framework supports, such as CIS or HIPAA.

control_sets instance-attribute

control_sets: NotRequired[ControlSets]

The control sets that are associated with the framework.

The Controls object returns a partial response when called through Framework APIs. For a complete Controls object, use GetControl.

control_sources instance-attribute

control_sources: NotRequired[ControlSources]

The control data sources where Audit Manager collects evidence from.

This API parameter is no longer supported.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The time when the framework was created.

created_by instance-attribute

created_by: NotRequired[CreatedBy]

The user or role that created the framework.

description instance-attribute

description: NotRequired[FrameworkDescription]

The description of the framework.

id instance-attribute

id: NotRequired[UUID]

The unique identifier for the framework.

last_updated_at instance-attribute

last_updated_at: NotRequired[Timestamp]

The time when the framework was most recently updated.

last_updated_by instance-attribute

last_updated_by: NotRequired[LastUpdatedBy]

The user or role that most recently updated the framework.

logo: NotRequired[Filename]

The logo that's associated with the framework.

name instance-attribute

name: NotRequired[FrameworkName]

The name of the framework.

tags instance-attribute

tags: NotRequired[TagMap]

The tags that are associated with the framework.

type instance-attribute

type: NotRequired[FrameworkType]

Specifies whether the framework is a standard framework or a custom framework.