EKS / Paginator / ListAccessPolicies

ListAccessPolicies

class EKS.Paginator.ListAccessPolicies

paginator = client.get_paginator('list_access_policies')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EKS.Client.list_access_policies().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'accessPolicies': [
        {
            'name': 'string',
            'arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • accessPolicies (list) –

    The list of available access policies. You can’t view the contents of an access policy using the API. To view the contents, see Access policy permissions in the Amazon EKS User Guide.

    • (dict) –

      An access policy includes permissions that allow Amazon EKS to authorize an IAM principal to work with Kubernetes objects on your cluster. The policies are managed by Amazon EKS, but they’re not IAM policies. You can’t view the permissions in the policies using the API. The permissions for many of the policies are similar to the Kubernetes cluster-admin, admin, edit, and view cluster roles. For more information about these cluster roles, see User-facing roles in the Kubernetes documentation. To view the contents of the policies, see Access policy permissions in the Amazon EKS User Guide.

      • name (string) –

        The name of the access policy.

      • arn (string) –

        The ARN of the access policy.

  • NextToken (string) –

    A token to resume pagination.