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

ListCapabilities

Lists all managed capabilities in your Amazon EKS cluster. You can use this operation to get an overview of all capabilities and their current status.

Request Syntax


GET /clusters/name/capabilities?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the Amazon EKS cluster for which you want to list capabilities.

Required: Yes

maxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you don't specify a value, the default is 100 results.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "capabilities": [ 
      { 
         "arn": "string",
         "capabilityName": "string",
         "createdAt": number,
         "modifiedAt": number,
         "status": "string",
         "type": "string",
         "version": "string"
      }
   ],
   "nextToken": "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.

capabilities

A list of capability summary objects, each containing basic information about a capability including its name, ARN, type, status, version, and timestamps.

Type: Array of CapabilitySummary objects

nextToken

The nextToken value to include in a future ListCapabilities request. When the results of a ListCapabilities request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Errors

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

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

addonName: The specified parameter for the add-on name is invalid. Review the available parameters for the API request
clusterName: The Amazon EKS cluster associated with the exception.
fargateProfileName: The Fargate profile associated with the exception.
message: The specified parameter is invalid. Review the available parameters for the API request.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server-side issue.

addonName: The Amazon EKS add-on name associated with the exception.
clusterName: The Amazon EKS cluster associated with the exception.
message: These errors are usually caused by a server-side issue.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 500