Skip to content

Registers a capability for an OpenSearch UI application

Description

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 Agentic AI for OpenSearch UI.

Usage

opensearchservice_register_capability(applicationId, capabilityName,
  capabilityConfig)

Arguments

  • applicationId

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

  • capabilityName

[required] The name of the capability to register. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens. This identifies the type of capability being enabled for the application. For registering AI Assistant capability, use ai-capability

  • capabilityConfig

[required] The configuration settings for the capability being registered. This includes capability-specific settings such as AI configuration.

Value

A list with the following syntax:

list(
  capabilityName = "string",
  applicationId = "string",
  status = "creating"|"create_failed"|"active"|"updating"|"update_failed"|"deleting"|"delete_failed",
  capabilityConfig = list(
    aiConfig = list()
  )
)

Request syntax

svc$register_capability(
  applicationId = "string",
  capabilityName = "string",
  capabilityConfig = list(
    aiConfig = list()
  )
)