AssumeRoleForPodIdentity

$result = $client->assumeRoleForPodIdentity([/* ... */]);
$promise = $client->assumeRoleForPodIdentityAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->assumeRoleForPodIdentity([
    'clusterName' => '<string>', // REQUIRED
    'token' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assumedRoleUser' => [
        'arn' => '<string>',
        'assumeRoleId' => '<string>',
    ],
    'audience' => '<string>',
    'credentials' => [
        'accessKeyId' => '<string>',
        'expiration' => <DateTime>,
        'secretAccessKey' => '<string>',
        'sessionToken' => '<string>',
    ],
    'podIdentityAssociation' => [
        'associationArn' => '<string>',
        'associationId' => '<string>',
    ],
    'subject' => [
        'namespace' => '<string>',
        'serviceAccount' => '<string>',
    ],
]

Result Details

Errors

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.