We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.ControlTower

Inherits:
AWS.Service show all
Identifier:
controltower
API Version:
2018-05-10
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

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.

The 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 User 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 Controls reference guide section of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls cannot be added or removed.

Note: ARN format: arn:aws:controltower:[REGION]::control/[CONTROL_NAME] Example: arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED

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.

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

Details and examples

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.

Sending a Request Using ControlTower

var controltower = new AWS.ControlTower();
controltower.createLandingZone(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ControlTower object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var controltower = new AWS.ControlTower({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the controltower service identifier:

AWS.config.apiVersions = {
  controltower: '2018-05-10',
  // other service API versions
};

var controltower = new AWS.ControlTower();

Version:

  • 2018-05-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ControlTower(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ControlTower object

var controltower = new AWS.ControlTower({apiVersion: '2018-05-10'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ControlTower.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.ControlTower.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ControlTower.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createLandingZone(params = {}, callback) ⇒ AWS.Request

Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.

Service Reference:

Examples:

Calling the createLandingZone operation

var params = {
  manifest: { /* required */
  },
  version: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
controltower.createLandingZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • manifest — (map)

      The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.

    • tags — (map<String>)

      Tags to be applied to the landing zone.

    • version — (String)

      The landing zone version, for example, 3.0.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The ARN of the landing zone resource.

      • operationIdentifier — (String)

        A unique identifier assigned to a CreateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteLandingZone(params = {}, callback) ⇒ AWS.Request

Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.

Service Reference:

Examples:

Calling the deleteLandingZone operation

var params = {
  landingZoneIdentifier: 'STRING_VALUE' /* required */
};
controltower.deleteLandingZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • landingZoneIdentifier — (String)

      The unique identifier of the landing zone.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • operationIdentifier — (String)

        >A unique identifier assigned to a DeleteLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disableBaseline(params = {}, callback) ⇒ AWS.Request

Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the disableBaseline operation

var params = {
  enabledBaselineIdentifier: 'STRING_VALUE' /* required */
};
controltower.disableBaseline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • enabledBaselineIdentifier — (String)

      Identifier of the EnabledBaseline resource to be deactivated, in ARN format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • operationIdentifier — (String)

        The ID (in UUID format) of the asynchronous DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disableControl(params = {}, callback) ⇒ AWS.Request

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. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the disableControl operation

var params = {
  controlIdentifier: 'STRING_VALUE', /* required */
  targetIdentifier: 'STRING_VALUE' /* required */
};
controltower.disableControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • controlIdentifier — (String)

      The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.

    • targetIdentifier — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • operationIdentifier — (String)

        The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

enableBaseline(params = {}, callback) ⇒ AWS.Request

Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the enableBaseline operation

var params = {
  baselineIdentifier: 'STRING_VALUE', /* required */
  baselineVersion: 'STRING_VALUE', /* required */
  targetIdentifier: 'STRING_VALUE', /* required */
  parameters: [
    {
      key: 'STRING_VALUE', /* required */
      value: { /* required */
      }
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
controltower.enableBaseline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • baselineIdentifier — (String)

      The ARN of the baseline to be enabled.

    • baselineVersion — (String)

      The specific version to be enabled of the specified baseline.

    • parameters — (Array<map>)

      A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.

      • keyrequired — (String)

        A string denoting the parameter key.

      • valuerequired — (map)

        A low-level Document object of any type (for example, a Java Object).

    • tags — (map<String>)

      Tags associated with input to EnableBaseline.

    • targetIdentifier — (String)

      The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The ARN of the EnabledBaseline resource.

      • operationIdentifier — (String)

        The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

enableControl(params = {}, callback) ⇒ AWS.Request

This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the enableControl operation

var params = {
  controlIdentifier: 'STRING_VALUE', /* required */
  targetIdentifier: 'STRING_VALUE', /* required */
  parameters: [
    {
      key: 'STRING_VALUE', /* required */
      value: { /* required */
      }
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
controltower.enableControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • controlIdentifier — (String)

      The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.

    • parameters — (Array<map>)

      A list of input parameter values, which are specified to configure the control when you enable it.

      • keyrequired — (String)

        The key of a key/value pair.

      • valuerequired — (map)

        The value of a key/value pair.

    • tags — (map<String>)

      Tags to be applied to the EnabledControl resource.

    • targetIdentifier — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The ARN of the EnabledControl resource.

      • operationIdentifier — (String)

        The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBaseline(params = {}, callback) ⇒ AWS.Request

Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the getBaseline operation

var params = {
  baselineIdentifier: 'STRING_VALUE' /* required */
};
controltower.getBaseline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • baselineIdentifier — (String)

      The ARN of the Baseline resource to be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • arn — (String)

        The baseline ARN.

      • description — (String)

        A description of the baseline.

      • name — (String)

        A user-friendly name for the baseline.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBaselineOperation(params = {}, callback) ⇒ AWS.Request

Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the getBaselineOperation operation

var params = {
  operationIdentifier: 'STRING_VALUE' /* required */
};
controltower.getBaselineOperation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • operationIdentifier — (String)

      The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • baselineOperation — (map)

        A baselineOperation object that shows information about the specified operation ID.

        • endTime — (Date)

          The end time of the operation (if applicable), in ISO 8601 format.

        • operationIdentifier — (String)

          The identifier of the specified operation.

        • operationType — (String)

          An enumerated type (enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.

          Possible values include:
          • "ENABLE_BASELINE"
          • "DISABLE_BASELINE"
          • "UPDATE_ENABLED_BASELINE"
          • "RESET_ENABLED_BASELINE"
        • startTime — (Date)

          The start time of the operation, in ISO 8601 format.

        • status — (String)

          An enumerated type (enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.

          Possible values include:
          • "SUCCEEDED"
          • "FAILED"
          • "IN_PROGRESS"
        • statusMessage — (String)

          A status message that gives more information about the operation's status, if applicable.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getControlOperation(params = {}, callback) ⇒ AWS.Request

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. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the getControlOperation operation

var params = {
  operationIdentifier: 'STRING_VALUE' /* required */
};
controltower.getControlOperation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • operationIdentifier — (String)

      The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • controlOperation — (map)

        An operation performed by the control.

        • controlIdentifier — (String)

          The controlIdentifier of the control for the operation.

        • enabledControlIdentifier — (String)

          The controlIdentifier of the enabled control.

        • endTime — (Date)

          The time that the operation finished.

        • operationIdentifier — (String)

          The identifier of the specified operation.

        • operationType — (String)

          One of ENABLE_CONTROL or DISABLE_CONTROL.

          Possible values include:
          • "ENABLE_CONTROL"
          • "DISABLE_CONTROL"
          • "UPDATE_ENABLED_CONTROL"
        • startTime — (Date)

          The time that the operation began.

        • status — (String)

          One of IN_PROGRESS, SUCEEDED, or FAILED.

          Possible values include:
          • "SUCCEEDED"
          • "FAILED"
          • "IN_PROGRESS"
        • statusMessage — (String)

          If the operation result is FAILED, this string contains a message explaining why the operation failed.

        • targetIdentifier — (String)

          The target upon which the control operation is working.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnabledBaseline(params = {}, callback) ⇒ AWS.Request

Retrieve details of an EnabledBaseline resource by specifying its identifier.

Service Reference:

Examples:

Calling the getEnabledBaseline operation

var params = {
  enabledBaselineIdentifier: 'STRING_VALUE' /* required */
};
controltower.getEnabledBaseline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • enabledBaselineIdentifier — (String)

      Identifier of the EnabledBaseline resource to be retrieved, in ARN format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • enabledBaselineDetails — (map)

        Details of the EnabledBaseline resource.

        • arnrequired — (String)

          The ARN of the EnabledBaseline resource.

        • baselineIdentifierrequired — (String)

          The specific Baseline enabled as part of the EnabledBaseline resource.

        • baselineVersion — (String)

          The enabled version of the Baseline.

        • parameters — (Array<map>)

          Shows the parameters that are applied when enabling this Baseline.

          • keyrequired — (String)

            A string denoting the parameter key.

          • valuerequired — (map)

            A low-level document object of any type (for example, a Java Object).

        • statusSummaryrequired — (map)

          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.

            Possible values include:
            • "SUCCEEDED"
            • "FAILED"
            • "UNDER_CHANGE"
        • targetIdentifierrequired — (String)

          The target on which to enable the Baseline.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnabledControl(params = {}, callback) ⇒ AWS.Request

Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the getEnabledControl operation

var params = {
  enabledControlIdentifier: 'STRING_VALUE' /* required */
};
controltower.getEnabledControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • enabledControlIdentifier — (String)

      The controlIdentifier of the enabled control.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • enabledControlDetails — (map)

        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 — (map)

          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 include:
            • "DRIFTED"
            • "IN_SYNC"
            • "NOT_CHECKING"
            • "UNKNOWN"
        • parameters — (Array<map>)

          Array of EnabledControlParameter objects.

          • keyrequired — (String)

            The key of a key/value pair.

          • valuerequired — (map)

            The value of a key/value pair.

        • statusSummary — (map)

          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.

            Possible values include:
            • "SUCCEEDED"
            • "FAILED"
            • "UNDER_CHANGE"
        • targetIdentifier — (String)

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

        • targetRegions — (Array<map>)

          Target Amazon Web Services Regions for the enabled control.

          • name — (String)

            The Amazon Web Services Region name.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLandingZone(params = {}, callback) ⇒ AWS.Request

Returns details about the landing zone. Displays a message in case of error.

Service Reference:

Examples:

Calling the getLandingZone operation

var params = {
  landingZoneIdentifier: 'STRING_VALUE' /* required */
};
controltower.getLandingZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • landingZoneIdentifier — (String)

      The unique identifier of the landing zone.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • landingZone — (map)

        Information about the landing zone.

        • arn — (String)

          The ARN of the landing zone.

        • driftStatus — (map)

          The drift status of the landing zone.

          • status — (String)

            The drift status of the landing zone.

            Valid values:

            • DRIFTED: The landing zone deployed in this configuration does not match the configuration that Amazon Web Services Control Tower expected.

            • IN_SYNC: The landing zone deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.

            Possible values include:
            • "DRIFTED"
            • "IN_SYNC"
        • latestAvailableVersion — (String)

          The latest available version of the landing zone.

        • manifestrequired — (map)

          The landing zone manifest JSON text file that specifies the landing zone configurations.

        • status — (String)

          The landing zone deployment status. One of ACTIVE, PROCESSING, FAILED.

          Possible values include:
          • "ACTIVE"
          • "PROCESSING"
          • "FAILED"
        • versionrequired — (String)

          The landing zone's current deployed version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLandingZoneOperation(params = {}, callback) ⇒ AWS.Request

Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.

Service Reference:

Examples:

Calling the getLandingZoneOperation operation

var params = {
  operationIdentifier: 'STRING_VALUE' /* required */
};
controltower.getLandingZoneOperation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • operationIdentifier — (String)

      A unique identifier assigned to a landing zone operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • operationDetails — (map)

        Details about a landing zone operation.

        • endTime — (Date)

          The landing zone operation end time.

        • operationType — (String)

          The landing zone operation type.

          Valid values:

          • DELETE: The DeleteLandingZone operation.

          • CREATE: The CreateLandingZone operation.

          • UPDATE: The UpdateLandingZone operation.

          • RESET: The ResetLandingZone operation.

          Possible values include:
          • "DELETE"
          • "CREATE"
          • "UPDATE"
          • "RESET"
        • startTime — (Date)

          The landing zone operation start time.

        • status — (String)

          Valid values:

          • SUCCEEDED: The landing zone operation succeeded.

          • IN_PROGRESS: The landing zone operation is in progress.

          • FAILED: The landing zone operation failed.

          Possible values include:
          • "SUCCEEDED"
          • "FAILED"
          • "IN_PROGRESS"
        • statusMessage — (String)

          If the operation result is FAILED, this string contains a message explaining why the operation failed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBaselines(params = {}, callback) ⇒ AWS.Request

Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the listBaselines operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
controltower.listBaselines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to be shown.

    • nextToken — (String)

      A pagination token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • baselines — (Array<map>)

        A list of Baseline object details.

        • arnrequired — (String)

          The full ARN of a Baseline.

        • description — (String)

          A summary description of a Baseline.

        • namerequired — (String)

          The human-readable name of a Baseline.

      • nextToken — (String)

        A pagination token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listControlOperations(params = {}, callback) ⇒ AWS.Request

Provides a list of operations in progress or queued.

Service Reference:

Examples:

Calling the listControlOperations operation

var params = {
  filter: {
    controlIdentifiers: [
      'STRING_VALUE',
      /* more items */
    ],
    controlOperationTypes: [
      ENABLE_CONTROL | DISABLE_CONTROL | UPDATE_ENABLED_CONTROL,
      /* more items */
    ],
    enabledControlIdentifiers: [
      'STRING_VALUE',
      /* more items */
    ],
    statuses: [
      SUCCEEDED | FAILED | IN_PROGRESS,
      /* more items */
    ],
    targetIdentifiers: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
controltower.listControlOperations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filter — (map)

      An input filter for the ListControlOperations API that lets you select the types of control operations to view.

      • controlIdentifiers — (Array<String>)

        The set of controlIdentifier returned by the filter.

      • controlOperationTypes — (Array<String>)

        The set of ControlOperation objects returned by the filter.

      • enabledControlIdentifiers — (Array<String>)

        The set controlIdentifier of enabled controls selected by the filter.

      • statuses — (Array<String>)

        Lists the status of control operations.

      • targetIdentifiers — (Array<String>)

        The set of targetIdentifier objects returned by the filter.

    • maxResults — (Integer)

      The maximum number of results to be shown.

    • nextToken — (String)

      A pagination token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • controlOperations — (Array<map>)

        Returns a list of output from control operations. PLACEHOLDER

        • controlIdentifier — (String)

          The controlIdentifier of a control.

        • enabledControlIdentifier — (String)

          The controlIdentifier of an enabled control.

        • endTime — (Date)

          The time at which the control operation was completed.

        • operationIdentifier — (String)

          The unique identifier of a control operation.

        • operationType — (String)

          The type of operation.

          Possible values include:
          • "ENABLE_CONTROL"
          • "DISABLE_CONTROL"
          • "UPDATE_ENABLED_CONTROL"
        • startTime — (Date)

          The time at which a control operation began.

        • status — (String)

          The status of the specified control operation.

          Possible values include:
          • "SUCCEEDED"
          • "FAILED"
          • "IN_PROGRESS"
        • statusMessage — (String)

          A speficic message displayed as part of the control status.

        • targetIdentifier — (String)

          The unique identifier of the target of a control operation.

      • nextToken — (String)

        A pagination token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEnabledBaselines(params = {}, callback) ⇒ AWS.Request

Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the listEnabledBaselines operation

var params = {
  filter: {
    baselineIdentifiers: [
      'STRING_VALUE',
      /* more items */
    ],
    targetIdentifiers: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
controltower.listEnabledBaselines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filter — (map)

      A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.

      • baselineIdentifiers — (Array<String>)

        Identifiers for the Baseline objects returned as part of the filter operation.

      • targetIdentifiers — (Array<String>)

        Identifiers for the targets of the Baseline filter operation.

    • maxResults — (Integer)

      The maximum number of results to be shown.

    • nextToken — (String)

      A pagination token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • enabledBaselines — (Array<map>)

        Retuens a list of summaries of EnabledBaseline resources.

        • arnrequired — (String)

          The ARN of the EnabledBaseline resource

        • baselineIdentifierrequired — (String)

          The specific baseline that is enabled as part of the EnabledBaseline resource.

        • baselineVersion — (String)

          The enabled version of the baseline.

        • statusSummaryrequired — (map)

          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.

            Possible values include:
            • "SUCCEEDED"
            • "FAILED"
            • "UNDER_CHANGE"
        • targetIdentifierrequired — (String)

          The target upon which the baseline is enabled.

      • nextToken — (String)

        A pagination token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEnabledControls(params = {}, callback) ⇒ AWS.Request

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 Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the listEnabledControls operation

var params = {
  filter: {
    controlIdentifiers: [
      'STRING_VALUE',
      /* more items */
    ],
    driftStatuses: [
      DRIFTED | IN_SYNC | NOT_CHECKING | UNKNOWN,
      /* more items */
    ],
    statuses: [
      SUCCEEDED | FAILED | UNDER_CHANGE,
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  targetIdentifier: 'STRING_VALUE'
};
controltower.listEnabledControls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • filter — (map)

      An input filter for the ListCEnabledControls API that lets you select the types of control operations to view.

      • controlIdentifiers — (Array<String>)

        The set of controlIdentifier returned by the filter.

      • driftStatuses — (Array<String>)

        A list of DriftStatus items.

      • statuses — (Array<String>)

        A list of EnablementStatus items.

    • maxResults — (Integer)

      How many results to return per API call.

    • nextToken — (String)

      The token to continue the list from a previous API call with the same parameters.

    • targetIdentifier — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • enabledControls — (Array<map>)

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

        • arn — (String)

          The ARN of the enabled control.

        • controlIdentifier — (String)

          The controlIdentifier of the enabled control.

        • driftStatusSummary — (map)

          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 include:
            • "DRIFTED"
            • "IN_SYNC"
            • "NOT_CHECKING"
            • "UNKNOWN"
        • statusSummary — (map)

          A short description of the status 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.

            Possible values include:
            • "SUCCEEDED"
            • "FAILED"
            • "UNDER_CHANGE"
        • 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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listLandingZones(params = {}, callback) ⇒ AWS.Request

Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.

Returns one landing zone ARN.

Service Reference:

Examples:

Calling the listLandingZones operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
controltower.listLandingZones(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of returned landing zone ARNs, which is one.

    • nextToken — (String)

      The token to continue the list from a previous API call with the same parameters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • landingZones — (Array<map>)

        The ARN of the landing zone.

        • arn — (String)

          The ARN of the landing zone.

      • nextToken — (String)

        Retrieves the next page of results. If the string is empty, the response is the end of the results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
controltower.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        A list of tags, as key:value strings.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

resetEnabledBaseline(params = {}, callback) ⇒ AWS.Request

Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the resetEnabledBaseline operation

var params = {
  enabledBaselineIdentifier: 'STRING_VALUE' /* required */
};
controltower.resetEnabledBaseline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • enabledBaselineIdentifier — (String)

      Specifies the ID of the EnabledBaseline resource to be re-enabled, in ARN format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • operationIdentifier — (String)

        The ID (in UUID format) of the asynchronous ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

resetLandingZone(params = {}, callback) ⇒ AWS.Request

This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.

Service Reference:

Examples:

Calling the resetLandingZone operation

var params = {
  landingZoneIdentifier: 'STRING_VALUE' /* required */
};
controltower.resetLandingZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • landingZoneIdentifier — (String)

      The unique identifier of the landing zone.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • operationIdentifier — (String)

        A unique identifier assigned to a ResetLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
controltower.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the resource to be tagged.

    • tags — (map<String>)

      Tags to be applied to the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
controltower.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the resource.

    • tagKeys — (Array<String>)

      Tag keys to be removed from the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEnabledBaseline(params = {}, callback) ⇒ AWS.Request

Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .

Service Reference:

Examples:

Calling the updateEnabledBaseline operation

var params = {
  baselineVersion: 'STRING_VALUE', /* required */
  enabledBaselineIdentifier: 'STRING_VALUE', /* required */
  parameters: [
    {
      key: 'STRING_VALUE', /* required */
      value: { /* required */
      }
    },
    /* more items */
  ]
};
controltower.updateEnabledBaseline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • baselineVersion — (String)

      Specifies the new Baseline version, to which the EnabledBaseline should be updated.

    • enabledBaselineIdentifier — (String)

      Specifies the EnabledBaseline resource to be updated.

    • parameters — (Array<map>)

      Parameters to apply when making an update.

      • keyrequired — (String)

        A string denoting the parameter key.

      • valuerequired — (map)

        A low-level Document object of any type (for example, a Java Object).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • operationIdentifier — (String)

        The ID (in UUID format) of the asynchronous UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEnabledControl(params = {}, callback) ⇒ AWS.Request

Updates the configuration of an already enabled control.

If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.

If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the Amazon Web Services Control Tower User Guide

Service Reference:

Examples:

Calling the updateEnabledControl operation

var params = {
  enabledControlIdentifier: 'STRING_VALUE', /* required */
  parameters: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: { /* required */
      }
    },
    /* more items */
  ]
};
controltower.updateEnabledControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • enabledControlIdentifier — (String)

      The ARN of the enabled control that will be updated.

    • parameters — (Array<map>)

      A key/value pair, where Key is of type String and Value is of type Document.

      • keyrequired — (String)

        The key of a key/value pair.

      • valuerequired — (map)

        The value of a key/value pair.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • operationIdentifier — (String)

        The operation identifier for this UpdateEnabledControl operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateLandingZone(params = {}, callback) ⇒ AWS.Request

This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.

Service Reference:

Examples:

Calling the updateLandingZone operation

var params = {
  landingZoneIdentifier: 'STRING_VALUE', /* required */
  manifest: { /* required */
  },
  version: 'STRING_VALUE' /* required */
};
controltower.updateLandingZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • landingZoneIdentifier — (String)

      The unique identifier of the landing zone.

    • manifest — (map)

      The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.

    • version — (String)

      The landing zone version, for example, 3.2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • operationIdentifier — (String)

        A unique identifier assigned to a UpdateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.