Skip to content

EKSClient#

Index > EKS > EKSClient

Auto-generated documentation for EKS type annotations stubs module mypy-boto3-eks.

EKSClient#

Type annotations and code completion for boto3.client("eks"). boto3 documentation

# EKSClient usage example

from boto3.session import Session
from mypy_boto3_eks.client import EKSClient

def get_eks_client() -> EKSClient:
    return Session().client("eks")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("eks").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("eks")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ClientException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidRequestException,
    client.exceptions.NotFoundException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourcePropagationDelayException,
    client.exceptions.ServerException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.UnsupportedAvailabilityZoneException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_eks.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

associate_encryption_config#

Associate encryption configuration to an existing cluster.

Type annotations and code completion for boto3.client("eks").associate_encryption_config method. boto3 documentation

# associate_encryption_config method definition

def associate_encryption_config(
    self,
    *,
    clusterName: str,
    encryptionConfig: Sequence[EncryptionConfigTypeDef],  # (1)
    clientRequestToken: str = ...,
) -> AssociateEncryptionConfigResponseTypeDef:  # (2)
    ...
  1. See EncryptionConfigTypeDef
  2. See AssociateEncryptionConfigResponseTypeDef
# associate_encryption_config method usage example with argument unpacking

kwargs: AssociateEncryptionConfigRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "encryptionConfig": ...,
}

parent.associate_encryption_config(**kwargs)
  1. See AssociateEncryptionConfigRequestRequestTypeDef

associate_identity_provider_config#

Associate an identity provider configuration to a cluster.

Type annotations and code completion for boto3.client("eks").associate_identity_provider_config method. boto3 documentation

# associate_identity_provider_config method definition

def associate_identity_provider_config(
    self,
    *,
    clusterName: str,
    oidc: OidcIdentityProviderConfigRequestTypeDef,  # (1)
    tags: Mapping[str, str] = ...,
    clientRequestToken: str = ...,
) -> AssociateIdentityProviderConfigResponseTypeDef:  # (2)
    ...
  1. See OidcIdentityProviderConfigRequestTypeDef
  2. See AssociateIdentityProviderConfigResponseTypeDef
# associate_identity_provider_config method usage example with argument unpacking

kwargs: AssociateIdentityProviderConfigRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "oidc": ...,
}

parent.associate_identity_provider_config(**kwargs)
  1. See AssociateIdentityProviderConfigRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("eks").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("eks").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_addon#

Creates an Amazon EKS add-on.

Type annotations and code completion for boto3.client("eks").create_addon method. boto3 documentation

# create_addon method definition

def create_addon(
    self,
    *,
    clusterName: str,
    addonName: str,
    addonVersion: str = ...,
    serviceAccountRoleArn: str = ...,
    resolveConflicts: ResolveConflictsType = ...,  # (1)
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
    configurationValues: str = ...,
) -> CreateAddonResponseTypeDef:  # (2)
    ...
  1. See ResolveConflictsType
  2. See CreateAddonResponseTypeDef
# create_addon method usage example with argument unpacking

kwargs: CreateAddonRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "addonName": ...,
}

parent.create_addon(**kwargs)
  1. See CreateAddonRequestRequestTypeDef

create_cluster#

Creates an Amazon EKS control plane.

Type annotations and code completion for boto3.client("eks").create_cluster method. boto3 documentation

# create_cluster method definition

def create_cluster(
    self,
    *,
    name: str,
    roleArn: str,
    resourcesVpcConfig: VpcConfigRequestTypeDef,  # (1)
    version: str = ...,
    kubernetesNetworkConfig: KubernetesNetworkConfigRequestTypeDef = ...,  # (2)
    logging: LoggingTypeDef = ...,  # (3)
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
    encryptionConfig: Sequence[EncryptionConfigTypeDef] = ...,  # (4)
    outpostConfig: OutpostConfigRequestTypeDef = ...,  # (5)
) -> CreateClusterResponseTypeDef:  # (6)
    ...
  1. See VpcConfigRequestTypeDef
  2. See KubernetesNetworkConfigRequestTypeDef
  3. See LoggingTypeDef
  4. See EncryptionConfigTypeDef
  5. See OutpostConfigRequestTypeDef
  6. See CreateClusterResponseTypeDef
# create_cluster method usage example with argument unpacking

kwargs: CreateClusterRequestRequestTypeDef = {  # (1)
    "name": ...,
    "roleArn": ...,
    "resourcesVpcConfig": ...,
}

parent.create_cluster(**kwargs)
  1. See CreateClusterRequestRequestTypeDef

create_eks_anywhere_subscription#

Creates an EKS Anywhere subscription.

Type annotations and code completion for boto3.client("eks").create_eks_anywhere_subscription method. boto3 documentation

# create_eks_anywhere_subscription method definition

def create_eks_anywhere_subscription(
    self,
    *,
    name: str,
    term: EksAnywhereSubscriptionTermTypeDef,  # (1)
    licenseQuantity: int = ...,
    licenseType: EksAnywhereSubscriptionLicenseTypeType = ...,  # (2)
    autoRenew: bool = ...,
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateEksAnywhereSubscriptionResponseTypeDef:  # (3)
    ...
  1. See EksAnywhereSubscriptionTermTypeDef
  2. See EksAnywhereSubscriptionLicenseTypeType
  3. See CreateEksAnywhereSubscriptionResponseTypeDef
# create_eks_anywhere_subscription method usage example with argument unpacking

kwargs: CreateEksAnywhereSubscriptionRequestRequestTypeDef = {  # (1)
    "name": ...,
    "term": ...,
}

parent.create_eks_anywhere_subscription(**kwargs)
  1. See CreateEksAnywhereSubscriptionRequestRequestTypeDef

create_fargate_profile#

Creates an Fargate profile for your Amazon EKS cluster.

Type annotations and code completion for boto3.client("eks").create_fargate_profile method. boto3 documentation

# create_fargate_profile method definition

def create_fargate_profile(
    self,
    *,
    fargateProfileName: str,
    clusterName: str,
    podExecutionRoleArn: str,
    subnets: Sequence[str] = ...,
    selectors: Sequence[FargateProfileSelectorTypeDef] = ...,  # (1)
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateFargateProfileResponseTypeDef:  # (2)
    ...
  1. See FargateProfileSelectorTypeDef
  2. See CreateFargateProfileResponseTypeDef
# create_fargate_profile method usage example with argument unpacking

kwargs: CreateFargateProfileRequestRequestTypeDef = {  # (1)
    "fargateProfileName": ...,
    "clusterName": ...,
    "podExecutionRoleArn": ...,
}

parent.create_fargate_profile(**kwargs)
  1. See CreateFargateProfileRequestRequestTypeDef

create_nodegroup#

Creates a managed node group for an Amazon EKS cluster.

Type annotations and code completion for boto3.client("eks").create_nodegroup method. boto3 documentation

# create_nodegroup method definition

def create_nodegroup(
    self,
    *,
    clusterName: str,
    nodegroupName: str,
    subnets: Sequence[str],
    nodeRole: str,
    scalingConfig: NodegroupScalingConfigTypeDef = ...,  # (1)
    diskSize: int = ...,
    instanceTypes: Sequence[str] = ...,
    amiType: AMITypesType = ...,  # (2)
    remoteAccess: RemoteAccessConfigTypeDef = ...,  # (3)
    labels: Mapping[str, str] = ...,
    taints: Sequence[TaintTypeDef] = ...,  # (4)
    tags: Mapping[str, str] = ...,
    clientRequestToken: str = ...,
    launchTemplate: LaunchTemplateSpecificationTypeDef = ...,  # (5)
    updateConfig: NodegroupUpdateConfigTypeDef = ...,  # (6)
    capacityType: CapacityTypesType = ...,  # (7)
    version: str = ...,
    releaseVersion: str = ...,
) -> CreateNodegroupResponseTypeDef:  # (8)
    ...
  1. See NodegroupScalingConfigTypeDef
  2. See AMITypesType
  3. See RemoteAccessConfigTypeDef
  4. See TaintTypeDef
  5. See LaunchTemplateSpecificationTypeDef
  6. See NodegroupUpdateConfigTypeDef
  7. See CapacityTypesType
  8. See CreateNodegroupResponseTypeDef
# create_nodegroup method usage example with argument unpacking

kwargs: CreateNodegroupRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "nodegroupName": ...,
    "subnets": ...,
    "nodeRole": ...,
}

parent.create_nodegroup(**kwargs)
  1. See CreateNodegroupRequestRequestTypeDef

create_pod_identity_association#

Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity.

Type annotations and code completion for boto3.client("eks").create_pod_identity_association method. boto3 documentation

# create_pod_identity_association method definition

def create_pod_identity_association(
    self,
    *,
    clusterName: str,
    namespace: str,
    serviceAccount: str,
    roleArn: str,
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreatePodIdentityAssociationResponseTypeDef:  # (1)
    ...
  1. See CreatePodIdentityAssociationResponseTypeDef
# create_pod_identity_association method usage example with argument unpacking

kwargs: CreatePodIdentityAssociationRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "namespace": ...,
    "serviceAccount": ...,
    "roleArn": ...,
}

parent.create_pod_identity_association(**kwargs)
  1. See CreatePodIdentityAssociationRequestRequestTypeDef

delete_addon#

Delete an Amazon EKS add-on.

Type annotations and code completion for boto3.client("eks").delete_addon method. boto3 documentation

# delete_addon method definition

def delete_addon(
    self,
    *,
    clusterName: str,
    addonName: str,
    preserve: bool = ...,
) -> DeleteAddonResponseTypeDef:  # (1)
    ...
  1. See DeleteAddonResponseTypeDef
# delete_addon method usage example with argument unpacking

kwargs: DeleteAddonRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "addonName": ...,
}

parent.delete_addon(**kwargs)
  1. See DeleteAddonRequestRequestTypeDef

delete_cluster#

Deletes the Amazon EKS cluster control plane.

Type annotations and code completion for boto3.client("eks").delete_cluster method. boto3 documentation

# delete_cluster method definition

def delete_cluster(
    self,
    *,
    name: str,
) -> DeleteClusterResponseTypeDef:  # (1)
    ...
  1. See DeleteClusterResponseTypeDef
# delete_cluster method usage example with argument unpacking

kwargs: DeleteClusterRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_cluster(**kwargs)
  1. See DeleteClusterRequestRequestTypeDef

delete_eks_anywhere_subscription#

Deletes an expired or inactive subscription.

Type annotations and code completion for boto3.client("eks").delete_eks_anywhere_subscription method. boto3 documentation

# delete_eks_anywhere_subscription method definition

def delete_eks_anywhere_subscription(
    self,
    *,
    id: str,
) -> DeleteEksAnywhereSubscriptionResponseTypeDef:  # (1)
    ...
  1. See DeleteEksAnywhereSubscriptionResponseTypeDef
# delete_eks_anywhere_subscription method usage example with argument unpacking

kwargs: DeleteEksAnywhereSubscriptionRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_eks_anywhere_subscription(**kwargs)
  1. See DeleteEksAnywhereSubscriptionRequestRequestTypeDef

delete_fargate_profile#

Deletes an Fargate profile.

Type annotations and code completion for boto3.client("eks").delete_fargate_profile method. boto3 documentation

# delete_fargate_profile method definition

def delete_fargate_profile(
    self,
    *,
    clusterName: str,
    fargateProfileName: str,
) -> DeleteFargateProfileResponseTypeDef:  # (1)
    ...
  1. See DeleteFargateProfileResponseTypeDef
# delete_fargate_profile method usage example with argument unpacking

kwargs: DeleteFargateProfileRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "fargateProfileName": ...,
}

parent.delete_fargate_profile(**kwargs)
  1. See DeleteFargateProfileRequestRequestTypeDef

delete_nodegroup#

Deletes an Amazon EKS node group for a cluster.

Type annotations and code completion for boto3.client("eks").delete_nodegroup method. boto3 documentation

# delete_nodegroup method definition

def delete_nodegroup(
    self,
    *,
    clusterName: str,
    nodegroupName: str,
) -> DeleteNodegroupResponseTypeDef:  # (1)
    ...
  1. See DeleteNodegroupResponseTypeDef
# delete_nodegroup method usage example with argument unpacking

kwargs: DeleteNodegroupRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "nodegroupName": ...,
}

parent.delete_nodegroup(**kwargs)
  1. See DeleteNodegroupRequestRequestTypeDef

delete_pod_identity_association#

Deletes a EKS Pod Identity association.

Type annotations and code completion for boto3.client("eks").delete_pod_identity_association method. boto3 documentation

# delete_pod_identity_association method definition

def delete_pod_identity_association(
    self,
    *,
    clusterName: str,
    associationId: str,
) -> DeletePodIdentityAssociationResponseTypeDef:  # (1)
    ...
  1. See DeletePodIdentityAssociationResponseTypeDef
# delete_pod_identity_association method usage example with argument unpacking

kwargs: DeletePodIdentityAssociationRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "associationId": ...,
}

parent.delete_pod_identity_association(**kwargs)
  1. See DeletePodIdentityAssociationRequestRequestTypeDef

deregister_cluster#

Deregisters a connected cluster to remove it from the Amazon EKS control plane.

Type annotations and code completion for boto3.client("eks").deregister_cluster method. boto3 documentation

# deregister_cluster method definition

def deregister_cluster(
    self,
    *,
    name: str,
) -> DeregisterClusterResponseTypeDef:  # (1)
    ...
  1. See DeregisterClusterResponseTypeDef
# deregister_cluster method usage example with argument unpacking

kwargs: DeregisterClusterRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.deregister_cluster(**kwargs)
  1. See DeregisterClusterRequestRequestTypeDef

describe_addon#

Describes an Amazon EKS add-on.

Type annotations and code completion for boto3.client("eks").describe_addon method. boto3 documentation

# describe_addon method definition

def describe_addon(
    self,
    *,
    clusterName: str,
    addonName: str,
) -> DescribeAddonResponseTypeDef:  # (1)
    ...
  1. See DescribeAddonResponseTypeDef
# describe_addon method usage example with argument unpacking

kwargs: DescribeAddonRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "addonName": ...,
}

parent.describe_addon(**kwargs)
  1. See