DirectoryService / Client / list_ad_assessments

list_ad_assessments

DirectoryService.Client.list_ad_assessments(**kwargs)

Retrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.

See also: AWS API Documentation

Request Syntax

response = client.list_ad_assessments(
    DirectoryId='string',
    NextToken='string',
    Limit=123
)
Parameters:

  • DirectoryId (string) – The identifier of the directory for which to list assessments. If not specified, all assessments in your account are returned.

  • NextToken (string) – The pagination token from a previous request to ListADAssessments. Pass null if this is the first request.

  • Limit (integer) – The maximum number of assessment summaries to return.

Return type:

dict

Returns:

Response Syntax

{
    'Assessments': [
        {
            'AssessmentId': 'string',
            'DirectoryId': 'string',
            'DnsName': 'string',
            'StartTime': datetime(2015, 1, 1),
            'LastUpdateDateTime': datetime(2015, 1, 1),
            'Status': 'string',
            'CustomerDnsIps': [
                'string',
            ],
            'ReportType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Assessments (list) –

      A list of assessment summaries containing basic information about each directory assessment.

      • (dict) –

        Contains summary information about a directory assessment, providing a high-level overview without detailed validation results.

        • 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.

        • CustomerDnsIps (list) –

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

          • (string) –

        • ReportType (string) –

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

    • NextToken (string) –

      If not null, more results are available. Pass this value for the NextToken parameter in a subsequent request to retrieve the next set of items.

Exceptions