There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Actions for AWS Control Tower using AWS SDKs
The following code examples demonstrate how to perform individual AWS Control Tower actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
The following examples include only the most commonly used actions. For a complete list, see the [AWS Control Tower API Reference](https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html).
**Topics**
+ [`DisableBaseline`](controltower_example_controltower_DisableBaseline_section.md)
+ [`DisableControl`](controltower_example_controltower_DisableControl_section.md)
+ [`EnableBaseline`](controltower_example_controltower_EnableBaseline_section.md)
+ [`EnableControl`](controltower_example_controltower_EnableControl_section.md)
+ [`GetBaselineOperation`](controltower_example_controltower_GetBaselineOperation_section.md)
+ [`GetControlOperation`](controltower_example_controltower_GetControlOperation_section.md)
+ [`ListBaselines`](controltower_example_controltower_ListBaselines_section.md)
+ [`ListEnabledBaselines`](controltower_example_controltower_ListEnabledBaselines_section.md)
+ [`ListEnabledControls`](controltower_example_controltower_ListEnabledControls_section.md)
+ [`ListLandingZones`](controltower_example_controltower_ListLandingZones_section.md)
+ [`ResetEnabledBaseline`](controltower_example_controltower_ResetEnabledBaseline_section.md)
# Use `DisableBaseline` with an AWS SDK
The following code examples show how to use `DisableBaseline`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// Disable a baseline for a specific target and wait for the operation to complete.
///
/// The identifier of the baseline to disable.
/// The operation ID or null if there was a conflict.
public async Task DisableBaselineAsync(string enabledBaselineIdentifier)
{
try
{
var request = new DisableBaselineRequest
{
EnabledBaselineIdentifier = enabledBaselineIdentifier
};
var response = await _controlTowerService.DisableBaselineAsync(request);
var operationId = response.OperationIdentifier;
// Wait for operation to complete
while (true)
{
var status = await GetBaselineOperationAsync(operationId);
Console.WriteLine($"Baseline operation status: {status}");
if (status == BaselineOperationStatus.SUCCEEDED || status == BaselineOperationStatus.FAILED)
{
break;
}
await Task.Delay(30000); // Wait 30 seconds
}
return operationId;
}
catch (ConflictException ex)
{
Console.WriteLine($"Conflict disabling baseline: {ex.Message}. Skipping disable step.");
return null;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't disable baseline. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [DisableBaseline](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/DisableBaseline) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Disables a baseline for a specified target.
*
* @param enabledBaselineIdentifier the identifier of the enabled baseline to disable
* @return the operation identifier
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture disableBaselineAsync(String enabledBaselineIdentifier) {
System.out.println("Starting disable of enabled baseline…");
System.out.println("This operation will check the status every 15 seconds until it completes (SUCCEEDED or FAILED).");
DisableBaselineRequest request = DisableBaselineRequest.builder()
.enabledBaselineIdentifier(enabledBaselineIdentifier)
.build();
return getAsyncClient().disableBaseline(request)
.thenCompose(response -> {
String operationId = response.operationIdentifier();
System.out.println("Disable baseline operation ID: " + operationId);
// CompletableFuture that will be completed when operation finishes
CompletableFuture resultFuture = new CompletableFuture<>();
// Polling loop
Runnable poller = new Runnable() {
@Override
public void run() {
getBaselineOperationAsync(operationId)
.thenAccept(statusObj -> {
String status = statusObj.toString(); // Convert enum/status to string for printing
System.out.println("Current disable operation status: " + status + " → waiting for SUCCEEDED or FAILED...");
if ("SUCCEEDED".equalsIgnoreCase(status) || "FAILED".equalsIgnoreCase(status)) {
System.out.println("Disable operation finished with status: " + status);
resultFuture.complete(operationId);
} else {
// Schedule next poll in 15 seconds
CompletableFuture.delayedExecutor(15, TimeUnit.SECONDS)
.execute(this);
}
})
.exceptionally(ex -> {
System.out.println("Error checking baseline operation status: " + ex.getMessage());
resultFuture.completeExceptionally(ex);
return null;
});
}
};
// Start first poll immediately
poller.run();
return resultFuture;
})
.exceptionally(ex -> {
Throwable cause = ex.getCause() != null ? ex.getCause() : ex;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails() != null ? e.awsErrorDetails().errorCode() : "UNKNOWN";
String errorMessage = e.awsErrorDetails() != null ? e.awsErrorDetails().errorMessage() : e.getMessage();
System.out.println("ControlTowerException caught while disabling baseline: Code=" + errorCode + ", Message=" + errorMessage);
return null;
}
if (cause instanceof SdkException sdkEx) {
System.out.println("SDK exception caught while disabling baseline: " + sdkEx.getMessage());
return null;
}
System.out.println("Unexpected exception while disabling baseline: " + cause.getMessage());
return null;
});
}
```
+ For API details, see [DisableBaseline](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/DisableBaseline) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def disable_baseline(self, enabled_baseline_identifier: str):
"""
Disables a baseline for a specific target and waits for the operation to complete.
:param enabled_baseline_identifier: The identifier of the baseline to disable.
:return: The operation ID.
:raises ClientError: If disabling the baseline fails.
"""
try:
response = self.controltower_client.disable_baseline(
enabledBaselineIdentifier=enabled_baseline_identifier
)
operation_id = response["operationIdentifier"]
while True:
status = self.get_baseline_operation(operation_id)
print(f"Baseline operation status: {status}")
if status in ["SUCCEEDED", "FAILED"]:
break
time.sleep(30)
return response["operationIdentifier"]
except ClientError as err:
if err.response["Error"]["Code"] == "ConflictException":
print(
f"Conflict disabling baseline: {err.response['Error']['Message']}. Skipping disable step."
)
return None
else:
logger.error(
"Couldn't disable baseline. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [DisableBaseline](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/DisableBaseline) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
TRY.
" Disable the baseline
DATA(lo_output) = io_ctt->disablebaseline(
iv_enabledbaselineidentifier = iv_enabled_baseline_identifier
).
DATA(lv_operation_id) = lo_output->get_operationidentifier( ).
" Wait for operation to complete
DATA lv_status TYPE /aws1/cttbaselineopstatus.
DO 100 TIMES.
lv_status = get_baseline_operation(
io_ctt = io_ctt
iv_operation_id = lv_operation_id
).
DATA(lv_msg) = |Baseline operation status: { lv_status }|.
MESSAGE lv_msg TYPE 'I'.
IF lv_status = 'SUCCEEDED' OR lv_status = 'FAILED'.
EXIT.
ENDIF.
" Wait 30 seconds
WAIT UP TO 30 SECONDS.
ENDDO.
ov_operation_id = lv_operation_id.
MESSAGE 'Baseline disabled successfully.' TYPE 'I'.
CATCH /aws1/cx_cttconflictexception INTO DATA(lo_conflict).
" Log conflict but don't fail - return empty operation ID
DATA(lv_msg2) = |Conflict disabling baseline: { lo_conflict->get_text( ) }. Skipping disable step.|.
MESSAGE lv_msg2 TYPE 'I'.
CLEAR ov_operation_id.
ENDTRY.
```
+ For API details, see [DisableBaseline](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DisableControl` with an AWS SDK
The following code examples show how to use `DisableControl`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// Disable a control for a specified target.
///
/// The ARN of the control to disable.
/// The identifier of the target (e.g., OU ARN).
/// The operation ID.
public async Task DisableControlAsync(string controlArn, string targetIdentifier)
{
try
{
var request = new DisableControlRequest
{
ControlIdentifier = controlArn,
TargetIdentifier = targetIdentifier
};
var response = await _controlTowerService.DisableControlAsync(request);
var operationId = response.OperationIdentifier;
// Wait for operation to complete
while (true)
{
var status = await GetControlOperationAsync(operationId);
Console.WriteLine($"Control operation status: {status}");
if (status == ControlOperationStatus.SUCCEEDED || status == ControlOperationStatus.FAILED)
{
break;
}
await Task.Delay(30000); // Wait 30 seconds
}
return operationId;
}
catch (Amazon.ControlTower.Model.ResourceNotFoundException)
{
Console.WriteLine("Control not found.");
throw;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't disable control. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [DisableControl](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/DisableControl) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Disables a control for a specified target.
*
* @param controlIdentifier the identifier of the control to disable
* @param targetIdentifier the identifier of the target (e.g., OU ARN)
* @return the operation identifier
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture disableControlAsync(
String controlIdentifier,
String targetIdentifier) {
DisableControlRequest request = DisableControlRequest.builder()
.controlIdentifier(controlIdentifier)
.targetIdentifier(targetIdentifier)
.build();
return getAsyncClient().disableControl(request)
.thenCompose(response -> {
String operationId = response.operationIdentifier();
System.out.println("Disable control operation started. Operation ID: " + operationId);
CompletableFuture resultFuture = new CompletableFuture<>();
Runnable poller = new Runnable() {
@Override
public void run() {
getControlOperationAsync(operationId)
.thenAccept(status -> {
System.out.println("Control operation status: " + status);
if (status == ControlOperationStatus.SUCCEEDED
|| status == ControlOperationStatus.FAILED) {
resultFuture.complete(operationId);
} else {
// poll again after 30 seconds
CompletableFuture.delayedExecutor(30, TimeUnit.SECONDS)
.execute(this);
}
})
.exceptionally(ex -> {
resultFuture.completeExceptionally(ex);
return null;
});
}
};
// start polling immediately
poller.run();
return resultFuture;
})
.exceptionally(ex -> {
Throwable cause = ex.getCause() != null ? ex.getCause() : ex;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails().errorCode();
if ("ResourceNotFoundException".equals(errorCode)) {
// SPEC: notify user and continue
System.out.println("Control not found for disabling: " + e.getMessage());
return null;
}
throw new CompletionException(
"Error disabling control: " + e.getMessage(), e);
}
if (cause instanceof SdkException) {
throw new CompletionException(
"SDK error disabling control: " + cause.getMessage(), cause);
}
throw new CompletionException(
"Failed to disable control", cause);
});
}
```
+ For API details, see [DisableControl](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/DisableControl) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def disable_control(self, control_arn: str, target_identifier: str):
"""
Disables a control for a specified target.
:param control_arn: The ARN of the control to disable.
:param target_identifier: The identifier of the target (e.g., OU ARN).
:return: The operation ID.
:raises ClientError: If disabling the control fails.
"""
try:
response = self.controltower_client.disable_control(
controlIdentifier=control_arn, targetIdentifier=target_identifier
)
operation_id = response["operationIdentifier"]
while True:
status = self.get_control_operation(operation_id)
print(f"Control operation status: {status}")
if status in ["SUCCEEDED", "FAILED"]:
break
time.sleep(30)
return operation_id
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Control not found.")
else:
logger.error(
"Couldn't disable control. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [DisableControl](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/DisableControl) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
" Disable the control
DATA(lo_output) = io_ctt->disablecontrol(
iv_controlidentifier = iv_control_arn
iv_targetidentifier = iv_target_identifier
).
DATA(lv_operation_id) = lo_output->get_operationidentifier( ).
" Wait for operation to complete
DATA lv_status TYPE /aws1/cttcontrolopstatus.
DO 100 TIMES.
lv_status = get_control_operation(
io_ctt = io_ctt
iv_operation_id = lv_operation_id
).
DATA(lv_msg) = |Control operation status: { lv_status }|.
MESSAGE lv_msg TYPE 'I'.
IF lv_status = 'SUCCEEDED' OR lv_status = 'FAILED'.
EXIT.
ENDIF.
" Wait 30 seconds
WAIT UP TO 30 SECONDS.
ENDDO.
ov_operation_id = lv_operation_id.
MESSAGE 'Control disabled successfully.' TYPE 'I'.
```
+ For API details, see [DisableControl](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `EnableBaseline` with an AWS SDK
The following code examples show how to use `EnableBaseline`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// Enable a baseline for the specified target.
///
/// The ARN of the target.
/// The identifier of baseline to enable.
/// The version of baseline to enable.
/// The identifier of identity center baseline if it is enabled.
/// The enabled baseline ARN or null.
public async Task EnableBaselineAsync(string targetIdentifier, string baselineIdentifier, string baselineVersion, string identityCenterBaseline)
{
try
{
var parameters = new List();
if (!string.IsNullOrEmpty(identityCenterBaseline))
{
parameters.Add(
new EnabledBaselineParameter
{
Key = "IdentityCenterEnabledBaselineArn",
Value = identityCenterBaseline
});
}
var request = new EnableBaselineRequest
{
BaselineIdentifier = baselineIdentifier,
BaselineVersion = baselineVersion,
TargetIdentifier = targetIdentifier,
Parameters = parameters
};
var response = await _controlTowerService.EnableBaselineAsync(request);
var operationId = response.OperationIdentifier;
// Wait for operation to complete
while (true)
{
var status = await GetBaselineOperationAsync(operationId);
Console.WriteLine($"Baseline operation status: {status}");
if (status == BaselineOperationStatus.SUCCEEDED || status == BaselineOperationStatus.FAILED)
{
break;
}
await Task.Delay(30000); // Wait 30 seconds
}
return response.Arn;
}
catch (ValidationException ex)
{
if (ex.Message.Contains("already enabled"))
Console.WriteLine("Baseline is already enabled for this target");
else { Console.WriteLine(ex.Message); }
// Write the message and return null if baseline cannot be enabled.
return null;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't enable baseline. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [EnableBaseline](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/EnableBaseline) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Asynchronously enables a baseline for the specified target if not already enabled.
*
* @param targetIdentifier The ARN of the target (OU or account).
* @param baselineIdentifier The baseline definition ARN to enable.
* @param baselineVersion The baseline version to enable.
* @return A CompletableFuture containing the enabled baseline ARN, or null if already enabled.
*/
public CompletableFuture enableBaselineAsync(
String targetIdentifier,
String baselineIdentifier,
String baselineVersion
) {
EnableBaselineRequest request = EnableBaselineRequest.builder()
.baselineIdentifier(baselineIdentifier)
.baselineVersion(baselineVersion)
.targetIdentifier(targetIdentifier)
.build();
return getAsyncClient().enableBaseline(request)
.handle((resp, exception) -> {
if (exception != null) {
Throwable cause = exception.getCause() != null ? exception.getCause() : exception;
if (cause instanceof ControlTowerException e) {
String code = e.awsErrorDetails() != null ? e.awsErrorDetails().errorCode() : "UNKNOWN";
String msg = e.awsErrorDetails() != null ? e.awsErrorDetails().errorMessage() : e.getMessage();
if ("ValidationException".equals(code) && msg.contains("already enabled")) {
System.out.println("Baseline is already enabled for this target → fetching ARN...");
return fetchEnabledBaselineArn(targetIdentifier, baselineIdentifier)
.join(); // fetch existing ARN synchronously
}
throw new RuntimeException("Error enabling baseline: " + code + " - " + msg, e);
}
throw new RuntimeException("Unexpected error enabling baseline: " + cause.getMessage(), cause);
}
return resp;
})
.thenCompose(result -> {
if (result instanceof EnableBaselineResponse resp) {
String operationId = resp.operationIdentifier();
String enabledBaselineArn = resp.arn();
System.out.println("Baseline enable started. ARN: " + enabledBaselineArn
+ ", operation ID: " + operationId);
// Inline polling
return CompletableFuture.supplyAsync(() -> {
while (true) {
GetBaselineOperationRequest opReq = GetBaselineOperationRequest.builder()
.operationIdentifier(operationId)
.build();
GetBaselineOperationResponse opResp = getAsyncClient().getBaselineOperation(opReq).join();
BaselineOperation op = opResp.baselineOperation();
BaselineOperationStatus status = op.status();
System.out.println("Operation " + operationId + " status: " + status);
if (status == BaselineOperationStatus.SUCCEEDED) {
return enabledBaselineArn;
} else if (status == BaselineOperationStatus.FAILED) {
String opId = op.operationIdentifier();
String reason = op.statusMessage() != null ? op.statusMessage() : "No failure reason provided";
throw new RuntimeException("Baseline operation failed (ID: " + opId + "), status: "
+ status + ", reason: " + reason);
}
try {
Thread.sleep(Duration.ofSeconds(15).toMillis());
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new RuntimeException(e);
}
}
});
} else if (result instanceof String existingArn) {
// Already enabled branch
return CompletableFuture.completedFuture(existingArn);
}
return CompletableFuture.completedFuture(null);
});
}
/**
* Fetches the ARN of an already-enabled baseline for the target asynchronously.
*/
private CompletableFuture fetchEnabledBaselineArn(String targetIdentifier, String baselineIdentifier) {
return getAsyncClient().listEnabledBaselines(ListEnabledBaselinesRequest.builder().build())
.thenApply(listResp -> {
for (EnabledBaselineSummary eb : listResp.enabledBaselines()) {
if (baselineIdentifier.equals(eb.baselineIdentifier())
&& targetIdentifier.equals(eb.targetIdentifier())) {
return eb.arn();
}
}
return null; // not yet available
});
}
```
+ For API details, see [EnableBaseline](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/EnableBaseline) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def enable_baseline(
self,
target_identifier: str,
identity_center_baseline: str,
baseline_identifier: str,
baseline_version: str,
):
"""
Enables a baseline for the specified target if it's not already enabled.
:param target_identifier: The ARN of the target.
:param baseline_identifier: The identifier of baseline to enable.
:param identity_center_baseline: The identifier of identity center baseline if it is enabled.
:param baseline_version: The version of baseline to enable.
:return: The enabled baseline ARN or None if already enabled.
:raises ClientError: If enabling the baseline fails for reasons other than it being already enabled.
"""
try:
# Only include parameters if identity_center_baseline is not empty
parameters = []
if identity_center_baseline:
parameters = [
{
"key": "IdentityCenterEnabledBaselineArn",
"value": identity_center_baseline,
}
]
response = self.controltower_client.enable_baseline(
baselineIdentifier=baseline_identifier,
baselineVersion=baseline_version,
targetIdentifier=target_identifier,
parameters=parameters,
)
operation_id = response["operationIdentifier"]
while True:
status = self.get_baseline_operation(operation_id)
print(f"Baseline operation status: {status}")
if status in ["SUCCEEDED", "FAILED"]:
break
time.sleep(30)
return response["arn"]
except ClientError as err:
if err.response["Error"]["Code"] == "ValidationException":
if "already enabled" in err.response["Error"]["Message"]:
print("Baseline is already enabled for this target")
else:
print(
"Unable to enable baseline due to validation exception: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
logger.error(
"Couldn't enable baseline. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
return None
```
+ For API details, see [EnableBaseline](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/EnableBaseline) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
" Prepare parameters for enabling baseline
DATA lt_parameters TYPE /aws1/cl_cttenbdbaselineparam=>tt_enabledbaselineparameters.
" Add Identity Center baseline parameter if provided
IF iv_identity_center_baseline IS NOT INITIAL.
" Create a JSON document with the baseline ARN value
DATA(lv_json) = |\{ "IdentityCenterEnabledBaselineArn": "{ iv_identity_center_baseline }" \}|.
DATA(lo_param) = NEW /aws1/cl_cttenbdbaselineparam(
iv_key = 'IdentityCenterEnabledBaselineArn'
io_value = /aws1/cl_rt_document=>from_json_str( lv_json )
).
APPEND lo_param TO lt_parameters.
ENDIF.
" Enable the baseline
DATA(lo_output) = io_ctt->enablebaseline(
iv_baselineidentifier = iv_baseline_identifier
iv_baselineversion = iv_baseline_version
iv_targetidentifier = iv_target_identifier
it_parameters = lt_parameters
).
DATA(lv_operation_id) = lo_output->get_operationidentifier( ).
" Wait for operation to complete
DATA lv_status TYPE /aws1/cttbaselineopstatus.
DO 100 TIMES.
lv_status = get_baseline_operation(
io_ctt = io_ctt
iv_operation_id = lv_operation_id
).
DATA(lv_msg) = |Baseline operation status: { lv_status }|.
MESSAGE lv_msg TYPE 'I'.
IF lv_status = 'SUCCEEDED' OR lv_status = 'FAILED'.
EXIT.
ENDIF.
" Wait 30 seconds
WAIT UP TO 30 SECONDS.
ENDDO.
ov_enabled_baseline_arn = lo_output->get_arn( ).
MESSAGE 'Baseline enabled successfully.' TYPE 'I'.
```
+ For API details, see [EnableBaseline](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `EnableControl` with an AWS SDK
The following code examples show how to use `EnableControl`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// Enable a control for a specified target.
///
/// The ARN of the control to enable.
/// The identifier of the target (e.g., OU ARN).
/// The operation ID or null if already enabled.
public async Task EnableControlAsync(string controlArn, string targetIdentifier)
{
try
{
Console.WriteLine(controlArn);
Console.WriteLine(targetIdentifier);
var request = new EnableControlRequest
{
ControlIdentifier = controlArn,
TargetIdentifier = targetIdentifier
};
var response = await _controlTowerService.EnableControlAsync(request);
var operationId = response.OperationIdentifier;
// Wait for operation to complete
while (true)
{
var status = await GetControlOperationAsync(operationId);
Console.WriteLine($"Control operation status: {status}");
if (status == ControlOperationStatus.SUCCEEDED || status == ControlOperationStatus.FAILED)
{
break;
}
await Task.Delay(30000); // Wait 30 seconds
}
return operationId;
}
catch (Amazon.ControlTower.Model.ValidationException ex) when (ex.Message.Contains("already enabled"))
{
Console.WriteLine("Control is already enabled for this target");
return null;
}
catch (Amazon.ControlTower.Model.ResourceNotFoundException ex) when (ex.Message.Contains("not registered with AWS Control Tower"))
{
Console.WriteLine("AWS Control Tower must be enabled to work with enabling controls.");
return null;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't enable control. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [EnableControl](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/EnableControl) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Enables a control for a specified target.
*
* @param controlIdentifier the identifier of the control to enable
* @param targetIdentifier the identifier of the target (e.g., OU ARN)
* @return the operation identifier
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture enableControlAsync(
String controlIdentifier,
String targetIdentifier) {
EnableControlRequest request = EnableControlRequest.builder()
.controlIdentifier(controlIdentifier)
.targetIdentifier(targetIdentifier)
.build();
return getAsyncClient().enableControl(request)
.thenCompose(response -> {
String operationId = response.operationIdentifier();
System.out.println("Enable control operation started. Operation ID: " + operationId);
CompletableFuture resultFuture = new CompletableFuture<>();
Runnable poller = new Runnable() {
@Override
public void run() {
getControlOperationAsync(operationId)
.thenAccept(status -> {
System.out.println("Control operation status: " + status);
if (status == ControlOperationStatus.SUCCEEDED
|| status == ControlOperationStatus.FAILED) {
resultFuture.complete(operationId);
} else {
// Poll again after 30 seconds
CompletableFuture.delayedExecutor(30, TimeUnit.SECONDS)
.execute(this);
}
})
.exceptionally(ex -> {
resultFuture.completeExceptionally(ex);
return null;
});
}
};
// Start polling immediately
poller.run();
return resultFuture;
})
.exceptionally(ex -> {
Throwable cause = ex.getCause() != null ? ex.getCause() : ex;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails().errorCode();
String message = e.getMessage() != null ? e.getMessage() : "";
if ("ValidationException".equals(errorCode)
&& message.contains("already enabled")) {
System.out.println("Control is already enabled for this target");
return null;
}
if ("ResourceNotFoundException".equals(errorCode)
&& message.contains("not registered with AWS Control Tower")) {
System.out.println(
"Control Tower must be enabled to work with controls.");
return null;
}
throw new CompletionException(
"Couldn't enable control: %s".formatted(message),
e
);
}
if (cause instanceof SdkException) {
throw new CompletionException(
"SDK error enabling control: %s"
.formatted(cause.getMessage()),
cause
);
}
throw new CompletionException(
"Failed to enable control",
cause
);
});
}
```
+ For API details, see [EnableControl](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/EnableControl) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def enable_control(self, control_arn: str, target_identifier: str):
"""
Enables a control for a specified target.
:param control_arn: The ARN of the control to enable.
:param target_identifier: The identifier of the target (e.g., OU ARN).
:return: The operation ID.
:raises ClientError: If enabling the control fails.
"""
try:
print(control_arn)
print(target_identifier)
response = self.controltower_client.enable_control(
controlIdentifier=control_arn, targetIdentifier=target_identifier
)
operation_id = response["operationIdentifier"]
while True:
status = self.get_control_operation(operation_id)
print(f"Control operation status: {status}")
if status in ["SUCCEEDED", "FAILED"]:
break
time.sleep(30)
return operation_id
except ClientError as err:
if (
err.response["Error"]["Code"] == "ValidationException"
and "already enabled" in err.response["Error"]["Message"]
):
logger.info("Control is already enabled for this target")
return None
elif (
err.response["Error"]["Code"] == "ResourceNotFoundException"
and "not registered with AWS Control Tower"
in err.response["Error"]["Message"]
):
logger.error("Control Tower must be enabled to work with controls.")
return None
logger.error(
"Couldn't enable control. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [EnableControl](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/EnableControl) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
" Enable the control
DATA(lo_output) = io_ctt->enablecontrol(
iv_controlidentifier = iv_control_arn
iv_targetidentifier = iv_target_identifier
).
DATA(lv_operation_id) = lo_output->get_operationidentifier( ).
" Wait for operation to complete
DATA lv_status TYPE /aws1/cttcontrolopstatus.
DO 100 TIMES.
lv_status = get_control_operation(
io_ctt = io_ctt
iv_operation_id = lv_operation_id
).
DATA(lv_msg) = |Control operation status: { lv_status }|.
MESSAGE lv_msg TYPE 'I'.
IF lv_status = 'SUCCEEDED' OR lv_status = 'FAILED'.
EXIT.
ENDIF.
" Wait 30 seconds
WAIT UP TO 30 SECONDS.
ENDDO.
ov_operation_id = lv_operation_id.
MESSAGE 'Control enabled successfully.' TYPE 'I'.
```
+ For API details, see [EnableControl](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `GetBaselineOperation` with an AWS SDK
The following code examples show how to use `GetBaselineOperation`.
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// Get the status of a baseline operation.
///
/// The ID of the baseline operation.
/// The operation status.
public async Task GetBaselineOperationAsync(string operationId)
{
try
{
var request = new GetBaselineOperationRequest
{
OperationIdentifier = operationId
};
var response = await _controlTowerService.GetBaselineOperationAsync(request);
return response.BaselineOperation.Status;
}
catch (Amazon.ControlTower.Model.ResourceNotFoundException)
{
Console.WriteLine("Operation not found.");
throw;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't get baseline operation status. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [GetBaselineOperation](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/GetBaselineOperation) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Gets the status of a baseline operation.
*
* @param operationIdentifier the identifier of the operation
* @return the operation status
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture getBaselineOperationAsync(
String operationIdentifier) {
GetBaselineOperationRequest request = GetBaselineOperationRequest.builder()
.operationIdentifier(operationIdentifier)
.build();
return getAsyncClient().getBaselineOperation(request)
.whenComplete((response, exception) -> {
if (exception != null) {
Throwable cause = exception.getCause() != null
? exception.getCause()
: exception;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails().errorCode();
if ("ResourceNotFoundException".equals(errorCode)) {
throw new CompletionException(
"Baseline operation not found: %s"
.formatted(e.getMessage()),
e
);
}
throw new CompletionException(
"Error getting baseline operation status: %s"
.formatted(e.getMessage()),
e
);
}
if (cause instanceof SdkException) {
throw new CompletionException(
"SDK error getting baseline operation status: %s"
.formatted(cause.getMessage()),
cause
);
}
throw new CompletionException(
"Failed to get baseline operation status",
cause
);
}
})
.thenApply(response -> {
BaselineOperationStatus status =
response.baselineOperation().status();
return status;
});
}
```
+ For API details, see [GetBaselineOperation](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/GetBaselineOperation) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def get_baseline_operation(self, operation_id: str):
"""
Gets the status of a baseline operation.
:param operation_id: The ID of the baseline operation.
:return: The operation status.
:raises ClientError: If getting the operation status fails.
"""
try:
response = self.controltower_client.get_baseline_operation(
operationIdentifier=operation_id
)
return response["baselineOperation"]["status"]
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Operation not found.")
else:
logger.error(
"Couldn't get baseline operation status. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [GetBaselineOperation](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/GetBaselineOperation) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
DATA(lo_output) = io_ctt->getbaselineoperation(
iv_operationidentifier = iv_operation_id
).
ov_status = lo_output->get_baselineoperation( )->get_status( ).
```
+ For API details, see [GetBaselineOperation](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `GetControlOperation` with an AWS SDK
The following code examples show how to use `GetControlOperation`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// Get the status of a control operation.
///
/// The ID of the control operation.
/// The operation status.
public async Task GetControlOperationAsync(string operationId)
{
try
{
var request = new GetControlOperationRequest
{
OperationIdentifier = operationId
};
var response = await _controlTowerService.GetControlOperationAsync(request);
return response.ControlOperation.Status;
}
catch (Amazon.ControlTower.Model.ResourceNotFoundException)
{
Console.WriteLine("Operation not found.");
throw;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't get control operation status. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [GetControlOperation](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/GetControlOperation) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Gets the status of a control operation.
*
* @param operationIdentifier the identifier of the operation
* @return the operation status
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture getControlOperationAsync(
String operationIdentifier) {
GetControlOperationRequest request = GetControlOperationRequest.builder()
.operationIdentifier(operationIdentifier)
.build();
return getAsyncClient().getControlOperation(request)
.whenComplete((response, exception) -> {
if (exception != null) {
Throwable cause = exception.getCause() != null ? exception.getCause() : exception;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails().errorCode();
if ("ResourceNotFoundException".equals(errorCode)) {
throw new CompletionException(
"Control operation not found: %s".formatted(e.getMessage()),
e
);
}
throw new CompletionException(
"Error getting control operation status: %s".formatted(e.getMessage()),
e
);
}
if (cause instanceof SdkException) {
throw new CompletionException(
"SDK error getting control operation status: %s".formatted(cause.getMessage()),
cause
);
}
throw new CompletionException("Failed to get control operation status", cause);
}
})
.thenApply(response -> response.controlOperation().status());
}
```
+ For API details, see [GetControlOperation](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/GetControlOperation) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def get_control_operation(self, operation_id: str):
"""
Gets the status of a control operation.
:param operation_id: The ID of the control operation.
:return: The operation status.
:raises ClientError: If getting the operation status fails.
"""
try:
response = self.controltower_client.get_control_operation(
operationIdentifier=operation_id
)
return response["controlOperation"]["status"]
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Operation not found.")
else:
logger.error(
"Couldn't get control operation status. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [GetControlOperation](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/GetControlOperation) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
DATA(lo_output) = io_ctt->getcontroloperation(
iv_operationidentifier = iv_operation_id
).
ov_status = lo_output->get_controloperation( )->get_status( ).
```
+ For API details, see [GetControlOperation](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ListBaselines` with an AWS SDK
The following code examples show how to use `ListBaselines`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// List all baselines.
///
/// A list of baseline summaries.
public async Task> ListBaselinesAsync()
{
try
{
var baselines = new List();
var baselinesPaginator = _controlTowerService.Paginators.ListBaselines(new ListBaselinesRequest());
await foreach (var response in baselinesPaginator.Responses)
{
baselines.AddRange(response.Baselines);
}
return baselines;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't list baselines. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [ListBaselines](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/ListBaselines) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Lists all available baselines using pagination to retrieve complete results.
*
* @return a list of all baselines
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture> listBaselinesAsync() {
System.out.println("Starting list baselines paginator…");
ListBaselinesRequest request = ListBaselinesRequest.builder().build();
ListBaselinesPublisher paginator =
getAsyncClient().listBaselinesPaginator(request);
List baselines = new ArrayList<>();
return paginator.subscribe(response -> {
if (response.baselines() != null && !response.baselines().isEmpty()) {
response.baselines().forEach(baseline -> {
baselines.add(baseline);
});
} else {
System.out.println("Page contained no baselines.");
}
})
.thenRun(() ->
System.out.println("Successfully listed baselines. Total: " + baselines.size())
)
.thenApply(v -> baselines)
.exceptionally(ex -> {
Throwable cause = ex.getCause() != null ? ex.getCause() : ex;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails().errorCode();
if ("AccessDeniedException".equals(errorCode)) {
throw new CompletionException(
"Access denied when listing baselines: %s".formatted(e.getMessage()),
e
);
}
throw new CompletionException(
"Error listing baselines: %s".formatted(e.getMessage()),
e
);
}
if (cause instanceof SdkException) {
throw new CompletionException(
"SDK error listing baselines: %s".formatted(cause.getMessage()),
cause
);
}
throw new CompletionException("Failed to list baselines", cause);
});
}
```
+ For API details, see [ListBaselines](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/ListBaselines) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def list_baselines(self):
"""
Lists all baselines.
:return: List of baselines.
:raises ClientError: If the listing operation fails.
"""
try:
paginator = self.controltower_client.get_paginator("list_baselines")
baselines = []
for page in paginator.paginate():
baselines.extend(page["baselines"])
return baselines
except ClientError as err:
if err.response["Error"]["Code"] == "AccessDeniedException":
logger.error(
"Access denied. Please ensure you have the necessary permissions."
)
else:
logger.error(
"Couldn't list baselines. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [ListBaselines](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/ListBaselines) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
DATA lt_baselines TYPE /aws1/cl_cttbaselinesummary=>tt_baselines.
DATA lv_nexttoken TYPE /aws1/cttstring.
" List all baselines using pagination
DO.
DATA(lo_output) = io_ctt->listbaselines(
iv_nexttoken = lv_nexttoken
).
APPEND LINES OF lo_output->get_baselines( ) TO lt_baselines.
lv_nexttoken = lo_output->get_nexttoken( ).
IF lv_nexttoken IS INITIAL.
EXIT.
ENDIF.
ENDDO.
ot_baselines = lt_baselines.
MESSAGE 'Listed baselines successfully.' TYPE 'I'.
```
+ For API details, see [ListBaselines](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ListEnabledBaselines` with an AWS SDK
The following code examples show how to use `ListEnabledBaselines`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// List all enabled baselines.
///
/// A list of enabled baseline summaries.
public async Task> ListEnabledBaselinesAsync()
{
try
{
var enabledBaselines = new List();
var enabledBaselinesPaginator = _controlTowerService.Paginators.ListEnabledBaselines(new ListEnabledBaselinesRequest());
await foreach (var response in enabledBaselinesPaginator.Responses)
{
enabledBaselines.AddRange(response.EnabledBaselines);
}
return enabledBaselines;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't list enabled baselines. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [ListEnabledBaselines](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/ListEnabledBaselines) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Lists all enabled baselines using pagination to retrieve complete results.
*
* @return a list of all enabled baselines
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture> listEnabledBaselinesAsync() {
System.out.println("Starting list enabled baselines paginator…");
ListEnabledBaselinesRequest request =
ListEnabledBaselinesRequest.builder().build();
ListEnabledBaselinesPublisher paginator =
getAsyncClient().listEnabledBaselinesPaginator(request);
List enabledBaselines = new ArrayList<>();
return paginator.subscribe(response -> {
if (response.enabledBaselines() != null
&& !response.enabledBaselines().isEmpty()) {
response.enabledBaselines().forEach(baseline -> {
enabledBaselines.add(baseline);
});
} else {
System.out.println("Page contained no enabled baselines.");
}
})
.thenRun(() ->
System.out.println(
"Successfully listed enabled baselines. Total: " +
enabledBaselines.size()
)
)
.thenApply(v -> enabledBaselines)
.exceptionally(ex -> {
Throwable cause = ex.getCause() != null ? ex.getCause() : ex;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails().errorCode();
if ("AccessDeniedException".equals(errorCode)) {
throw new CompletionException(
"Access denied when listing enabled baselines: %s".formatted(e.getMessage()), e);
}
throw new CompletionException(
"Error listing enabled baselines: %s"
.formatted(e.getMessage()),
e
);
}
if (cause instanceof SdkException) {
throw new CompletionException(
"SDK error listing enabled baselines: %s"
.formatted(cause.getMessage()),
cause
);
}
throw new CompletionException(
"Failed to list enabled baselines",
cause
);
});
}
```
+ For API details, see [ListEnabledBaselines](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/ListEnabledBaselines) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def list_enabled_baselines(self):
"""
Lists all enabled baselines.
:return: List of enabled baselines.
:raises ClientError: If the listing operation fails.
"""
try:
paginator = self.controltower_client.get_paginator("list_enabled_baselines")
enabled_baselines = []
for page in paginator.paginate():
enabled_baselines.extend(page["enabledBaselines"])
return enabled_baselines
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Target not found.")
else:
logger.error(
"Couldn't list enabled baselines. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [ListEnabledBaselines](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/ListEnabledBaselines) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
DATA lt_enabled_baselines TYPE /aws1/cl_cttenbdbaselinesumm=>tt_enabledbaselines.
DATA lv_nexttoken TYPE /aws1/cttlstenbdbaselinesnex00.
" List all enabled baselines using pagination
DO.
DATA(lo_output) = io_ctt->listenabledbaselines(
iv_nexttoken = lv_nexttoken
).
APPEND LINES OF lo_output->get_enabledbaselines( ) TO lt_enabled_baselines.
lv_nexttoken = lo_output->get_nexttoken( ).
IF lv_nexttoken IS INITIAL.
EXIT.
ENDIF.
ENDDO.
ot_enabled_baselines = lt_enabled_baselines.
MESSAGE 'Listed enabled baselines successfully.' TYPE 'I'.
```
+ For API details, see [ListEnabledBaselines](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ListEnabledControls` with an AWS SDK
The following code examples show how to use `ListEnabledControls`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// List enabled controls for a target organizational unit.
///
/// The target organizational unit identifier.
/// A list of enabled control summaries.
public async Task> ListEnabledControlsAsync(string targetIdentifier)
{
try
{
var request = new ListEnabledControlsRequest
{
TargetIdentifier = targetIdentifier
};
var enabledControls = new List();
var enabledControlsPaginator = _controlTowerService.Paginators.ListEnabledControls(request);
await foreach (var response in enabledControlsPaginator.Responses)
{
enabledControls.AddRange(response.EnabledControls);
}
return enabledControls;
}
catch (Amazon.ControlTower.Model.ResourceNotFoundException ex) when (ex.Message.Contains("not registered with AWS Control Tower"))
{
Console.WriteLine("AWS Control Tower must be enabled to work with enabling controls.");
return new List();
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't list enabled controls. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [ListEnabledControls](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/ListEnabledControls) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Lists all enabled controls for a specific target using pagination.
*
* @param targetIdentifier the identifier of the target (e.g., OU ARN)
* @return a list of enabled controls
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture> listEnabledControlsAsync(String targetIdentifier) {
System.out.println("Starting list enabled controls paginator for target " + targetIdentifier);
ListEnabledControlsRequest request = ListEnabledControlsRequest.builder()
.targetIdentifier(targetIdentifier)
.build();
ListEnabledControlsPublisher paginator = getAsyncClient().listEnabledControlsPaginator(request);
List enabledControls = new ArrayList<>();
// Subscribe to the paginator asynchronously
return paginator.subscribe(response -> {
if (response.enabledControls() != null && !response.enabledControls().isEmpty()) {
response.enabledControls().forEach(control -> {
enabledControls.add(control);
});
} else {
System.out.println("Page contained no enabled controls.");
}
})
.thenRun(() -> System.out.println(
"Successfully retrieved "+enabledControls.size() +" enabled controls for target "+targetIdentifier
))
.thenApply(v -> enabledControls)
.exceptionally(ex -> {
Throwable cause = ex.getCause() != null ? ex.getCause() : ex;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails().errorCode();
switch (errorCode) {
case "AccessDeniedException":
throw new CompletionException(
"Access denied when listing enabled controls: %s".formatted(e.getMessage()), e);
case "ResourceNotFoundException":
if (e.getMessage() != null && e.getMessage().contains("not registered with AWS Control Tower")) {
throw new CompletionException(
"Control Tower must be enabled to work with controls", e);
}
throw new CompletionException(
"Target not found when listing enabled controls: %s".formatted(e.getMessage()), e);
default:
throw new CompletionException(
"Error listing enabled controls: %s".formatted(e.getMessage()), e);
}
}
if (cause instanceof SdkException) {
throw new CompletionException(
"SDK error listing enabled controls: %s".formatted(cause.getMessage()), cause);
}
throw new CompletionException("Failed to list enabled controls", cause);
});
}
```
+ For API details, see [ListEnabledControls](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/ListEnabledControls) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def list_enabled_controls(self, target_identifier: str):
"""
Lists all enabled controls for a specific target.
:param target_identifier: The identifier of the target (e.g., OU ARN).
:return: List of enabled controls.
:raises ClientError: If the listing operation fails.
"""
enabled_controls = []
try:
paginator = self.controltower_client.get_paginator("list_enabled_controls")
for page in paginator.paginate(targetIdentifier=target_identifier):
enabled_controls.extend(page["enabledControls"])
return enabled_controls
except ClientError as err:
if err.response["Error"]["Code"] == "AccessDeniedException":
logger.error(
"Access denied. Please ensure you have the necessary permissions."
)
return enabled_controls
elif (
err.response["Error"]["Code"] == "ResourceNotFoundException"
and "not registered with AWS Control Tower"
in err.response["Error"]["Message"]
):
logger.error("Control Tower must be enabled to work with controls.")
return enabled_controls
else:
logger.error(
"Couldn't list enabled controls. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [ListEnabledControls](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/ListEnabledControls) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
DATA lt_enabled_controls TYPE /aws1/cl_cttenabledcontrolsumm=>tt_enabledcontrols.
DATA lv_nexttoken TYPE /aws1/cttstring.
" List all enabled controls using pagination
DO.
DATA(lo_output) = io_ctt->listenabledcontrols(
iv_targetidentifier = iv_target_identifier
iv_nexttoken = lv_nexttoken
).
APPEND LINES OF lo_output->get_enabledcontrols( ) TO lt_enabled_controls.
lv_nexttoken = lo_output->get_nexttoken( ).
IF lv_nexttoken IS INITIAL.
EXIT.
ENDIF.
ENDDO.
ot_enabled_controls = lt_enabled_controls.
MESSAGE 'Listed enabled controls successfully.' TYPE 'I'.
```
+ For API details, see [ListEnabledControls](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ListLandingZones` with an AWS SDK
The following code examples show how to use `ListLandingZones`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// List the AWS Control Tower landing zones for an account.
///
/// A list of LandingZoneSummary objects.
public async Task> ListLandingZonesAsync()
{
try
{
var landingZones = new List();
var landingZonesPaginator = _controlTowerService.Paginators.ListLandingZones(new ListLandingZonesRequest());
await foreach (var response in landingZonesPaginator.Responses)
{
landingZones.AddRange(response.LandingZones);
}
return landingZones;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't list landing zones. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [ListLandingZones](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/ListLandingZones) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Lists all landing zones using pagination to retrieve complete results.
*
* @return a list of all landing zones
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture> listLandingZonesAsync() {
System.out.println("Starting list landing zones paginator…");
ListLandingZonesRequest request = ListLandingZonesRequest.builder().build();
ListLandingZonesPublisher paginator = getAsyncClient().listLandingZonesPaginator(request);
List landingZones = new ArrayList<>();
return paginator.subscribe(response -> {
if (response.landingZones() != null && !response.landingZones().isEmpty()) {
response.landingZones().forEach(lz -> {
System.out.println("Landing zone ARN: " + lz.arn());
landingZones.add(lz);
});
} else {
System.out.println("Page contained no landing zones.");
}
})
.thenRun(() -> System.out.println("Successfully retrieved "+ landingZones.size() + " landing zones." ))
.thenApply(v -> landingZones)
.exceptionally(ex -> {
Throwable cause = ex.getCause() != null ? ex.getCause() : ex;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails().errorCode();
switch (errorCode) {
case "AccessDeniedException":
throw new CompletionException(
"Access denied when listing landing zones: " + e.getMessage(), e);
default:
throw new CompletionException(
"Error listing landing zones: " + e.getMessage(), e);
}
}
if (cause instanceof SdkException) {
throw new CompletionException(
"SDK error listing landing zones: " + cause.getMessage(), cause);
}
throw new CompletionException("Failed to list landing zones", cause);
});
}
```
+ For API details, see [ListLandingZones](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/ListLandingZones) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def list_landing_zones(self):
"""
Lists all landing zones.
:return: List of landing zones.
:raises ClientError: If the listing operation fails.
"""
try:
paginator = self.controltower_client.get_paginator("list_landing_zones")
landing_zones = []
for page in paginator.paginate():
landing_zones.extend(page["landingZones"])
return landing_zones
except ClientError as err:
if err.response["Error"]["Code"] == "AccessDeniedException":
logger.error(
"Access denied. Please ensure you have the necessary permissions."
)
else:
logger.error(
"Couldn't list landing zones. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [ListLandingZones](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/ListLandingZones) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
DATA lt_landing_zones TYPE /aws1/cl_cttlandingzonesummary=>tt_landingzonesummaries.
DATA lv_nexttoken TYPE /aws1/cttstring.
" List all landing zones using pagination
DO.
DATA(lo_output) = io_ctt->listlandingzones(
iv_nexttoken = lv_nexttoken
).
APPEND LINES OF lo_output->get_landingzones( ) TO lt_landing_zones.
lv_nexttoken = lo_output->get_nexttoken( ).
IF lv_nexttoken IS INITIAL.
EXIT.
ENDIF.
ENDDO.
ot_landing_zones = lt_landing_zones.
MESSAGE 'Listed landing zones successfully.' TYPE 'I'.
```
+ For API details, see [ListLandingZones](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ResetEnabledBaseline` with an AWS SDK
The following code examples show how to use `ResetEnabledBaseline`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](controltower_example_controltower_Scenario_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/ControlTower#code-examples).
```
///
/// Reset an enabled baseline for a specific target.
///
/// The identifier of the enabled baseline to reset.
/// The operation ID.
public async Task ResetEnabledBaselineAsync(string enabledBaselineIdentifier)
{
try
{
var request = new ResetEnabledBaselineRequest
{
EnabledBaselineIdentifier = enabledBaselineIdentifier
};
var response = await _controlTowerService.ResetEnabledBaselineAsync(request);
var operationId = response.OperationIdentifier;
// Wait for operation to complete
while (true)
{
var status = await GetBaselineOperationAsync(operationId);
Console.WriteLine($"Baseline operation status: {status}");
if (status == BaselineOperationStatus.SUCCEEDED || status == BaselineOperationStatus.FAILED)
{
break;
}
await Task.Delay(30000); // Wait 30 seconds
}
return operationId;
}
catch (Amazon.ControlTower.Model.ResourceNotFoundException)
{
Console.WriteLine("Target not found, unable to reset enabled baseline.");
throw;
}
catch (AmazonControlTowerException ex)
{
Console.WriteLine($"Couldn't reset enabled baseline. Here's why: {ex.ErrorCode}: {ex.Message}");
throw;
}
}
```
+ For API details, see [ResetEnabledBaseline](https://docs.aws.amazon.com/goto/DotNetSDKV4/controltower-2018-05-10/ResetEnabledBaseline) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/controltower#code-examples).
```
/**
* Resets an enabled baseline for a specific target.
*
* @param enabledBaselineIdentifier the identifier of the enabled baseline to reset
* @return the operation identifier
* @throws ControlTowerException if a service-specific error occurs
* @throws SdkException if an SDK error occurs
*/
public CompletableFuture resetEnabledBaselineAsync(String enabledBaselineIdentifier) {
System.out.println("Starting reset of enabled baseline…");
System.out.println("This operation will check the status every 15 seconds until it completes (SUCCEEDED or FAILED).");
ResetEnabledBaselineRequest request = ResetEnabledBaselineRequest.builder()
.enabledBaselineIdentifier(enabledBaselineIdentifier)
.build();
return getAsyncClient().resetEnabledBaseline(request)
.thenCompose(response -> {
String operationId = response.operationIdentifier();
System.out.println("Reset enabled baseline operation ID: " + operationId);
// Polling loop
CompletableFuture resultFuture = new CompletableFuture<>();
Runnable poller = new Runnable() {
@Override
public void run() {
getBaselineOperationAsync(operationId)
.thenAccept(statusObj -> {
String status = statusObj.toString(); // Convert enum/status to string for printing
System.out.println("Current baseline operation status: " + status + " → waiting for SUCCEEDED or FAILED...");
if ("SUCCEEDED".equalsIgnoreCase(status) || "FAILED".equalsIgnoreCase(status)) {
System.out.println("Baseline operation finished with status: " + status);
resultFuture.complete(operationId);
} else {
// Schedule next poll in 15 seconds
CompletableFuture.delayedExecutor(15, TimeUnit.SECONDS)
.execute(this);
}
})
.exceptionally(ex -> {
System.out.println("Error checking baseline operation status: " + ex.getMessage());
resultFuture.completeExceptionally(ex);
return null;
});
}
};
// Start first poll immediately
poller.run();
return resultFuture;
})
.exceptionally(ex -> {
Throwable cause = ex.getCause() != null ? ex.getCause() : ex;
if (cause instanceof ControlTowerException e) {
String errorCode = e.awsErrorDetails() != null ? e.awsErrorDetails().errorCode() : "UNKNOWN";
String errorMessage = e.awsErrorDetails() != null ? e.awsErrorDetails().errorMessage() : e.getMessage();
System.out.println("ControlTowerException caught: Code=" + errorCode + ", Message=" + errorMessage);
return null;
}
if (cause instanceof SdkException sdkEx) {
System.out.println("SDK exception caught: " + sdkEx.getMessage());
return null;
}
System.out.println("Unexpected exception resetting baseline: " + cause.getMessage());
return null;
});
}
```
+ For API details, see [ResetEnabledBaseline](https://docs.aws.amazon.com/goto/SdkForJavaV2/controltower-2018-05-10/ResetEnabledBaseline) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/controltower#code-examples).
```
class ControlTowerWrapper:
"""Encapsulates AWS Control Tower and Control Catalog functionality."""
def __init__(
self, controltower_client: boto3.client, controlcatalog_client: boto3.client
):
"""
:param controltower_client: A Boto3 Amazon ControlTower client.
:param controlcatalog_client: A Boto3 Amazon ControlCatalog client.
"""
self.controltower_client = controltower_client
self.controlcatalog_client = controlcatalog_client
@classmethod
def from_client(cls):
controltower_client = boto3.client("controltower")
controlcatalog_client = boto3.client("controlcatalog")
return cls(controltower_client, controlcatalog_client)
def reset_enabled_baseline(self, enabled_baseline_identifier: str):
"""
Resets an enabled baseline for a specific target.
:param enabled_baseline_identifier: The identifier of the enabled baseline to reset.
:return: The operation ID.
:raises ClientError: If resetting the baseline fails.
"""
try:
response = self.controltower_client.reset_enabled_baseline(
enabledBaselineIdentifier=enabled_baseline_identifier
)
operation_id = response["operationIdentifier"]
while True:
status = self.get_baseline_operation(operation_id)
print(f"Baseline operation status: {status}")
if status in ["SUCCEEDED", "FAILED"]:
break
time.sleep(30)
return operation_id
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error("Target not found.")
else:
logger.error(
"Couldn't reset enabled baseline. Here's why: %s: %s",
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [ResetEnabledBaseline](https://docs.aws.amazon.com/goto/boto3/controltower-2018-05-10/ResetEnabledBaseline) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ctt#code-examples).
```
" Reset the enabled baseline
DATA(lo_output) = io_ctt->resetenabledbaseline(
iv_enabledbaselineidentifier = iv_enabled_baseline_identifier
).
DATA(lv_operation_id) = lo_output->get_operationidentifier( ).
" Wait for operation to complete
DATA lv_status TYPE /aws1/cttbaselineopstatus.
DO 100 TIMES.
lv_status = get_baseline_operation(
io_ctt = io_ctt
iv_operation_id = lv_operation_id
).
DATA(lv_msg) = |Baseline operation status: { lv_status }|.
MESSAGE lv_msg TYPE 'I'.
IF lv_status = 'SUCCEEDED' OR lv_status = 'FAILED'.
EXIT.
ENDIF.
" Wait 30 seconds
WAIT UP TO 30 SECONDS.
ENDDO.
ov_operation_id = lv_operation_id.
MESSAGE 'Baseline reset successfully.' TYPE 'I'.
```
+ For API details, see [ResetEnabledBaseline](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------