describe_acls

MemoryDB.Client.describe_acls(**kwargs)

Returns a list of ACLs

See also: AWS API Documentation

Request Syntax

response = client.describe_acls(
    ACLName='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• ACLName (string) -- The name of the ACL
• MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
• NextToken (string) -- An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Return type

dict

Returns

Response Syntax

{
    'ACLs': [
        {
            'Name': 'string',
            'Status': 'string',
            'UserNames': [
                'string',
            ],
            'MinimumEngineVersion': 'string',
            'PendingChanges': {
                'UserNamesToRemove': [
                    'string',
                ],
                'UserNamesToAdd': [
                    'string',
                ]
            },
            'Clusters': [
                'string',
            ],
            'ARN': 'string'
        },
    ],
    'NextToken': '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

  • NextToken (string) --

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Exceptions

• MemoryDB.Client.exceptions.ACLNotFoundFault
• MemoryDB.Client.exceptions.InvalidParameterCombinationException