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

ListSecurityControlDefinitions

Lists all of the security controls that apply to a specified standard.

Request Syntax


GET /securityControls/definitions?MaxResults=MaxResults&NextToken=NextToken&StandardsArn=StandardsArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 security controls that apply to the specified standard. The results also include a NextToken parameter that you can use in a subsequent API call to get the next 25 controls. This repeats until all controls for the standard are returned.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

Optional pagination parameter.

StandardsArn

The Amazon Resource Name (ARN) of the standard that you want to view controls for.

Pattern: .*\S.*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "SecurityControlDefinitions": [ 
      { 
         "CurrentRegionAvailability": "string",
         "CustomizableProperties": [ "string" ],
         "Description": "string",
         "ParameterDefinitions": { 
            "string" : { 
               "ConfigurationOptions": { ... },
               "Description": "string"
            }
         },
         "RemediationUrl": "string",
         "SecurityControlId": "string",
         "SeverityRating": "string",
         "Title": "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.

NextToken

A pagination parameter that's included in the response only if it was included in the request.

Type: String

SecurityControlDefinitions

An array of controls that apply to the specified standard.

Type: Array of SecurityControlDefinition objects

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

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

HTTP Status Code: 429