DescribeStandardsControls
Returns a list of security standards controls.
For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.
This operation returns an empty list for standard subscriptions where StandardsControlsUpdatable has value NOT_READY_FOR_UPDATES.
Request Syntax
GET /standards/controls/StandardsSubscriptionArn+?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of security standard controls to return.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
The token that is required for pagination. On your first call to the
DescribeStandardsControlsoperation, set the value of this parameter toNULL.For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- StandardsSubscriptionArn
-
The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of the standards you have enabled, use the
GetEnabledStandardsoperation.Pattern:
.*\S.*Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Controls": [
{
"ControlId": "string",
"ControlStatus": "string",
"ControlStatusUpdatedAt": "string",
"Description": "string",
"DisabledReason": "string",
"RelatedRequirements": [ "string" ],
"RemediationUrl": "string",
"SeverityRating": "string",
"StandardsControlArn": "string",
"Title": "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.
- Controls
-
A list of security standards controls.
Type: Array of StandardsControl objects
- NextToken
-
The pagination token to use to request the next page of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidAccessException
-
The account doesn't have permission to perform this action.
HTTP Status Code: 401
- InvalidInputException
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
- ResourceNotFoundException
-
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
