ad_assessments

Creates, updates, deletes, gets or lists an ad_assessments resource.

Overview

Name	ad_assessments
Type	Resource
Id	aws.ds.ad_assessments

Fields

The following fields are returned by SELECT queries:

describe_ad_assessment

Name	Datatype	Description
assessment	object	Detailed information about the self-managed instance settings (IDs and DNS IPs).
assessment_reports	array	A list of assessment reports containing validation results for each domain controller and test category. Each report includes specific validation details and outcomes.

list_ad_assessments

Name	Datatype	Description
assessment_id	string	The unique identifier of the directory assessment. (pattern: <code>^da-[0-9a-f]{18}$</code>)
customer_dns_ips	array	The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.
directory_id	string	The identifier of the directory associated with this assessment. (pattern: <code>^d-[0-9a-f]{10}$</code>)
dns_name	string	The fully qualified domain name (FQDN) of the Active Directory domain being assessed. (pattern: <code>^([a-zA-Z0-9]+[\.-])+([a-zA-Z0-9])+$</code>)
last_update_date_time	string (date-time)	The date and time when the assessment status was last updated.
report_type	string	The type of assessment report generated. Valid values include CUSTOMER and SYSTEM.
start_time	string (date-time)	The date and time when the assessment was initiated.
status	string	The current status of the assessment. Valid values include SUCCESS, FAILED, PENDING, and IN_PROGRESS.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ad_assessment	select	region		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.
list_ad_assessments	select	region		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.
delete_ad_assessment	delete	region		Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information. You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_ad_assessment

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.

SELECT
assessment,
assessment_reports
FROM aws.ds.ad_assessments
WHERE region = '{{ region }}' -- required
;

list_ad_assessments

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.

SELECT
assessment_id,
customer_dns_ips,
directory_id,
dns_name,
last_update_date_time,
report_type,
start_time,
status
FROM aws.ds.ad_assessments
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_ad_assessment

Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information. You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.

DELETE FROM aws.ds.ad_assessments
WHERE region = '{{ region }}' --required
;