Skip to content

AssessmentRun

Source code in docs_src/capo_inspector/types/assessment_run.py
class AssessmentRun(TypedDict, closed=True):
    arn: "capo_inspector.types.arn.Arn"
    """<p>The ARN of the assessment run.</p>"""
    name: "capo_inspector.types.assessment_run_name.AssessmentRunName"
    """<p>The auto-generated name for the assessment run.</p>"""
    assessment_template_arn: "capo_inspector.types.arn.Arn"
    """<p>The ARN of the assessment template that is associated with the assessment run.</p>"""
    state: "capo_inspector.types.assessment_run_state.AssessmentRunState"
    """<p>The state of the assessment run.</p>"""
    duration_in_seconds: (
        "capo_inspector.types.assessment_run_duration.AssessmentRunDuration"
    )
    """<p>The duration of the assessment run.</p>"""
    rules_package_arns: "capo_inspector.types.assessment_rules_package_arn_list.AssessmentRulesPackageArnList"
    """<p>The rules packages selected for the assessment run.</p>"""
    user_attributes_for_findings: (
        "capo_inspector.types.user_attribute_list.UserAttributeList"
    )
    """<p>The user-defined attributes that are assigned to every generated finding.</p>"""
    created_at: "capo_inspector.types.timestamp.Timestamp"
    """<p>The time when <a>StartAssessmentRun</a> was called.</p>"""
    started_at: NotRequired["capo_inspector.types.timestamp.Timestamp"]
    """<p>The time when <a>StartAssessmentRun</a> was called.</p>"""
    completed_at: NotRequired["capo_inspector.types.timestamp.Timestamp"]
    """<p>The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.</p>"""
    state_changed_at: "capo_inspector.types.timestamp.Timestamp"
    """<p>The last time when the assessment run's state changed.</p>"""
    data_collected: "capo_inspector.types.bool.Bool"
    """<p>A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.</p>"""
    state_changes: "capo_inspector.types.assessment_run_state_change_list.AssessmentRunStateChangeList"
    """<p>A list of the assessment run state changes.</p>"""
    notifications: "capo_inspector.types.assessment_run_notification_list.AssessmentRunNotificationList"
    """<p>A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.</p>"""
    finding_counts: (
        "capo_inspector.types.assessment_run_finding_counts.AssessmentRunFindingCounts"
    )
    """<p>Provides a total count of generated findings per severity.</p>"""

arn instance-attribute

arn: Arn

The ARN of the assessment run.

assessment_template_arn instance-attribute

assessment_template_arn: Arn

The ARN of the assessment template that is associated with the assessment run.

completed_at instance-attribute

completed_at: NotRequired[Timestamp]

The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.

created_at instance-attribute

created_at: Timestamp

The time when StartAssessmentRun was called.

data_collected instance-attribute

data_collected: Bool

A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.

duration_in_seconds instance-attribute

duration_in_seconds: AssessmentRunDuration

The duration of the assessment run.

finding_counts instance-attribute

Provides a total count of generated findings per severity.

name instance-attribute

The auto-generated name for the assessment run.

notifications instance-attribute

A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

rules_package_arns instance-attribute

rules_package_arns: AssessmentRulesPackageArnList

The rules packages selected for the assessment run.

started_at instance-attribute

started_at: NotRequired[Timestamp]

The time when StartAssessmentRun was called.

state instance-attribute

The state of the assessment run.

state_changed_at instance-attribute

state_changed_at: Timestamp

The last time when the assessment run's state changed.

state_changes instance-attribute

A list of the assessment run state changes.

user_attributes_for_findings instance-attribute

user_attributes_for_findings: UserAttributeList

The user-defined attributes that are assigned to every generated finding.