<a id="cli-aws-controltower-get-enabled-control"></a>

# get-enabled-control

## Description

Retrieves details about an enabled control. For usage examples, see the \` *Controls Reference Guide* [https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short](https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short).html\`_\_ .

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetEnabledControl)

`get-enabled-control` uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type `document` must be provided as JSON. Shorthand syntax does not support document types.

## Synopsis

```
  get-enabled-control
--enabled-control-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--enabled-control-identifier` (string) [required]

> The `controlIdentifier` of the enabled control.

> Constraints:

> * min: `20`
> * max: `2048`
> * pattern: `arn:aws[0-9a-zA-Z_\-:\/]+`

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those 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. This may not be specified along with `--cli-input-yaml`.

`--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`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--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.

* json
* text
* table
* yaml
* yaml-stream
* off

`--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.

* on
* off
* auto

`--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.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**To get a Control Tower enabled control**

The following `get-enabled-control` example gets details of an AWS Control Tower enabled control.

```bash
aws controltower get-enabled-control \
    --enabled-control-identifier arn:aws:controltower:us-west-2:123456789012:enabledcontrol/26RGJRSLXCP1KW8D
```

Output:

```json
{
    "enabledControlDetails": {
        "arn": "arn:aws:controltower:us-west-2:123456789012:enabledcontrol/26RGJRSLXCP1KW8D",
        "controlIdentifier": "arn:aws:controltower:us-west-2::control/AWS-GR_CLOUDTRAIL_CHANGE_PROHIBITED",
        "driftStatusSummary": {
            "driftStatus": "NOT_CHECKING"
        },
        "parameters": [],
        "statusSummary": {
            "status": "SUCCEEDED"
        },
        "targetIdentifier": "arn:aws:organizations::123456789012:ou/o-s64ryixxxx/ou-oqxx-i5wnxxxx",
        "targetRegions": [
            {
                "name": "us-west-2"
            }
        ]
    }
}
```

For more information, see [About controls in AWS Control Tower](https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html) in the *AWS Control Tower User Guide*.

## Output

enabledControlDetails -> (structure)

> Information about the enabled control.

> arn -> (string)

> > The ARN of the enabled control.

> > Constraints:

> > * min: `20`
> > * max: `2048`
> > * pattern: `arn:aws[0-9a-zA-Z_\-:\/]+`

> controlIdentifier -> (string)

> > The control identifier of the enabled control. For information on how to find the `controlIdentifier` , see [the overview page](https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html) .

> > Constraints:

> > * min: `20`
> > * max: `2048`
> > * pattern: `arn:aws[0-9a-zA-Z_\-:\/]+`

> targetIdentifier -> (string)

> > The ARN of the organizational unit. For information on how to find the `targetIdentifier` , see [the overview page](https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html) .

> > Constraints:

> > * min: `20`
> > * max: `2048`
> > * pattern: `arn:aws[0-9a-zA-Z_\-:\/]+`

> statusSummary -> (structure)

> > The deployment summary of the enabled control.

> > status -> (string)

> > > The deployment status of the enabled resource.

> > > Valid values:

> > > * `SUCCEEDED` : The `EnabledControl` or `EnabledBaseline` configuration was deployed successfully.
> > > * `UNDER_CHANGE` : The `EnabledControl` or `EnabledBaseline` configuration is changing.
> > > * `FAILED` : The `EnabledControl` or `EnabledBaseline` configuration failed to deploy.

> > > Possible values:

> > > * `SUCCEEDED`
> > > * `FAILED`
> > > * `UNDER_CHANGE`

> > lastOperationIdentifier -> (string)

> > > The last operation identifier for the enabled resource.

> > > Constraints:

> > > * min: `36`
> > > * max: `36`
> > > * pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`

> driftStatusSummary -> (structure)

> > The drift status of the enabled control.

> > driftStatus -> (string)

> > > The drift status of the enabled control.

> > > Valid values:

> > > * `DRIFTED` : The `enabledControl` deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected.
> > > * `IN_SYNC` : The `enabledControl` 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.

> > > Possible values:

> > > * `DRIFTED`
> > > * `IN_SYNC`
> > > * `NOT_CHECKING`
> > > * `UNKNOWN`

> > types -> (structure)

> > > An object that categorizes the different types of drift detected for the enabled control.

> > > inheritance -> (structure)

> > > > Indicates drift related to inheritance configuration between parent and child controls.

> > > > status -> (string)

> > > > > The status of inheritance drift for the enabled control, indicating whether inheritance configuration matches expectations.

> > > > > Possible values:

> > > > > * `DRIFTED`
> > > > > * `IN_SYNC`
> > > > > * `NOT_CHECKING`
> > > > > * `UNKNOWN`

> > > resource -> (structure)

> > > > Indicates drift related to the underlying Amazon Web Services resources managed by the control.

> > > > status -> (string)

> > > > > The status of resource drift for the enabled control, indicating whether the underlying resources match the expected configuration.

> > > > > Possible values:

> > > > > * `DRIFTED`
> > > > > * `IN_SYNC`
> > > > > * `NOT_CHECKING`
> > > > > * `UNKNOWN`

> parentIdentifier -> (string)

> > The ARN of the parent enabled control from which this control inherits its configuration, if applicable.

> > Constraints:

> > * min: `20`
> > * max: `2048`
> > * pattern: `arn:aws[0-9a-zA-Z_\-:\/]+`

> targetRegions -> (list)

> > Target Amazon Web Services Regions for the enabled control.

> > (structure)

> > > An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.

> > > The expected Regions are based on the Regions that are governed by the landing zone. In certain cases, a control is not actually enabled in the Region as expected, such as during drift, or [mixed governance](https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html#mixed-governance) .

> > > name -> (string)

> > > > The Amazon Web Services Region name.

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `50`

> parameters -> (list)

> > Array of `EnabledControlParameter` objects.

> > (structure)

> > > Returns a summary of information about the parameters of an enabled control.

> > > key -> (string) [required]

> > > > The key of a key/value pair.

> > > value -> (document) [required]

> > > > The value of a key/value pair.