MemoryDB / Client / delete_acl

delete_acl#

MemoryDB.Client.delete_acl(**kwargs)#

Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).

Request Syntax

response = client.delete_acl(
    ACLName='string'
)

Parameters:

ACLName (string) –

[REQUIRED]

The name of the Access Control List to delete

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- ACL (dict) –
  
  The Access Control List object that has been deleted.
  - 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

Exceptions

MemoryDB.Client.exceptions.ACLNotFoundFault
MemoryDB.Client.exceptions.InvalidACLStateFault
MemoryDB.Client.exceptions.InvalidParameterValueException