Skip to content

Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains

Description

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

Usage

controltower_list_enabled_controls(targetIdentifier, nextToken,
  maxResults, filter, includeChildren)

Arguments

  • targetIdentifier

    The ARN of the target. The value depends on the target type:

    • Organizational unit (OU) – Specify the ARN of the OU.
    • Account – Specify the ARN of the account.

    For information on how to find the targetIdentifier, see the overview page.

  • nextToken

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

  • maxResults

    How many results to return per API call.

  • filter

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

  • includeChildren

    Specifies whether to include enabled controls from child organizational units and child accounts in the response.

Value

A list with the following syntax:

list(
  enabledControls = list(
    list(
      arn = "string",
      controlIdentifier = "string",
      targetIdentifier = "string",
      statusSummary = list(
        status = "SUCCEEDED"|"FAILED"|"UNDER_CHANGE",
        lastOperationIdentifier = "string"
      ),
      driftStatusSummary = list(
        driftStatus = "DRIFTED"|"IN_SYNC"|"NOT_CHECKING"|"UNKNOWN",
        types = list(
          inheritance = list(
            status = "DRIFTED"|"IN_SYNC"|"NOT_CHECKING"|"UNKNOWN"
          ),
          resource = list(
            status = "DRIFTED"|"IN_SYNC"|"NOT_CHECKING"|"UNKNOWN"
          )
        )
      ),
      parentIdentifier = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_enabled_controls(
  targetIdentifier = "string",
  nextToken = "string",
  maxResults = 123,
  filter = list(
    controlIdentifiers = list(
      "string"
    ),
    statuses = list(
      "SUCCEEDED"|"FAILED"|"UNDER_CHANGE"
    ),
    driftStatuses = list(
      "DRIFTED"|"IN_SYNC"|"NOT_CHECKING"|"UNKNOWN"
    ),
    parentIdentifiers = list(
      "string"
    ),
    inheritanceDriftStatuses = list(
      "DRIFTED"|"IN_SYNC"|"NOT_CHECKING"|"UNKNOWN"
    ),
    resourceDriftStatuses = list(
      "DRIFTED"|"IN_SYNC"|"NOT_CHECKING"|"UNKNOWN"
    )
  ),
  includeChildren = TRUE|FALSE
)