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

DescribeAddonVersions

Describes the versions for an add-on.

Information such as the Kubernetes versions that you can use the add-on with, the owner, publisher, and the type of the add-on are returned.

Request Syntax


GET /addons/supported-versions?addonName=addonName&kubernetesVersion=kubernetesVersion&maxResults=maxResults&nextToken=nextToken&owners=owners&publishers=publishers&types=types 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 you can use the add-on with.

maxResults

The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a nextToken value, if applicable, are returned.

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.

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.

owners

The owner of the add-on. For valid owners, don't specify a value for this property.

publishers

The publisher of the add-on. For valid publishers, don't specify a value for this property.

types

The type of the add-on. For valid types, don't specify a value for this property.

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" ]
                  }
               ],
               "requiresConfiguration": boolean
            }
         ],
         "marketplaceInformation": { 
            "productId": "string",
            "productUrl": "string"
         },
         "owner": "string",
         "publisher": "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 and other properties.

Type: Array of AddonInfo objects

nextToken

The nextToken value to include in a future DescribeAddonVersions request. When the results of a DescribeAddonVersions 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.

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 AWS 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 Amazon EKS 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) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

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
}