EKS / Paginator / ListPodIdentityAssociations

ListPodIdentityAssociations

class EKS.Paginator.ListPodIdentityAssociations

paginator = client.get_paginator('list_pod_identity_associations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• clusterName (string) –

  [REQUIRED]

  The name of the cluster that the associations are in.

• namespace (string) – The name of the Kubernetes namespace inside the cluster that the associations are in.

• serviceAccount (string) – The name of the Kubernetes service account that the associations use.

• 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

{
    'associations': [
        {
            'clusterName': 'string',
            'namespace': 'string',
            'serviceAccount': 'string',
            'associationArn': 'string',
            'associationId': 'string',
            'ownerArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • associations (list) –

    The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided.

    Each summary is simplified by removing these fields compared to the full ``PodIdentityAssociation ``:

    • The IAM role: roleArn

    • The timestamp that the association was created at: createdAt

    • The most recent timestamp that the association was modified at:. modifiedAt

    • The tags on the association: tags

    • (dict) –

      The summarized description of the association.

      Each summary is simplified by removing these fields compared to the full ``PodIdentityAssociation ``:

      • The IAM role: roleArn

      • The timestamp that the association was created at: createdAt

      • The most recent timestamp that the association was modified at:. modifiedAt

      • The tags on the association: tags

      • clusterName (string) –

        The name of the cluster that the association is in.

      • namespace (string) –

        The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the pods that use the service account must be in this namespace.

      • serviceAccount (string) –

        The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

      • associationArn (string) –

        The Amazon Resource Name (ARN) of the association.

      • associationId (string) –

        The ID of the association.

      • ownerArn (string) –

        If defined, the Pod Identity Association is owned by an Amazon EKS Addon.

  • NextToken (string) –

    A token to resume pagination.