Client

controltower

R Documentation

AWS Control Tower

Description

Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:

• Controls

  • disable_control

  • enable_control

  • get_enabled_control

  • list_control_operations

  • list_enabled_controls

  • update_enabled_control

• Landing zones

  • create_landing_zone

  • delete_landing_zone

  • get_landing_zone

  • get_landing_zone_operation

  • list_landing_zones

  • list_landing_zone_operations

  • reset_landing_zone

  • update_landing_zone

• Baselines

  • disable_baseline

  • enable_baseline

  • get_baseline

  • get_baseline_operation

  • get_enabled_baseline

  • list_baselines

  • list_enabled_baselines

  • reset_enabled_baseline

  • update_enabled_baseline

• Tagging

  • list_tags_for_resource

  • tag_resource

  • untag_resource

For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .

About control APIs

These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.

To call these APIs, you'll need to know:

• the controlIdentifier for the control–or guardrail–you are targeting.

• the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.

• the ARN associated with a resource that you wish to tag or untag.

To get the controlIdentifier for your Amazon Web Services Control Tower control:

The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.

About identifiers for Amazon Web Services Control Tower

The Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.

A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.

Some controls have two identifiers

• ARN format for Amazon Web Services Control Tower: ⁠arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}⁠

  Example:

  ⁠arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED⁠

• ARN format for Amazon Web Services Control Catalog: arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}

You can find the {CONTROL_CATALOG_OPAQUE_ID} in the Amazon Web Services Control Tower Controls Reference Guide , or in the Amazon Web Services Control Tower console, on the Control details page.

The Amazon Web Services Control Tower APIs for enabled controls, such as get_enabled_control and list_enabled_controls always return an ARN of the same type given when the control was enabled.

To get the targetIdentifier:

The targetIdentifier is the ARN for an OU.

In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

OU ARN format:

⁠arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}⁠

About landing zone APIs

You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.

For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the "Actions" section.

About baseline APIs

You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.

You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.

The individual API operations for baselines are detailed in this document, the API reference manual, in the "Actions" section. For usage examples, see Baseline API input and output examples with CLI.

About Amazon Web Services Control Catalog identifiers

• The enable_control and disable_control API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.

• If you use an Amazon Web Services Control Tower identifier to call the enable_control API, and then call enable_control again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to the disable_control API operation.

• Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.

Details and examples

• Control API input and output examples with CLI

• Baseline API input and output examples with CLI

• Enable controls with CloudFormation

• Launch a landing zone with CloudFormation

• Control metadata tables (large page)

• Control availability by Region tables (large page)

• List of identifiers for legacy controls

• Controls reference guide

• Controls library groupings

• Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower

Recording API Requests

Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.

Usage

controltower(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- controltower(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_landing_zone

Creates a new landing zone

delete_landing_zone

Decommissions a landing zone

disable_baseline

Disable an EnabledBaseline resource on the specified Target

disable_control

This API call turns off a control

enable_baseline

Enable (apply) a Baseline to a Target

enable_control

This API call activates a control

get_baseline

Retrieve details about an existing Baseline resource by specifying its identifier

get_baseline_operation

Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline

get_control_operation

Returns the status of a particular EnableControl or DisableControl operation

get_enabled_baseline

Retrieve details of an EnabledBaseline resource by specifying its identifier

get_enabled_control

Retrieves details about an enabled control

get_landing_zone

Returns details about the landing zone

get_landing_zone_operation

Returns the status of the specified landing zone operation

list_baselines

Returns a summary list of all available baselines

list_control_operations

Provides a list of operations in progress or queued

list_enabled_baselines

Returns a list of summaries describing EnabledBaseline resources

list_enabled_controls

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

list_landing_zone_operations

Lists all landing zone operations from the past 90 days

list_landing_zones

Returns the landing zone ARN for the landing zone deployed in your managed account

list_tags_for_resource

Returns a list of tags associated with the resource

reset_enabled_baseline

Re-enables an EnabledBaseline resource

reset_landing_zone

This API call resets a landing zone

tag_resource

Applies tags to a resource

untag_resource

Removes tags from a resource

update_enabled_baseline

Updates an EnabledBaseline resource's applied parameters or version

update_enabled_control

Updates the configuration of an already enabled control

update_landing_zone

This API call updates the landing zone

Examples

## Not run: 
svc <- controltower()
svc$create_landing_zone(
  Foo = 123
)

## End(Not run)