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

UpdateCapability

Updates the configuration of a managed capability in your Amazon EKS cluster. You can update the IAM role, configuration settings, and delete propagation policy for a capability.

When you update a capability, Amazon EKS applies the changes and may restart capability components as needed. The capability remains available during the update process, but some operations may be temporarily unavailable.

Request Syntax


POST /clusters/name/capabilities/capabilityName HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string",
   "configuration": { 
      "argoCd": { 
         "networkAccess": { 
            "vpceIds": [ "string" ]
         },
         "rbacRoleMappings": { 
            "addOrUpdateRoleMappings": [ 
               { 
                  "identities": [ 
                     { 
                        "id": "string",
                        "type": "string"
                     }
                  ],
                  "role": "string"
               }
            ],
            "removeRoleMappings": [ 
               { 
                  "identities": [ 
                     { 
                        "id": "string",
                        "type": "string"
                     }
                  ],
                  "role": "string"
               }
            ]
         }
      }
   },
   "deletePropagationPolicy": "string",
   "roleArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

capabilityName

The name of the capability to update configuration for.

Required: Yes

name

The name of the Amazon EKS cluster that contains the capability you want to update configuration for.

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. This token is valid for 24 hours after creation.

Type: String

Required: No

configuration

The updated configuration settings for the capability. You only need to specify the configuration parameters you want to change. For Argo CD capabilities, you can update RBAC role mappings and network access settings.

Type: UpdateCapabilityConfiguration object

Required: No

deletePropagationPolicy

The updated delete propagation policy for the capability. Currently, the only supported value is RETAIN.

Type: String

Valid Values: RETAIN

Required: No

roleArn

The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services. If you specify a new role ARN, the capability will start using the new role for all subsequent operations.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "update": { 
      "createdAt": number,
      "errors": [ 
         { 
            "errorCode": "string",
            "errorMessage": "string",
            "resourceIds": [ "string" ]
         }
      ],
      "id": "string",
      "params": [ 
         { 
            "type": "string",
            "value": "string"
         }
      ],
      "status": "string",
      "type": "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.

update

An object representing an asynchronous update.

Type: Update object

Errors

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

AccessDeniedException

You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.

message: You do not have sufficient access to perform this action.

HTTP Status Code: 403

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

ResourceInUseException

The specified resource is in use.

addonName: The specified add-on name is in use.
clusterName: The Amazon EKS cluster associated with the exception.
message: The Amazon EKS message associated with the exception.
nodegroupName: The Amazon EKS managed node group associated with the exception.

HTTP Status Code: 409

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