Interface EksClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EksClient extends AwsClient
Service client for accessing Amazon EKS. This can be created using the staticbuilder()method.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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateAccessPolicy
default AssociateAccessPolicyResponse associateAccessPolicy(AssociateAccessPolicyRequest associateAccessPolicyRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
associateAccessPolicyRequest-- Returns:
- Result of the AssociateAccessPolicy operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateAccessPolicy
default AssociateAccessPolicyResponse associateAccessPolicy(Consumer<AssociateAccessPolicyRequest.Builder> associateAccessPolicyRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
AssociateAccessPolicyRequest.Builderavoiding the need to create one manually viaAssociateAccessPolicyRequest.builder()- Parameters:
associateAccessPolicyRequest- AConsumerthat will call methods onAssociateAccessPolicyRequest.Builderto create a request.- Returns:
- Result of the AssociateAccessPolicy operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateEncryptionConfig
default AssociateEncryptionConfigResponse associateEncryptionConfig(AssociateEncryptionConfigRequest associateEncryptionConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
associateEncryptionConfigRequest-- Returns:
- Result of the AssociateEncryptionConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateEncryptionConfig
default AssociateEncryptionConfigResponse associateEncryptionConfig(Consumer<AssociateEncryptionConfigRequest.Builder> associateEncryptionConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
AssociateEncryptionConfigRequest.Builderavoiding the need to create one manually viaAssociateEncryptionConfigRequest.builder()- Parameters:
associateEncryptionConfigRequest- AConsumerthat will call methods onAssociateEncryptionConfigRequest.Builderto create a request.- Returns:
- Result of the AssociateEncryptionConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateIdentityProviderConfig
default AssociateIdentityProviderConfigResponse associateIdentityProviderConfig(AssociateIdentityProviderConfigRequest associateIdentityProviderConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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
RoleandClusterRoleobjects, assign permissions to them, and then bind them to the identities using KubernetesRoleBindingandClusterRoleBindingobjects. For more information see Using RBAC Authorization in the Kubernetes documentation.- Parameters:
associateIdentityProviderConfigRequest-- Returns:
- Result of the AssociateIdentityProviderConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
associateIdentityProviderConfig
default AssociateIdentityProviderConfigResponse associateIdentityProviderConfig(Consumer<AssociateIdentityProviderConfigRequest.Builder> associateIdentityProviderConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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
RoleandClusterRoleobjects, assign permissions to them, and then bind them to the identities using KubernetesRoleBindingandClusterRoleBindingobjects. For more information see Using RBAC Authorization in the Kubernetes documentation.
This is a convenience which creates an instance of the
AssociateIdentityProviderConfigRequest.Builderavoiding the need to create one manually viaAssociateIdentityProviderConfigRequest.builder()- Parameters:
associateIdentityProviderConfigRequest- AConsumerthat will call methods onAssociateIdentityProviderConfigRequest.Builderto create a request.- Returns:
- Result of the AssociateIdentityProviderConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAccessEntry
default CreateAccessEntryResponse createAccessEntry(CreateAccessEntryRequest createAccessEntryRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, EksException
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-authConfigMapfor 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 KubernetesRole,ClusterRole,RoleBinding, andClusterRoleBindingobjects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage KubernetesRole,ClusterRole,RoleBinding, andClusterRoleBindingobjects.For more information about access entries, see Access entries in the Amazon EKS User Guide.
- Parameters:
createAccessEntryRequest-- Returns:
- Result of the CreateAccessEntry operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAccessEntry
default CreateAccessEntryResponse createAccessEntry(Consumer<CreateAccessEntryRequest.Builder> createAccessEntryRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, EksException
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-authConfigMapfor 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 KubernetesRole,ClusterRole,RoleBinding, andClusterRoleBindingobjects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage KubernetesRole,ClusterRole,RoleBinding, andClusterRoleBindingobjects.For more information about access entries, see Access entries in the Amazon EKS User Guide.
This is a convenience which creates an instance of the
CreateAccessEntryRequest.Builderavoiding the need to create one manually viaCreateAccessEntryRequest.builder()- Parameters:
createAccessEntryRequest- AConsumerthat will call methods onCreateAccessEntryRequest.Builderto create a request.- Returns:
- Result of the CreateAccessEntry operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAddon
default CreateAddonResponse createAddon(CreateAddonRequest createAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
createAddonRequest-- Returns:
- Result of the CreateAddon operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAddon
default CreateAddonResponse createAddon(Consumer<CreateAddonRequest.Builder> createAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
CreateAddonRequest.Builderavoiding the need to create one manually viaCreateAddonRequest.builder()- Parameters:
createAddonRequest- AConsumerthat will call methods onCreateAddonRequest.Builderto create a request.- Returns:
- Result of the CreateAddon operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createCluster
default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws ResourceInUseException, ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EksException
Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as
etcdand 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, andproxydata 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
endpointPublicAccessandendpointPrivateAccessparameters 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
loggingparameter 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.
- Parameters:
createClusterRequest-- Returns:
- Result of the CreateCluster operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createCluster
default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws ResourceInUseException, ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EksException
Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as
etcdand 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, andproxydata 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
endpointPublicAccessandendpointPrivateAccessparameters 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
loggingparameter 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.
This is a convenience which creates an instance of the
CreateClusterRequest.Builderavoiding the need to create one manually viaCreateClusterRequest.builder()- Parameters:
createClusterRequest- AConsumerthat will call methods onCreateClusterRequest.Builderto create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createEksAnywhereSubscription
default CreateEksAnywhereSubscriptionResponse createEksAnywhereSubscription(CreateEksAnywhereSubscriptionRequest createEksAnywhereSubscriptionRequest) throws ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
createEksAnywhereSubscriptionRequest-- Returns:
- Result of the CreateEksAnywhereSubscription operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createEksAnywhereSubscription
default CreateEksAnywhereSubscriptionResponse createEksAnywhereSubscription(Consumer<CreateEksAnywhereSubscriptionRequest.Builder> createEksAnywhereSubscriptionRequest) throws ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
CreateEksAnywhereSubscriptionRequest.Builderavoiding the need to create one manually viaCreateEksAnywhereSubscriptionRequest.builder()- Parameters:
createEksAnywhereSubscriptionRequest- AConsumerthat will call methods onCreateEksAnywhereSubscriptionRequest.Builderto create a request.- Returns:
- Result of the CreateEksAnywhereSubscription operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createFargateProfile
default CreateFargateProfileResponse createFargateProfile(CreateFargateProfileRequest createFargateProfileRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ServerException, ResourceLimitExceededException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EksException
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
kubeletthat 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
DELETINGstatus, 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.
- Parameters:
createFargateProfileRequest-- Returns:
- Result of the CreateFargateProfile operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createFargateProfile
default CreateFargateProfileResponse createFargateProfile(Consumer<CreateFargateProfileRequest.Builder> createFargateProfileRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ServerException, ResourceLimitExceededException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EksException
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
kubeletthat 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
DELETINGstatus, 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.
This is a convenience which creates an instance of the
CreateFargateProfileRequest.Builderavoiding the need to create one manually viaCreateFargateProfileRequest.builder()- Parameters:
createFargateProfileRequest- AConsumerthat will call methods onCreateFargateProfileRequest.Builderto create a request.- Returns:
- Result of the CreateFargateProfile operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createNodegroup
default CreateNodegroupResponse createNodegroup(CreateNodegroupRequest createNodegroupRequest) throws ResourceInUseException, ResourceLimitExceededException, InvalidRequestException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
createNodegroupRequest-- Returns:
- Result of the CreateNodegroup operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createNodegroup
default CreateNodegroupResponse createNodegroup(Consumer<CreateNodegroupRequest.Builder> createNodegroupRequest) throws ResourceInUseException, ResourceLimitExceededException, InvalidRequestException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
CreateNodegroupRequest.Builderavoiding the need to create one manually viaCreateNodegroupRequest.builder()- Parameters:
createNodegroupRequest- AConsumerthat will call methods onCreateNodegroupRequest.Builderto create a request.- Returns:
- Result of the CreateNodegroup operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPodIdentityAssociation
default CreatePodIdentityAssociationResponse createPodIdentityAssociation(CreatePodIdentityAssociationRequest createPodIdentityAssociationRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
createPodIdentityAssociationRequest-- Returns:
- Result of the CreatePodIdentityAssociation operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPodIdentityAssociation
default CreatePodIdentityAssociationResponse createPodIdentityAssociation(Consumer<CreatePodIdentityAssociationRequest.Builder> createPodIdentityAssociationRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
CreatePodIdentityAssociationRequest.Builderavoiding the need to create one manually viaCreatePodIdentityAssociationRequest.builder()- Parameters:
createPodIdentityAssociationRequest- AConsumerthat will call methods onCreatePodIdentityAssociationRequest.Builderto create a request.- Returns:
- Result of the CreatePodIdentityAssociation operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccessEntry
default DeleteAccessEntryResponse deleteAccessEntry(DeleteAccessEntryRequest deleteAccessEntryRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Deletes an access entry.
Deleting an access entry of a type other than
Standardcan cause your cluster to function improperly. If you delete an access entry in error, you can recreate it.- Parameters:
deleteAccessEntryRequest-- Returns:
- Result of the DeleteAccessEntry operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccessEntry
default DeleteAccessEntryResponse deleteAccessEntry(Consumer<DeleteAccessEntryRequest.Builder> deleteAccessEntryRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Deletes an access entry.
Deleting an access entry of a type other than
Standardcan cause your cluster to function improperly. If you delete an access entry in error, you can recreate it.
This is a convenience which creates an instance of the
DeleteAccessEntryRequest.Builderavoiding the need to create one manually viaDeleteAccessEntryRequest.builder()- Parameters:
deleteAccessEntryRequest- AConsumerthat will call methods onDeleteAccessEntryRequest.Builderto create a request.- Returns:
- Result of the DeleteAccessEntry operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAddon
default DeleteAddonResponse deleteAddon(DeleteAddonRequest deleteAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
deleteAddonRequest-- Returns:
- Result of the DeleteAddon operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAddon
default DeleteAddonResponse deleteAddon(Consumer<DeleteAddonRequest.Builder> deleteAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
DeleteAddonRequest.Builderavoiding the need to create one manually viaDeleteAddonRequest.builder()- Parameters:
deleteAddonRequest- AConsumerthat will call methods onDeleteAddonRequest.Builderto create a request.- Returns:
- Result of the DeleteAddon operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCluster
default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws ResourceInUseException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
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
DeleteNodgroupandDeleteFargateProfile.- Parameters:
deleteClusterRequest-- Returns:
- Result of the DeleteCluster operation returned by the service.
- Throws:
ResourceInUseException- The specified resource is in use.ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCluster
default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws ResourceInUseException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
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
DeleteNodgroupandDeleteFargateProfile.
This is a convenience which creates an instance of the
DeleteClusterRequest.Builderavoiding the need to create one manually viaDeleteClusterRequest.builder()- Parameters:
deleteClusterRequest- AConsumerthat will call methods onDeleteClusterRequest.Builderto create a request.- Returns:
- Result of the DeleteCluster operation returned by the service.
- Throws:
ResourceInUseException- The specified resource is in use.ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEksAnywhereSubscription
default DeleteEksAnywhereSubscriptionResponse deleteEksAnywhereSubscription(DeleteEksAnywhereSubscriptionRequest deleteEksAnywhereSubscriptionRequest) throws ResourceNotFoundException, ClientException, InvalidRequestException, ServerException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
deleteEksAnywhereSubscriptionRequest-- Returns:
- Result of the DeleteEksAnywhereSubscription operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEksAnywhereSubscription
default DeleteEksAnywhereSubscriptionResponse deleteEksAnywhereSubscription(Consumer<DeleteEksAnywhereSubscriptionRequest.Builder> deleteEksAnywhereSubscriptionRequest) throws ResourceNotFoundException, ClientException, InvalidRequestException, ServerException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
DeleteEksAnywhereSubscriptionRequest.Builderavoiding the need to create one manually viaDeleteEksAnywhereSubscriptionRequest.builder()- Parameters:
deleteEksAnywhereSubscriptionRequest- AConsumerthat will call methods onDeleteEksAnywhereSubscriptionRequest.Builderto create a request.- Returns:
- Result of the DeleteEksAnywhereSubscription operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFargateProfile
default DeleteFargateProfileResponse deleteFargateProfile(DeleteFargateProfileRequest deleteFargateProfileRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
Deletes an Fargate profile.
When you delete a Fargate profile, any
Podrunning on Fargate that was created with the profile is deleted. If thePodmatches 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
DELETINGstatus at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.- Parameters:
deleteFargateProfileRequest-- Returns:
- Result of the DeleteFargateProfile operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFargateProfile
default DeleteFargateProfileResponse deleteFargateProfile(Consumer<DeleteFargateProfileRequest.Builder> deleteFargateProfileRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
Deletes an Fargate profile.
When you delete a Fargate profile, any
Podrunning on Fargate that was created with the profile is deleted. If thePodmatches 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
DELETINGstatus at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.
This is a convenience which creates an instance of the
DeleteFargateProfileRequest.Builderavoiding the need to create one manually viaDeleteFargateProfileRequest.builder()- Parameters:
deleteFargateProfileRequest- AConsumerthat will call methods onDeleteFargateProfileRequest.Builderto create a request.- Returns:
- Result of the DeleteFargateProfile operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNodegroup
default DeleteNodegroupResponse deleteNodegroup(DeleteNodegroupRequest deleteNodegroupRequest) throws ResourceInUseException, ResourceNotFoundException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Deletes a managed node group.
- Parameters:
deleteNodegroupRequest-- Returns:
- Result of the DeleteNodegroup operation returned by the service.
- Throws:
ResourceInUseException- The specified resource is in use.ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNodegroup
default DeleteNodegroupResponse deleteNodegroup(Consumer<DeleteNodegroupRequest.Builder> deleteNodegroupRequest) throws ResourceInUseException, ResourceNotFoundException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Deletes a managed node group.
This is a convenience which creates an instance of the
DeleteNodegroupRequest.Builderavoiding the need to create one manually viaDeleteNodegroupRequest.builder()- Parameters:
deleteNodegroupRequest- AConsumerthat will call methods onDeleteNodegroupRequest.Builderto create a request.- Returns:
- Result of the DeleteNodegroup operation returned by the service.
- Throws:
ResourceInUseException- The specified resource is in use.ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePodIdentityAssociation
default DeletePodIdentityAssociationResponse deletePodIdentityAssociation(DeletePodIdentityAssociationRequest deletePodIdentityAssociationRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
deletePodIdentityAssociationRequest-- Returns:
- Result of the DeletePodIdentityAssociation operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePodIdentityAssociation
default DeletePodIdentityAssociationResponse deletePodIdentityAssociation(Consumer<DeletePodIdentityAssociationRequest.Builder> deletePodIdentityAssociationRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
DeletePodIdentityAssociationRequest.Builderavoiding the need to create one manually viaDeletePodIdentityAssociationRequest.builder()- Parameters:
deletePodIdentityAssociationRequest- AConsumerthat will call methods onDeletePodIdentityAssociationRequest.Builderto create a request.- Returns:
- Result of the DeletePodIdentityAssociation operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterCluster
default DeregisterClusterResponse deregisterCluster(DeregisterClusterRequest deregisterClusterRequest) throws ResourceInUseException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
deregisterClusterRequest-- Returns:
- Result of the DeregisterCluster operation returned by the service.
- Throws:
ResourceInUseException- The specified resource is in use.ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterCluster
default DeregisterClusterResponse deregisterCluster(Consumer<DeregisterClusterRequest.Builder> deregisterClusterRequest) throws ResourceInUseException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
DeregisterClusterRequest.Builderavoiding the need to create one manually viaDeregisterClusterRequest.builder()- Parameters:
deregisterClusterRequest- AConsumerthat will call methods onDeregisterClusterRequest.Builderto create a request.- Returns:
- Result of the DeregisterCluster operation returned by the service.
- Throws:
ResourceInUseException- The specified resource is in use.ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccessEntry
default DescribeAccessEntryResponse describeAccessEntry(DescribeAccessEntryRequest describeAccessEntryRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Describes an access entry.
- Parameters:
describeAccessEntryRequest-- Returns:
- Result of the DescribeAccessEntry operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccessEntry
default DescribeAccessEntryResponse describeAccessEntry(Consumer<DescribeAccessEntryRequest.Builder> describeAccessEntryRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Describes an access entry.
This is a convenience which creates an instance of the
DescribeAccessEntryRequest.Builderavoiding the need to create one manually viaDescribeAccessEntryRequest.builder()- Parameters:
describeAccessEntryRequest- AConsumerthat will call methods onDescribeAccessEntryRequest.Builderto create a request.- Returns:
- Result of the DescribeAccessEntry operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAddon
default DescribeAddonResponse describeAddon(DescribeAddonRequest describeAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
Describes an Amazon EKS add-on.
- Parameters:
describeAddonRequest-- Returns:
- Result of the DescribeAddon operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAddon
default DescribeAddonResponse describeAddon(Consumer<DescribeAddonRequest.Builder> describeAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
Describes an Amazon EKS add-on.
This is a convenience which creates an instance of the
DescribeAddonRequest.Builderavoiding the need to create one manually viaDescribeAddonRequest.builder()- Parameters:
describeAddonRequest- AConsumerthat will call methods onDescribeAddonRequest.Builderto create a request.- Returns:
- Result of the DescribeAddon operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAddonConfiguration
default DescribeAddonConfigurationResponse describeAddonConfiguration(DescribeAddonConfigurationRequest describeAddonConfigurationRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
Returns configuration options.
- Parameters:
describeAddonConfigurationRequest-- Returns:
- Result of the DescribeAddonConfiguration operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAddonConfiguration
default DescribeAddonConfigurationResponse describeAddonConfiguration(Consumer<DescribeAddonConfigurationRequest.Builder> describeAddonConfigurationRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
Returns configuration options.
This is a convenience which creates an instance of the
DescribeAddonConfigurationRequest.Builderavoiding the need to create one manually viaDescribeAddonConfigurationRequest.builder()- Parameters:
describeAddonConfigurationRequest- AConsumerthat will call methods onDescribeAddonConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeAddonConfiguration operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAddonVersions
default DescribeAddonVersionsResponse describeAddonVersions(DescribeAddonVersionsRequest describeAddonVersionsRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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 thetypeof the add-on are returned.- Parameters:
describeAddonVersionsRequest-- Returns:
- Result of the DescribeAddonVersions operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAddonVersions
default DescribeAddonVersionsResponse describeAddonVersions(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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 thetypeof the add-on are returned.
This is a convenience which creates an instance of the
DescribeAddonVersionsRequest.Builderavoiding the need to create one manually viaDescribeAddonVersionsRequest.builder()- Parameters:
describeAddonVersionsRequest- AConsumerthat will call methods onDescribeAddonVersionsRequest.Builderto create a request.- Returns:
- Result of the DescribeAddonVersions operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAddonVersionsPaginator
default DescribeAddonVersionsIterable describeAddonVersionsPaginator(DescribeAddonVersionsRequest describeAddonVersionsRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
This is a variant of
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client.describeAddonVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client .describeAddonVersionsPaginator(request); for (software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client.describeAddonVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)operation.- Parameters:
describeAddonVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAddonVersionsPaginator
default DescribeAddonVersionsIterable describeAddonVersionsPaginator(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
This is a variant of
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client.describeAddonVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client .describeAddonVersionsPaginator(request); for (software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client.describeAddonVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)operation.
This is a convenience which creates an instance of the
DescribeAddonVersionsRequest.Builderavoiding the need to create one manually viaDescribeAddonVersionsRequest.builder()- Parameters:
describeAddonVersionsRequest- AConsumerthat will call methods onDescribeAddonVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCluster
default DescribeClusterResponse describeCluster(DescribeClusterRequest describeClusterRequest) throws ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Describes an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for
kubeletandkubectlto communicate with your Kubernetes API server. For more information, see Creating or updating akubeconfigfile for an Amazon EKS cluster.The API server endpoint and certificate authority data aren't available until the cluster reaches the
ACTIVEstate.- Parameters:
describeClusterRequest-- Returns:
- Result of the DescribeCluster operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCluster
default DescribeClusterResponse describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) throws ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Describes an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for
kubeletandkubectlto communicate with your Kubernetes API server. For more information, see Creating or updating akubeconfigfile for an Amazon EKS cluster.The API server endpoint and certificate authority data aren't available until the cluster reaches the
ACTIVEstate.
This is a convenience which creates an instance of the
DescribeClusterRequest.Builderavoiding the need to create one manually viaDescribeClusterRequest.builder()- Parameters:
describeClusterRequest- AConsumerthat will call methods onDescribeClusterRequest.Builderto create a request.- Returns:
- Result of the DescribeCluster operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterVersions
default DescribeClusterVersionsResponse describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest) throws ServerException, InvalidParameterException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Lists available Kubernetes versions for Amazon EKS clusters.
- Parameters:
describeClusterVersionsRequest-- Returns:
- Result of the DescribeClusterVersions operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterVersions
default DescribeClusterVersionsResponse describeClusterVersions(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) throws ServerException, InvalidParameterException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Lists available Kubernetes versions for Amazon EKS clusters.
This is a convenience which creates an instance of the
DescribeClusterVersionsRequest.Builderavoiding the need to create one manually viaDescribeClusterVersionsRequest.builder()- Parameters:
describeClusterVersionsRequest- AConsumerthat will call methods onDescribeClusterVersionsRequest.Builderto create a request.- Returns:
- Result of the DescribeClusterVersions operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterVersionsPaginator
default DescribeClusterVersionsIterable describeClusterVersionsPaginator(DescribeClusterVersionsRequest describeClusterVersionsRequest) throws ServerException, InvalidParameterException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
This is a variant of
describeClusterVersions(software.amazon.awssdk.services.eks.model.DescribeClusterVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.DescribeClusterVersionsIterable responses = client .describeClusterVersionsPaginator(request); for (software.amazon.awssdk.services.eks.model.DescribeClusterVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.eks.model.DescribeClusterVersionsRequest)operation.- Parameters:
describeClusterVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeClusterVersionsPaginator
default DescribeClusterVersionsIterable describeClusterVersionsPaginator(Consumer<DescribeClusterVersionsRequest.Builder> describeClusterVersionsRequest) throws ServerException, InvalidParameterException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
This is a variant of
describeClusterVersions(software.amazon.awssdk.services.eks.model.DescribeClusterVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.DescribeClusterVersionsIterable responses = client .describeClusterVersionsPaginator(request); for (software.amazon.awssdk.services.eks.model.DescribeClusterVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.DescribeClusterVersionsIterable responses = client.describeClusterVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusterVersions(software.amazon.awssdk.services.eks.model.DescribeClusterVersionsRequest)operation.
This is a convenience which creates an instance of the
DescribeClusterVersionsRequest.Builderavoiding the need to create one manually viaDescribeClusterVersionsRequest.builder()- Parameters:
describeClusterVersionsRequest- AConsumerthat will call methods onDescribeClusterVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEksAnywhereSubscription
default DescribeEksAnywhereSubscriptionResponse describeEksAnywhereSubscription(DescribeEksAnywhereSubscriptionRequest describeEksAnywhereSubscriptionRequest) throws ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Returns descriptive information about a subscription.
- Parameters:
describeEksAnywhereSubscriptionRequest-- Returns:
- Result of the DescribeEksAnywhereSubscription operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEksAnywhereSubscription
default DescribeEksAnywhereSubscriptionResponse describeEksAnywhereSubscription(Consumer<DescribeEksAnywhereSubscriptionRequest.Builder> describeEksAnywhereSubscriptionRequest) throws ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Returns descriptive information about a subscription.
This is a convenience which creates an instance of the
DescribeEksAnywhereSubscriptionRequest.Builderavoiding the need to create one manually viaDescribeEksAnywhereSubscriptionRequest.builder()- Parameters:
describeEksAnywhereSubscriptionRequest- AConsumerthat will call methods onDescribeEksAnywhereSubscriptionRequest.Builderto create a request.- Returns:
- Result of the DescribeEksAnywhereSubscription operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource could not be found. You can view your available clusters withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeFargateProfile
default DescribeFargateProfileResponse describeFargateProfile(DescribeFargateProfileRequest describeFargateProfileRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
Describes an Fargate profile.
- Parameters:
describeFargateProfileRequest-- Returns:
- Result of the DescribeFargateProfile operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeFargateProfile
default DescribeFargateProfileResponse describeFargateProfile(Consumer<DescribeFargateProfileRequest.Builder> describeFargateProfileRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
Describes an Fargate profile.
This is a convenience which creates an instance of the
DescribeFargateProfileRequest.Builderavoiding the need to create one manually viaDescribeFargateProfileRequest.builder()- Parameters:
describeFargateProfileRequest- AConsumerthat will call methods onDescribeFargateProfileRequest.Builderto create a request.- Returns:
- Result of the DescribeFargateProfile operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeIdentityProviderConfig
default DescribeIdentityProviderConfigResponse describeIdentityProviderConfig(DescribeIdentityProviderConfigRequest describeIdentityProviderConfigRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Describes an identity provider configuration.
- Parameters:
describeIdentityProviderConfigRequest-- Returns:
- Result of the DescribeIdentityProviderConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeIdentityProviderConfig
default DescribeIdentityProviderConfigResponse describeIdentityProviderConfig(Consumer<DescribeIdentityProviderConfigRequest.Builder> describeIdentityProviderConfigRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Describes an identity provider configuration.
This is a convenience which creates an instance of the
DescribeIdentityProviderConfigRequest.Builderavoiding the need to create one manually viaDescribeIdentityProviderConfigRequest.builder()- Parameters:
describeIdentityProviderConfigRequest- AConsumerthat will call methods onDescribeIdentityProviderConfigRequest.Builderto create a request.- Returns:
- Result of the DescribeIdentityProviderConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeInsight
default DescribeInsightResponse describeInsight(DescribeInsightRequest describeInsightRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
Returns details about an insight that you specify using its ID.
- Parameters:
describeInsightRequest-- Returns:
- Result of the DescribeInsight operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeInsight
default DescribeInsightResponse describeInsight(Consumer<DescribeInsightRequest.Builder> describeInsightRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
Returns details about an insight that you specify using its ID.
This is a convenience which creates an instance of the
DescribeInsightRequest.Builderavoiding the need to create one manually viaDescribeInsightRequest.builder()- Parameters:
describeInsightRequest- AConsumerthat will call methods onDescribeInsightRequest.Builderto create a request.- Returns:
- Result of the DescribeInsight operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeNodegroup
default DescribeNodegroupResponse describeNodegroup(DescribeNodegroupRequest describeNodegroupRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Describes a managed node group.
- Parameters:
describeNodegroupRequest-- Returns:
- Result of the DescribeNodegroup operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeNodegroup
default DescribeNodegroupResponse describeNodegroup(Consumer<DescribeNodegroupRequest.Builder> describeNodegroupRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Describes a managed node group.
This is a convenience which creates an instance of the
DescribeNodegroupRequest.Builderavoiding the need to create one manually viaDescribeNodegroupRequest.builder()- Parameters:
describeNodegroupRequest- AConsumerthat will call methods onDescribeNodegroupRequest.Builderto create a request.- Returns:
- Result of the DescribeNodegroup operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePodIdentityAssociation
default DescribePodIdentityAssociationResponse describePodIdentityAssociation(DescribePodIdentityAssociationRequest describePodIdentityAssociationRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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
CreatePodIdentityAssocationfor newly created associations. Or, you can list the IDs for associations withListPodIdentityAssociationsand filter the list by namespace or service account.- Parameters:
describePodIdentityAssociationRequest-- Returns:
- Result of the DescribePodIdentityAssociation operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePodIdentityAssociation
default DescribePodIdentityAssociationResponse describePodIdentityAssociation(Consumer<DescribePodIdentityAssociationRequest.Builder> describePodIdentityAssociationRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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
CreatePodIdentityAssocationfor newly created associations. Or, you can list the IDs for associations withListPodIdentityAssociationsand filter the list by namespace or service account.
This is a convenience which creates an instance of the
DescribePodIdentityAssociationRequest.Builderavoiding the need to create one manually viaDescribePodIdentityAssociationRequest.builder()- Parameters:
describePodIdentityAssociationRequest- AConsumerthat will call methods onDescribePodIdentityAssociationRequest.Builderto create a request.- Returns:
- Result of the DescribePodIdentityAssociation operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeUpdate
default DescribeUpdateResponse describeUpdate(DescribeUpdateRequest describeUpdateRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
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 isFailed, and an error detail explains the reason for the failure.- Parameters:
describeUpdateRequest- Describes an update request.- Returns:
- Result of the DescribeUpdate operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeUpdate
default DescribeUpdateResponse describeUpdate(Consumer<DescribeUpdateRequest.Builder> describeUpdateRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
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 isFailed, and an error detail explains the reason for the failure.
This is a convenience which creates an instance of the
DescribeUpdateRequest.Builderavoiding the need to create one manually viaDescribeUpdateRequest.builder()- Parameters:
describeUpdateRequest- AConsumerthat will call methods onDescribeUpdateRequest.Builderto create a request. Describes an update request.- Returns:
- Result of the DescribeUpdate operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateAccessPolicy
default DisassociateAccessPolicyResponse disassociateAccessPolicy(DisassociateAccessPolicyRequest disassociateAccessPolicyRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Disassociates an access policy from an access entry.
- Parameters:
disassociateAccessPolicyRequest-- Returns:
- Result of the DisassociateAccessPolicy operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateAccessPolicy
default DisassociateAccessPolicyResponse disassociateAccessPolicy(Consumer<DisassociateAccessPolicyRequest.Builder> disassociateAccessPolicyRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Disassociates an access policy from an access entry.
This is a convenience which creates an instance of the
DisassociateAccessPolicyRequest.Builderavoiding the need to create one manually viaDisassociateAccessPolicyRequest.builder()- Parameters:
disassociateAccessPolicyRequest- AConsumerthat will call methods onDisassociateAccessPolicyRequest.Builderto create a request.- Returns:
- Result of the DisassociateAccessPolicy operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateIdentityProviderConfig
default DisassociateIdentityProviderConfigResponse disassociateIdentityProviderConfig(DisassociateIdentityProviderConfigRequest disassociateIdentityProviderConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
disassociateIdentityProviderConfigRequest-- Returns:
- Result of the DisassociateIdentityProviderConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateIdentityProviderConfig
default DisassociateIdentityProviderConfigResponse disassociateIdentityProviderConfig(Consumer<DisassociateIdentityProviderConfigRequest.Builder> disassociateIdentityProviderConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
DisassociateIdentityProviderConfigRequest.Builderavoiding the need to create one manually viaDisassociateIdentityProviderConfigRequest.builder()- Parameters:
disassociateIdentityProviderConfigRequest- AConsumerthat will call methods onDisassociateIdentityProviderConfigRequest.Builderto create a request.- Returns:
- Result of the DisassociateIdentityProviderConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessEntries
default ListAccessEntriesResponse listAccessEntries(ListAccessEntriesRequest listAccessEntriesRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
Lists the access entries for your cluster.
- Parameters:
listAccessEntriesRequest-- Returns:
- Result of the ListAccessEntries operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessEntries
default ListAccessEntriesResponse listAccessEntries(Consumer<ListAccessEntriesRequest.Builder> listAccessEntriesRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
Lists the access entries for your cluster.
This is a convenience which creates an instance of the
ListAccessEntriesRequest.Builderavoiding the need to create one manually viaListAccessEntriesRequest.builder()- Parameters:
listAccessEntriesRequest- AConsumerthat will call methods onListAccessEntriesRequest.Builderto create a request.- Returns:
- Result of the ListAccessEntries operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessEntriesPaginator
default ListAccessEntriesIterable listAccessEntriesPaginator(ListAccessEntriesRequest listAccessEntriesRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
This is a variant of
listAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListAccessEntriesIterable responses = client.listAccessEntriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListAccessEntriesIterable responses = client .listAccessEntriesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAccessEntriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAccessEntriesIterable responses = client.listAccessEntriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)operation.- Parameters:
listAccessEntriesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessEntriesPaginator
default ListAccessEntriesIterable listAccessEntriesPaginator(Consumer<ListAccessEntriesRequest.Builder> listAccessEntriesRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
This is a variant of
listAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListAccessEntriesIterable responses = client.listAccessEntriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListAccessEntriesIterable responses = client .listAccessEntriesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAccessEntriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAccessEntriesIterable responses = client.listAccessEntriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)operation.
This is a convenience which creates an instance of the
ListAccessEntriesRequest.Builderavoiding the need to create one manually viaListAccessEntriesRequest.builder()- Parameters:
listAccessEntriesRequest- AConsumerthat will call methods onListAccessEntriesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessPolicies
default ListAccessPoliciesResponse listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest) throws ServerException, AwsServiceException, SdkClientException, EksException
Lists the available access policies.
- Parameters:
listAccessPoliciesRequest-- Returns:
- Result of the ListAccessPolicies operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessPolicies
default ListAccessPoliciesResponse listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) throws ServerException, AwsServiceException, SdkClientException, EksException
Lists the available access policies.
This is a convenience which creates an instance of the
ListAccessPoliciesRequest.Builderavoiding the need to create one manually viaListAccessPoliciesRequest.builder()- Parameters:
listAccessPoliciesRequest- AConsumerthat will call methods onListAccessPoliciesRequest.Builderto create a request.- Returns:
- Result of the ListAccessPolicies operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessPoliciesPaginator
default ListAccessPoliciesIterable listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest) throws ServerException, AwsServiceException, SdkClientException, EksException
This is a variant of
listAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListAccessPoliciesIterable responses = client .listAccessPoliciesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAccessPoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)operation.- Parameters:
listAccessPoliciesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAccessPoliciesPaginator
default ListAccessPoliciesIterable listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) throws ServerException, AwsServiceException, SdkClientException, EksException
This is a variant of
listAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListAccessPoliciesIterable responses = client .listAccessPoliciesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAccessPoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)operation.
This is a convenience which creates an instance of the
ListAccessPoliciesRequest.Builderavoiding the need to create one manually viaListAccessPoliciesRequest.builder()- Parameters:
listAccessPoliciesRequest- AConsumerthat will call methods onListAccessPoliciesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAddons
default ListAddonsResponse listAddons(ListAddonsRequest listAddonsRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ResourceNotFoundException, ServerException, AwsServiceException, SdkClientException, EksException
Lists the installed add-ons.
- Parameters:
listAddonsRequest-- Returns:
- Result of the ListAddons operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.ServerException- These errors are usually caused by a server-side issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAddons
default ListAddonsResponse listAddons(Consumer<ListAddonsRequest.Builder> listAddonsRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ResourceNotFoundException, ServerException, AwsServiceException, SdkClientException, EksException
Lists the installed add-ons.
This is a convenience which creates an instance of the
ListAddonsRequest.Builderavoiding the need to create one manually viaListAddonsRequest.builder()- Parameters:
listAddonsRequest- AConsumerthat will call methods onListAddonsRequest.Builderto create a request.- Returns:
- Result of the ListAddons operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.ServerException- These errors are usually caused by a server-side issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAddonsPaginator
default ListAddonsIterable listAddonsPaginator(ListAddonsRequest listAddonsRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ResourceNotFoundException, ServerException, AwsServiceException, SdkClientException, EksException
This is a variant of
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAddonsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)operation.- Parameters:
listAddonsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.ServerException- These errors are usually caused by a server-side issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAddonsPaginator
default ListAddonsIterable listAddonsPaginator(Consumer<ListAddonsRequest.Builder> listAddonsRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ResourceNotFoundException, ServerException, AwsServiceException, SdkClientException, EksException
This is a variant of
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAddonsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)operation.
This is a convenience which creates an instance of the
ListAddonsRequest.Builderavoiding the need to create one manually viaListAddonsRequest.builder()- Parameters:
listAddonsRequest- AConsumerthat will call methods onListAddonsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.ServerException- These errors are usually caused by a server-side issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssociatedAccessPolicies
default ListAssociatedAccessPoliciesResponse listAssociatedAccessPolicies(ListAssociatedAccessPoliciesRequest listAssociatedAccessPoliciesRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Lists the access policies associated with an access entry.
- Parameters:
listAssociatedAccessPoliciesRequest-- Returns:
- Result of the ListAssociatedAccessPolicies operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssociatedAccessPolicies
default ListAssociatedAccessPoliciesResponse listAssociatedAccessPolicies(Consumer<ListAssociatedAccessPoliciesRequest.Builder> listAssociatedAccessPoliciesRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Lists the access policies associated with an access entry.
This is a convenience which creates an instance of the
ListAssociatedAccessPoliciesRequest.Builderavoiding the need to create one manually viaListAssociatedAccessPoliciesRequest.builder()- Parameters:
listAssociatedAccessPoliciesRequest- AConsumerthat will call methods onListAssociatedAccessPoliciesRequest.Builderto create a request.- Returns:
- Result of the ListAssociatedAccessPolicies operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssociatedAccessPoliciesPaginator
default ListAssociatedAccessPoliciesIterable listAssociatedAccessPoliciesPaginator(ListAssociatedAccessPoliciesRequest listAssociatedAccessPoliciesRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
This is a variant of
listAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesIterable responses = client.listAssociatedAccessPoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesIterable responses = client .listAssociatedAccessPoliciesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesIterable responses = client.listAssociatedAccessPoliciesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)operation.- Parameters:
listAssociatedAccessPoliciesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssociatedAccessPoliciesPaginator
default ListAssociatedAccessPoliciesIterable listAssociatedAccessPoliciesPaginator(Consumer<ListAssociatedAccessPoliciesRequest.Builder> listAssociatedAccessPoliciesRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
This is a variant of
listAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesIterable responses = client.listAssociatedAccessPoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesIterable responses = client .listAssociatedAccessPoliciesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesIterable responses = client.listAssociatedAccessPoliciesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)operation.
This is a convenience which creates an instance of the
ListAssociatedAccessPoliciesRequest.Builderavoiding the need to create one manually viaListAssociatedAccessPoliciesRequest.builder()- Parameters:
listAssociatedAccessPoliciesRequest- AConsumerthat will call methods onListAssociatedAccessPoliciesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listClusters
default ListClustersResponse listClusters(ListClustersRequest listClustersRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.
- Parameters:
listClustersRequest-- Returns:
- Result of the ListClusters operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listClusters
default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.
This is a convenience which creates an instance of the
ListClustersRequest.Builderavoiding the need to create one manually viaListClustersRequest.builder()- Parameters:
listClustersRequest- AConsumerthat will call methods onListClustersRequest.Builderto create a request.- Returns:
- Result of the ListClusters operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listClusters
default ListClustersResponse listClusters() throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.
- Returns:
- Result of the ListClusters operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listClusters(ListClustersRequest), AWS API Documentation
-
listClustersPaginator
default ListClustersIterable listClustersPaginator() throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
This is a variant of
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.eks.model.ListClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listClustersPaginator(ListClustersRequest), AWS API Documentation
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
This is a variant of
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.eks.model.ListClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)operation.- Parameters:
listClustersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
This is a variant of
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.eks.model.ListClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)operation.
This is a convenience which creates an instance of the
ListClustersRequest.Builderavoiding the need to create one manually viaListClustersRequest.builder()- Parameters:
listClustersRequest- AConsumerthat will call methods onListClustersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEksAnywhereSubscriptions
default ListEksAnywhereSubscriptionsResponse listEksAnywhereSubscriptions(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Displays the full description of the subscription.
- Parameters:
listEksAnywhereSubscriptionsRequest-- Returns:
- Result of the ListEksAnywhereSubscriptions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEksAnywhereSubscriptions
default ListEksAnywhereSubscriptionsResponse listEksAnywhereSubscriptions(Consumer<ListEksAnywhereSubscriptionsRequest.Builder> listEksAnywhereSubscriptionsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
Displays the full description of the subscription.
This is a convenience which creates an instance of the
ListEksAnywhereSubscriptionsRequest.Builderavoiding the need to create one manually viaListEksAnywhereSubscriptionsRequest.builder()- Parameters:
listEksAnywhereSubscriptionsRequest- AConsumerthat will call methods onListEksAnywhereSubscriptionsRequest.Builderto create a request.- Returns:
- Result of the ListEksAnywhereSubscriptions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEksAnywhereSubscriptionsPaginator
default ListEksAnywhereSubscriptionsIterable listEksAnywhereSubscriptionsPaginator(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
This is a variant of
listEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsIterable responses = client.listEksAnywhereSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsIterable responses = client .listEksAnywhereSubscriptionsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsIterable responses = client.listEksAnywhereSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)operation.- Parameters:
listEksAnywhereSubscriptionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEksAnywhereSubscriptionsPaginator
default ListEksAnywhereSubscriptionsIterable listEksAnywhereSubscriptionsPaginator(Consumer<ListEksAnywhereSubscriptionsRequest.Builder> listEksAnywhereSubscriptionsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException
This is a variant of
listEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsIterable responses = client.listEksAnywhereSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsIterable responses = client .listEksAnywhereSubscriptionsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsIterable responses = client.listEksAnywhereSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)operation.
This is a convenience which creates an instance of the
ListEksAnywhereSubscriptionsRequest.Builderavoiding the need to create one manually viaListEksAnywhereSubscriptionsRequest.builder()- Parameters:
listEksAnywhereSubscriptionsRequest- AConsumerthat will call methods onListEksAnywhereSubscriptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listFargateProfiles
default ListFargateProfilesResponse listFargateProfiles(ListFargateProfilesRequest listFargateProfilesRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.
- Parameters:
listFargateProfilesRequest-- Returns:
- Result of the ListFargateProfiles operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listFargateProfiles
default ListFargateProfilesResponse listFargateProfiles(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.
This is a convenience which creates an instance of the
ListFargateProfilesRequest.Builderavoiding the need to create one manually viaListFargateProfilesRequest.builder()- Parameters:
listFargateProfilesRequest- AConsumerthat will call methods onListFargateProfilesRequest.Builderto create a request.- Returns:
- Result of the ListFargateProfiles operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listFargateProfilesPaginator
default ListFargateProfilesIterable listFargateProfilesPaginator(ListFargateProfilesRequest listFargateProfilesRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
This is a variant of
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client.listFargateProfilesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client .listFargateProfilesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client.listFargateProfilesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest)operation.- Parameters:
listFargateProfilesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listFargateProfilesPaginator
default ListFargateProfilesIterable listFargateProfilesPaginator(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
This is a variant of
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client.listFargateProfilesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client .listFargateProfilesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client.listFargateProfilesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest)operation.
This is a convenience which creates an instance of the
ListFargateProfilesRequest.Builderavoiding the need to create one manually viaListFargateProfilesRequest.builder()- Parameters:
listFargateProfilesRequest- AConsumerthat will call methods onListFargateProfilesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityProviderConfigs
default ListIdentityProviderConfigsResponse listIdentityProviderConfigs(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
Lists the identity provider configurations for your cluster.
- Parameters:
listIdentityProviderConfigsRequest-- Returns:
- Result of the ListIdentityProviderConfigs operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityProviderConfigs
default ListIdentityProviderConfigsResponse listIdentityProviderConfigs(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
Lists the identity provider configurations for your cluster.
This is a convenience which creates an instance of the
ListIdentityProviderConfigsRequest.Builderavoiding the need to create one manually viaListIdentityProviderConfigsRequest.builder()- Parameters:
listIdentityProviderConfigsRequest- AConsumerthat will call methods onListIdentityProviderConfigsRequest.Builderto create a request.- Returns:
- Result of the ListIdentityProviderConfigs operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityProviderConfigsPaginator
default ListIdentityProviderConfigsIterable listIdentityProviderConfigsPaginator(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
This is a variant of
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client.listIdentityProviderConfigsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client .listIdentityProviderConfigsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client.listIdentityProviderConfigsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)operation.- Parameters:
listIdentityProviderConfigsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityProviderConfigsPaginator
default ListIdentityProviderConfigsIterable listIdentityProviderConfigsPaginator(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
This is a variant of
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client.listIdentityProviderConfigsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client .listIdentityProviderConfigsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client.listIdentityProviderConfigsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)operation.
This is a convenience which creates an instance of the
ListIdentityProviderConfigsRequest.Builderavoiding the need to create one manually viaListIdentityProviderConfigsRequest.builder()- Parameters:
listIdentityProviderConfigsRequest- AConsumerthat will call methods onListIdentityProviderConfigsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listInsights
default ListInsightsResponse listInsights(ListInsightsRequest listInsightsRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
listInsightsRequest-- Returns:
- Result of the ListInsights operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listInsights
default ListInsightsResponse listInsights(Consumer<ListInsightsRequest.Builder> listInsightsRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
ListInsightsRequest.Builderavoiding the need to create one manually viaListInsightsRequest.builder()- Parameters:
listInsightsRequest- AConsumerthat will call methods onListInsightsRequest.Builderto create a request.- Returns:
- Result of the ListInsights operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listInsightsPaginator
default ListInsightsIterable listInsightsPaginator(ListInsightsRequest listInsightsRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
This is a variant of
listInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListInsightsIterable responses = client.listInsightsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListInsightsIterable responses = client.listInsightsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListInsightsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListInsightsIterable responses = client.listInsightsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)operation.- Parameters:
listInsightsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listInsightsPaginator
default ListInsightsIterable listInsightsPaginator(Consumer<ListInsightsRequest.Builder> listInsightsRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
This is a variant of
listInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListInsightsIterable responses = client.listInsightsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListInsightsIterable responses = client.listInsightsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListInsightsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListInsightsIterable responses = client.listInsightsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)operation.
This is a convenience which creates an instance of the
ListInsightsRequest.Builderavoiding the need to create one manually viaListInsightsRequest.builder()- Parameters:
listInsightsRequest- AConsumerthat will call methods onListInsightsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listNodegroups
default ListNodegroupsResponse listNodegroups(ListNodegroupsRequest listNodegroupsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
listNodegroupsRequest-- Returns:
- Result of the ListNodegroups operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listNodegroups
default ListNodegroupsResponse listNodegroups(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
ListNodegroupsRequest.Builderavoiding the need to create one manually viaListNodegroupsRequest.builder()- Parameters:
listNodegroupsRequest- AConsumerthat will call methods onListNodegroupsRequest.Builderto create a request.- Returns:
- Result of the ListNodegroups operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listNodegroupsPaginator
default ListNodegroupsIterable listNodegroupsPaginator(ListNodegroupsRequest listNodegroupsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
This is a variant of
listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListNodegroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)operation.- Parameters:
listNodegroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listNodegroupsPaginator
default ListNodegroupsIterable listNodegroupsPaginator(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
This is a variant of
listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListNodegroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)operation.
This is a convenience which creates an instance of the
ListNodegroupsRequest.Builderavoiding the need to create one manually viaListNodegroupsRequest.builder()- Parameters:
listNodegroupsRequest- AConsumerthat will call methods onListNodegroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPodIdentityAssociations
default ListPodIdentityAssociationsResponse listPodIdentityAssociations(ListPodIdentityAssociationsRequest listPodIdentityAssociationsRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
listPodIdentityAssociationsRequest-- Returns:
- Result of the ListPodIdentityAssociations operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPodIdentityAssociations
default ListPodIdentityAssociationsResponse listPodIdentityAssociations(Consumer<ListPodIdentityAssociationsRequest.Builder> listPodIdentityAssociationsRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
ListPodIdentityAssociationsRequest.Builderavoiding the need to create one manually viaListPodIdentityAssociationsRequest.builder()- Parameters:
listPodIdentityAssociationsRequest- AConsumerthat will call methods onListPodIdentityAssociationsRequest.Builderto create a request.- Returns:
- Result of the ListPodIdentityAssociations operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPodIdentityAssociationsPaginator
default ListPodIdentityAssociationsIterable listPodIdentityAssociationsPaginator(ListPodIdentityAssociationsRequest listPodIdentityAssociationsRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
This is a variant of
listPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsIterable responses = client.listPodIdentityAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsIterable responses = client .listPodIdentityAssociationsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsIterable responses = client.listPodIdentityAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)operation.- Parameters:
listPodIdentityAssociationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPodIdentityAssociationsPaginator
default ListPodIdentityAssociationsIterable listPodIdentityAssociationsPaginator(Consumer<ListPodIdentityAssociationsRequest.Builder> listPodIdentityAssociationsRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
This is a variant of
listPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsIterable responses = client.listPodIdentityAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsIterable responses = client .listPodIdentityAssociationsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsIterable responses = client.listPodIdentityAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)operation.
This is a convenience which creates an instance of the
ListPodIdentityAssociationsRequest.Builderavoiding the need to create one manually viaListPodIdentityAssociationsRequest.builder()- Parameters:
listPodIdentityAssociationsRequest- AConsumerthat will call methods onListPodIdentityAssociationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException
List the tags for an Amazon EKS resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException
List the tags for an Amazon EKS resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listUpdates
default ListUpdatesResponse listUpdates(ListUpdatesRequest listUpdatesRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.
- Parameters:
listUpdatesRequest-- Returns:
- Result of the ListUpdates operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listUpdates
default ListUpdatesResponse listUpdates(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.
This is a convenience which creates an instance of the
ListUpdatesRequest.Builderavoiding the need to create one manually viaListUpdatesRequest.builder()- Parameters:
listUpdatesRequest- AConsumerthat will call methods onListUpdatesRequest.Builderto create a request.- Returns:
- Result of the ListUpdates operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listUpdatesPaginator
default ListUpdatesIterable listUpdatesPaginator(ListUpdatesRequest listUpdatesRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
This is a variant of
listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListUpdatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)operation.- Parameters:
listUpdatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listUpdatesPaginator
default ListUpdatesIterable listUpdatesPaginator(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException
This is a variant of
listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListUpdatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)operation.
This is a convenience which creates an instance of the
ListUpdatesRequest.Builderavoiding the need to create one manually viaListUpdatesRequest.builder()- Parameters:
listUpdatesRequest- AConsumerthat will call methods onListUpdatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
registerCluster
default RegisterClusterResponse registerCluster(RegisterClusterRequest registerClusterRequest) throws ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AccessDeniedException, ResourceInUseException, ResourcePropagationDelayException, AwsServiceException, SdkClientException, EksException
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
RegisterClusterRequestto add it to the Amazon EKS control plane.Second, a Manifest containing the
activationIDandactivationCodemust 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.- Parameters:
registerClusterRequest-- Returns:
- Result of the RegisterCluster operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
registerCluster
default RegisterClusterResponse registerCluster(Consumer<RegisterClusterRequest.Builder> registerClusterRequest) throws ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AccessDeniedException, ResourceInUseException, ResourcePropagationDelayException, AwsServiceException, SdkClientException, EksException
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
RegisterClusterRequestto add it to the Amazon EKS control plane.Second, a Manifest containing the
activationIDandactivationCodemust 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.
This is a convenience which creates an instance of the
RegisterClusterRequest.Builderavoiding the need to create one manually viaRegisterClusterRequest.builder()- Parameters:
registerClusterRequest- AConsumerthat will call methods onRegisterClusterRequest.Builderto create a request.- Returns:
- Result of the RegisterCluster operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException
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.- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException
Deletes specified tags from an Amazon EKS resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException
Deletes specified tags from an Amazon EKS resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccessEntry
default UpdateAccessEntryResponse updateAccessEntry(UpdateAccessEntryRequest updateAccessEntryRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
Updates an access entry.
- Parameters:
updateAccessEntryRequest-- Returns:
- Result of the UpdateAccessEntry operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccessEntry
default UpdateAccessEntryResponse updateAccessEntry(Consumer<UpdateAccessEntryRequest.Builder> updateAccessEntryRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
Updates an access entry.
This is a convenience which creates an instance of the
UpdateAccessEntryRequest.Builderavoiding the need to create one manually viaUpdateAccessEntryRequest.builder()- Parameters:
updateAccessEntryRequest- AConsumerthat will call methods onUpdateAccessEntryRequest.Builderto create a request.- Returns:
- Result of the UpdateAccessEntry operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAddon
default UpdateAddonResponse updateAddon(UpdateAddonRequest updateAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
Updates an Amazon EKS add-on.
- Parameters:
updateAddonRequest-- Returns:
- Result of the UpdateAddon operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAddon
default UpdateAddonResponse updateAddon(Consumer<UpdateAddonRequest.Builder> updateAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException
Updates an Amazon EKS add-on.
This is a convenience which creates an instance of the
UpdateAddonRequest.Builderavoiding the need to create one manually viaUpdateAddonRequest.builder()- Parameters:
updateAddonRequest- AConsumerthat will call methods onUpdateAddonRequest.Builderto create a request.- Returns:
- Result of the UpdateAddon operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateClusterConfig
default UpdateClusterConfigResponse updateClusterConfig(UpdateClusterConfigRequest updateClusterConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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 .
You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.
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 (eitherFailedorSuccessful), the cluster status moves toActive.- Parameters:
updateClusterConfigRequest-- Returns:
- Result of the UpdateClusterConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateClusterConfig
default UpdateClusterConfigResponse updateClusterConfig(Consumer<UpdateClusterConfigRequest.Builder> updateClusterConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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 .
You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.
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 (eitherFailedorSuccessful), the cluster status moves toActive.
This is a convenience which creates an instance of the
UpdateClusterConfigRequest.Builderavoiding the need to create one manually viaUpdateClusterConfigRequest.builder()- Parameters:
updateClusterConfigRequest- AConsumerthat will call methods onUpdateClusterConfigRequest.Builderto create a request.- Returns:
- Result of the UpdateClusterConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateClusterVersion
default UpdateClusterVersionResponse updateClusterVersion(UpdateClusterVersionRequest updateClusterVersionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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 (eitherFailedorSuccessful), the cluster status moves toActive.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.
- Parameters:
updateClusterVersionRequest-- Returns:
- Result of the UpdateClusterVersion operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateClusterVersion
default UpdateClusterVersionResponse updateClusterVersion(Consumer<UpdateClusterVersionRequest.Builder> updateClusterVersionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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 (eitherFailedorSuccessful), the cluster status moves toActive.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.
This is a convenience which creates an instance of the
UpdateClusterVersionRequest.Builderavoiding the need to create one manually viaUpdateClusterVersionRequest.builder()- Parameters:
updateClusterVersionRequest- AConsumerthat will call methods onUpdateClusterVersionRequest.Builderto create a request.- Returns:
- Result of the UpdateClusterVersion operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateEksAnywhereSubscription
default UpdateEksAnywhereSubscriptionResponse updateEksAnywhereSubscription(UpdateEksAnywhereSubscriptionRequest updateEksAnywhereSubscriptionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.
- Parameters:
updateEksAnywhereSubscriptionRequest-- Returns:
- Result of the UpdateEksAnywhereSubscription operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateEksAnywhereSubscription
default UpdateEksAnywhereSubscriptionResponse updateEksAnywhereSubscription(Consumer<UpdateEksAnywhereSubscriptionRequest.Builder> updateEksAnywhereSubscriptionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.
This is a convenience which creates an instance of the
UpdateEksAnywhereSubscriptionRequest.Builderavoiding the need to create one manually viaUpdateEksAnywhereSubscriptionRequest.builder()- Parameters:
updateEksAnywhereSubscriptionRequest- AConsumerthat will call methods onUpdateEksAnywhereSubscriptionRequest.Builderto create a request.- Returns:
- Result of the UpdateEksAnywhereSubscription operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateNodegroupConfig
default UpdateNodegroupConfigResponse updateNodegroupConfig(UpdateNodegroupConfigRequest updateNodegroupConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
updateNodegroupConfigRequest-- Returns:
- Result of the UpdateNodegroupConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateNodegroupConfig
default UpdateNodegroupConfigResponse updateNodegroupConfig(Consumer<UpdateNodegroupConfigRequest.Builder> updateNodegroupConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
UpdateNodegroupConfigRequest.Builderavoiding the need to create one manually viaUpdateNodegroupConfigRequest.builder()- Parameters:
updateNodegroupConfigRequest- AConsumerthat will call methods onUpdateNodegroupConfigRequest.Builderto create a request.- Returns:
- Result of the UpdateNodegroupConfig operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateNodegroupVersion
default UpdateNodegroupVersionResponse updateNodegroupVersion(UpdateNodegroupVersionRequest updateNodegroupVersionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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
Podon that node is drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You canforcethe update if Amazon EKS is unable to drain the nodes as a result of aPoddisruption budget issue.- Parameters:
updateNodegroupVersionRequest-- Returns:
- Result of the UpdateNodegroupVersion operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateNodegroupVersion
default UpdateNodegroupVersionResponse updateNodegroupVersion(Consumer<UpdateNodegroupVersionRequest.Builder> updateNodegroupVersionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException
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
Podon that node is drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You canforcethe update if Amazon EKS is unable to drain the nodes as a result of aPoddisruption budget issue.
This is a convenience which creates an instance of the
UpdateNodegroupVersionRequest.Builderavoiding the need to create one manually viaUpdateNodegroupVersionRequest.builder()- Parameters:
updateNodegroupVersionRequest- AConsumerthat will call methods onUpdateNodegroupVersionRequest.Builderto create a request.- Returns:
- Result of the UpdateNodegroupVersion operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePodIdentityAssociation
default UpdatePodIdentityAssociationResponse updatePodIdentityAssociation(UpdatePodIdentityAssociationRequest updatePodIdentityAssociationRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
- Parameters:
updatePodIdentityAssociationRequest-- Returns:
- Result of the UpdatePodIdentityAssociation operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePodIdentityAssociation
default UpdatePodIdentityAssociationResponse updatePodIdentityAssociation(Consumer<UpdatePodIdentityAssociationRequest.Builder> updatePodIdentityAssociationRequest) throws ServerException, ResourceNotFoundException, InvalidRequestException, InvalidParameterException, AwsServiceException, SdkClientException, EksException
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.
This is a convenience which creates an instance of the
UpdatePodIdentityAssociationRequest.Builderavoiding the need to create one manually viaUpdatePodIdentityAssociationRequest.builder()- Parameters:
updatePodIdentityAssociationRequest- AConsumerthat will call methods onUpdatePodIdentityAssociationRequest.Builderto create a request.- Returns:
- Result of the UpdatePodIdentityAssociation operation returned by the service.
- Throws:
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 withListClusters. You can view your available managed node groups withListNodegroups. 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EksException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default EksWaiter waiter()
Create an instance ofEksWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
EksWaiter
-
create
static EksClient create()
Create aEksClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static EksClientBuilder builder()
Create a builder that can be used to configure and create aEksClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default EksServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-