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

GetSecurityControlDefinition

Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.

Request Syntax


GET /securityControl/definition?SecurityControlId=SecurityControlId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

SecurityControlId

The ID of the security control to retrieve the definition for. This field doesn’t accept an Amazon Resource Name (ARN).

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "SecurityControlDefinition": { 
      "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.

SecurityControlDefinition

Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in AWS Regions, and a link to remediation steps.

Type: SecurityControlDefinition object

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

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404