Skip to content

AssessmentSummary

Source code in docs_src/capo_resiliencehubv2/types/assessment_summary.py
class AssessmentSummary(TypedDict, closed=True):
    assessment_id: "capo_resiliencehubv2.types.uuid.Uuid"
    """<p>The unique identifier of the assessment.</p>"""
    service_arn: "capo_resiliencehubv2.types.arn.Arn"
    assessment_status: NotRequired[
        "capo_resiliencehubv2.types.assessment_status.AssessmentStatus"
    ]
    """<p>The current status of the assessment.</p>"""
    assessment_step: NotRequired[
        "capo_resiliencehubv2.types.assessment_step.AssessmentStep"
    ]
    """<p>The current step of the assessment process.</p>"""
    total_findings: NotRequired["int"]
    """<p>The total number of findings generated by the assessment.</p>"""
    started_at: NotRequired["datetime.datetime"]
    """<p>The timestamp when the assessment started.</p>"""
    ended_at: NotRequired["datetime.datetime"]
    """<p>The timestamp when the assessment ended.</p>"""
    error_message: NotRequired["str"]
    """<p>A message describing the error if the assessment failed.</p>"""
    error_code: NotRequired[
        "capo_resiliencehubv2.types.assessment_error_code.AssessmentErrorCode"
    ]
    """<p>The error code if the assessment failed.</p>"""
    assessment_cost: NotRequired[
        "capo_resiliencehubv2.types.assessment_cost.AssessmentCost"
    ]
    """<p>The cost of the assessment.</p>"""
    billable_assessment_unit_count: NotRequired["int"]
    """<p>The number of billable assessment units consumed by the assessment.</p>"""
    achievability: NotRequired["capo_resiliencehubv2.types.achievability.Achievability"]
    """<p>The achievability results from the assessment.</p>"""

achievability instance-attribute

achievability: NotRequired[Achievability]

The achievability results from the assessment.

assessment_cost instance-attribute

assessment_cost: NotRequired[AssessmentCost]

The cost of the assessment.

assessment_id instance-attribute

assessment_id: Uuid

The unique identifier of the assessment.

assessment_status instance-attribute

assessment_status: NotRequired[AssessmentStatus]

The current status of the assessment.

assessment_step instance-attribute

assessment_step: NotRequired[AssessmentStep]

The current step of the assessment process.

billable_assessment_unit_count instance-attribute

billable_assessment_unit_count: NotRequired[int]

The number of billable assessment units consumed by the assessment.

ended_at instance-attribute

ended_at: NotRequired[datetime]

The timestamp when the assessment ended.

error_code instance-attribute

error_code: NotRequired[AssessmentErrorCode]

The error code if the assessment failed.

error_message instance-attribute

error_message: NotRequired[str]

A message describing the error if the assessment failed.

service_arn instance-attribute

service_arn: Arn

started_at instance-attribute

started_at: NotRequired[datetime]

The timestamp when the assessment started.

total_findings instance-attribute

total_findings: NotRequired[int]

The total number of findings generated by the assessment.