OpenSearchService / Client / get_capability

get_capability¶

OpenSearchService.Client.get_capability(**kwargs)¶

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

Request Syntax

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

Parameters:

applicationId (string) –
[REQUIRED]

The unique identifier of the OpenSearch UI application.
capabilityName (string) –
[REQUIRED]

The name of the capability to retrieve information about.

Return type:

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.
  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.
- 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.

Exceptions

OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.AccessDeniedException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.DisabledOperationException