Lists analytics data for control domains within a specified active assessment.
Audit Manager supports the control domains that are provided by AWS
Control Catalog. For information about how to find a list of available control domains, see
ListDomains in the AWS Control
Catalog API Reference.
Note
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.
Request Syntax
GET /insights/control-domains-by-assessment?assessmentId=assessmentId&maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- assessmentId
-
The unique identifier for the active assessment.
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- maxResults
-
Represents the maximum number of results on a page or for an API request call.
Valid Range: Minimum value of 1. Maximum value of 1000.
- nextToken
-
The pagination token that's used to fetch the next set of results.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[A-Za-z0-9+\/=]*$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"controlDomainInsights": [
{
"controlsCountByNoncompliantEvidence": number,
"evidenceInsights": {
"compliantEvidenceCount": number,
"inconclusiveEvidenceCount": number,
"noncompliantEvidenceCount": number
},
"id": "string",
"lastUpdated": number,
"name": "string",
"totalControlsCount": number
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- controlDomainInsights
-
The control domain analytics data that the
ListControlDomainInsightsByAssessmentAPI returned.Type: Array of ControlDomainInsights objects
- nextToken
-
The pagination token that's used to fetch the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[A-Za-z0-9+\/=]*$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Your account isn't registered with AWS Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.
HTTP Status Code: 403
- InternalServerException
-
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource that's specified in the request can't be found.
HTTP Status Code: 404
- ValidationException
-
The request has invalid or missing parameters.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
