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

DescribeAddonConfiguration

Returns configuration options.

Request Syntax


GET /addons/configuration-schemas?addonName=addonName&addonVersion=addonVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

addonName

The name of the add-on. The name must match one of the names returned by DescribeAddonVersions.

Required: Yes

addonVersion

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "addonName": "string",
   "addonVersion": "string",
   "configurationSchema": "string",
   "podIdentityConfiguration": [ 
      { 
         "recommendedManagedPolicies": [ "string" ],
         "serviceAccount": "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.

addonName

The name of the add-on.

Type: String

addonVersion

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions.

Type: String

configurationSchema

A JSON schema that's used to validate the configuration values you provide when an add-on is created or updated.

Type: String

podIdentityConfiguration

The Kubernetes service account name used by the add-on, and any suggested IAM policies. Use this information to create an IAM Role for the add-on.

Type: Array of AddonPodIdentityConfiguration objects

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.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are AWS Region specific.

HTTP Status Code: 404

ServerException

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

HTTP Status Code: 500