list_access_entries ¶

def list_access_entries(
    self,
    cluster_name: "capo_eks.types.string.String",
    *,
    config_overrides: Optional[EKSClientConfig] = None,
    associated_policy_arn: Optional["capo_eks.types.string.String"] = None,
    max_results: Optional[
        "capo_eks.types.list_access_entries_request_max_results.ListAccessEntriesRequestMaxResults"
    ] = None,
    next_token: Optional["capo_eks.types.string.String"] = None,
) -> "capo_eks.types.list_access_entries_response.ListAccessEntriesResponse":
    """<p>Lists the access entries for your cluster.</p>

    Args:
        cluster_name: <p>The name of your cluster.</p>
        associated_policy_arn: <p>The ARN of an <code>AccessPolicy</code>. 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 <code>ListAccessPolicies</code>.</p>
        max_results: <p>The maximum number of results, returned in paginated output. You receive <code>maxResults</code> in a single page, along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <code>nextToken</code> value, if applicable, are returned.</p>
        next_token: <p>The <code>nextToken</code> value returned from a previous paginated request, where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is null when there are no more results to return.</p> <note> <p>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.</p> </note>

    Raises:
        capo_eks.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
        capo_eks.errors.invalid_request_exception.InvalidRequestException: <p>The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.</p>
        capo_eks.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found. You can view your available clusters with <code>ListClusters</code>. You can view your available managed node groups with <code>ListNodegroups</code>. Amazon EKS clusters and node groups are Amazon Web Services Region specific.</p>
        capo_eks.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
        capo_eks.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_eks.types.list_access_entries_request.ListAccessEntriesRequest]",
    ) -> OperationResponse[
        "capo_eks.types.list_access_entries_response.ListAccessEntriesResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.list_access_entries

        output, http_response = (
            capo_eks._operations.aws_wesley_frontend.list_access_entries.list_access_entries(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAccessEntries")
    )
    input_: capo_eks.types.list_access_entries_request.ListAccessEntriesRequest = {
        "cluster_name": cluster_name
    }
    if associated_policy_arn is not None:
        input_["associated_policy_arn"] = associated_policy_arn
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output