Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

Retrieves information about a registered capability for an OpenSearch UI application, including its configuration and current status.

get/2021-01-01/opensearch/application/{ApplicationId}/capability/{CapabilityName}

Path parameters

ApplicationIdstring required

The unique identifier of the OpenSearch UI application.

CapabilityNamestring required

The name of a capability. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens.

The name of the capability to retrieve information about.

Response

Success

capabilityNamestring

The name of the capability.

applicationIdstring

The unique identifier of the OpenSearch UI application.

status'creating' | 'create_failed' | 'active' | 'updating' | 'update_failed' | 'deleting' | 'delete_failed'

The current status of the capability. Possible values: <code>creating</code>, <code>create_failed</code>, <code>active</code>, <code>updating</code>, <code>update_failed</code>, <code>deleting</code>, <code>delete_failed</code>.