EKS / Client / list_associated_access_policies

list_associated_access_policies#

EKS.Client.list_associated_access_policies(**kwargs)#

Lists the access policies associated with an access entry.

See also: AWS API Documentation

Request Syntax

response = client.list_associated_access_policies(
    clusterName='string',
    principalArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • clusterName (string) –

    [REQUIRED]

    The name of your cluster.

  • principalArn (string) –

    [REQUIRED]

    The ARN of the IAM principal for the AccessEntry.

  • 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

{
    'clusterName': 'string',
    'principalArn': 'string',
    'nextToken': 'string',
    'associatedAccessPolicies': [
        {
            'policyArn': 'string',
            'accessScope': {
                'type': 'cluster'|'namespace',
                'namespaces': [
                    'string',
                ]
            },
            'associatedAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • clusterName (string) –

      The name of your cluster.

    • principalArn (string) –

      The ARN of the IAM principal for the AccessEntry.

    • 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.

    • associatedAccessPolicies (list) –

      The list of access policies associated with the access entry.

      • (dict) –

        An access policy association.

        • policyArn (string) –

          The ARN of the AccessPolicy.

        • accessScope (dict) –

          The scope of the access policy.

          • type (string) –

            The scope type of an access policy.

          • namespaces (list) –

            A Kubernetes namespace that an access policy is scoped to. A value is required if you specified namespace for Type.

            • (string) –

        • associatedAt (datetime) –

          The date and time the AccessPolicy was associated with an AccessEntry.

        • modifiedAt (datetime) –

          The Unix epoch timestamp for the last modification to the object.

Exceptions

  • EKS.Client.exceptions.ServerException

  • EKS.Client.exceptions.ResourceNotFoundException

  • EKS.Client.exceptions.InvalidRequestException