DirectoryService / Paginator / ListADAssessments

ListADAssessments¶

class DirectoryService.Paginator.ListADAssessments¶

paginator = client.get_paginator('list_ad_assessments')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from DirectoryService.Client.list_ad_assessments().

Request Syntax

response_iterator = paginator.paginate(
    DirectoryId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

DirectoryId (string) – The identifier of the directory for which to list assessments. If not specified, all assessments in your account are returned.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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.