EKS / Client / list_access_entries

list_access_entries#

EKS.Client.list_access_entries(**kwargs)#

Lists the access entries for your cluster.

See also: AWS API Documentation

Request Syntax

response = client.list_access_entries(
    clusterName='string',
    associatedPolicyArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • clusterName (string) –

    [REQUIRED]

    The name of your cluster.

  • associatedPolicyArn (string) – The ARN of an AccessPolicy. When you specify an access policy ARN, only the access entries associated to that access policy are returned. For a list of available policy ARNs, use ListAccessPolicies.

  • maxResults (integer) – The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a nextToken value, if applicable, are returned.

  • nextToken (string) –

    The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

    Note

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Return type:

dict

Returns:

Response Syntax

{
    'accessEntries': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • accessEntries (list) –

      The list of access entries that exist for the cluster.

      • (string) –

    • nextToken (string) –

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      Note

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Exceptions