OpenSearchService / Client / register_capability

register_capability

OpenSearchService.Client.register_capability(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.register_capability(
    applicationId='string',
    capabilityName='string',
    capabilityConfig={
        'aiConfig': {}

    }
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

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

  • capabilityName (string) –

    [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 (dict) –

    [REQUIRED]

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

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: aiConfig.

    • aiConfig (dict) –

      Configuration settings for AI-powered capabilities.

Return type:

dict

Returns:

Response Syntax

{
    'capabilityName': 'string',
    'applicationId': 'string',
    'status': 'creating'|'create_failed'|'active'|'updating'|'update_failed'|'deleting'|'delete_failed',
    'capabilityConfig': {
        'aiConfig': {}
    }
}

Response Structure

  • (dict) –

    The result of a RegisterCapability request. Contains details about the registered capability.

    • capabilityName (string) –

      The name of the registered capability.

    • applicationId (string) –

      The unique identifier of the OpenSearch UI application.

    • status (string) –

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

    • capabilityConfig (dict) –

      The configuration settings for the registered capability.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: aiConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • aiConfig (dict) –

        Configuration settings for AI-powered capabilities.

Exceptions