capabilities

Creates, updates, deletes, gets or lists a capabilities resource.

Overview

Name	capabilities
Type	Resource
Id	aws.opensearch.capabilities

Fields

The following fields are returned by SELECT queries:

get_capability

Name	Datatype	Description
application_id	string	The unique identifier of the OpenSearch UI application. (pattern: <code>[a-z0-9]{3,30}</code>)
capability_config	object	The configuration settings for the capability, including capability-specific settings such as AI configuration.
capability_name	string	The name of a capability. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens. (pattern: <code>^[a-zA-Z0-9-]+$</code>)
failures	array	A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.
status	string	The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed. (creating, create_failed, active, updating, update_failed, deleting, delete_failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_capability	select	application_id, capability_name, region		Retrieves information about a registered capability for an OpenSearch UI application, including its configuration and current status.
register_capability	insert	application_id, region, capabilityName, capabilityConfig		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.
deregister_capability	delete	application_id, capability_name, region		Deregisters a capability from an OpenSearch UI application. This operation removes the capability and its associated configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_id	string	The unique identifier of the OpenSearch UI application to deregister the capability from.
capability_name	string	The name of the capability to deregister.
region	string	AWS region (default: us-east-1)

SELECT examples

get_capability

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

SELECT
application_id,
capability_config,
capability_name,
failures,
status
FROM aws.opensearch.capabilities
WHERE application_id = '{{ application_id }}' -- required
AND capability_name = '{{ capability_name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

register_capability

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.

INSERT INTO aws.opensearch.capabilities (
capabilityName,
capabilityConfig,
application_id,
region
)
SELECT 
'{{ capabilityName }}' /* required */,
'{{ capabilityConfig }}' /* required */,
'{{ application_id }}',
'{{ region }}'
RETURNING
application_id,
capability_config,
capability_name,
status
;

Manifest

# Description fields are for documentation purposes
- name: capabilities
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the capabilities resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the capabilities resource.
  - name: capabilityName
    value: "{{ capabilityName }}"
    description: |
      The name of a capability. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens.
  - name: capabilityConfig
    description: |
      The base configuration for registering a capability. Contains capability-specific configuration such as AI settings.
    value:
      aiConfig: "{{ aiConfig }}"

DELETE examples

deregister_capability

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

DELETE FROM aws.opensearch.capabilities
WHERE application_id = '{{ application_id }}' --required
AND capability_name = '{{ capability_name }}' --required
AND region = '{{ region }}' --required
;