GetEvidenceFoldersByAssessmentControl
Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.
Request Syntax
GET /assessments/assessmentId
/evidenceFolders-by-assessment-control/controlSetId
/controlId
?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- assessmentId
-
The identifier for the 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
- controlId
-
The identifier for the control.
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
- controlSetId
-
The identifier for the control set.
Length Constraints: Minimum length of 1. Maximum length of 300.
Pattern:
^[\w\W\s\S]*$
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
{
"evidenceFolders": [
{
"assessmentId": "string",
"assessmentReportSelectionCount": number,
"author": "string",
"controlId": "string",
"controlName": "string",
"controlSetId": "string",
"dataSource": "string",
"date": number,
"evidenceAwsServiceSourceCount": number,
"evidenceByTypeComplianceCheckCount": number,
"evidenceByTypeComplianceCheckIssuesCount": number,
"evidenceByTypeConfigurationDataCount": number,
"evidenceByTypeManualCount": number,
"evidenceByTypeUserActivityCount": number,
"evidenceResourcesIncludedCount": number,
"id": "string",
"name": "string",
"totalEvidence": 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.
- evidenceFolders
-
The list of evidence folders that the
GetEvidenceFoldersByAssessmentControl
API returned.Type: Array of AssessmentEvidenceFolder 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: