AWS CLI Command Reference

[ aws . controltower ]

get-enabled-control

Description

Retrieves details about an enabled control. For usage examples, see ` the Amazon Web Services Control Tower User Guide https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html`__ .

See also: AWS API Documentation

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]

Options

--enabled-control-identifier (string)

The controlIdentifier of the enabled control.

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

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

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

Output

enabledControlDetails -> (structure)

Information about the enabled control.

arn -> (string)

The ARN of the enabled control.

controlIdentifier -> (string)

The control identifier of the enabled control. For information on how to find the controlIdentifier , see the overview page .

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.

parameters -> (list)

Array of EnabledControlParameter objects.

(structure)

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

key -> (string)

The key of a key/value pair.

value -> (document)

The value of a key/value pair.

statusSummary -> (structure)

The deployment summary of the enabled control.

lastOperationIdentifier -> (string)

The last operation identifier for the enabled control.

status -> (string)

The deployment status of the enabled control.

Valid values:

  • SUCCEEDED : The enabledControl configuration was deployed successfully.
  • UNDER_CHANGE : The enabledControl configuration is changing.
  • FAILED : The enabledControl configuration failed to deploy.

targetIdentifier -> (string)

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

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 .

name -> (string)

The Amazon Web Services Region name.
© Copyright 2018, Amazon Web Services. Created using Sphinx.