DeleteApplicationCommand

Suggest an Edit

Deletes an existing OpenSearch Application.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { OpenSearchClient, DeleteApplicationCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
// const { OpenSearchClient, DeleteApplicationCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
const client = new OpenSearchClient(config);
const input = { // DeleteApplicationRequest
  id: "STRING_VALUE", // required
};
const command = new DeleteApplicationCommand(input);
const response = await client.send(command);
// {};

DeleteApplicationCommand Input

See DeleteApplicationCommandInput for more details

Parameter
Type
Description
id
Required
string | undefined

Unique identifier for the OpenSearch Application that you want to delete.

DeleteApplicationCommand Output

See DeleteApplicationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

An error occurred because you don't have permissions to access the resource.

BaseException
client

An error occurred while processing the request.

ConflictException
client

An error occurred because the client attempts to remove a resource that is currently in use.

DisabledOperationException
client

An error occured because the client wanted to access an unsupported operation.

InternalException
server

Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException
client

An exception for accessing or deleting a resource that doesn't exist.

ValidationException
client

An exception for accessing or deleting a resource that doesn't exist.

OpenSearchServiceException
Base exception class for all service exceptions from OpenSearch service.