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

ListPodIdentityAssociations

List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses.

Request Syntax


GET /clusters/name/pod-identity-associations?maxResults=maxResults&namespace=namespace&nextToken=nextToken&serviceAccount=serviceAccount HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the cluster that the associations are in.

Required: Yes

maxResults

The maximum number of EKS Pod Identity association results returned by ListPodIdentityAssociations in paginated output. When you use this parameter, ListPodIdentityAssociations returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListPodIdentityAssociations request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListPodIdentityAssociations returns up to 100 results and a nextToken value if applicable.

Valid Range: Minimum value of 1. Maximum value of 100.

namespace

The name of the Kubernetes namespace inside the cluster that the associations are in.

nextToken

The nextToken value returned from a previous paginated ListUpdates 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.

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.

serviceAccount

The name of the Kubernetes service account that the associations use.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "associations": [ 
      { 
         "associationArn": "string",
         "associationId": "string",
         "clusterName": "string",
         "namespace": "string",
         "ownerArn": "string",
         "serviceAccount": "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.

associations

The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided.

Each summary is simplified by removing these fields compared to the full PodIdentityAssociation:

The IAM role: roleArn
The timestamp that the association was created at: createdAt
The most recent timestamp that the association was modified at:. modifiedAt
The tags on the association: tags

Type: Array of PodIdentityAssociationSummary objects

nextToken

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

addonName: The specified parameter for the add-on name is invalid. Review the available parameters for the API request
clusterName: The Amazon EKS cluster associated with the exception.
fargateProfileName: The Fargate profile associated with the exception.
message: The specified parameter is invalid. Review the available parameters for the API request.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

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.

addonName: The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations.
clusterName: The Amazon EKS cluster associated with the exception.
message: The Amazon EKS add-on name associated with the exception.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

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.

addonName: The Amazon EKS add-on name associated with the exception.
clusterName: The Amazon EKS cluster associated with the exception.
fargateProfileName: The Fargate profile associated with the exception.
message: The Amazon EKS message associated with the exception.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 404

ServerException

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

addonName: The Amazon EKS add-on name associated with the exception.
clusterName: The Amazon EKS cluster associated with the exception.
message: These errors are usually caused by a server-side issue.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 500