Class: AWS.ControlTower

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.

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.

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.

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.

    • key — required — (String)

      A string denoting the parameter key.

    • value — required — (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.

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.

    • key — required — (String)

      The key of a key/value pair.

    • value — required — (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.

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.

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.

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.

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.

      • arn — required — (String)

        The ARN of the EnabledBaseline resource.

      • baselineIdentifier — required — (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.

        • key — required — (String)

          A string denoting the parameter key.

        • value — required — (map)

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

      • statusSummary — required — (map)

        The deployment summary of an EnabledControl or EnabledBaseline resource.

        • lastOperationIdentifier — (String)

          The last operation identifier for the enabled resource.

        • status — (String)

          The deployment status of the enabled resource.

          Valid values:

          • SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.

          • UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.

          • FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.

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

        The target on which to enable the Baseline.

Returns:

• (AWS.Request) —

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

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.

        • key — required — (String)

          The key of a key/value pair.

        • value — required — (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 resource.

        • status — (String)

          The deployment status of the enabled resource.

          Valid values:

          • SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.

          • UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.

          • FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.

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

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.

      • manifest — required — (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"
      • version — required — (String)

        The landing zone's current deployed version.

Returns:

• (AWS.Request) —

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

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.

      • operationIdentifier — (String)

        The operationIdentifier of the landing zone operation.

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

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.

      • arn — required — (String)

        The full ARN of a Baseline.

      • description — (String)

        A summary description of a Baseline.

      • name — required — (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.

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.

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

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.

      • arn — required — (String)

        The ARN of the EnabledBaseline resource

      • baselineIdentifier — required — (String)

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

      • baselineVersion — (String)

        The enabled version of the baseline.

      • statusSummary — required — (map)

        The deployment summary of an EnabledControl or EnabledBaseline resource.

        • lastOperationIdentifier — (String)

          The last operation identifier for the enabled resource.

        • status — (String)

          The deployment status of the enabled resource.

          Valid values:

          • SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.

          • UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.

          • FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.

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

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

        • status — (String)

          The deployment status of the enabled resource.

          Valid values:

          • SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.

          • UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.

          • FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.

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

var params = {
  filter: {
    statuses: [
      SUCCEEDED | FAILED | IN_PROGRESS,
      /* more items */
    ],
    types: [
      DELETE | CREATE | UPDATE | RESET,
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
controltower.listLandingZoneOperations(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 ListLandingZoneOperations API that lets you select the types of landing zone operations to view.

    • statuses — (Array<String>)

      The statuses of the set of landing zone operations selected by the filter.

    • types — (Array<String>)

      The set of landing zone operation types selected by the filter.

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

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:

    • landingZoneOperations — (Array<map>)

      Lists landing zone operations.

      • operationIdentifier — (String)

        The operationIdentifier of the landing zone operation.

      • operationType — (String)

        The type of the landing zone operation.

        Possible values include:
        • "DELETE"
        • "CREATE"
        • "UPDATE"
        • "RESET"
      • status — (String)

        The status of the landing zone operation.

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

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.

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.

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.

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.

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.

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.

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.

    • key — required — (String)

      A string denoting the parameter key.

    • value — required — (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.

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.

    • key — required — (String)

      The key of a key/value pair.

    • value — required — (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.

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 file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design.

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