Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

DescribeAccessEntry

Describes an access entry.

Request Syntax


GET /clusters/name/access-entries/principalArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of your cluster.

Required: Yes

principalArn

The ARN of the IAM principal for the AccessEntry.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "accessEntry": { 
      "accessEntryArn": "string",
      "clusterName": "string",
      "createdAt": number,
      "kubernetesGroups": [ "string" ],
      "modifiedAt": number,
      "principalArn": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string",
      "username": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

accessEntry

Information about the access entry.

Type: AccessEntry object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidRequestException

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are AWS Region specific.

HTTP Status Code: 404

ServerException

These errors are usually caused by a server-side issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon EKS General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

The following example describes an access entry for an IAM role with the name my-role.

Sample Request


GET /clusters/my-cluster/access-entries/arn%3Aaws%3Aiam%3A%3A012345678910%3Arole%2Fmy-role HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.describe-access-entry
X-Amz-Date: 20230530T195959Z
Authorization: AUTHPARAMS

Sample Response


HTTP/1.1 200 OK
Date: Tue, 30 May 2023 20:00:14 GMT
Content-Type: application/json
Content-Length: 485
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id
x-amz-apigw-id: FwJV-FPGvHcFzPg=
Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS
Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive

{
  "accessEntry" : {
    "clusterName" : "my-cluster",
    "principalArn" : "arn:aws:iam::012345678910:role/my-role",
    "kubernetesGroups" : [ ],
    "accessEntryArn" : "arn:aws:eks:us-west-2:012345678910:accessEntry/my-cluster/role/012345678910/my-role/xxx11111-xx1x-xx11-1x11-xxx111x111x1",
    "createdAt" : 1.685475163532E9,
    "modifiedAt" : 1.685475163532E9,
    "tags" : { },
    "username" : "arn:aws:sts::012345678910:assumed-role/my-role/{{SessionName}}",
    "type" : "STANDARD"
  }
}