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: Union[AccessScopeTypeDef, AccessScopeExtraOutputTypeDef],  # (1)
) -> AssociateAccessPolicyResponseTypeDef:  # (2)
    ...
  1. See AccessScopeTypeDef AccessScopeExtraOutputTypeDef
  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[Union[EncryptionConfigTypeDef, EncryptionConfigOutputTypeDef]],  # (1)
    clientRequestToken: str = ...,
) -> AssociateEncryptionConfigResponseTypeDef:  # (2)
    ...
  1. See EncryptionConfigTypeDef EncryptionConfigOutputTypeDef
  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.