Skip to content

RegisterCapabilityRequest

Source code in docs_src/capo_opensearch/types/register_capability_request.py 
15
16
17
18
19
20
21
class RegisterCapabilityRequest(TypedDict, closed=True):
    application_id: "capo_opensearch.types.application_id.ApplicationId"
    """<p>The unique identifier of the OpenSearch UI application to register the capability for.</p>"""
    capability_name: "capo_opensearch.types.capability_name.CapabilityName"
    """<p>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 <code>ai-capability</code> </p>"""
    capability_config: "capo_opensearch.types.capability_base_request_config.CapabilityBaseRequestConfig"
    """<p>The configuration settings for the capability being registered. This includes capability-specific settings such as AI configuration.</p>"""

application_id instance-attribute 

application_id: ApplicationId

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

capability_config instance-attribute 

capability_config: CapabilityBaseRequestConfig

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

capability_name instance-attribute 

capability_name: 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