EKS module#
Index > EKS
Auto-generated documentation for EKS type annotations stubs module mypy-boto3-eks.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and EKS
.
From PyPI with pip#
Install boto3-stubs
for EKS
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[eks]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[eks]'
# standalone installation
python -m pip install mypy-boto3-eks
How to uninstall#
python -m pip uninstall -y mypy-boto3-eks
Usage#
Code samples can be found in Examples.
EKSClient#
Type annotations and code completion for boto3.client("eks")
as EKSClient
boto3 documentation
# EKSClient usage example
from boto3.session import Session
from mypy_boto3_eks.client import EKSClient
def get_client() -> EKSClient:
return Session().client("eks")
Paginators#
Type annotations and code completion for paginators
from boto3.client("eks").get_paginator("...")
.
# DescribeAddonVersionsPaginator usage example
from boto3.session import Session
from mypy_boto3_eks.paginator import DescribeAddonVersionsPaginator
def get_describe_addon_versions_paginator() -> DescribeAddonVersionsPaginator:
return Session().client("eks").get_paginator("describe_addon_versions"))
- DescribeAddonVersionsPaginator
- ListAddonsPaginator
- ListClustersPaginator
- ListFargateProfilesPaginator
- ListIdentityProviderConfigsPaginator
- ListNodegroupsPaginator
- ListUpdatesPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("eks").get_waiter("...")
.
# AddonActiveWaiter usage example
from boto3.session import Session
from mypy_boto3_eks.waiter import AddonActiveWaiter
def get_addon_active_waiter() -> AddonActiveWaiter:
return Session().client("eks").get_waiter("addon_active")
- AddonActiveWaiter
- AddonDeletedWaiter
- ClusterActiveWaiter
- ClusterDeletedWaiter
- FargateProfileActiveWaiter
- FargateProfileDeletedWaiter
- NodegroupActiveWaiter
- NodegroupDeletedWaiter
Literals#
Type annotations for literals used in methods and schemas.
# AMITypesType usage example
from mypy_boto3_eks.literals import AMITypesType
def get_value() -> AMITypesType:
return "AL2_ARM_64"
- AMITypesType
- AddonActiveWaiterName
- AddonDeletedWaiterName
- AddonIssueCodeType
- AddonStatusType
- CapacityTypesType
- ClusterActiveWaiterName
- ClusterDeletedWaiterName
- ClusterIssueCodeType
- ClusterStatusType
- ConnectorConfigProviderType
- DescribeAddonVersionsPaginatorName
- ErrorCodeType
- FargateProfileActiveWaiterName
- FargateProfileDeletedWaiterName
- FargateProfileStatusType
- IpFamilyType
- ListAddonsPaginatorName
- ListClustersPaginatorName
- ListFargateProfilesPaginatorName
- ListIdentityProviderConfigsPaginatorName
- ListNodegroupsPaginatorName
- ListUpdatesPaginatorName
- LogTypeType
- NodegroupActiveWaiterName
- NodegroupDeletedWaiterName
- NodegroupIssueCodeType
- NodegroupStatusType
- ResolveConflictsType
- TaintEffectType
- UpdateParamTypeType
- UpdateStatusType
- UpdateTypeType
- configStatusType
- EKSServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AddonIssueTypeDef usage example
from mypy_boto3_eks.type_defs import AddonIssueTypeDef
def get_value() -> AddonIssueTypeDef:
return {
"code": ...,
}
- AddonIssueTypeDef
- MarketplaceInformationTypeDef
- CompatibilityTypeDef
- OidcIdentityProviderConfigRequestTypeDef
- AutoScalingGroupTypeDef
- CertificateTypeDef
- ClusterIssueTypeDef
- ConnectorConfigResponseTypeDef
- KubernetesNetworkConfigResponseTypeDef
- VpcConfigResponseTypeDef
- ConnectorConfigRequestTypeDef
- ControlPlanePlacementRequestTypeDef
- ControlPlanePlacementResponseTypeDef
- CreateAddonRequestRequestTypeDef
- KubernetesNetworkConfigRequestTypeDef
- VpcConfigRequestTypeDef
- FargateProfileSelectorTypeDef
- LaunchTemplateSpecificationTypeDef
- NodegroupScalingConfigTypeDef
- NodegroupUpdateConfigTypeDef
- RemoteAccessConfigTypeDef
- TaintTypeDef
- DeleteAddonRequestRequestTypeDef
- DeleteClusterRequestRequestTypeDef
- DeleteFargateProfileRequestRequestTypeDef
- DeleteNodegroupRequestRequestTypeDef
- DeregisterClusterRequestRequestTypeDef
- DescribeAddonConfigurationRequestRequestTypeDef
- DescribeAddonConfigurationResponseTypeDef
- WaiterConfigTypeDef
- DescribeAddonRequestRequestTypeDef
- DescribeAddonVersionsRequestDescribeAddonVersionsPaginateTypeDef
- DescribeAddonVersionsRequestRequestTypeDef
- DescribeClusterRequestRequestTypeDef
- DescribeFargateProfileRequestRequestTypeDef
- IdentityProviderConfigTypeDef
- DescribeNodegroupRequestRequestTypeDef
- DescribeUpdateRequestRequestTypeDef
- ProviderTypeDef
- ErrorDetailTypeDef
- OidcIdentityProviderConfigTypeDef
- OIDCTypeDef
- IssueTypeDef
- ListAddonsRequestListAddonsPaginateTypeDef
- ListAddonsRequestRequestTypeDef
- ListAddonsResponseTypeDef
- ListClustersRequestListClustersPaginateTypeDef
- ListClustersRequestRequestTypeDef
- ListClustersResponseTypeDef
- ListFargateProfilesRequestListFargateProfilesPaginateTypeDef
- ListFargateProfilesRequestRequestTypeDef
- ListFargateProfilesResponseTypeDef
- ListIdentityProviderConfigsRequestListIdentityProviderConfigsPaginateTypeDef
- ListIdentityProviderConfigsRequestRequestTypeDef
- ListNodegroupsRequestListNodegroupsPaginateTypeDef
- ListNodegroupsRequestRequestTypeDef
- ListNodegroupsResponseTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- ListUpdatesRequestListUpdatesPaginateTypeDef
- ListUpdatesRequestRequestTypeDef
- ListUpdatesResponseTypeDef
- LogSetupTypeDef
- PaginatorConfigTypeDef
- ResponseMetadataTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateAddonRequestRequestTypeDef
- UpdateClusterVersionRequestRequestTypeDef
- UpdateLabelsPayloadTypeDef
- UpdateParamTypeDef
- AddonHealthTypeDef
- AddonVersionInfoTypeDef
- AssociateIdentityProviderConfigRequestRequestTypeDef
- NodegroupResourcesTypeDef
- ClusterHealthTypeDef
- RegisterClusterRequestRequestTypeDef
- OutpostConfigRequestTypeDef
- OutpostConfigResponseTypeDef
- CreateFargateProfileRequestRequestTypeDef
- FargateProfileTypeDef
- UpdateNodegroupVersionRequestRequestTypeDef
- CreateNodegroupRequestRequestTypeDef
- UpdateTaintsPayloadTypeDef
- DescribeAddonRequestAddonActiveWaitTypeDef
- DescribeAddonRequestAddonDeletedWaitTypeDef
- DescribeClusterRequestClusterActiveWaitTypeDef
- DescribeClusterRequestClusterDeletedWaitTypeDef
- DescribeFargateProfileRequestFargateProfileActiveWaitTypeDef
- DescribeFargateProfileRequestFargateProfileDeletedWaitTypeDef
- DescribeNodegroupRequestNodegroupActiveWaitTypeDef
- DescribeNodegroupRequestNodegroupDeletedWaitTypeDef
- DescribeIdentityProviderConfigRequestRequestTypeDef
- DisassociateIdentityProviderConfigRequestRequestTypeDef
- ListIdentityProviderConfigsResponseTypeDef
- EncryptionConfigTypeDef
- IdentityProviderConfigResponseTypeDef
- IdentityTypeDef
- NodegroupHealthTypeDef
- LoggingTypeDef
- UpdateTypeDef
- AddonTypeDef
- AddonInfoTypeDef
- CreateFargateProfileResponseTypeDef
- DeleteFargateProfileResponseTypeDef
- DescribeFargateProfileResponseTypeDef
- UpdateNodegroupConfigRequestRequestTypeDef
- AssociateEncryptionConfigRequestRequestTypeDef
- DescribeIdentityProviderConfigResponseTypeDef
- NodegroupTypeDef
- ClusterTypeDef
- CreateClusterRequestRequestTypeDef
- UpdateClusterConfigRequestRequestTypeDef
- AssociateEncryptionConfigResponseTypeDef
- AssociateIdentityProviderConfigResponseTypeDef
- DescribeUpdateResponseTypeDef
- DisassociateIdentityProviderConfigResponseTypeDef
- UpdateAddonResponseTypeDef
- UpdateClusterConfigResponseTypeDef
- UpdateClusterVersionResponseTypeDef
- UpdateNodegroupConfigResponseTypeDef
- UpdateNodegroupVersionResponseTypeDef
- CreateAddonResponseTypeDef
- DeleteAddonResponseTypeDef
- DescribeAddonResponseTypeDef
- DescribeAddonVersionsResponseTypeDef
- CreateNodegroupResponseTypeDef
- DeleteNodegroupResponseTypeDef
- DescribeNodegroupResponseTypeDef
- CreateClusterResponseTypeDef
- DeleteClusterResponseTypeDef
- DeregisterClusterResponseTypeDef
- DescribeClusterResponseTypeDef
- RegisterClusterResponseTypeDef