Skip to content

CreateAssessmentRequest

Source code in docs_src/capo_auditmanager/types/create_assessment_request.py
class CreateAssessmentRequest(TypedDict, closed=True):
    name: "capo_auditmanager.types.assessment_name.AssessmentName"
    """<p> The name of the assessment to be created. </p>"""
    description: NotRequired[
        "capo_auditmanager.types.assessment_description.AssessmentDescription"
    ]
    """<p> The optional description of the assessment to be created. </p>"""
    assessment_reports_destination: "capo_auditmanager.types.assessment_reports_destination.AssessmentReportsDestination"
    """<p> The assessment report storage destination for the assessment that's being created. </p>"""
    scope: "capo_auditmanager.types.scope.Scope"
    roles: "capo_auditmanager.types.roles.Roles"
    """<p> The list of roles for the assessment. </p>"""
    framework_id: "capo_auditmanager.types.uuid.UUID"
    """<p> The identifier for the framework that the assessment will be created from. </p>"""
    tags: NotRequired["capo_auditmanager.types.tag_map.TagMap"]
    """<p> The tags that are associated with the assessment. </p>"""

assessment_reports_destination instance-attribute

assessment_reports_destination: AssessmentReportsDestination

The assessment report storage destination for the assessment that's being created.

description instance-attribute

description: NotRequired[AssessmentDescription]

The optional description of the assessment to be created.

framework_id instance-attribute

framework_id: UUID

The identifier for the framework that the assessment will be created from.

name instance-attribute

The name of the assessment to be created.

roles instance-attribute

roles: Roles

The list of roles for the assessment.

scope instance-attribute

scope: Scope

tags instance-attribute

tags: NotRequired[TagMap]

The tags that are associated with the assessment.