Skip to content

GetCapabilityResponse

Source code in docs_src/capo_opensearch/types/get_capability_response.py
class GetCapabilityResponse(TypedDict, closed=True):
    capability_name: NotRequired["capo_opensearch.types.capability_name.CapabilityName"]
    """<p>The name of the 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_extended_response_config.CapabilityExtendedResponseConfig"
    ]
    """<p>The configuration settings for the capability, including capability-specific settings such as AI configuration.</p>"""
    failures: NotRequired[
        "capo_opensearch.types.capability_failures.CapabilityFailures"
    ]
    """<p>A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.</p>"""

application_id instance-attribute

application_id: NotRequired[ApplicationId]

The unique identifier of the OpenSearch UI application.

capability_config instance-attribute

capability_config: NotRequired[CapabilityExtendedResponseConfig]

The configuration settings for the capability, including capability-specific settings such as AI configuration.

capability_name instance-attribute

capability_name: NotRequired[CapabilityName]

The name of the capability.

failures instance-attribute

failures: NotRequired[CapabilityFailures]

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

status instance-attribute

status: NotRequired[CapabilityStatus]

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