AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . controltower ]
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 https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html`__ .
See also: AWS API Documentation
list-enabled-controls
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: enabledControls
list-enabled-controls
[--filter <value>]
[--target-identifier <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--filter
(structure)
An input filter for the
ListEnabledControls
API that lets you select the types of control operations to view.controlIdentifiers -> (list)
The set of
controlIdentifier
returned by the filter.(string)
driftStatuses -> (list)
A list of
DriftStatus
items.(string)
statuses -> (list)
A list of
EnablementStatus
items.(string)
Shorthand Syntax:
controlIdentifiers=string,string,driftStatuses=string,string,statuses=string,string
JSON Syntax:
{
"controlIdentifiers": ["string", ...],
"driftStatuses": ["DRIFTED"|"IN_SYNC"|"NOT_CHECKING"|"UNKNOWN", ...],
"statuses": ["SUCCEEDED"|"FAILED"|"UNDER_CHANGE", ...]
}
--target-identifier
(string)
The ARN of the organizational unit. For information on how to find thetargetIdentifier
, see the overview page .
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command's output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
enabledControls -> (list)
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
(structure)
Returns a summary of information about an enabled control.
arn -> (string)
The ARN of the enabled control.controlIdentifier -> (string)
ThecontrolIdentifier
of the enabled control.driftStatusSummary -> (structure)
The drift status of the enabled control.
driftStatus -> (string)
The drift status of the enabled control.
Valid values:
DRIFTED
: TheenabledControl
deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected.IN_SYNC
: TheenabledControl
deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.NOT_CHECKING
: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.UNKNOWN
: Amazon Web Services Control Tower is not able to check the drift status for the enabled control.statusSummary -> (structure)
A short description of the status of the enabled control.
lastOperationIdentifier -> (string)
The last operation identifier for the enabled resource.status -> (string)
The deployment status of the enabled resource.
Valid values:
SUCCEEDED
: TheEnabledControl
orEnabledBaseline
configuration was deployed successfully.UNDER_CHANGE
: TheEnabledControl
orEnabledBaseline
configuration is changing.FAILED
: TheEnabledControl
orEnabledBaseline
configuration failed to deploy.targetIdentifier -> (string)
The ARN of the organizational unit.
nextToken -> (string)
Retrieves the next page of results. If the string is empty, the response is the end of the results.