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

Deletes an access entry.

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

# delete_access_entry method definition

def delete_access_entry(
    self,
    *,
    clusterName: str,
    principalArn: str,
) -> Dict[str, Any]:
    ...
# delete_access_entry method usage example with argument unpacking

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

parent.delete_access_entry(**kwargs)
  1. See DeleteAccessEntryRequestRequestTypeDef

delete_addon#

Deletes 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 an 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 a managed node group.

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

Describes an access entry.

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

# describe_access_entry method definition

def describe_access_entry(
    self,
    *,
    clusterName: str,
    principalArn: str,
) -> DescribeAccessEntryResponseTypeDef:  # (1)
    ...
  1. See DescribeAccessEntryResponseTypeDef
# describe_access_entry method usage example with argument unpacking

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

parent.describe_access_entry(**kwargs)
  1. See DescribeAccessEntryRequestRequestTypeDef

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 DescribeAddonRequestRequestTypeDef

describe_addon_configuration#

Returns configuration options.

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

# describe_addon_configuration method definition

def describe_addon_configuration(
    self,
    *,
    addonName: str,
    addonVersion: str,
) -> DescribeAddonConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeAddonConfigurationResponseTypeDef
# describe_addon_configuration method usage example with argument unpacking

kwargs: DescribeAddonConfigurationRequestRequestTypeDef = {  # (1)
    "addonName": ...,
    "addonVersion": ...,
}

parent.describe_addon_configuration(**kwargs)
  1. See DescribeAddonConfigurationRequestRequestTypeDef

describe_addon_versions#

Describes the versions for an add-on.

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

# describe_addon_versions method definition

def describe_addon_versions(
    self,
    *,
    kubernetesVersion: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    addonName: str = ...,
    types: Sequence[str] = ...,
    publishers: Sequence[str] = ...,
    owners: Sequence[str] = ...,
) -> DescribeAddonVersionsResponseTypeDef:  # (1)
    ...
  1. See DescribeAddonVersionsResponseTypeDef
# describe_addon_versions method usage example with argument unpacking

kwargs: DescribeAddonVersionsRequestRequestTypeDef = {  # (1)
    "kubernetesVersion": ...,
}

parent.describe_addon_versions(**kwargs)
  1. See DescribeAddonVersionsRequestRequestTypeDef

describe_cluster#

Describes an Amazon EKS cluster.

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

# describe_cluster method definition

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

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

parent.describe_cluster(**kwargs)
  1. See DescribeClusterRequestRequestTypeDef

describe_eks_anywhere_subscription#

Returns descriptive information about a subscription.

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

# describe_eks_anywhere_subscription method definition

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

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

parent.describe_eks_anywhere_subscription(**kwargs)
  1. See DescribeEksAnywhereSubscriptionRequestRequestTypeDef

describe_fargate_profile#

Describes an Fargate profile.

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

# describe_fargate_profile method definition

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

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

parent.describe_fargate_profile(**kwargs)
  1. See DescribeFargateProfileRequestRequestTypeDef

describe_identity_provider_config#

Describes an identity provider configuration.

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

# describe_identity_provider_config method definition

def describe_identity_provider_config(
    self,
    *,
    clusterName: str,
    identityProviderConfig: IdentityProviderConfigTypeDef,  # (1)
) -> DescribeIdentityProviderConfigResponseTypeDef:  # (2)
    ...
  1. See IdentityProviderConfigTypeDef
  2. See DescribeIdentityProviderConfigResponseTypeDef
# describe_identity_provider_config method usage example with argument unpacking

kwargs: DescribeIdentityProviderConfigRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "identityProviderConfig": ...,
}

parent.describe_identity_provider_config(**kwargs)
  1. See DescribeIdentityProviderConfigRequestRequestTypeDef

describe_insight#

Returns details about an insight that you specify using its ID.

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

# describe_insight method definition

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

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

parent.describe_insight(**kwargs)
  1. See DescribeInsightRequestRequestTypeDef

describe_nodegroup#

Describes a managed node group.

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

# describe_nodegroup method definition

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

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

parent.describe_nodegroup(**kwargs)
  1. See DescribeNodegroupRequestRequestTypeDef

describe_pod_identity_association#

Returns descriptive information about an EKS Pod Identity association.

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

# describe_pod_identity_association method definition

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

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

parent.describe_pod_identity_association(**kwargs)
  1. See DescribePodIdentityAssociationRequestRequestTypeDef

describe_update#

Describes an update to an Amazon EKS resource.

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

# describe_update method definition

def describe_update(
    self,
    *,
    name: str,
    updateId: str,
    nodegroupName: str = ...,
    addonName: str = ...,
) -> DescribeUpdateResponseTypeDef:  # (1)
    ...
  1. See DescribeUpdateResponseTypeDef
# describe_update method usage example with argument unpacking

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

parent.describe_update(**kwargs)
  1. See DescribeUpdateRequestRequestTypeDef

disassociate_access_policy#

Disassociates an access policy from an access entry.

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

# disassociate_access_policy method definition

def disassociate_access_policy(
    self,
    *,
    clusterName: str,
    principalArn: str,
    policyArn: str,
) -> Dict[str, Any]:
    ...
# disassociate_access_policy method usage example with argument unpacking

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

parent.disassociate_access_policy(**kwargs)
  1. See DisassociateAccessPolicyRequestRequestTypeDef

disassociate_identity_provider_config#

Disassociates an identity provider configuration from a cluster.

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

# disassociate_identity_provider_config method definition

def disassociate_identity_provider_config(
    self,
    *,
    clusterName: str,
    identityProviderConfig: IdentityProviderConfigTypeDef,  # (1)
    clientRequestToken: str = ...,
) -> DisassociateIdentityProviderConfigResponseTypeDef:  # (2)
    ...
  1. See IdentityProviderConfigTypeDef
  2. See DisassociateIdentityProviderConfigResponseTypeDef
# disassociate_identity_provider_config method usage example with argument unpacking

kwargs: DisassociateIdentityProviderConfigRequestRequestTypeDef = {  # (1)
    "clusterName": ...,
    "identityProviderConfig": ...,
}

parent.disassociate_identity_provider_config(**kwargs)
  1. See DisassociateIdentityProviderConfigRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_access_entries#

Lists the access entries for your cluster.

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

# list_access_entries method definition

def list_access_entries(
    self,
    *,
    clusterName: str,
    associatedPolicyArn: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAccessEntriesResponseTypeDef:  # (1)
    ...
  1. See ListAccessEntriesResponseTypeDef
# list_access_entries method usage example with argument unpacking

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

parent.list_access_entries(**kwargs)
  1. See ListAccessEntriesRequestRequestTypeDef

list_access_policies#

Lists the available access policies.

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

# list_access_policies method definition

def list_access_policies(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAccessPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListAccessPoliciesResponseTypeDef
# list_access_policies method usage example with argument unpacking

kwargs: ListAccessPoliciesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_access_policies(**kwargs)
  1. See ListAccessPoliciesRequestRequestTypeDef

list_addons#

Lists the installed add-ons.

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

# list_addons method definition

def list_addons(
    self,
    *,
    clusterName: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAddonsResponseTypeDef:  # (1)
    ...
  1. See ListAddonsResponseTypeDef
# list_addons method usage example with argument unpacking

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

parent.list_addons(**kwargs)
  1. See ListAddonsRequestRequestTypeDef

list_associated_access_policies#

Lists the access policies associated with an access entry.

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

# list_associated_access_policies method definition

def list_associated_access_policies(
    self,
    *,
    clusterName: str,
    principalArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAssociatedAccessPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListAssociatedAccessPoliciesResponseTypeDef
# list_associated_access_policies method usage example with argument unpacking

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

parent.list_associated_access_policies(**kwargs)
  1. See ListAssociatedAccessPoliciesRequestRequestTypeDef

list_clusters#

Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.

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

# list_clusters method definition

def list_clusters(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    include: Sequence[str] = ...,
) -> ListClustersResponseTypeDef:  # (1)
    ...
  1. See ListClustersResponseTypeDef
# list_clusters method usage example with argument unpacking

kwargs: ListClustersRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_clusters(**kwargs)
  1. See ListClustersRequestRequestTypeDef

list_eks_anywhere_subscriptions#

Displays the full description of the subscription.

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

# list_eks_anywhere_subscriptions method definition

def list_eks_anywhere_subscriptions(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    includeStatus: Sequence[EksAnywhereSubscriptionStatusType] = ...,  # (1)
) -> ListEksAnywhereSubscriptionsResponseTypeDef:  # (2)
    ...
  1. See EksAnywhereSubscriptionStatusType
  2. See ListEksAnywhereSubscriptionsResponseTypeDef
# list_eks_anywhere_subscriptions method usage example with argument unpacking

kwargs: ListEksAnywhereSubscriptionsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_eks_anywhere_subscriptions(**kwargs)
  1. See ListEksAnywhereSubscriptionsRequestRequestTypeDef

list_fargate_profiles#

Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.

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

# list_fargate_profiles method definition

def list_fargate_profiles(
    self,
    *,
    clusterName: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFargateProfilesResponseTypeDef:  # (1)
    ...
  1. See ListFargateProfilesResponseTypeDef
# list_fargate_profiles method usage example with argument unpacking

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

parent.list_fargate_profiles(**kwargs)
  1. See ListFargateProfilesRequestRequestTypeDef

list_identity_provider_configs#

Lists the identity provider configurations for your cluster.

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

# list_identity_provider_configs method definition

def list_identity_provider_configs(
    self,
    *,
    clusterName: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIdentityProviderConfigsResponseTypeDef:  # (1)
    ...
  1. See ListIdentityProviderConfigsResponseTypeDef
# list_identity_provider_configs method usage example with argument unpacking

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

parent.list_identity_provider_configs(**kwargs)
  1. See ListIdentityProviderConfigsRequestRequestTypeDef

list_insights#

Returns a list of all insights checked for against the specified cluster.

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

# list_insights method definition

def list_insights(
    self,
    *,
    clusterName: str,
    filter: InsightsFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListInsightsResponseTypeDef:  # (2)
    ...
  1. See InsightsFilterTypeDef
  2. See ListInsightsResponseTypeDef
# list_insights method usage example with argument unpacking

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

parent.list_insights(**kwargs)
  1. See ListInsightsRequestRequestTypeDef

list_nodegroups#

Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.

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

# list_nodegroups method definition

def list_nodegroups(
    self,
    *,
    clusterName: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListNodegroupsResponseTypeDef:  # (1)
    ...
  1. See ListNodegroupsResponseTypeDef
# list_nodegroups method usage example with argument unpacking

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

parent.list_nodegroups(**kwargs)
  1. See ListNodegroupsRequestRequestTypeDef

list_pod_identity_associations#

List the EKS Pod Identity associations in a cluster.

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

# list_pod_identity_associations method definition

def list_pod_identity_associations(
    self,
    *,
    clusterName: str,
    namespace: str = ...,
    serviceAccount: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPodIdentityAssociationsResponseTypeDef:  # (1)
    ...
  1. See ListPodIdentityAssociationsResponseTypeDef
# list_pod_identity_associations method usage example with argument unpacking

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

parent.list_pod_identity_associations(**kwargs)
  1. See ListPodIdentityAssociationsRequestRequestTypeDef

list_tags_for_resource#

List the tags for an Amazon EKS resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_updates#

Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.

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

# list_updates method definition

def list_updates(
    self,
    *,
    name: str,
    nodegroupName: str = ...,
    addonName: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListUpdatesResponseTypeDef:  # (1)
    ...
  1. See ListUpdatesResponseTypeDef
# list_updates method usage example with argument unpacking

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

parent.list_updates(**kwargs)
  1. See ListUpdatesRequestRequestTypeDef

register_cluster#

Connects a Kubernetes cluster to the Amazon EKS control plane.

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

# register_cluster method definition

def register_cluster(
    self,
    *,
    name: str,
    connectorConfig: ConnectorConfigRequestTypeDef,  # (1)
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> RegisterClusterResponseTypeDef:  # (2)
    ...
  1. See ConnectorConfigRequestTypeDef
  2. See RegisterClusterResponseTypeDef
# register_cluster method usage example with argument unpacking

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

parent.register_cluster(**kwargs)
  1. See RegisterClusterRequestRequestTypeDef

tag_resource#

Associates the specified tags to an Amazon EKS resource with the specified resourceArn.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Deletes specified tags from an Amazon EKS resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_access_entry#

Updates an access entry.

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

# update_access_entry method definition

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

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

parent.update_access_entry(**kwargs)
  1. See UpdateAccessEntryRequestRequestTypeDef

update_addon#

Updates an Amazon EKS add-on.

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

# update_addon method definition

def update_addon(
    self,
    *,
    clusterName: str,
    addonName: str,
    addonVersion: str = ...,
    serviceAccountRoleArn: str = ...,
    resolveConflicts: ResolveConflictsType = ...,  # (1)
    clientRequestToken: str = ...,
    configurationValues: str = ...,
) -> UpdateAddonResponseTypeDef:  # (2)
    ...
  1. See ResolveConflictsType
  2. See UpdateAddonResponseTypeDef
# update_addon method usage example with argument unpacking

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

parent.update_addon(**kwargs)
  1. See UpdateAddonRequestRequestTypeDef

update_cluster_config#

Updates an Amazon EKS cluster configuration.

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

# update_cluster_config method definition

def update_cluster_config(
    self,
    *,
    name: str,
    resourcesVpcConfig: VpcConfigRequestTypeDef = ...,  # (1)
    logging: LoggingTypeDef = ...,  # (2)
    clientRequestToken: str = ...,
    accessConfig: UpdateAccessConfigRequestTypeDef = ...,  # (3)
) -> UpdateClusterConfigResponseTypeDef:  # (4)
    ...
  1. See VpcConfigRequestTypeDef
  2. See LoggingTypeDef
  3. See UpdateAccessConfigRequestTypeDef
  4. See UpdateClusterConfigResponseTypeDef
# update_cluster_config method usage example with argument unpacking

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

parent.update_cluster_config(**kwargs)
  1. See UpdateClusterConfigRequestRequestTypeDef

update_cluster_version#

Updates an Amazon EKS cluster to the specified Kubernetes version.

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

# update_cluster_version method definition

def update_cluster_version(
    self,
    *,
    name: str,
    version: str,
    clientRequestToken: str = ...,
) -> UpdateClusterVersionResponseTypeDef:  # (1)
    ...
  1. See UpdateClusterVersionResponseTypeDef
# update_cluster_version method usage example with argument unpacking

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

parent.update_cluster_version(**kwargs)
  1. See UpdateClusterVersionRequestRequestTypeDef

update_eks_anywhere_subscription#

Update an EKS Anywhere Subscription.

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

# update_eks_anywhere_subscription method definition

def update_eks_anywhere_subscription(
    self,
    *,
    id: str,
    autoRenew: bool,
    clientRequestToken: str = ...,
) -> UpdateEksAnywhereSubscriptionResponseTypeDef:  # (1)
    ...
  1. See UpdateEksAnywhereSubscriptionResponseTypeDef
# update_eks_anywhere_subscription method usage example with argument unpacking

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

parent.update_eks_anywhere_subscription(**kwargs)
  1. See UpdateEksAnywhereSubscriptionRequestRequestTypeDef

update_nodegroup_config#

Updates an Amazon EKS managed node group configuration.

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

# update_nodegroup_config method definition

def update_nodegroup_config(
    self,
    *,
    clusterName: str,
    nodegroupName: str,
    labels: UpdateLabelsPayloadTypeDef = ...,  # (1)
    taints: UpdateTaintsPayloadTypeDef = ...,  # (2)
    scalingConfig: NodegroupScalingConfigTypeDef = ...,  # (3)
    updateConfig: NodegroupUpdateConfigTypeDef = ...,  # (4)
    clientRequestToken: str = ...,
) -> UpdateNodegroupConfigResponseTypeDef:  # (5)
    ...
  1. See UpdateLabelsPayloadTypeDef
  2. See UpdateTaintsPayloadTypeDef
  3. See NodegroupScalingConfigTypeDef
  4. See NodegroupUpdateConfigTypeDef
  5. See UpdateNodegroupConfigResponseTypeDef
# update_nodegroup_config method usage example with argument unpacking

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

parent.update_nodegroup_config(**kwargs)
  1. See UpdateNodegroupConfigRequestRequestTypeDef

update_nodegroup_version#

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

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

# update_nodegroup_version method definition

def update_nodegroup_version(
    self,
    *,
    clusterName: str,
    nodegroupName: str,
    version: str = ...,
    releaseVersion: str = ...,
    launchTemplate: LaunchTemplateSpecificationTypeDef = ...,  # (1)
    force: bool = ...,
    clientRequestToken: str = ...,
) -> UpdateNodegroupVersionResponseTypeDef:  # (2)
    ...
  1. See LaunchTemplateSpecificationTypeDef
  2. See UpdateNodegroupVersionResponseTypeDef
# update_nodegroup_version method usage example with argument unpacking

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

parent.update_nodegroup_version(**kwargs)
  1. See UpdateNodegroupVersionRequestRequestTypeDef

update_pod_identity_association#

Updates a EKS Pod Identity association.

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

# update_pod_identity_association method definition

def update_pod_identity_association(
    self,
    *,
    clusterName: str,
    associationId: str,
    roleArn: str = ...,
    clientRequestToken: str = ...,
) -> UpdatePodIdentityAssociationResponseTypeDef:  # (1)
    ...
  1. See UpdatePodIdentityAssociationResponseTypeDef
# update_pod_identity_association method usage example with argument unpacking

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

parent.update_pod_identity_association(**kwargs)
  1. See UpdatePodIdentityAssociationRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("eks").get_paginator method with overloads.

get_waiter#

Type annotations and code completion for boto3.client("eks").get_waiter method with overloads.