Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

Registers a capability for an OpenSearch UI application. Use this operation to enable specific capabilities, such as AI features, for a given application. The capability configuration defines the type and settings of the capability to register. For more information about the AI features, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application-ai-assistant.html">Agentic AI for OpenSearch UI</a>.

post/2021-01-01/opensearch/application/{ApplicationId}/capability/register

Path parameters

ApplicationIdstring required

The unique identifier of the OpenSearch UI application to register the capability for.

Request body

capabilityNamestring required

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

Response

Success

capabilityNamestring

The name of the registered 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>.