Skip to content

AppAssessment

Source code in docs_src/capo_resiliencehub/types/app_assessment.py
class AppAssessment(TypedDict, closed=True):
    app_arn: NotRequired["capo_resiliencehub.types.arn.Arn"]
    """<p>Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p>"""
    app_version: NotRequired["capo_resiliencehub.types.entity_version.EntityVersion"]
    """<p>Version of an application.</p>"""
    invoker: "capo_resiliencehub.types.assessment_invoker.AssessmentInvoker"
    """<p>The entity that invoked the assessment.</p>"""
    cost: NotRequired["capo_resiliencehub.types.cost.Cost"]
    """<p>Cost for the application.</p>"""
    resiliency_score: NotRequired[
        "capo_resiliencehub.types.resiliency_score.ResiliencyScore"
    ]
    """<p>Current resiliency score for an application.</p>"""
    compliance: NotRequired[
        "capo_resiliencehub.types.assessment_compliance.AssessmentCompliance"
    ]
    """<p>Application compliance against the resiliency policy.</p>"""
    compliance_status: NotRequired[
        "capo_resiliencehub.types.compliance_status.ComplianceStatus"
    ]
    """<p>Current status of the compliance for the resiliency policy.</p>"""
    assessment_status: "capo_resiliencehub.types.assessment_status.AssessmentStatus"
    """<p>Current status of the assessment for the resiliency policy.</p>"""
    start_time: NotRequired["capo_resiliencehub.types.time_stamp.TimeStamp"]
    """<p>Starting time for the action.</p>"""
    end_time: NotRequired["capo_resiliencehub.types.time_stamp.TimeStamp"]
    """<p>End time for the action.</p>"""
    message: NotRequired["capo_resiliencehub.types.string500.String500"]
    """<p>Error or warning message from the assessment execution</p>"""
    assessment_name: NotRequired["capo_resiliencehub.types.entity_name.EntityName"]
    """<p>Name of the assessment.</p>"""
    assessment_arn: "capo_resiliencehub.types.arn.Arn"
    """<p>Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app-assessment/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p>"""
    policy: NotRequired["capo_resiliencehub.types.resiliency_policy.ResiliencyPolicy"]
    """<p>Resiliency policy of an application.</p>"""
    tags: NotRequired["capo_resiliencehub.types.tag_map.TagMap"]
    """<p>Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>"""
    resource_errors_details: NotRequired[
        "capo_resiliencehub.types.resource_errors_details.ResourceErrorsDetails"
    ]
    """<p> A resource error object containing a list of errors retrieving an application's resources. </p>"""
    version_name: NotRequired["capo_resiliencehub.types.entity_version.EntityVersion"]
    """<p>Version name of the published application.</p>"""
    drift_status: NotRequired["capo_resiliencehub.types.drift_status.DriftStatus"]
    """<p>Indicates if compliance drifts (deviations) were detected while running an assessment for your application.</p>"""
    summary: NotRequired[
        "capo_resiliencehub.types.assessment_summary.AssessmentSummary"
    ]
    """<p>Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.</p> <note> <p>This property is available only in the US East (N. Virginia) Region.</p> </note>"""

app_arn instance-attribute

app_arn: NotRequired[Arn]

Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

app_version instance-attribute

app_version: NotRequired[EntityVersion]

Version of an application.

assessment_arn instance-attribute

assessment_arn: Arn

Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

assessment_name instance-attribute

assessment_name: NotRequired[EntityName]

Name of the assessment.

assessment_status instance-attribute

assessment_status: AssessmentStatus

Current status of the assessment for the resiliency policy.

compliance instance-attribute

compliance: NotRequired[AssessmentCompliance]

Application compliance against the resiliency policy.

compliance_status instance-attribute

compliance_status: NotRequired[ComplianceStatus]

Current status of the compliance for the resiliency policy.

cost instance-attribute

cost: NotRequired[Cost]

Cost for the application.

drift_status instance-attribute

drift_status: NotRequired[DriftStatus]

Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

end_time instance-attribute

end_time: NotRequired[TimeStamp]

End time for the action.

invoker instance-attribute

The entity that invoked the assessment.

message instance-attribute

message: NotRequired[String500]

Error or warning message from the assessment execution

policy instance-attribute

policy: NotRequired[ResiliencyPolicy]

Resiliency policy of an application.

resiliency_score instance-attribute

resiliency_score: NotRequired[ResiliencyScore]

Current resiliency score for an application.

resource_errors_details instance-attribute

resource_errors_details: NotRequired[ResourceErrorsDetails]

A resource error object containing a list of errors retrieving an application's resources.

start_time instance-attribute

start_time: NotRequired[TimeStamp]

Starting time for the action.

summary instance-attribute

summary: NotRequired[AssessmentSummary]

Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.

This property is available only in the US East (N. Virginia) Region.

tags instance-attribute

tags: NotRequired[TagMap]

Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

version_name instance-attribute

version_name: NotRequired[EntityVersion]

Version name of the published application.