- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteAppCommand
Deletes an Resilience Hub application. This is a destructive action that can't be undone.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ResiliencehubClient, DeleteAppCommand } from "@aws-sdk/client-resiliencehub"; // ES Modules import
// const { ResiliencehubClient, DeleteAppCommand } = require("@aws-sdk/client-resiliencehub"); // CommonJS import
const client = new ResiliencehubClient(config);
const input = { // DeleteAppRequest
appArn: "STRING_VALUE", // required
forceDelete: true || false,
clientToken: "STRING_VALUE",
};
const command = new DeleteAppCommand(input);
const response = await client.send(command);
// { // DeleteAppResponse
// appArn: "STRING_VALUE", // required
// };
DeleteAppCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
appArnRequired | string | undefined | Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: |
clientToken | string | undefined | 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. |
forceDelete | boolean | undefined | A boolean option to force the deletion of an Resilience Hub application. |
DeleteAppCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
appArnRequired | string | undefined | Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| ConflictException | client | 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 | server | This exception occurs when there is an internal failure in the Resilience Hub service. |
| ResourceNotFoundException | client | This exception occurs when the specified resource could not be found. |
| ThrottlingException | client | This exception occurs when you have exceeded the limit on the number of requests per second. |
| ValidationException | client | This exception occurs when a request is not valid. |
| ResiliencehubServiceException | Base exception class for all service exceptions from Resiliencehub service. |