PATCH

/ledgers/{name}/permissions-mode

http://qldb.{region}.amazonaws.com/ledgers/{name}/permissions-mode

Updates the permissions mode of a ledger. <important> Before you switch to the <code>STANDARD</code> permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating">Migrating to the standard permissions mode</a> in the Amazon QLDB Developer Guide. </important>

Access Token Required: API Key

Path Parameters

namestringrequired

The name of the ledger.

Body Params

PermissionsModestringrequired

The permissions mode to assign to the ledger. This parameter can have one of the following values: <ul> <li> <code>ALLOW_ALL</code>: A legacy permissions mode that enables access control with API-level granularity for ledgers. This mode allows users who have the <code>SendCommand</code> API permission for this ledger to run all PartiQL commands (hence, <code>ALLOW_ALL</code>) 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. </li> <li> <code>STANDARD</code>: (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 <code>SendCommand</code> API permission for the ledger. For information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html">Getting started with the standard permissions mode</a> in the Amazon QLDB Developer Guide. </li> </ul> <note> We strongly recommend using the <code>STANDARD</code> permissions mode to maximize the security of your ledger data. </note>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://qldb.{region}.amazonaws.com/ledgers/{name}/permissions-mode' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}