Package software.amazon.awssdk.services.eksauth

Interface EksAuthAsyncClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface EksAuthAsyncClient
extends AwsClient

Service client for accessing Amazon EKS Auth asynchronously. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AssumeRoleForPodIdentityResponse>	assumeRoleForPodIdentity(Consumer<AssumeRoleForPodIdentityRequest.Builder> assumeRoleForPodIdentityRequest)	The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.
default CompletableFuture<AssumeRoleForPodIdentityResponse>	assumeRoleForPodIdentity(AssumeRoleForPodIdentityRequest assumeRoleForPodIdentityRequest)	The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.
static EksAuthAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a EksAuthAsyncClient.
static EksAuthAsyncClient	create()	Create a EksAuthAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default EksAuthServiceClientConfiguration	serviceClientConfiguration()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

assumeRoleForPodIdentity

default CompletableFuture<AssumeRoleForPodIdentityResponse> assumeRoleForPodIdentity(AssumeRoleForPodIdentityRequest assumeRoleForPodIdentityRequest)

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

We recommend that applications use the Amazon Web Services SDKs to connect to Amazon Web Services services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically.

Parameters:

assumeRoleForPodIdentityRequest -

Returns:

A Java Future containing the result of the AssumeRoleForPodIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ThrottlingException The request was denied because your request rate is too high. Reduce the frequency of requests.
• InvalidRequestException This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
• AccessDeniedException You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.
• InternalServerException These errors are usually caused by a server-side issue.
• InvalidTokenException The specified Kubernetes service account token is invalid.
• InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
• ExpiredTokenException The specified Kubernetes service account token is expired.
• ResourceNotFoundException The specified resource could not be found.
• ServiceUnavailableException The service is unavailable. Back off and retry the operation.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• EksAuthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

assumeRoleForPodIdentity

default CompletableFuture<AssumeRoleForPodIdentityResponse> assumeRoleForPodIdentity(Consumer<AssumeRoleForPodIdentityRequest.Builder> assumeRoleForPodIdentityRequest)

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

We recommend that applications use the Amazon Web Services SDKs to connect to Amazon Web Services services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically.

This is a convenience which creates an instance of the AssumeRoleForPodIdentityRequest.Builder avoiding the need to create one manually via AssumeRoleForPodIdentityRequest.builder()

Parameters:

assumeRoleForPodIdentityRequest - A Consumer that will call methods on AssumeRoleForPodIdentityRequest.Builder to create a request.

Returns:

A Java Future containing the result of the AssumeRoleForPodIdentity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ThrottlingException The request was denied because your request rate is too high. Reduce the frequency of requests.
• InvalidRequestException This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
• AccessDeniedException You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.
• InternalServerException These errors are usually caused by a server-side issue.
• InvalidTokenException The specified Kubernetes service account token is invalid.
• InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
• ExpiredTokenException The specified Kubernetes service account token is expired.
• ResourceNotFoundException The specified resource could not be found.
• ServiceUnavailableException The service is unavailable. Back off and retry the operation.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• EksAuthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

serviceClientConfiguration

default EksAuthServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

create

static EksAuthAsyncClient create()

Create a EksAuthAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static EksAuthAsyncClientBuilder builder()

Create a builder that can be used to configure and create a EksAuthAsyncClient.