com.amazonaws.services.eksauth

Interface AmazonEKSAuth

All Known Subinterfaces:

AmazonEKSAuthAsync

All Known Implementing Classes:

AbstractAmazonEKSAuth, AbstractAmazonEKSAuthAsync, AmazonEKSAuthAsyncClient, AmazonEKSAuthClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonEKSAuth

Interface for accessing Amazon EKS Auth.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonEKSAuth instead.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssumeRoleForPodIdentityResult	assumeRoleForPodIdentity(AssumeRoleForPodIdentityRequest assumeRoleForPodIdentityRequest) The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

assumeRoleForPodIdentity

AssumeRoleForPodIdentityResult 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:

Result of the AssumeRoleForPodIdentity operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.