ListEnabledControls - AWS Control Tower (original) (raw)

Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Controls Reference Guide.

Request Syntax

POST /list-enabled-controls HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "controlIdentifiers": [ "string" ],
      "driftStatuses": [ "string" ],
      "statuses": [ "string" ]
   },
   "maxResults": number,
   "nextToken": "string",
   "targetIdentifier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filter

An input filter for the ListEnabledControls API that lets you select the types of control operations to view.

Type: EnabledControlFilter object

Required: No

maxResults

How many results to return per API call.

Type: Integer

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

Required: No

nextToken

The token to continue the list from a previous API call with the same parameters.

Type: String

Required: No

targetIdentifier

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

Type: String

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

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

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "enabledControls": [ 
      { 
         "arn": "string",
         "controlIdentifier": "string",
         "driftStatusSummary": { 
            "driftStatus": "string"
         },
         "statusSummary": { 
            "lastOperationIdentifier": "string",
            "status": "string"
         },
         "targetIdentifier": "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.

enabledControls

Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.

Type: Array of EnabledControlSummary objects

nextToken

Retrieves the next page of results. If the string is empty, the response is the end of the results.

Type: String

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: