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

BatchGetSecurityControls

Provides details about a batch of security controls for the current AWS account and AWS Region.

Request Syntax


POST /securityControls/batchGet HTTP/1.1
Content-type: application/json

{
   "SecurityControlIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

SecurityControlIds

A list of security controls (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters). The security control ID or Amazon Resource Name (ARN) is the same across standards.

Type: Array of strings

Pattern: .*\S.*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "SecurityControls": [ 
      { 
         "Description": "string",
         "LastUpdateReason": "string",
         "Parameters": { 
            "string" : { 
               "Value": { ... },
               "ValueType": "string"
            }
         },
         "RemediationUrl": "string",
         "SecurityControlArn": "string",
         "SecurityControlId": "string",
         "SecurityControlStatus": "string",
         "SeverityRating": "string",
         "Title": "string",
         "UpdateStatus": "string"
      }
   ],
   "UnprocessedIds": [ 
      { 
         "ErrorCode": "string",
         "ErrorReason": "string",
         "SecurityControlId": "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.

SecurityControls

An array that returns the identifier, Amazon Resource Name (ARN), and other details about a security control. The same information is returned whether the request includes SecurityControlId or SecurityControlArn.

Type: Array of SecurityControl objects

UnprocessedIds

A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which details cannot be returned.

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