QLDB / Client / update_ledger_permissions_mode

update_ledger_permissions_mode#

QLDB.Client.update_ledger_permissions_mode(**kwargs)#

Updates the permissions mode of a ledger.

Warning

Before you switch to the STANDARD permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_ledger_permissions_mode(
    Name='string',
    PermissionsMode='ALLOW_ALL'|'STANDARD'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the ledger.

  • PermissionsMode (string) –

    [REQUIRED]

    The permissions mode to assign to the ledger. This parameter can have one of the following values:

    • ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for ledgers. This mode allows users who have the SendCommand API permission for this ledger to run all PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.

    • STANDARD: (Recommended) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands. By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the SendCommand API permission for the ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide.

    Note

    We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger data.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Arn': 'string',
    'PermissionsMode': 'ALLOW_ALL'|'STANDARD'
}

Response Structure

  • (dict) –

    • Name (string) –

      The name of the ledger.

    • Arn (string) –

      The Amazon Resource Name (ARN) for the ledger.

    • PermissionsMode (string) –

      The current permissions mode of the ledger.

Exceptions

  • QLDB.Client.exceptions.InvalidParameterException

  • QLDB.Client.exceptions.ResourceNotFoundException