Amazon OpenSearch Service

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

See also: AWS API Documentation

Request Syntax

client.deregister_capability(
    applicationId='string',
    capabilityName='string'
)

type applicationId:

string

param applicationId:

[REQUIRED]

The unique identifier of the OpenSearch UI application to deregister the capability from.

type capabilityName:

string

param capabilityName:

[REQUIRED]

The name of the capability to deregister.

rtype:

dict

returns:

Response Syntax

{
    'status': 'creating'|'create_failed'|'active'|'updating'|'update_failed'|'deleting'|'delete_failed'
}

Response Structure

• (dict) --

  The result of a DeregisterCapability request.

  • status (string) --

    The status of the deregistration operation. Returns deleting when the capability is being removed.

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

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

    }
)

type applicationId:

string

param applicationId:

[REQUIRED]

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

type capabilityName:

string

param 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

type capabilityConfig:

dict

param capabilityConfig:

[REQUIRED]

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

• aiConfig (dict) --

  Configuration settings for AI-powered capabilities.

rtype:

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.

    • aiConfig (dict) --

      Configuration settings for AI-powered capabilities.

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

See also: AWS API Documentation

Request Syntax

client.get_capability(
    applicationId='string',
    capabilityName='string'
)

type applicationId:

string

param applicationId:

[REQUIRED]

The unique identifier of the OpenSearch UI application.

type capabilityName:

string

param capabilityName:

[REQUIRED]

The name of the capability to retrieve information about.

rtype:

dict

returns:

Response Syntax

{
    'capabilityName': 'string',
    'applicationId': 'string',
    'status': 'creating'|'create_failed'|'active'|'updating'|'update_failed'|'deleting'|'delete_failed',
    'capabilityConfig': {
        'aiConfig': {}
    },
    'failures': [
        {
            'reason': 'KMS_KEY_INSUFFICIENT_PERMISSION',
            'details': 'string'
        },
    ]
}

Response Structure

• (dict) --

  The result of a GetCapability request. Contains details about the capability.

  • capabilityName (string) --

    The name of the 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 capability, including capability-specific settings such as AI configuration.

    • aiConfig (dict) --

      Configuration settings for AI-powered capabilities.

  • failures (list) --

    A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.

    • (dict) --

      Information about a capability failure.

      • reason (string) --

        The reason for the capability failure. Possible values: KMS_KEY_INSUFFICIENT_PERMISSION.

      • details (string) --

        Additional details about the capability failure.