EKSClient

Index > EKS > EKSClient

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

EKSClient

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

# EKSClient usage example

from boto3.session import Session
from types_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.InvalidStateException,
    client.exceptions.NotFoundException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourcePropagationDelayException,
    client.exceptions.ServerException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnsupportedAvailabilityZoneException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_eks.client import Exceptions

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

Methods

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

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: AccessScopeUnionTypeDef,  # (1)
) -> AssociateAccessPolicyResponseTypeDef:  # (2)
    ...

1. See AccessScopeUnionTypeDef
2. See AssociateAccessPolicyResponseTypeDef

# associate_access_policy method usage example with argument unpacking

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

parent.associate_access_policy(**kwargs)

1. See AssociateAccessPolicyRequestTypeDef

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[EncryptionConfigUnionTypeDef],  # (1)
    clientRequestToken: str = ...,
) -> AssociateEncryptionConfigResponseTypeDef:  # (2)
    ...

1. See Sequence[EncryptionConfigUnionTypeDef]
2. See AssociateEncryptionConfigResponseTypeDef

# associate_encryption_config method usage example with argument unpacking

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

parent.associate_encryption_config(**kwargs)

1. See AssociateEncryptionConfigRequestTypeDef

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: AssociateIdentityProviderConfigRequestTypeDef = {  # (1)
    "clusterName": ...,
    "oidc": ...,
}

parent.associate_identity_provider_config(**kwargs)

1. See AssociateIdentityProviderConfigRequestTypeDef

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: CreateAccessEntryRequestTypeDef = {  # (1)
    "clusterName": ...,
    "principalArn": ...,
}

parent.create_access_entry(**kwargs)

1. See CreateAccessEntryRequestTypeDef

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 = ...,
    podIdentityAssociations: Sequence[AddonPodIdentityAssociationsTypeDef] = ...,  # (2)
    namespaceConfig: AddonNamespaceConfigRequestTypeDef = ...,  # (3)
) -> CreateAddonResponseTypeDef:  # (4)
    ...

1. See ResolveConflictsType
2. See Sequence[AddonPodIdentityAssociationsTypeDef]
3. See AddonNamespaceConfigRequestTypeDef
4. See CreateAddonResponseTypeDef

# create_addon method usage example with argument unpacking

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

parent.create_addon(**kwargs)

1. See CreateAddonRequestTypeDef

create_capability

Creates a managed capability resource for an Amazon EKS cluster.

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

# create_capability method definition

def create_capability(
    self,
    *,
    capabilityName: str,
    clusterName: str,
    type: CapabilityTypeType,  # (1)
    roleArn: str,
    deletePropagationPolicy: CapabilityDeletePropagationPolicyType,  # (2)
    clientRequestToken: str = ...,
    configuration: CapabilityConfigurationRequestTypeDef = ...,  # (3)
    tags: Mapping[str, str] = ...,
) -> CreateCapabilityResponseTypeDef:  # (4)
    ...

1. See CapabilityTypeType
2. See CapabilityDeletePropagationPolicyType
3. See CapabilityConfigurationRequestTypeDef
4. See CreateCapabilityResponseTypeDef

# create_capability method usage example with argument unpacking

kwargs: CreateCapabilityRequestTypeDef = {  # (1)
    "capabilityName": ...,
    "clusterName": ...,
    "type": ...,
    "roleArn": ...,
    "deletePropagationPolicy": ...,
}

parent.create_capability(**kwargs)

1. See CreateCapabilityRequestTypeDef

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: LoggingUnionTypeDef = ...,  # (3)
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
    encryptionConfig: Sequence[EncryptionConfigUnionTypeDef] = ...,  # (4)
    outpostConfig: OutpostConfigRequestTypeDef = ...,  # (5)
    accessConfig: CreateAccessConfigRequestTypeDef = ...,  # (6)
    bootstrapSelfManagedAddons: bool = ...,
    upgradePolicy: UpgradePolicyRequestTypeDef = ...,  # (7)
    zonalShiftConfig: ZonalShiftConfigRequestTypeDef = ...,  # (8)
    remoteNetworkConfig: RemoteNetworkConfigRequestTypeDef = ...,  # (9)
    computeConfig: ComputeConfigRequestTypeDef = ...,  # (10)
    storageConfig: StorageConfigRequestTypeDef = ...,  # (11)
    deletionProtection: bool = ...,
    controlPlaneScalingConfig: ControlPlaneScalingConfigTypeDef = ...,  # (12)
) -> CreateClusterResponseTypeDef:  # (13)
    ...

1. See VpcConfigRequestTypeDef
2. See KubernetesNetworkConfigRequestTypeDef
3. See LoggingUnionTypeDef
4. See Sequence[EncryptionConfigUnionTypeDef]
5. See OutpostConfigRequestTypeDef
6. See CreateAccessConfigRequestTypeDef
7. See UpgradePolicyRequestTypeDef
8. See ZonalShiftConfigRequestTypeDef
9. See RemoteNetworkConfigRequestTypeDef
10. See ComputeConfigRequestTypeDef
11. See StorageConfigRequestTypeDef
12. See ControlPlaneScalingConfigTypeDef
13. See CreateClusterResponseTypeDef

# create_cluster method usage example with argument unpacking

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

parent.create_cluster(**kwargs)

1. See CreateClusterRequestTypeDef

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: CreateEksAnywhereSubscriptionRequestTypeDef = {  # (1)
    "name": ...,
    "term": ...,
}

parent.create_eks_anywhere_subscription(**kwargs)

1. See CreateEksAnywhereSubscriptionRequestTypeDef

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[FargateProfileSelectorUnionTypeDef] = ...,  # (1)
    clientRequestToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateFargateProfileResponseTypeDef:  # (2)
    ...

1. See Sequence[FargateProfileSelectorUnionTypeDef]
2. See CreateFargateProfileResponseTypeDef

# create_fargate_profile method usage example with argument unpacking

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

parent.create_fargate_profile(**kwargs)

1. See CreateFargateProfileRequestTypeDef

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: RemoteAccessConfigUnionTypeDef = ...,  # (3)
    labels: Mapping[str, str] = ...,
    taints: Sequence[TaintTypeDef] = ...,  # (4)
    tags: Mapping[str, str] = ...,
    clientRequestToken: str = ...,
    launchTemplate: LaunchTemplateSpecificationTypeDef = ...,  # (5)
    updateConfig: NodegroupUpdateConfigTypeDef = ...,  # (6)
    nodeRepairConfig: NodeRepairConfigUnionTypeDef = ...,  # (7)
    capacityType: CapacityTypesType = ...,  # (8)
    version: str = ...,
    releaseVersion: str = ...,
) -> CreateNodegroupResponseTypeDef:  # (9)
    ...

1. See NodegroupScalingConfigTypeDef
2. See AMITypesType
3. See RemoteAccessConfigUnionTypeDef
4. See Sequence[TaintTypeDef]
5. See LaunchTemplateSpecificationTypeDef
6. See NodegroupUpdateConfigTypeDef
7. See NodeRepairConfigUnionTypeDef
8. See CapacityTypesType
9. See CreateNodegroupResponseTypeDef

# create_nodegroup method usage example with argument unpacking

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

parent.create_nodegroup(**kwargs)

1. See CreateNodegroupRequestTypeDef

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] = ...,
    disableSessionTags: bool = ...,
    targetRoleArn: str = ...,
) -> CreatePodIdentityAssociationResponseTypeDef:  # (1)
    ...

1. See CreatePodIdentityAssociationResponseTypeDef

# create_pod_identity_association method usage example with argument unpacking

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

parent.create_pod_identity_association(**kwargs)

1. See CreatePodIdentityAssociationRequestTypeDef

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: DeleteAccessEntryRequestTypeDef = {  # (1)
    "clusterName": ...,
    "principalArn": ...,
}

parent.delete_access_entry(**kwargs)

1. See DeleteAccessEntryRequestTypeDef

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: DeleteAddonRequestTypeDef = {  # (1)
    "clusterName": ...,
    "addonName": ...,
}

parent.delete_addon(**kwargs)

1. See DeleteAddonRequestTypeDef

delete_capability

Deletes a managed capability from your Amazon EKS cluster.

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

# delete_capability method definition

def delete_capability(
    self,
    *,
    clusterName: str,
    capabilityName: str,
) -> DeleteCapabilityResponseTypeDef:  # (1)
    ...

1. See DeleteCapabilityResponseTypeDef

# delete_capability method usage example with argument unpacking

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

parent.delete_capability(**kwargs)

1. See DeleteCapabilityRequestTypeDef

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: DeleteClusterRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_cluster(**kwargs)

1. See DeleteClusterRequestTypeDef

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: DeleteEksAnywhereSubscriptionRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_eks_anywhere_subscription(**kwargs)

1. See DeleteEksAnywhereSubscriptionRequestTypeDef

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: DeleteFargateProfileRequestTypeDef = {  # (1)
    "clusterName": ...,
    "fargateProfileName": ...,
}

parent.delete_fargate_profile(**kwargs)

1. See DeleteFargateProfileRequestTypeDef

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: DeleteNodegroupRequestTypeDef = {  # (1)
    "clusterName": ...,
    "nodegroupName": ...,
}

parent.delete_nodegroup(**kwargs)

1. See DeleteNodegroupRequestTypeDef

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: DeletePodIdentityAssociationRequestTypeDef = {  # (1)
    "clusterName": ...,
    "associationId": ...,
}

parent.delete_pod_identity_association(**kwargs)

1. See DeletePodIdentityAssociationRequestTypeDef

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: DeregisterClusterRequestTypeDef = {  # (1)
    "name": ...,
}

parent.deregister_cluster(**kwargs)

1. See DeregisterClusterRequestTypeDef

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: DescribeAccessEntryRequestTypeDef = {  # (1)
    "clusterName": ...,
    "principalArn": ...,
}

parent.describe_access_entry(**kwargs)

1. See DescribeAccessEntryRequestTypeDef

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: DescribeAddonRequestTypeDef = {  # (1)
    "clusterName": ...,
    "addonName": ...,
}

parent.describe_addon(**kwargs)

1. See DescribeAddonRequestTypeDef

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: DescribeAddonConfigurationRequestTypeDef = {  # (1)
    "addonName": ...,
    "addonVersion": ...,
}

parent.describe_addon_configuration(**kwargs)

1. See DescribeAddonConfigurationRequestTypeDef

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: DescribeAddonVersionsRequestTypeDef = {  # (1)
    "kubernetesVersion": ...,
}

parent.describe_addon_versions(**kwargs)

1. See DescribeAddonVersionsRequestTypeDef

describe_capability

Returns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information, and any issues that may be affecting its operation.

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

# describe_capability method definition

def describe_capability(
    self,
    *,
    clusterName: str,
    capabilityName: str,
) -> DescribeCapabilityResponseTypeDef:  # (1)
    ...

1. See DescribeCapabilityResponseTypeDef

# describe_capability method usage example with argument unpacking

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

parent.describe_capability(**kwargs)

1. See DescribeCapabilityRequestTypeDef

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: DescribeClusterRequestTypeDef = {  # (1)
    "name": ...,
}

parent.describe_cluster(**kwargs)

1. See DescribeClusterRequestTypeDef

describe_cluster_versions

Lists available Kubernetes versions for Amazon EKS clusters.

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

# describe_cluster_versions method definition

def describe_cluster_versions(
    self,
    *,
    clusterType: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    defaultOnly: bool = ...,
    includeAll: bool = ...,
    clusterVersions: Sequence[str] = ...,
    status: ClusterVersionStatusType = ...,  # (1)
    versionStatus: VersionStatusType = ...,  # (2)
) -> DescribeClusterVersionsResponseTypeDef:  # (3)
    ...

1. See ClusterVersionStatusType
2. See VersionStatusType
3. See DescribeClusterVersionsResponseTypeDef

# describe_cluster_versions method usage example with argument unpacking

kwargs: DescribeClusterVersionsRequestTypeDef = {  # (1)
    "clusterType": ...,
}

parent.describe_cluster_versions(**kwargs)

1. See DescribeClusterVersionsRequestTypeDef

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: DescribeEksAnywhereSubscriptionRequestTypeDef = {  # (1)
    "id": ...,
}

parent.describe_eks_anywhere_subscription(**kwargs)

1. See DescribeEksAnywhereSubscriptionRequestTypeDef

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: DescribeFargateProfileRequestTypeDef = {  # (1)
    "clusterName": ...,
    "fargateProfileName": ...,
}

parent.describe_fargate_profile(**kwargs)

1. See DescribeFargateProfileRequestTypeDef

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: DescribeIdentityProviderConfigRequestTypeDef = {  # (1)
    "clusterName": ...,
    "identityProviderConfig": ...,
}

parent.describe_identity_provider_config(**kwargs)

1. See DescribeIdentityProviderConfigRequestTypeDef

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: DescribeInsightRequestTypeDef = {  # (1)
    "clusterName": ...,
    "id": ...,
}

parent.describe_insight(**kwargs)

1. See DescribeInsightRequestTypeDef

describe_insights_refresh

Returns the status of the latest on-demand cluster insights refresh operation.

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

# describe_insights_refresh method definition

def describe_insights_refresh(
    self,
    *,
    clusterName: str,
) -> DescribeInsightsRefreshResponseTypeDef:  # (1)
    ...

1. See DescribeInsightsRefreshResponseTypeDef

# describe_insights_refresh method usage example with argument unpacking

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

parent.describe_insights_refresh(**kwargs)

1. See DescribeInsightsRefreshRequestTypeDef

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: DescribeNodegroupRequestTypeDef = {  # (1)
    "clusterName": ...,
    "nodegroupName": ...,
}

parent.describe_nodegroup(**kwargs)

1. See DescribeNodegroupRequestTypeDef

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: DescribePodIdentityAssociationRequestTypeDef = {  # (1)
    "clusterName": ...,
    "associationId": ...,
}

parent.describe_pod_identity_association(**kwargs)

1. See DescribePodIdentityAssociationRequestTypeDef

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 = ...,
    capabilityName: str = ...,
) -> DescribeUpdateResponseTypeDef:  # (1)
    ...

1. See DescribeUpdateResponseTypeDef

# describe_update method usage example with argument unpacking

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

parent.describe_update(**kwargs)

1. See DescribeUpdateRequestTypeDef

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: DisassociateAccessPolicyRequestTypeDef = {  # (1)
    "clusterName": ...,
    "principalArn": ...,
    "policyArn": ...,
}

parent.disassociate_access_policy(**kwargs)

1. See DisassociateAccessPolicyRequestTypeDef

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: DisassociateIdentityProviderConfigRequestTypeDef = {  # (1)
    "clusterName": ...,
    "identityProviderConfig": ...,
}

parent.disassociate_identity_provider_config(**kwargs)

1. See DisassociateIdentityProviderConfigRequestTypeDef

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: ListAccessEntriesRequestTypeDef = {  # (1)
    "clusterName": ...,
}

parent.list_access_entries(**kwargs)

1. See ListAccessEntriesRequestTypeDef

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: ListAccessPoliciesRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_access_policies(**kwargs)

1. See ListAccessPoliciesRequestTypeDef

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: ListAddonsRequestTypeDef = {  # (1)
    "clusterName": ...,
}

parent.list_addons(**kwargs)

1. See ListAddonsRequestTypeDef

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: ListAssociatedAccessPoliciesRequestTypeDef = {  # (1)
    "clusterName": ...,
    "principalArn": ...,
}

parent.list_associated_access_policies(**kwargs)

1. See ListAssociatedAccessPoliciesRequestTypeDef

list_capabilities

Lists all managed capabilities in your Amazon EKS cluster.

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

# list_capabilities method definition

def list_capabilities(
    self,
    *,
    clusterName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCapabilitiesResponseTypeDef:  # (1)
    ...

1. See ListCapabilitiesResponseTypeDef

# list_capabilities method usage example with argument unpacking

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

parent.list_capabilities(**kwargs)

1. See ListCapabilitiesRequestTypeDef

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: ListClustersRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_clusters(**kwargs)

1. See ListClustersRequestTypeDef

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 Sequence[EksAnywhereSubscriptionStatusType]
2. See ListEksAnywhereSubscriptionsResponseTypeDef

# list_eks_anywhere_subscriptions method usage example with argument unpacking

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

parent.list_eks_anywhere_subscriptions(**kwargs)

1. See ListEksAnywhereSubscriptionsRequestTypeDef

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: ListFargateProfilesRequestTypeDef = {  # (1)
    "clusterName": ...,
}

parent.list_fargate_profiles(**kwargs)

1. See ListFargateProfilesRequestTypeDef

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: ListIdentityProviderConfigsRequestTypeDef = {  # (1)
    "clusterName": ...,
}

parent.list_identity_provider_configs(**kwargs)

1. See ListIdentityProviderConfigsRequestTypeDef

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: ListInsightsRequestTypeDef = {  # (1)
    "clusterName": ...,
}

parent.list_insights(**kwargs)

1. See ListInsightsRequestTypeDef

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: ListNodegroupsRequestTypeDef = {  # (1)
    "clusterName": ...,
}

parent.list_nodegroups(**kwargs)

1. See ListNodegroupsRequestTypeDef

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: ListPodIdentityAssociationsRequestTypeDef = {  # (1)
    "clusterName": ...,
}

parent.list_pod_identity_associations(**kwargs)

1. See ListPodIdentityAssociationsRequestTypeDef

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: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

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 = ...,
    capabilityName: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListUpdatesResponseTypeDef:  # (1)
    ...

1. See ListUpdatesResponseTypeDef

# list_updates method usage example with argument unpacking

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

parent.list_updates(**kwargs)

1. See ListUpdatesRequestTypeDef

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: RegisterClusterRequestTypeDef = {  # (1)
    "name": ...,
    "connectorConfig": ...,
}

parent.register_cluster(**kwargs)

1. See RegisterClusterRequestTypeDef

start_insights_refresh

Initiates an on-demand refresh operation for cluster insights, getting the latest analysis outside of the standard refresh schedule.

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

# start_insights_refresh method definition

def start_insights_refresh(
    self,
    *,
    clusterName: str,
) -> StartInsightsRefreshResponseTypeDef:  # (1)
    ...

1. See StartInsightsRefreshResponseTypeDef

# start_insights_refresh method usage example with argument unpacking

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

parent.start_insights_refresh(**kwargs)

1. See StartInsightsRefreshRequestTypeDef

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: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

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: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

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: UpdateAccessEntryRequestTypeDef = {  # (1)
    "clusterName": ...,
    "principalArn": ...,
}

parent.update_access_entry(**kwargs)

1. See UpdateAccessEntryRequestTypeDef

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 = ...,
    podIdentityAssociations: Sequence[AddonPodIdentityAssociationsTypeDef] = ...,  # (2)
) -> UpdateAddonResponseTypeDef:  # (3)
    ...

1. See ResolveConflictsType
2. See Sequence[AddonPodIdentityAssociationsTypeDef]
3. See UpdateAddonResponseTypeDef

# update_addon method usage example with argument unpacking

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

parent.update_addon(**kwargs)

1. See UpdateAddonRequestTypeDef

update_capability

Updates the configuration of a managed capability in your Amazon EKS cluster.

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

# update_capability method definition

def update_capability(
    self,
    *,
    clusterName: str,
    capabilityName: str,
    roleArn: str = ...,
    configuration: UpdateCapabilityConfigurationTypeDef = ...,  # (1)
    clientRequestToken: str = ...,
    deletePropagationPolicy: CapabilityDeletePropagationPolicyType = ...,  # (2)
) -> UpdateCapabilityResponseTypeDef:  # (3)
    ...

1. See UpdateCapabilityConfigurationTypeDef
2. See CapabilityDeletePropagationPolicyType
3. See UpdateCapabilityResponseTypeDef

# update_capability method usage example with argument unpacking

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

parent.update_capability(**kwargs)

1. See UpdateCapabilityRequestTypeDef

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: LoggingUnionTypeDef = ...,  # (2)
    clientRequestToken: str = ...,
    accessConfig: UpdateAccessConfigRequestTypeDef = ...,  # (3)
    upgradePolicy: UpgradePolicyRequestTypeDef = ...,  # (4)
    zonalShiftConfig: ZonalShiftConfigRequestTypeDef = ...,  # (5)
    computeConfig: ComputeConfigRequestTypeDef = ...,  # (6)
    kubernetesNetworkConfig: KubernetesNetworkConfigRequestTypeDef = ...,  # (7)
    storageConfig: StorageConfigRequestTypeDef = ...,  # (8)
    remoteNetworkConfig: RemoteNetworkConfigRequestTypeDef = ...,  # (9)
    deletionProtection: bool = ...,
    controlPlaneScalingConfig: ControlPlaneScalingConfigTypeDef = ...,  # (10)
) -> UpdateClusterConfigResponseTypeDef:  # (11)
    ...

1. See VpcConfigRequestTypeDef
2. See LoggingUnionTypeDef
3. See UpdateAccessConfigRequestTypeDef
4. See UpgradePolicyRequestTypeDef
5. See ZonalShiftConfigRequestTypeDef
6. See ComputeConfigRequestTypeDef
7. See KubernetesNetworkConfigRequestTypeDef
8. See StorageConfigRequestTypeDef
9. See RemoteNetworkConfigRequestTypeDef
10. See ControlPlaneScalingConfigTypeDef
11. See UpdateClusterConfigResponseTypeDef

# update_cluster_config method usage example with argument unpacking

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

parent.update_cluster_config(**kwargs)

1. See UpdateClusterConfigRequestTypeDef

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 = ...,
    force: bool = ...,
) -> UpdateClusterVersionResponseTypeDef:  # (1)
    ...

1. See UpdateClusterVersionResponseTypeDef

# update_cluster_version method usage example with argument unpacking

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

parent.update_cluster_version(**kwargs)

1. See UpdateClusterVersionRequestTypeDef

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: UpdateEksAnywhereSubscriptionRequestTypeDef = {  # (1)
    "id": ...,
    "autoRenew": ...,
}

parent.update_eks_anywhere_subscription(**kwargs)

1. See UpdateEksAnywhereSubscriptionRequestTypeDef

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)
    nodeRepairConfig: NodeRepairConfigUnionTypeDef = ...,  # (5)
    clientRequestToken: str = ...,
) -> UpdateNodegroupConfigResponseTypeDef:  # (6)
    ...

1. See UpdateLabelsPayloadTypeDef
2. See UpdateTaintsPayloadTypeDef
3. See NodegroupScalingConfigTypeDef
4. See NodegroupUpdateConfigTypeDef
5. See NodeRepairConfigUnionTypeDef
6. See UpdateNodegroupConfigResponseTypeDef

# update_nodegroup_config method usage example with argument unpacking

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

parent.update_nodegroup_config(**kwargs)

1. See UpdateNodegroupConfigRequestTypeDef

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: UpdateNodegroupVersionRequestTypeDef = {  # (1)
    "clusterName": ...,
    "nodegroupName": ...,
}

parent.update_nodegroup_version(**kwargs)

1. See UpdateNodegroupVersionRequestTypeDef

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 = ...,
    disableSessionTags: bool = ...,
    targetRoleArn: str = ...,
) -> UpdatePodIdentityAssociationResponseTypeDef:  # (1)
    ...

1. See UpdatePodIdentityAssociationResponseTypeDef

# update_pod_identity_association method usage example with argument unpacking

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

parent.update_pod_identity_association(**kwargs)

1. See UpdatePodIdentityAssociationRequestTypeDef

get_paginator

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

• client.get_paginator("describe_addon_versions") -> DescribeAddonVersionsPaginator
• client.get_paginator("describe_cluster_versions") -> DescribeClusterVersionsPaginator
• client.get_paginator("list_access_entries") -> ListAccessEntriesPaginator
• client.get_paginator("list_access_policies") -> ListAccessPoliciesPaginator
• client.get_paginator("list_addons") -> ListAddonsPaginator
• client.get_paginator("list_associated_access_policies") -> ListAssociatedAccessPoliciesPaginator
• client.get_paginator("list_capabilities") -> ListCapabilitiesPaginator
• client.get_paginator("list_clusters") -> ListClustersPaginator
• client.get_paginator("list_eks_anywhere_subscriptions") -> ListEksAnywhereSubscriptionsPaginator
• client.get_paginator("list_fargate_profiles") -> ListFargateProfilesPaginator
• client.get_paginator("list_identity_provider_configs") -> ListIdentityProviderConfigsPaginator
• client.get_paginator("list_insights") -> ListInsightsPaginator
• client.get_paginator("list_nodegroups") -> ListNodegroupsPaginator
• client.get_paginator("list_pod_identity_associations") -> ListPodIdentityAssociationsPaginator
• client.get_paginator("list_updates") -> ListUpdatesPaginator

get_waiter

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

• client.get_waiter("addon_active") -> AddonActiveWaiter
• client.get_waiter("addon_deleted") -> AddonDeletedWaiter
• client.get_waiter("cluster_active") -> ClusterActiveWaiter
• client.get_waiter("cluster_deleted") -> ClusterDeletedWaiter
• client.get_waiter("fargate_profile_active") -> FargateProfileActiveWaiter
• client.get_waiter("fargate_profile_deleted") -> FargateProfileDeletedWaiter
• client.get_waiter("nodegroup_active") -> NodegroupActiveWaiter
• client.get_waiter("nodegroup_deleted") -> NodegroupDeletedWaiter