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

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.

Usage example

client = boto3.client("eks")

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

Type checking example

from mypy_boto3_eks.client import Exceptions

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

Methods

associate_encryption_config

Associate encryption configuration to an existing cluster.

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

Method definition

def associate_encryption_config(
    self,
    *,
    clusterName: str,
    encryptionConfig: Sequence[EncryptionConfigTypeDef],  # (1)
    clientRequestToken: str = ...,
) -> AssociateEncryptionConfigResponseTypeDef:  # (2)
    ...

1. See EncryptionConfigTypeDef
2. See AssociateEncryptionConfigResponseTypeDef

Usage example with kwargs

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

parent.associate_encryption_config(**kwargs)

1. See AssociateEncryptionConfigRequestRequestTypeDef

associate_identity_provider_config

Associate an identity provider configuration to a cluster.

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

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

Usage example with kwargs

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

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

Method definition

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

create_addon

Creates an Amazon EKS add-on.

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

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

Usage example with kwargs

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

Method definition

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

1. See VpcConfigRequestTypeDef
2. See KubernetesNetworkConfigRequestTypeDef
3. See LoggingTypeDef
4. See EncryptionConfigTypeDef
5. See OutpostConfigRequestTypeDef
6. See CreateClusterResponseTypeDef

Usage example with kwargs

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

parent.create_cluster(**kwargs)

1. See CreateClusterRequestRequestTypeDef

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

parent.create_nodegroup(**kwargs)

1. See CreateNodegroupRequestRequestTypeDef

delete_addon

Delete an Amazon EKS add-on.

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

Method definition

def delete_addon(
    self,
    *,
    clusterName: str,
    addonName: str,
    preserve: bool = ...,
) -> DeleteAddonResponseTypeDef:  # (1)
    ...

1. See DeleteAddonResponseTypeDef

Usage example with kwargs

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

parent.delete_addon(**kwargs)

1. See DeleteAddonRequestRequestTypeDef

delete_cluster

Deletes the Amazon EKS cluster control plane.

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

Method definition

def delete_cluster(
    self,
    *,
    name: str,
) -> DeleteClusterResponseTypeDef:  # (1)
    ...

1. See DeleteClusterResponseTypeDef

Usage example with kwargs

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

parent.delete_cluster(**kwargs)

1. See DeleteClusterRequestRequestTypeDef

delete_fargate_profile

Deletes an Fargate profile.

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

Method definition

def delete_fargate_profile(
    self,
    *,
    clusterName: str,
    fargateProfileName: str,
) -> DeleteFargateProfileResponseTypeDef:  # (1)
    ...

1. See DeleteFargateProfileResponseTypeDef

Usage example with kwargs

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

parent.delete_fargate_profile(**kwargs)

1. See DeleteFargateProfileRequestRequestTypeDef

delete_nodegroup

Deletes an Amazon EKS node group for a cluster.

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

Method definition

def delete_nodegroup(
    self,
    *,
    clusterName: str,
    nodegroupName: str,
) -> DeleteNodegroupResponseTypeDef:  # (1)
    ...

1. See DeleteNodegroupResponseTypeDef

Usage example with kwargs

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

parent.delete_nodegroup(**kwargs)

1. See DeleteNodegroupRequestRequestTypeDef

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

Method definition

def deregister_cluster(
    self,
    *,
    name: str,
) -> DeregisterClusterResponseTypeDef:  # (1)
    ...

1. See DeregisterClusterResponseTypeDef

Usage example with kwargs

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

parent.deregister_cluster(**kwargs)

1. See DeregisterClusterRequestRequestTypeDef

describe_addon

Describes an Amazon EKS add-on.

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

Method definition

def describe_addon(
    self,
    *,
    clusterName: str,
    addonName: str,
) -> DescribeAddonResponseTypeDef:  # (1)
    ...

1. See DescribeAddonResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_addon_configuration(
    self,
    *,
    addonName: str,
    addonVersion: str,
) -> DescribeAddonConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeAddonConfigurationResponseTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

parent.describe_addon_versions(**kwargs)

1. See DescribeAddonVersionsRequestRequestTypeDef

describe_cluster

Returns descriptive information about an Amazon EKS cluster.

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

Method definition

def describe_cluster(
    self,
    *,
    name: str,
) -> DescribeClusterResponseTypeDef:  # (1)
    ...

1. See DescribeClusterResponseTypeDef

Usage example with kwargs

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

parent.describe_cluster(**kwargs)

1. See DescribeClusterRequestRequestTypeDef

describe_fargate_profile

Returns descriptive information about an Fargate profile.

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

Method definition

def describe_fargate_profile(
    self,
    *,
    clusterName: str,
    fargateProfileName: str,
) -> DescribeFargateProfileResponseTypeDef:  # (1)
    ...

1. See DescribeFargateProfileResponseTypeDef

Usage example with kwargs

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

parent.describe_fargate_profile(**kwargs)

1. See DescribeFargateProfileRequestRequestTypeDef

describe_identity_provider_config

Returns descriptive information about an identity provider configuration.

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

Method definition

def describe_identity_provider_config(
    self,
    *,
    clusterName: str,
    identityProviderConfig: IdentityProviderConfigTypeDef,  # (1)
) -> DescribeIdentityProviderConfigResponseTypeDef:  # (2)
    ...

1. See IdentityProviderConfigTypeDef
2. See DescribeIdentityProviderConfigResponseTypeDef

Usage example with kwargs

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

parent.describe_identity_provider_config(**kwargs)

1. See DescribeIdentityProviderConfigRequestRequestTypeDef

describe_nodegroup

Returns descriptive information about an Amazon EKS node group.

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

Method definition

def describe_nodegroup(
    self,
    *,
    clusterName: str,
    nodegroupName: str,
) -> DescribeNodegroupResponseTypeDef:  # (1)
    ...

1. See DescribeNodegroupResponseTypeDef

Usage example with kwargs

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

parent.describe_nodegroup(**kwargs)

1. See DescribeNodegroupRequestRequestTypeDef

describe_update

Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.

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

Method definition

def describe_update(
    self,
    *,
    name: str,
    updateId: str,
    nodegroupName: str = ...,
    addonName: str = ...,
) -> DescribeUpdateResponseTypeDef:  # (1)
    ...

1. See DescribeUpdateResponseTypeDef

Usage example with kwargs

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

parent.describe_update(**kwargs)

1. See DescribeUpdateRequestRequestTypeDef

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

Method definition

def disassociate_identity_provider_config(
    self,
    *,
    clusterName: str,
    identityProviderConfig: IdentityProviderConfigTypeDef,  # (1)
    clientRequestToken: str = ...,
) -> DisassociateIdentityProviderConfigResponseTypeDef:  # (2)
    ...

1. See IdentityProviderConfigTypeDef
2. See DisassociateIdentityProviderConfigResponseTypeDef

Usage example with kwargs

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

Method definition

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

list_addons

Lists the available add-ons.

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

Method definition

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

1. See ListAddonsResponseTypeDef

Usage example with kwargs

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

parent.list_addons(**kwargs)

1. See ListAddonsRequestRequestTypeDef

list_clusters

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

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

Method definition

def list_clusters(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    include: Sequence[str] = ...,
) -> ListClustersResponseTypeDef:  # (1)
    ...

1. See ListClustersResponseTypeDef

Usage example with kwargs

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

parent.list_clusters(**kwargs)

1. See ListClustersRequestRequestTypeDef

list_fargate_profiles

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

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

Method definition

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

1. See ListFargateProfilesResponseTypeDef

Usage example with kwargs

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

parent.list_fargate_profiles(**kwargs)

1. See ListFargateProfilesRequestRequestTypeDef

list_identity_provider_configs

A list of identity provider configurations.

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

Method definition

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

1. See ListIdentityProviderConfigsResponseTypeDef

Usage example with kwargs

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

parent.list_identity_provider_configs(**kwargs)

1. See ListIdentityProviderConfigsRequestRequestTypeDef

list_nodegroups

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

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

Method definition

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

1. See ListNodegroupsResponseTypeDef

Usage example with kwargs

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

parent.list_nodegroups(**kwargs)

1. See ListNodegroupsRequestRequestTypeDef

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

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_updates

Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.

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

Method definition

def list_updates(
    self,
    *,
    name: str,
    nodegroupName: str = ...,
    addonName: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListUpdatesResponseTypeDef:  # (1)
    ...

1. See ListUpdatesResponseTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

parent.register_cluster(**kwargs)

1. See RegisterClusterRequestRequestTypeDef

tag_resource

Associates the specified tags to a resource with the specified resourceArn.

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

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Deletes specified tags from a resource.

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

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_addon

Updates an Amazon EKS add-on.

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

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

Usage example with kwargs

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

Method definition

def update_cluster_config(
    self,
    *,
    name: str,
    resourcesVpcConfig: VpcConfigRequestTypeDef = ...,  # (1)
    logging: LoggingTypeDef = ...,  # (2)
    clientRequestToken: str = ...,
) -> UpdateClusterConfigResponseTypeDef:  # (3)
    ...

1. See VpcConfigRequestTypeDef
2. See LoggingTypeDef
3. See UpdateClusterConfigResponseTypeDef

Usage example with kwargs

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

Method definition

def update_cluster_version(
    self,
    *,
    name: str,
    version: str,
    clientRequestToken: str = ...,
) -> UpdateClusterVersionResponseTypeDef:  # (1)
    ...

1. See UpdateClusterVersionResponseTypeDef

Usage example with kwargs

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

parent.update_cluster_version(**kwargs)

1. See UpdateClusterVersionRequestRequestTypeDef

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

parent.update_nodegroup_version(**kwargs)

1. See UpdateNodegroupVersionRequestRequestTypeDef

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("list_addons") -> ListAddonsPaginator
• client.get_paginator("list_clusters") -> ListClustersPaginator
• client.get_paginator("list_fargate_profiles") -> ListFargateProfilesPaginator
• client.get_paginator("list_identity_provider_configs") -> ListIdentityProviderConfigsPaginator
• client.get_paginator("list_nodegroups") -> ListNodegroupsPaginator
• 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