MemoryDB / Paginator / DescribeACLs

DescribeACLs

class MemoryDB.Paginator.DescribeACLs

paginator = client.get_paginator('describe_acls')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MemoryDB.Client.describe_acls().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ACLName (string) – The name of the ACL

• 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

{
    'ACLs': [
        {
            'Name': 'string',
            'Status': 'string',
            'UserNames': [
                'string',
            ],
            'MinimumEngineVersion': 'string',
            'PendingChanges': {
                'UserNamesToRemove': [
                    'string',
                ],
                'UserNamesToAdd': [
                    'string',
                ]
            },
            'Clusters': [
                'string',
            ],
            'ARN': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • ACLs (list) –

    The list of ACLs

    • (dict) –

      An Access Control List. You can authenticate users with Access Contol Lists. ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.

      • Name (string) –

        The name of the Access Control List

      • Status (string) –

        Indicates ACL status. Can be “creating”, “active”, “modifying”, “deleting”.

      • UserNames (list) –

        The list of user names that belong to the ACL.

        • (string) –

      • MinimumEngineVersion (string) –

        The minimum engine version supported for the ACL

      • PendingChanges (dict) –

        A list of updates being applied to the ACL.

        • UserNamesToRemove (list) –

          A list of user names being removed from the ACL

          • (string) –

        • UserNamesToAdd (list) –

          A list of users being added to the ACL

          • (string) –

      • Clusters (list) –

        A list of clusters associated with the ACL.

        • (string) –

      • ARN (string) –

        The Amazon Resource Name (ARN) of the ACL