Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListAssessmentControlInsightsByControlDomain

Lists the latest analytics data for controls within a specific control domain and a specific active assessment.

Note

Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control.

Request Syntax


GET /insights/controls-by-assessment?assessmentId=assessmentId&controlDomainId=controlDomainId&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

controlDomainId

The unique identifier for the control domain.

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.

Length Constraints: Minimum length of 13. Maximum length of 2048.

Pattern: ^arn:.*:controlcatalog:.*:.*:domain/.*|UNCATEGORIZED|^[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

{
   "controlInsightsByAssessment": [ 
      { 
         "controlSetName": "string",
         "evidenceInsights": { 
            "compliantEvidenceCount": number,
            "inconclusiveEvidenceCount": number,
            "noncompliantEvidenceCount": number
         },
         "id": "string",
         "lastUpdated": number,
         "name": "string"
      }
   ],
   "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.

controlInsightsByAssessment

The assessment control analytics data that the ListAssessmentControlInsightsByControlDomain API returned.

Type: Array of ControlInsightsMetadataByAssessmentItem 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