Skip to content

Assessment

Source code in docs_src/capo_directory_service/types/assessment.py
class Assessment(TypedDict, closed=True):
    assessment_id: NotRequired[
        "capo_directory_service.types.assessment_id.AssessmentId"
    ]
    """<p>The unique identifier of the directory assessment.</p>"""
    directory_id: NotRequired["capo_directory_service.types.directory_id.DirectoryId"]
    """<p>The identifier of the directory associated with this assessment.</p>"""
    dns_name: NotRequired["capo_directory_service.types.directory_name.DirectoryName"]
    """<p>The fully qualified domain name (FQDN) of the Active Directory domain being assessed.</p>"""
    start_time: NotRequired[
        "capo_directory_service.types.assessment_start_time.AssessmentStartTime"
    ]
    """<p>The date and time when the assessment was initiated.</p>"""
    last_update_date_time: NotRequired[
        "capo_directory_service.types.last_update_date_time.LastUpdateDateTime"
    ]
    """<p>The date and time when the assessment status was last updated.</p>"""
    status: NotRequired[
        "capo_directory_service.types.assessment_status.AssessmentStatus"
    ]
    """<p>The current status of the assessment. Valid values include <code>SUCCESS</code>, <code>FAILED</code>, <code>PENDING</code>, and <code>IN_PROGRESS</code>.</p>"""
    status_code: NotRequired[
        "capo_directory_service.types.assessment_status_code.AssessmentStatusCode"
    ]
    """<p>A detailed status code providing additional information about the assessment state.</p>"""
    status_reason: NotRequired[
        "capo_directory_service.types.assessment_status_reason.AssessmentStatusReason"
    ]
    """<p>A human-readable description of the current assessment status, including any error details or progress information.</p>"""
    customer_dns_ips: NotRequired[
        "capo_directory_service.types.customer_dns_ips.CustomerDnsIps"
    ]
    """<p>The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.</p>"""
    vpc_id: NotRequired["capo_directory_service.types.vpc_id.VpcId"]
    """<p>Contains Amazon VPC information for the <code>StartADAssessment</code> operation. </p>"""
    subnet_ids: NotRequired["capo_directory_service.types.subnet_ids.SubnetIds"]
    """<p>A list of subnet identifiers in the Amazon VPC in which the hybrid directory is created.</p>"""
    security_group_ids: NotRequired[
        "capo_directory_service.types.security_group_ids.SecurityGroupIds"
    ]
    """<p>The security groups identifiers attached to the network interfaces.</p>"""
    self_managed_instance_ids: NotRequired[
        "capo_directory_service.types.assessment_instance_ids.AssessmentInstanceIds"
    ]
    """<p>The identifiers of the self-managed AD instances used to perform the assessment.</p>"""
    report_type: NotRequired[
        "capo_directory_service.types.assessment_report_type.AssessmentReportType"
    ]
    """<p>The type of assessment report generated. Valid values are <code>CUSTOMER</code> and <code>SYSTEM</code>.</p>"""
    version: NotRequired[
        "capo_directory_service.types.assessment_version.AssessmentVersion"
    ]
    """<p>The version of the assessment framework used to evaluate your self-managed AD environment.</p>"""

assessment_id instance-attribute

assessment_id: NotRequired[AssessmentId]

The unique identifier of the directory assessment.

customer_dns_ips instance-attribute

customer_dns_ips: NotRequired[CustomerDnsIps]

The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.

directory_id instance-attribute

directory_id: NotRequired[DirectoryId]

The identifier of the directory associated with this assessment.

dns_name instance-attribute

dns_name: NotRequired[DirectoryName]

The fully qualified domain name (FQDN) of the Active Directory domain being assessed.

last_update_date_time instance-attribute

last_update_date_time: NotRequired[LastUpdateDateTime]

The date and time when the assessment status was last updated.

report_type instance-attribute

report_type: NotRequired[AssessmentReportType]

The type of assessment report generated. Valid values are CUSTOMER and SYSTEM.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIds]

The security groups identifiers attached to the network interfaces.

self_managed_instance_ids instance-attribute

self_managed_instance_ids: NotRequired[AssessmentInstanceIds]

The identifiers of the self-managed AD instances used to perform the assessment.

start_time instance-attribute

start_time: NotRequired[AssessmentStartTime]

The date and time when the assessment was initiated.

status instance-attribute

status: NotRequired[AssessmentStatus]

The current status of the assessment. Valid values include SUCCESS, FAILED, PENDING, and IN_PROGRESS.

status_code instance-attribute

status_code: NotRequired[AssessmentStatusCode]

A detailed status code providing additional information about the assessment state.

status_reason instance-attribute

status_reason: NotRequired[AssessmentStatusReason]

A human-readable description of the current assessment status, including any error details or progress information.

subnet_ids instance-attribute

subnet_ids: NotRequired[SubnetIds]

A list of subnet identifiers in the Amazon VPC in which the hybrid directory is created.

version instance-attribute

version: NotRequired[AssessmentVersion]

The version of the assessment framework used to evaluate your self-managed AD environment.

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

Contains Amazon VPC information for the StartADAssessment operation.