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_access_policy#

Associates an access policy and its scope to an access entry.

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

# associate_access_policy method definition

def associate_access_policy(
    self,
    *,
    clusterName: str,
    principalArn: str,
    policyArn: str,
    accessScope: AccessScopeTypeDef,  # (1)
) -> AssociateAccessPolicyResponseTypeDef:  # (2)
    ...
  1. See AccessScopeTypeDef
  2. See AssociateAccessPolicyResponseTypeDef
# associate_access_policy method usage example with argument unpacking

kwargs: AssociateAccessPolicyRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "principalArn": ...,
    "policyArn": ...,
    "accessScope": ...,
}

parent.associate_access_policy(**kwargs)
  1. See AssociateAccessPolicyRequestRequestTypeDef

associate_encryption_config#

Associates an 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#

Associates 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_access_entry#

Creates an access entry.

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

# create_access_entry method definition

def create_access_entry(
    self,
    *,
    clusterName: str,
    principalArn: str,
    kubernetesGroups: Sequence[str] = ...,
    tags: Mapping[str, str] = ...,
    clientRequestToken: str = ...,
    username: str = ...,
    type: str = ...,
) -> CreateAccessEntryResponseTypeDef:  # (1)
    ...
  1. See CreateAccessEntryResponseTypeDef
# create_access_entry method usage example with argument unpacking

kwargs: CreateAccessEntryRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "principalArn": ...,
}

parent.create_access_entry(**kwargs)
  1. See CreateAccessEntryRequestRequestTypeDef

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)
    accessConfig: CreateAccessConfigRequestTypeDef = ...,  # (6)
) -> CreateClusterResponseTypeDef:  # (7)
    ...
  1. See VpcConfigRequestTypeDef
  2. See KubernetesNetworkConfigRequestTypeDef
  3. See LoggingTypeDef
  4. See EncryptionConfigTypeDef
  5. See OutpostConfigRequestTypeDef
  6. See CreateAccessConfigRequestTypeDef
  7. 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