Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .
Parameters:
-
enabled_baseline_identifier
(Arn)
–
Identifier of the EnabledBaseline resource to be deactivated, in ARN format.
Raises:
Source code in docs_src/capo_controltower/_services/async_control_tower.py
| async def disable_baseline(
self,
enabled_baseline_identifier: "capo_controltower.types.arn.Arn",
*,
config_overrides: Optional[AsyncControlTowerClientConfig] = None,
) -> "capo_controltower.types.disable_baseline_output.DisableBaselineOutput":
"""<p>Disable an <code>EnabledBaseline</code> resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html"> <i>the Amazon Web Services Control Tower User Guide</i> </a>.</p>
Args:
enabled_baseline_identifier: <p>Identifier of the <code>EnabledBaseline</code> resource to be deactivated, in ARN format.</p>
Raises:
capo_controltower.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_controltower.errors.conflict_exception.ConflictException: <p>Updating or deleting the resource can cause an inconsistent state.</p>
capo_controltower.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during processing of a request.</p>
capo_controltower.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</p>
capo_controltower.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would cause a service quota to be exceeded. See <a href="https://docs.aws.amazon.com/controltower/latest/userguide/request-an-increase.html">Service quotas</a>.</p>
capo_controltower.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_controltower.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
capo_controltower.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_controltower.types.disable_baseline_input.DisableBaselineInput]",
) -> AsyncOperationResponse[
"capo_controltower.types.disable_baseline_output.DisableBaselineOutput"
]:
import capo_controltower._operations.aws_control_tower_apis.disable_baseline
(
output,
http_response,
) = await capo_controltower._operations.aws_control_tower_apis.disable_baseline.async_disable_baseline(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DisableBaseline")
)
input_: capo_controltower.types.disable_baseline_input.DisableBaselineInput = {
"enabled_baseline_identifier": enabled_baseline_identifier
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|