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

UpdatePodIdentityAssociation

Updates a EKS Pod Identity association. Only the IAM role can be changed; an association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings.

Request Syntax


POST /clusters/name/pod-identity-associations/associationId HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string",
   "roleArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

associationId

The ID of the association to be updated.

Required: Yes

name

The name of the cluster that you want to update the association in.

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientRequestToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Required: No

roleArn

The new IAM role to change the

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "association": { 
      "associationArn": "string",
      "associationId": "string",
      "clusterName": "string",
      "createdAt": number,
      "modifiedAt": number,
      "namespace": "string",
      "ownerArn": "string",
      "roleArn": "string",
      "serviceAccount": "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.

association

The full description of the EKS Pod Identity association that was updated.

Type: PodIdentityAssociation object

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

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