Deletes an Resilience Hub application. This is a destructive action that can't be undone.
Parameters:
-
app_arn
(Arn)
–
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
-
force_delete
(Optional[BooleanOptional], default:
None
)
–
A boolean option to force the deletion of an Resilience Hub application.
-
client_token
(Optional[ClientToken], default:
None
)
–
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
Raises:
-
ConflictException
–
This exception occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
-
InternalServerException
–
This exception occurs when there is an internal failure in the Resilience Hub service.
-
ResourceNotFoundException
–
This exception occurs when the specified resource could not be found.
-
ThrottlingException
–
This exception occurs when you have exceeded the limit on the number of requests per second.
-
ValidationException
–
This exception occurs when a request is not valid.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_resiliencehub/_services/resiliencehub.py
| def delete_app(
self,
app_arn: "capo_resiliencehub.types.arn.Arn",
*,
config_overrides: Optional[resiliencehubClientConfig] = None,
force_delete: Optional[
"capo_resiliencehub.types.boolean_optional.BooleanOptional"
] = None,
client_token: Optional[
"capo_resiliencehub.types.client_token.ClientToken"
] = None,
) -> "capo_resiliencehub.types.delete_app_response.DeleteAppResponse":
"""<p>Deletes an Resilience Hub application. This is a destructive action that can't be undone.</p>
Args:
app_arn: <p>Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p>
force_delete: <p>A boolean option to force the deletion of an Resilience Hub application. </p>
client_token: <p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>
Raises:
capo_resiliencehub.errors.conflict_exception.ConflictException: <p>This exception occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
capo_resiliencehub.errors.internal_server_exception.InternalServerException: <p>This exception occurs when there is an internal failure in the Resilience Hub service.</p>
capo_resiliencehub.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception occurs when the specified resource could not be found.</p>
capo_resiliencehub.errors.throttling_exception.ThrottlingException: <p>This exception occurs when you have exceeded the limit on the number of requests per second.</p>
capo_resiliencehub.errors.validation_exception.ValidationException: <p>This exception occurs when a request is not valid.</p>
capo_resiliencehub.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_resiliencehub.types.delete_app_request.DeleteAppRequest]",
) -> OperationResponse[
"capo_resiliencehub.types.delete_app_response.DeleteAppResponse"
]:
import capo_resiliencehub._operations.aws_resilience_hub.delete_app
output, http_response = (
capo_resiliencehub._operations.aws_resilience_hub.delete_app.delete_app(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteApp")
)
input_: capo_resiliencehub.types.delete_app_request.DeleteAppRequest = {
"app_arn": app_arn
}
if force_delete is not None:
input_["force_delete"] = force_delete
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|