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

GetEnabledControl

Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide.

Request Syntax


POST /get-enabled-control HTTP/1.1
Content-type: application/json

{
   "enabledControlIdentifier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

enabledControlIdentifier

The controlIdentifier of the enabled control.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "enabledControlDetails": { 
      "arn": "string",
      "controlIdentifier": "string",
      "driftStatusSummary": { 
         "driftStatus": "string"
      },
      "parameters": [ 
         { 
            "key": "string",
            "value": JSON value
         }
      ],
      "statusSummary": { 
         "lastOperationIdentifier": "string",
         "status": "string"
      },
      "targetIdentifier": "string",
      "targetRegions": [ 
         { 
            "name": "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.

enabledControlDetails

Information about the enabled control.

Type: EnabledControlDetails object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during processing of a request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400