DirectoryService / Client / describe_ad_assessment

describe_ad_assessment

DirectoryService.Client.describe_ad_assessment(**kwargs)

Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.

See also: AWS API Documentation

Request Syntax

response = client.describe_ad_assessment(
    AssessmentId='string'
)
Parameters:

AssessmentId (string) –

[REQUIRED]

The identifier of the directory assessment to describe.

Return type:

dict

Returns:

Response Syntax

{
    'Assessment': {
        'AssessmentId': 'string',
        'DirectoryId': 'string',
        'DnsName': 'string',
        'StartTime': datetime(2015, 1, 1),
        'LastUpdateDateTime': datetime(2015, 1, 1),
        'Status': 'string',
        'StatusCode': 'string',
        'StatusReason': 'string',
        'CustomerDnsIps': [
            'string',
        ],
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'SelfManagedInstanceIds': [
            'string',
        ],
        'ReportType': 'string',
        'Version': 'string'
    },
    'AssessmentReports': [
        {
            'DomainControllerIp': 'string',
            'Validations': [
                {
                    'Category': 'string',
                    'Name': 'string',
                    'Status': 'string',
                    'StatusCode': 'string',
                    'StatusReason': 'string',
                    'StartTime': datetime(2015, 1, 1),
                    'LastUpdateDateTime': datetime(2015, 1, 1)
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • Assessment (dict) –

      Detailed information about the self-managed instance settings (IDs and DNS IPs).

      • AssessmentId (string) –

        The unique identifier of the directory assessment.

      • DirectoryId (string) –

        The identifier of the directory associated with this assessment.

      • DnsName (string) –

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

      • StartTime (datetime) –

        The date and time when the assessment was initiated.

      • LastUpdateDateTime (datetime) –

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

      • Status (string) –

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

      • StatusCode (string) –

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

      • StatusReason (string) –

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

      • CustomerDnsIps (list) –

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

        • (string) –

      • VpcId (string) –

        Contains Amazon VPC information for the StartADAssessment operation.

      • SubnetIds (list) –

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

        • (string) –

      • SecurityGroupIds (list) –

        The security groups identifiers attached to the network interfaces.

        • (string) –

      • SelfManagedInstanceIds (list) –

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

        • (string) –

      • ReportType (string) –

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

      • Version (string) –

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

    • AssessmentReports (list) –

      A list of assessment reports containing validation results for each domain controller and test category. Each report includes specific validation details and outcomes.

      • (dict) –

        Contains the results of validation tests performed against a specific domain controller during a directory assessment.

        • DomainControllerIp (string) –

          The IP address of the domain controller that was tested during the assessment.

        • Validations (list) –

          A list of validation results for different test categories performed against this domain controller.

          • (dict) –

            Contains information about a specific validation test performed during a directory assessment.

            • Category (string) –

              The category of the validation test.

            • Name (string) –

              The name of the specific validation test performed within the category.

            • Status (string) –

              The result status of the validation test. Valid values include SUCCESS, FAILED, PENDING, and IN_PROGRESS.

            • StatusCode (string) –

              A detailed status code providing additional information about the validation result.

            • StatusReason (string) –

              A human-readable description of the validation result, including any error details or recommendations.

            • StartTime (datetime) –

              The date and time when the validation test was started.

            • LastUpdateDateTime (datetime) –

              The date and time when the validation test was completed or last updated.

Exceptions