Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCapability

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

Request Syntax


GET /2021-01-01/opensearch/application/ApplicationId/capability/CapabilityName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationId

The unique identifier of the OpenSearch UI application.

Pattern: [a-z0-9]{3,30}

Required: Yes

CapabilityName

The name of the capability to retrieve information about.

Length Constraints: Minimum length of 3. Maximum length of 30.

Pattern: ^[a-zA-Z0-9-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "capabilityConfig": { ... },
   "capabilityName": "string",
   "failures": [ 
      { 
         "details": "string",
         "reason": "string"
      }
   ],
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

applicationId

The unique identifier of the OpenSearch UI application.

Type: String

Pattern: [a-z0-9]{3,30}

capabilityConfig

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

Type: CapabilityExtendedResponseConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

capabilityName

The name of the capability.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 30.

Pattern: ^[a-zA-Z0-9-]+$

failures

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

Type: Array of CapabilityFailure objects

status

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

An error occurred because you don't have permissions to access the resource.

HTTP Status Code: 403

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400