Edit on GitHub

Controltower

This page documents function available when using the Controltower module, created with @service Controltower.

Index

Documentation

Main.Controltower.disable_control — Method
disable_control(control_identifier, target_identifier)
disable_control(control_identifier, target_identifier, params::Dict{String,<:Any})

This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify.

Arguments

  • control_identifier: The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny guardrail.
  • target_identifier: The ARN of the organizational unit.
source
Main.Controltower.enable_control — Method
enable_control(control_identifier, target_identifier)
enable_control(control_identifier, target_identifier, params::Dict{String,<:Any})

This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify.

Arguments

  • control_identifier: The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny guardrail.
  • target_identifier: The ARN of the organizational unit.
source
Main.Controltower.get_control_operation — Method
get_control_operation(operation_identifier)
get_control_operation(operation_identifier, params::Dict{String,<:Any})

Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days.

Arguments

  • operation_identifier: The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
source
Main.Controltower.list_enabled_controls — Method
list_enabled_controls(target_identifier)
list_enabled_controls(target_identifier, params::Dict{String,<:Any})

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

Arguments

  • target_identifier: The ARN of the organizational unit.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": How many results to return per API call.
  • "nextToken": The token to continue the list from a previous API call with the same parameters.
source