control_insights_by_control_domains
Creates, updates, deletes, gets or lists a control_insights_by_control_domains resource.
Overview
| Name | control_insights_by_control_domains |
| Type | Resource |
| Id | aws.auditmanager.control_insights_by_control_domains |
Fields
The following fields are returned by SELECT queries:
- list_control_insights_by_control_domain
| Name | Datatype | Description |
|---|---|---|
control_insights_metadata | array | The control analytics data that the ListControlInsightsByControlDomain 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_insights_by_control_domain | select | controlDomainId, region | nextToken, maxResults | Lists the latest analytics data for controls within a specific control domain across all active assessments. Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control. |
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 |
|---|---|---|
controlDomainId | string | The unique identifier for the control domain. 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. |
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_insights_by_control_domain
Lists the latest analytics data for controls within a specific control domain across all active assessments. Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control.
SELECT
control_insights_metadata,
next_token
FROM aws.auditmanager.control_insights_by_control_domains
WHERE controlDomainId = '{{ controlDomainId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;