control_domain_insights_by_assessments

Creates, updates, deletes, gets or lists a control_domain_insights_by_assessments resource.

Overview

Name	control_domain_insights_by_assessments
Type	Resource
Id	aws.auditmanager.control_domain_insights_by_assessments

Fields

The following fields are returned by SELECT queries:

list_control_domain_insights_by_assessment

Name	Datatype	Description
control_domain_insights	array	The control domain analytics data that the ListControlDomainInsightsByAssessment API returned.
next_token	string	The pagination token that's used to fetch the next set of results. (pattern: <code>^[A-Za-z0-9+/=]*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_control_domain_insights_by_assessment	select	assessmentId, region	nextToken, maxResults	Lists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.

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
assessmentId	string	The unique identifier for the active assessment.
region	string	AWS region (default: us-east-1)
maxResults	integer	Represents the maximum number of results on a page or for an API request call.
nextToken	string	The pagination token that's used to fetch the next set of results.

SELECT examples

list_control_domain_insights_by_assessment

Lists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.

SELECT
control_domain_insights,
next_token
FROM aws.auditmanager.control_domain_insights_by_assessments
WHERE assessmentId = '{{ assessmentId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;