DeregisterCapability

Deregisters a capability from an OpenSearch UI application. This operation removes the capability and its associated configuration.

Request Syntax


DELETE /2021-01-01/opensearch/application/ApplicationId/capability/deregister/CapabilityName HTTP/1.1

The request uses the following URI parameters.

The unique identifier of the OpenSearch UI application to deregister the capability from.

Pattern: [a-z0-9]{3,30}

Required: Yes

The name of the capability to deregister.

Length Constraints: Minimum length of 3. Maximum length of 30.

Pattern: ^[a-zA-Z0-9-]+$

Required: Yes

The request does not have a request body.


HTTP/1.1 200
Content-type: application/json

{
   "status": "string"
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

The status of the deregistration operation. Returns deleting when the capability is being removed.

Type: String

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

ConflictException

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

HTTP Status Code: 409

DisabledOperationException

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

HTTP Status Code: 409

InternalException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 409

ValidationException

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

HTTP Status Code: 400