Skip to content

CreateAssessmentFrameworkRequest

Source code in docs_src/capo_auditmanager/types/create_assessment_framework_request.py
class CreateAssessmentFrameworkRequest(TypedDict, closed=True):
    name: "capo_auditmanager.types.framework_name.FrameworkName"
    """<p> The name of the new custom framework. </p>"""
    description: NotRequired[
        "capo_auditmanager.types.framework_description.FrameworkDescription"
    ]
    """<p> An optional description for the new custom framework. </p>"""
    compliance_type: NotRequired[
        "capo_auditmanager.types.compliance_type.ComplianceType"
    ]
    """<p> The compliance type that the new custom framework supports, such as CIS or HIPAA. </p>"""
    control_sets: "capo_auditmanager.types.create_assessment_framework_control_sets.CreateAssessmentFrameworkControlSets"
    """<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>"""
    tags: NotRequired["capo_auditmanager.types.tag_map.TagMap"]
    """<p> The tags that are associated with the framework. </p>"""

compliance_type instance-attribute

compliance_type: NotRequired[ComplianceType]

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

control_sets instance-attribute

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.

description instance-attribute

description: NotRequired[FrameworkDescription]

An optional description for the new custom framework.

name instance-attribute

The name of the new custom framework.

tags instance-attribute

tags: NotRequired[TagMap]

The tags that are associated with the framework.