ListAssessmentFrameworks
Returns a list of the frameworks that are available in the AWS Audit Manager framework library.
Request Syntax
GET /assessmentFrameworks?frameworkType=frameworkType
&maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- frameworkType
-
The type of framework, such as a standard framework or a custom framework.
Valid Values:
Standard | Custom
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
{
"frameworkMetadataList": [
{
"arn": "string",
"complianceType": "string",
"controlsCount": number,
"controlSetsCount": number,
"createdAt": number,
"description": "string",
"id": "string",
"lastUpdatedAt": number,
"logo": "string",
"name": "string",
"type": "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.
- frameworkMetadataList
-
The list of metadata objects for the framework.
Type: Array of AssessmentFrameworkMetadata 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 AWS 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
- 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: