There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# 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*.
------