DescribeAddonVersions
Describes the Kubernetes versions that the add-on can be used with.
Request Syntax
GET /addons/supported-versions?addonName=addonName
&kubernetesVersion=kubernetesVersion
&maxResults=maxResults
&nextToken=nextToken
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
ListAddons
. - kubernetesVersion
-
The Kubernetes versions that the add-on can be used with.
- maxResults
-
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The
nextToken
value returned from a previous paginatedDescribeAddonVersionsRequest
wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.Note This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"addons": [
{
"addonName": "string",
"addonVersions": [
{
"addonVersion": "string",
"architecture": [ "string" ],
"compatibilities": [
{
"clusterVersion": "string",
"defaultVersion": boolean,
"platformVersions": [ "string" ]
}
]
}
],
"type": "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.
- addons
-
The list of available versions with Kubernetes version compatibility.
Type: Array of AddonInfo objects
- nextToken
-
The
nextToken
value returned from a previous paginatedDescribeAddonVersionsResponse
wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.Note This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
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
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an AWS Signature Version 4
signature. For more information about creating these signatures, see Signature
Version 4 Signing Process in the AWS General
Reference.
You need to learn how to sign HTTP requests only if you intend to manually
create them. When you use the AWS Command Line
Interface (AWS CLI)
Example
The following example describes the add-on versions available for an add-on
named vpc-cni
.
Sample Request
GET /addons/supported-versions?addonName=vpc-cni HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34
X-Amz-Date: 20201125T143627Z
Authorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OK
Date: Wed, 25 Nov 2020 14:36:27 GMT
Content-Type: application/json
Content-Length: 418
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: WkXM1FDXvHcFaHg=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive
{
"addons": [{
"addonName": "vpc-cni",
"type": "networking",
"addonVersions": [{
"addonVersion": "v1.7.5-eksbuild.1",
"architecture": ["amd64", "arm64"],
"compatibilities": [{
"clusterVersion": "1.18",
"platformVersions": ["*"],
"defaultVersion": true
}]
}, {
"addonVersion": "v1.6.3-eksbuild.1",
"architecture": ["amd64", "arm64"],
"compatibilities": [{
"clusterVersion": "1.18",
"platformVersions": ["*"],
"defaultVersion": false
}]
}]
}],
"nextToken": null
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: