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

DescribeAddon

Describes an Amazon EKS add-on.

Request Syntax


GET /clusters/name/addons/addonName 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.

Required: Yes

name

The name of your cluster.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "addon": { 
      "addonArn": "string",
      "addonName": "string",
      "addonVersion": "string",
      "clusterName": "string",
      "configurationValues": "string",
      "createdAt": number,
      "health": { 
         "issues": [ 
            { 
               "code": "string",
               "message": "string",
               "resourceIds": [ "string" ]
            }
         ]
      },
      "marketplaceInformation": { 
         "productId": "string",
         "productUrl": "string"
      },
      "modifiedAt": number,
      "owner": "string",
      "podIdentityAssociations": [ "string" ],
      "publisher": "string",
      "serviceAccountRoleArn": "string",
      "status": "string",
      "tags": { 
         "string" : "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.

addon

An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

Type: Addon object

Errors

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

ClientException

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

HTTP Status Code: 400

InvalidParameterException

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

HTTP Status Code: 400

InvalidRequestException

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

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 an add-on named vpc-cni.

Sample Request


GET /clusters/1-18/addons/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: 20201125T144831Z
Authorization: AUTHPARAMS

Sample Response


HTTP/1.1 200 OK
Date: Wed, 25 Nov 2020 14:48:32 GMT
Content-Type: application/json
Content-Length: 472
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: WkY-BEEPPHcFwEg=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive

{
  "addon" : {
    "addonName" : "vpc-cni",
    "clusterName" : "1-18",
    "status" : "ACTIVE",
    "addonVersion" : "v1.7.5-eksbuild.1",
    "health" : {
      "issues" : [ ]
    },
    "addonArn" : "arn:aws:eks:us-west-2:012345678910:addon/my-cluster/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "createdAt" : 1.606315184255E9,
    "modifiedAt" : 1.606315202754E9,
    "serviceAccountRoleArn" : "arn:aws:iam::012345678910:role/AmazonEKSCNIRole",
    "tags" : { }
  }
}