EKSAuthClient

Index > EKSAuth > EKSAuthClient

Auto-generated documentation for EKSAuth type annotations stubs module types-aiobotocore-eks-auth.

EKSAuthClient

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

# EKSAuthClient usage example

from aioboto3.session import Session
from types_aiobotocore_eks_auth.client import EKSAuthClient

session = Session()
async with session.client("eks-auth") as client:
    client: EKSAuthClient

Exceptions

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

# EKSAuthClient.exceptions usage example

async with session.client("eks-auth") as client:
    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)

# EKSAuthClient.exceptions type checking example

from types_aiobotocore_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 session.client("eks-auth").assume_role_for_pod_identity method. boto3 documentation

# assume_role_for_pod_identity method definition

await 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 session.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 session.client("eks-auth").close method. boto3 documentation

# close method definition

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

generate_presigned_url

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

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

# generate_presigned_url method definition

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

__aenter__

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

# __aenter__ method definition

await def __aenter__(
    self,
) -> EKSAuthClient:
    ...

__aexit__

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

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...