EKSAuthClient

Index > EKSAuth > EKSAuthClient

Auto-generated documentation for EKSAuth type annotations stubs module mypy-boto3-eks-auth.

EKSAuthClient

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

# EKSAuthClient usage example

from boto3.session import Session
from mypy_boto3_eks_auth.client import EKSAuthClient

def get_eks-auth_client() -> EKSAuthClient:
    return Session().client("eks-auth")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("eks-auth").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("eks-auth")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ExpiredTokenException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidRequestException,
    client.exceptions.InvalidTokenException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_eks_auth.client import Exceptions

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

Methods

assume_role_for_pod_identity

The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.

Type annotations and code completion for boto3.client("eks-auth").assume_role_for_pod_identity method. boto3 documentation

# assume_role_for_pod_identity method definition

def assume_role_for_pod_identity(
    self,
    *,
    clusterName: str,
    token: str,
) -> AssumeRoleForPodIdentityResponseTypeDef:  # (1)
    ...

1. See AssumeRoleForPodIdentityResponseTypeDef

# assume_role_for_pod_identity method usage example with argument unpacking

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

parent.assume_role_for_pod_identity(**kwargs)

1. See AssumeRoleForPodIdentityRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("eks-auth").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("eks-auth").close method. boto3 documentation

# close method definition

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

generate_presigned_url

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

Type annotations and code completion for boto3.client("eks-auth").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:
    ...