MemoryDB / Client / update_acl

update_acl

MemoryDB.Client.update_acl(**kwargs)

Changes the list of users that belong to the Access Control List.

See also: AWS API Documentation

Request Syntax

response = client.update_acl(
    ACLName='string',
    UserNamesToAdd=[
        'string',
    ],
    UserNamesToRemove=[
        'string',
    ]
)

Parameters:

• ACLName (string) –

  [REQUIRED]

  The name of the Access Control List.

• UserNamesToAdd (list) –

  The list of users to add to the Access Control List.

  • (string) –

• UserNamesToRemove (list) –

  The list of users to remove from the Access Control List.

  • (string) –

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 updated Access Control List.

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

• MemoryDB.Client.exceptions.DuplicateUserNameFault

• MemoryDB.Client.exceptions.DefaultUserRequired

• MemoryDB.Client.exceptions.InvalidACLStateFault

• MemoryDB.Client.exceptions.InvalidParameterValueException

• MemoryDB.Client.exceptions.InvalidParameterCombinationException