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 that
DescribeAddonVersions
returns.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"
}
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 that you provide when an addon is created or updated.
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.
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 Region-specific.
HTTP Status Code: 404
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: