Skip to content

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

Description

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

Usage

opensearchservice_get_capability(applicationId, capabilityName)

Arguments

  • applicationId

[required] The unique identifier of the OpenSearch UI application.

  • capabilityName

[required] The name of the capability to retrieve information about.

Value

A list with the following syntax:

list(
  capabilityName = "string",
  applicationId = "string",
  status = "creating"|"create_failed"|"active"|"updating"|"update_failed"|"deleting"|"delete_failed",
  capabilityConfig = list(
    aiConfig = list()
  ),
  failures = list(
    list(
      reason = "KMS_KEY_INSUFFICIENT_PERMISSION",
      details = "string"
    )
  )
)

Request syntax

svc$get_capability(
  applicationId = "string",
  capabilityName = "string"
)