@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonEKS
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonEKS instead.
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to setup or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.
Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateAccessPolicyResult |
associateAccessPolicy(AssociateAccessPolicyRequest associateAccessPolicyRequest)
Associates an access policy and its scope to an access entry.
|
AssociateEncryptionConfigResult |
associateEncryptionConfig(AssociateEncryptionConfigRequest associateEncryptionConfigRequest)
Associates an encryption configuration to an existing cluster.
|
AssociateIdentityProviderConfigResult |
associateIdentityProviderConfig(AssociateIdentityProviderConfigRequest associateIdentityProviderConfigRequest)
Associates an identity provider configuration to a cluster.
|
CreateAccessEntryResult |
createAccessEntry(CreateAccessEntryRequest createAccessEntryRequest)
Creates an access entry.
|
CreateAddonResult |
createAddon(CreateAddonRequest createAddonRequest)
Creates an Amazon EKS add-on.
|
CreateClusterResult |
createCluster(CreateClusterRequest createClusterRequest)
Creates an Amazon EKS control plane.
|
CreateEksAnywhereSubscriptionResult |
createEksAnywhereSubscription(CreateEksAnywhereSubscriptionRequest createEksAnywhereSubscriptionRequest)
Creates an EKS Anywhere subscription.
|
CreateFargateProfileResult |
createFargateProfile(CreateFargateProfileRequest createFargateProfileRequest)
Creates an Fargate profile for your Amazon EKS cluster.
|
CreateNodegroupResult |
createNodegroup(CreateNodegroupRequest createNodegroupRequest)
Creates a managed node group for an Amazon EKS cluster.
|
CreatePodIdentityAssociationResult |
createPodIdentityAssociation(CreatePodIdentityAssociationRequest createPodIdentityAssociationRequest)
Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with
EKS Pod Identity.
|
DeleteAccessEntryResult |
deleteAccessEntry(DeleteAccessEntryRequest deleteAccessEntryRequest)
Deletes an access entry.
|
DeleteAddonResult |
deleteAddon(DeleteAddonRequest deleteAddonRequest)
Deletes an Amazon EKS add-on.
|
DeleteClusterResult |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes an Amazon EKS cluster control plane.
|
DeleteEksAnywhereSubscriptionResult |
deleteEksAnywhereSubscription(DeleteEksAnywhereSubscriptionRequest deleteEksAnywhereSubscriptionRequest)
Deletes an expired or inactive subscription.
|
DeleteFargateProfileResult |
deleteFargateProfile(DeleteFargateProfileRequest deleteFargateProfileRequest)
Deletes an Fargate profile.
|
DeleteNodegroupResult |
deleteNodegroup(DeleteNodegroupRequest deleteNodegroupRequest)
Deletes a managed node group.
|
DeletePodIdentityAssociationResult |
deletePodIdentityAssociation(DeletePodIdentityAssociationRequest deletePodIdentityAssociationRequest)
Deletes a EKS Pod Identity association.
|
DeregisterClusterResult |
deregisterCluster(DeregisterClusterRequest deregisterClusterRequest)
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
|
DescribeAccessEntryResult |
describeAccessEntry(DescribeAccessEntryRequest describeAccessEntryRequest)
Describes an access entry.
|
DescribeAddonResult |
describeAddon(DescribeAddonRequest describeAddonRequest)
Describes an Amazon EKS add-on.
|
DescribeAddonConfigurationResult |
describeAddonConfiguration(DescribeAddonConfigurationRequest describeAddonConfigurationRequest)
Returns configuration options.
|
DescribeAddonVersionsResult |
describeAddonVersions(DescribeAddonVersionsRequest describeAddonVersionsRequest)
Describes the versions for an add-on.
|
DescribeClusterResult |
describeCluster(DescribeClusterRequest describeClusterRequest)
Describes an Amazon EKS cluster.
|
DescribeEksAnywhereSubscriptionResult |
describeEksAnywhereSubscription(DescribeEksAnywhereSubscriptionRequest describeEksAnywhereSubscriptionRequest)
Returns descriptive information about a subscription.
|
DescribeFargateProfileResult |
describeFargateProfile(DescribeFargateProfileRequest describeFargateProfileRequest)
Describes an Fargate profile.
|
DescribeIdentityProviderConfigResult |
describeIdentityProviderConfig(DescribeIdentityProviderConfigRequest describeIdentityProviderConfigRequest)
Describes an identity provider configuration.
|
DescribeInsightResult |
describeInsight(DescribeInsightRequest describeInsightRequest)
Returns details about an insight that you specify using its ID.
|
DescribeNodegroupResult |
describeNodegroup(DescribeNodegroupRequest describeNodegroupRequest)
Describes a managed node group.
|
DescribePodIdentityAssociationResult |
describePodIdentityAssociation(DescribePodIdentityAssociationRequest describePodIdentityAssociationRequest)
Returns descriptive information about an EKS Pod Identity association.
|
DescribeUpdateResult |
describeUpdate(DescribeUpdateRequest describeUpdateRequest)
Describes an update to an Amazon EKS resource.
|
DisassociateAccessPolicyResult |
disassociateAccessPolicy(DisassociateAccessPolicyRequest disassociateAccessPolicyRequest)
Disassociates an access policy from an access entry.
|
DisassociateIdentityProviderConfigResult |
disassociateIdentityProviderConfig(DisassociateIdentityProviderConfigRequest disassociateIdentityProviderConfigRequest)
Disassociates an identity provider configuration from a cluster.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAccessEntriesResult |
listAccessEntries(ListAccessEntriesRequest listAccessEntriesRequest)
Lists the access entries for your cluster.
|
ListAccessPoliciesResult |
listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
Lists the available access policies.
|
ListAddonsResult |
listAddons(ListAddonsRequest listAddonsRequest)
Lists the installed add-ons.
|
ListAssociatedAccessPoliciesResult |
listAssociatedAccessPolicies(ListAssociatedAccessPoliciesRequest listAssociatedAccessPoliciesRequest)
Lists the access policies associated with an access entry.
|
ListClustersResult |
listClusters(ListClustersRequest listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.
|
ListEksAnywhereSubscriptionsResult |
listEksAnywhereSubscriptions(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest)
Displays the full description of the subscription.
|
ListFargateProfilesResult |
listFargateProfiles(ListFargateProfilesRequest listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the
specified Amazon Web Services Region.
|
ListIdentityProviderConfigsResult |
listIdentityProviderConfigs(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest)
Lists the identity provider configurations for your cluster.
|
ListInsightsResult |
listInsights(ListInsightsRequest listInsightsRequest)
Returns a list of all insights checked for against the specified cluster.
|
ListNodegroupsResult |
listNodegroups(ListNodegroupsRequest listNodegroupsRequest)
Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the
specified Amazon Web Services Region.
|
ListPodIdentityAssociationsResult |
listPodIdentityAssociations(ListPodIdentityAssociationsRequest listPodIdentityAssociationsRequest)
List the EKS Pod Identity associations in a cluster.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon EKS resource.
|
ListUpdatesResult |
listUpdates(ListUpdatesRequest listUpdatesRequest)
Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified
Amazon Web Services Region.
|
RegisterClusterResult |
registerCluster(RegisterClusterRequest registerClusterRequest)
Connects a Kubernetes cluster to the Amazon EKS control plane.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to an Amazon EKS resource with the specified
resourceArn. |
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from an Amazon EKS resource.
|
UpdateAccessEntryResult |
updateAccessEntry(UpdateAccessEntryRequest updateAccessEntryRequest)
Updates an access entry.
|
UpdateAddonResult |
updateAddon(UpdateAddonRequest updateAddonRequest)
Updates an Amazon EKS add-on.
|
UpdateClusterConfigResult |
updateClusterConfig(UpdateClusterConfigRequest updateClusterConfigRequest)
Updates an Amazon EKS cluster configuration.
|
UpdateClusterVersionResult |
updateClusterVersion(UpdateClusterVersionRequest updateClusterVersionRequest)
Updates an Amazon EKS cluster to the specified Kubernetes version.
|
UpdateEksAnywhereSubscriptionResult |
updateEksAnywhereSubscription(UpdateEksAnywhereSubscriptionRequest updateEksAnywhereSubscriptionRequest)
Update an EKS Anywhere Subscription.
|
UpdateNodegroupConfigResult |
updateNodegroupConfig(UpdateNodegroupConfigRequest updateNodegroupConfigRequest)
Updates an Amazon EKS managed node group configuration.
|
UpdateNodegroupVersionResult |
updateNodegroupVersion(UpdateNodegroupVersionRequest updateNodegroupVersionRequest)
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
|
UpdatePodIdentityAssociationResult |
updatePodIdentityAssociation(UpdatePodIdentityAssociationRequest updatePodIdentityAssociationRequest)
Updates a EKS Pod Identity association.
|
AmazonEKSWaiters |
waiters() |
static final String ENDPOINT_PREFIX
AssociateAccessPolicyResult associateAccessPolicy(AssociateAccessPolicyRequest associateAccessPolicyRequest)
Associates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entries in the Amazon EKS User Guide.
associateAccessPolicyRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.AssociateEncryptionConfigResult associateEncryptionConfig(AssociateEncryptionConfigRequest associateEncryptionConfigRequest)
Associates an encryption configuration to an existing cluster.
Use this API to enable encryption on existing clusters that don't already have encryption enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters.
associateEncryptionConfigRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.AssociateIdentityProviderConfigResult associateIdentityProviderConfig(AssociateIdentityProviderConfigRequest associateIdentityProviderConfigRequest)
Associates an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you can create an identity provider
configuration and associate it to your cluster. After configuring authentication to your cluster you can create
Kubernetes Role and ClusterRole objects, assign permissions to them, and then bind them
to the identities using Kubernetes RoleBinding and ClusterRoleBinding objects. For more
information see Using RBAC
Authorization in the Kubernetes documentation.
associateIdentityProviderConfigRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.CreateAccessEntryResult createAccessEntry(CreateAccessEntryRequest createAccessEntryRequest)
Creates an access entry.
An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain
entries in the aws-auth ConfigMap for authentication. You have the following options
for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access
control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes
Role, ClusterRole, RoleBinding, and ClusterRoleBinding
objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need
to create and manage Kubernetes Role, ClusterRole, RoleBinding, and
ClusterRoleBinding objects.
For more information about access entries, see Access entries in the Amazon EKS User Guide.
createAccessEntryRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ResourceLimitExceededException - You have encountered a service limit on the specified resource.ResourceInUseException - The specified resource is in use.CreateAddonResult createAddon(CreateAddonRequest createAddonRequest)
Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.
createAddonRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.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 Amazon Web Services Region specific.ResourceInUseException - The specified resource is in use.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.ServerException - These errors are usually caused by a server-side issue.CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)
Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as
etcd and the API server. The control plane runs in an account managed by Amazon Web Services, and
the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is
single tenant and unique. It runs on its own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load
Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to
provide connectivity from the control plane instances to the nodes (for example, to support
kubectl exec, logs, and proxy data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or
disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is
enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access
Control in the Amazon EKS User Guide .
You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs
for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs.
For more information, see Amazon EKS Cluster Control Plane
Logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Allowing users to access your cluster and Launching Amazon EKS nodes in the Amazon EKS User Guide.
createClusterRequest - ResourceInUseException - The specified resource is in use.ResourceLimitExceededException - You have encountered a service limit on the specified resource.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.UnsupportedAvailabilityZoneException - At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon
EKS. The exception output specifies the supported Availability Zones for your account, from which you can
choose subnets for your cluster.CreateEksAnywhereSubscriptionResult createEksAnywhereSubscription(CreateEksAnywhereSubscriptionRequest createEksAnywhereSubscriptionRequest)
Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.
createEksAnywhereSubscriptionRequest - ResourceLimitExceededException - You have encountered a service limit on the specified resource.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.CreateFargateProfileResult createFargateProfile(CreateFargateProfileRequest createFargateProfileRequest)
Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled
with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for
authorization so that the kubelet that is running on the Fargate infrastructure can register with
your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM
permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more
information, see Pod Execution
Role in the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate
profile to finish deleting before you can create any other profiles in that cluster.
For more information, see Fargate profile in the Amazon EKS User Guide.
createFargateProfileRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.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.ServerException - These errors are usually caused by a server-side issue.ResourceLimitExceededException - You have encountered a service limit on the specified resource.UnsupportedAvailabilityZoneException - At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon
EKS. The exception output specifies the supported Availability Zones for your account, from which you can
choose subnets for your cluster.CreateNodegroupResult createNodegroup(CreateNodegroupRequest createNodegroupRequest)
Creates a managed node group for an Amazon EKS cluster.
You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Customizing managed nodes with launch templates.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.
Windows AMI types are only supported for commercial Amazon Web Services Regions that support Windows on Amazon EKS.
createNodegroupRequest - ResourceInUseException - The specified resource is in use.ResourceLimitExceededException - You have encountered a service limit on the specified resource.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.CreatePodIdentityAssociationResult createPodIdentityAssociation(CreatePodIdentityAssociationRequest createPodIdentityAssociationRequest)
Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to pods and the credentials are rotated automatically.
Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.
If a pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the pod. The environment variables configure the Amazon Web Services SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials.
Pod Identity is a simpler method than IAM roles for service accounts, as this method doesn't use OIDC identity providers. Additionally, you can configure a role for Pod Identity once, and reuse it across clusters.
createPodIdentityAssociationRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ResourceLimitExceededException - You have encountered a service limit on the specified resource.ResourceInUseException - The specified resource is in use.DeleteAccessEntryResult deleteAccessEntry(DeleteAccessEntryRequest deleteAccessEntryRequest)
Deletes an access entry.
Deleting an access entry of a type other than Standard can cause your cluster to function
improperly. If you delete an access entry in error, you can recreate it.
deleteAccessEntryRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.DeleteAddonResult deleteAddon(DeleteAddonRequest deleteAddonRequest)
Deletes an Amazon EKS add-on.
When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
deleteAddonRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.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 Amazon Web Services Region specific.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.ServerException - These errors are usually caused by a server-side issue.DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes an Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more
information, see DeleteNodgroup and DeleteFargateProfile.
deleteClusterRequest - ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.DeleteEksAnywhereSubscriptionResult deleteEksAnywhereSubscription(DeleteEksAnywhereSubscriptionRequest deleteEksAnywhereSubscriptionRequest)
Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating a ticket in the Amazon Web Services Support Center.
deleteEksAnywhereSubscriptionRequest - 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 Amazon Web Services Region specific.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.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.ServerException - These errors are usually caused by a server-side issue.DeleteFargateProfileResult deleteFargateProfile(DeleteFargateProfileRequest deleteFargateProfileRequest)
Deletes an Fargate profile.
When you delete a Fargate profile, any Pod running on Fargate that was created with the profile is
deleted. If the Pod matches another Fargate profile, then it is scheduled on Fargate with that
profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and may remain in a
pending state.
Only one Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a
Fargate profile to finish deleting before you can delete any other profiles in that cluster.
deleteFargateProfileRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.DeleteNodegroupResult deleteNodegroup(DeleteNodegroupRequest deleteNodegroupRequest)
Deletes a managed node group.
deleteNodegroupRequest - ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.DeletePodIdentityAssociationResult deletePodIdentityAssociation(DeletePodIdentityAssociationRequest deletePodIdentityAssociationRequest)
Deletes a EKS Pod Identity association.
The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console.
deletePodIdentityAssociationRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.DeregisterClusterResult deregisterCluster(DeregisterClusterRequest deregisterClusterRequest)
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector.
deregisterClusterRequest - ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.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.DescribeAccessEntryResult describeAccessEntry(DescribeAccessEntryRequest describeAccessEntryRequest)
Describes an access entry.
describeAccessEntryRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.DescribeAddonResult describeAddon(DescribeAddonRequest describeAddonRequest)
Describes an Amazon EKS add-on.
describeAddonRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.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 Amazon Web Services Region specific.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.ServerException - These errors are usually caused by a server-side issue.DescribeAddonConfigurationResult describeAddonConfiguration(DescribeAddonConfigurationRequest describeAddonConfigurationRequest)
Returns configuration options.
describeAddonConfigurationRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.DescribeAddonVersionsResult describeAddonVersions(DescribeAddonVersionsRequest describeAddonVersionsRequest)
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.
describeAddonVersionsRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)
Describes an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for
kubelet and kubectl to communicate with your Kubernetes API server. For more
information, see Creating or
updating a kubeconfig file for an Amazon EKS cluster.
The API server endpoint and certificate authority data aren't available until the cluster reaches the
ACTIVE state.
describeClusterRequest - 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 Amazon Web Services Region specific.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.DescribeEksAnywhereSubscriptionResult describeEksAnywhereSubscription(DescribeEksAnywhereSubscriptionRequest describeEksAnywhereSubscriptionRequest)
Returns descriptive information about a subscription.
describeEksAnywhereSubscriptionRequest - 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 Amazon Web Services Region specific.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.DescribeFargateProfileResult describeFargateProfile(DescribeFargateProfileRequest describeFargateProfileRequest)
Describes an Fargate profile.
describeFargateProfileRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.DescribeIdentityProviderConfigResult describeIdentityProviderConfig(DescribeIdentityProviderConfigRequest describeIdentityProviderConfigRequest)
Describes an identity provider configuration.
describeIdentityProviderConfigRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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 Amazon Web Services Region specific.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.DescribeInsightResult describeInsight(DescribeInsightRequest describeInsightRequest)
Returns details about an insight that you specify using its ID.
describeInsightRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.DescribeNodegroupResult describeNodegroup(DescribeNodegroupRequest describeNodegroupRequest)
Describes a managed node group.
describeNodegroupRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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 Amazon Web Services Region specific.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.DescribePodIdentityAssociationResult describePodIdentityAssociation(DescribePodIdentityAssociationRequest describePodIdentityAssociationRequest)
Returns descriptive information about an EKS Pod Identity association.
This action requires the ID of the association. You can get the ID from the response to the
CreatePodIdentityAssocation for newly created associations. Or, you can list the IDs for
associations with ListPodIdentityAssociations and filter the list by namespace or service account.
describePodIdentityAssociationRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.DescribeUpdateResult describeUpdate(DescribeUpdateRequest describeUpdateRequest)
Describes an update to an Amazon EKS resource.
When the status of the update is Succeeded, the update is complete. If an update fails, the status
is Failed, and an error detail explains the reason for the failure.
describeUpdateRequest - Describes an update request.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.DisassociateAccessPolicyResult disassociateAccessPolicy(DisassociateAccessPolicyRequest disassociateAccessPolicyRequest)
Disassociates an access policy from an access entry.
disassociateAccessPolicyRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.DisassociateIdentityProviderConfigResult disassociateIdentityProviderConfig(DisassociateIdentityProviderConfigRequest disassociateIdentityProviderConfigRequest)
Disassociates an identity provider configuration from a cluster.
If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with IAM principals.
disassociateIdentityProviderConfigRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.ListAccessEntriesResult listAccessEntries(ListAccessEntriesRequest listAccessEntriesRequest)
Lists the access entries for your cluster.
listAccessEntriesRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
Lists the available access policies.
listAccessPoliciesRequest - ServerException - These errors are usually caused by a server-side issue.ListAddonsResult listAddons(ListAddonsRequest listAddonsRequest)
Lists the installed add-ons.
listAddonsRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.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.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 Amazon Web Services Region specific.ServerException - These errors are usually caused by a server-side issue.ListAssociatedAccessPoliciesResult listAssociatedAccessPolicies(ListAssociatedAccessPoliciesRequest listAssociatedAccessPoliciesRequest)
Lists the access policies associated with an access entry.
listAssociatedAccessPoliciesRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.ListClustersResult listClusters(ListClustersRequest listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.
listClustersRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.ListEksAnywhereSubscriptionsResult listEksAnywhereSubscriptions(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest)
Displays the full description of the subscription.
listEksAnywhereSubscriptionsRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.ListFargateProfilesResult listFargateProfiles(ListFargateProfilesRequest listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.
listFargateProfilesRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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 Amazon Web Services Region specific.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.ServerException - These errors are usually caused by a server-side issue.ListIdentityProviderConfigsResult listIdentityProviderConfigs(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest)
Lists the identity provider configurations for your cluster.
listIdentityProviderConfigsRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.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 Amazon Web Services Region specific.ListInsightsResult listInsights(ListInsightsRequest listInsightsRequest)
Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.
listInsightsRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ListNodegroupsResult listNodegroups(ListNodegroupsRequest listNodegroupsRequest)
Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed.
listNodegroupsRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.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 Amazon Web Services Region specific.ListPodIdentityAssociationsResult listPodIdentityAssociations(ListPodIdentityAssociationsRequest listPodIdentityAssociationsRequest)
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.
listPodIdentityAssociationsRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon EKS resource.
listTagsForResourceRequest - BadRequestException - This exception is thrown if the request contains a semantic error. The precise meaning will depend on the
API, and will be documented in the error message.NotFoundException - A service resource associated with the request could not be found. Clients should not retry such
requests.ListUpdatesResult listUpdates(ListUpdatesRequest listUpdatesRequest)
Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.
listUpdatesRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.RegisterClusterResult registerCluster(RegisterClusterRequest registerClusterRequest)
Connects a Kubernetes cluster to the Amazon EKS control plane.
Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.
Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to
the Amazon EKS control plane.
Second, a Manifest containing the activationID and activationCode must be applied to the
Kubernetes cluster through it's native provider to provide visibility.
After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If
the manifest isn't applied within three days, the connected cluster will no longer be visible and must be
deregistered using DeregisterCluster.
registerClusterRequest - ResourceLimitExceededException - You have encountered a service limit on the specified resource.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.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.ResourceInUseException - The specified resource is in use.ResourcePropagationDelayException - Required resources (such as service-linked roles) were created and are still propagating. Retry later.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to an Amazon EKS resource with the specified resourceArn. If existing
tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted,
the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't
propagate to any other resources associated with the cluster. For example, if you tag a cluster with this
operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster.
tagResourceRequest - BadRequestException - This exception is thrown if the request contains a semantic error. The precise meaning will depend on the
API, and will be documented in the error message.NotFoundException - A service resource associated with the request could not be found. Clients should not retry such
requests.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from an Amazon EKS resource.
untagResourceRequest - BadRequestException - This exception is thrown if the request contains a semantic error. The precise meaning will depend on the
API, and will be documented in the error message.NotFoundException - A service resource associated with the request could not be found. Clients should not retry such
requests.UpdateAccessEntryResult updateAccessEntry(UpdateAccessEntryRequest updateAccessEntryRequest)
Updates an access entry.
updateAccessEntryRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.UpdateAddonResult updateAddon(UpdateAddonRequest updateAddonRequest)
Updates an Amazon EKS add-on.
updateAddonRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.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 Amazon Web Services Region specific.ResourceInUseException - The specified resource is in use.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.ServerException - These errors are usually caused by a server-side issue.UpdateClusterConfigResult updateClusterConfig(UpdateClusterConfigRequest updateClusterConfigRequest)
Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response
output includes an update ID that you can use to track the status of your cluster update with
DescribeUpdate"/>.
You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https ://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide .
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster
status moves to UPDATING (this status transition is eventually consistent). When the update is
complete (either Failed or Successful), the cluster status moves to Active
.
updateClusterConfigRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.UpdateClusterVersionResult updateClusterVersion(UpdateClusterVersionRequest updateClusterVersionRequest)
Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster
status moves to UPDATING (this status transition is eventually consistent). When the update is
complete (either Failed or Successful), the cluster status moves to Active
.
If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
updateClusterVersionRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.UpdateEksAnywhereSubscriptionResult updateEksAnywhereSubscription(UpdateEksAnywhereSubscriptionRequest updateEksAnywhereSubscriptionRequest)
Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.
updateEksAnywhereSubscriptionRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.UpdateNodegroupConfigResult updateNodegroupConfig(UpdateNodegroupConfigRequest updateNodegroupConfigRequest)
Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
updateNodegroupConfigRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.UpdateNodegroupVersionResult updateNodegroupVersion(UpdateNodegroupVersionRequest updateNodegroupVersionRequest)
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling action or update, every Pod on
that node is drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do
so. You can force the update if Amazon EKS is unable to drain the nodes as a result of a
Pod disruption budget issue.
updateNodegroupVersionRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.ServerException - These errors are usually caused by a server-side issue.ResourceInUseException - The specified resource is in use.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.UpdatePodIdentityAssociationResult updatePodIdentityAssociation(UpdatePodIdentityAssociationRequest updatePodIdentityAssociationRequest)
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.
updatePodIdentityAssociationRequest - ServerException - These errors are usually caused by a server-side issue.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 Amazon Web Services Region specific.InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.AmazonEKSWaiters waiters()