Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

RegisterCapability

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.

Request Syntax


POST /2021-01-01/opensearch/application/ApplicationId/capability/register HTTP/1.1
Content-type: application/json

{
   "capabilityConfig": { ... },
   "capabilityName": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ApplicationId

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

capabilityConfig

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

Type: CapabilityBaseRequestConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

capabilityName

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

Type: String

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

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "capabilityConfig": { ... },
   "capabilityName": "string",
   "status": "string"
}

Response Elements

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

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

applicationId

The unique identifier of the OpenSearch UI application.

Type: String

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

capabilityConfig

The configuration settings for the registered capability.

Type: CapabilityBaseResponseConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

capabilityName

The name of the registered capability.

Type: String

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

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

status

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

Type: String

Errors

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

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

ServiceQuotaExceededException

An exception for when a request would cause a service quota to be exceeded.

HTTP Status Code: 402

ValidationException

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

HTTP Status Code: 400