Skip to content

RegisterCapabilityResponse

Source code in docs_src/capo_opensearch/types/register_capability_response.py 
14
15
16
17
18
19
20
21
22
23
24
class RegisterCapabilityResponse(TypedDict, closed=True):
    capability_name: NotRequired["capo_opensearch.types.capability_name.CapabilityName"]
    """<p>The name of the registered capability.</p>"""
    application_id: NotRequired["capo_opensearch.types.application_id.ApplicationId"]
    """<p>The unique identifier of the OpenSearch UI application.</p>"""
    status: NotRequired["capo_opensearch.types.capability_status.CapabilityStatus"]
    """<p>The current status of the capability. Possible values: <code>creating</code>, <code>create_failed</code>, <code>active</code>, <code>updating</code>, <code>update_failed</code>, <code>deleting</code>, <code>delete_failed</code>.</p>"""
    capability_config: NotRequired[
        "capo_opensearch.types.capability_base_response_config.CapabilityBaseResponseConfig"
    ]
    """<p>The configuration settings for the registered capability.</p>"""

application_id instance-attribute 

application_id: NotRequired[ApplicationId]

The unique identifier of the OpenSearch UI application.

capability_config instance-attribute 

capability_config: NotRequired[CapabilityBaseResponseConfig]

The configuration settings for the registered capability.

capability_name instance-attribute 

capability_name: NotRequired[CapabilityName]

The name of the registered capability.

status instance-attribute 

status: NotRequired[CapabilityStatus]

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