Class: AWS.QLDB

var params = {
  Name: 'STRING_VALUE', /* required */
  PermissionsMode: ALLOW_ALL | STANDARD, /* required */
  DeletionProtection: true || false,
  KmsKey: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
qldb.createLedger(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger that you want to create. The name must be unique among all of the ledgers in your Amazon Web Services account in the current Region.

    Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

  • Tags — (map<String>)

    The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

  • PermissionsMode — (String)

    The permissions mode to assign to the ledger that you want to create. 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.
    Possible values include:
    • "ALLOW_ALL"
    • "STANDARD"
  • DeletionProtection — (Boolean)

    The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

    If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

  • KmsKey — (String)

    The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see Encryption at rest in the Amazon QLDB Developer Guide.

    Use one of the following options to specify this parameter:

    • AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.

    • Undefined: By default, use an Amazon Web Services owned KMS key.

    • A valid symmetric customer managed KMS key: Use the specified KMS key in your account that you create, own, and manage.

      Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

    To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • Alias name: alias/ExampleAlias

    • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

    For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the ledger.

    • Arn — (String)

      The Amazon Resource Name (ARN) for the ledger.

    • State — (String)

      The current status of the ledger.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
    • CreationDateTime — (Date)

      The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    • PermissionsMode — (String)

      The permissions mode of the ledger that you created.

      Possible values include:
      • "ALLOW_ALL"
      • "STANDARD"
    • DeletionProtection — (Boolean)

      The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

      If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

    • KmsKeyArn — (String)

      The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
qldb.deleteLedger(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LedgerName: 'STRING_VALUE', /* required */
  StreamId: 'STRING_VALUE' /* required */
};
qldb.describeJournalKinesisStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LedgerName — (String)

    The name of the ledger.

  • StreamId — (String)

    The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Stream — (map)

      Information about the QLDB journal stream returned by a DescribeJournalS3Export request.

      • LedgerName — required — (String)

        The name of the ledger.

      • CreationTime — (Date)

        The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

      • InclusiveStartTime — (Date)

        The inclusive start date and time from which to start streaming journal data.

      • ExclusiveEndTime — (Date)

        The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

      • StreamId — required — (String)

        The UUID (represented in Base62-encoded text) of the QLDB journal stream.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the QLDB journal stream.

      • Status — required — (String)

        The current state of the QLDB journal stream.

        Possible values include:
        • "ACTIVE"
        • "COMPLETED"
        • "CANCELED"
        • "FAILED"
        • "IMPAIRED"
      • KinesisConfiguration — required — (map)

        The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

        • StreamArn — required — (String)

          The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

        • AggregationEnabled — (Boolean)

          Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

          This option is enabled by default. Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide.

      • ErrorCause — (String)

        The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

        Possible values include:
        • "KINESIS_STREAM_NOT_FOUND"
        • "IAM_PERMISSION_REVOKED"
      • StreamName — required — (String)

        The user-defined name of the QLDB journal stream.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExportId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
qldb.describeJournalS3Export(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger.

  • ExportId — (String)

    The UUID (represented in Base62-encoded text) of the journal export job to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ExportDescription — (map)

      Information about the journal export job returned by a DescribeJournalS3Export request.

      • LedgerName — required — (String)

        The name of the ledger.

      • ExportId — required — (String)

        The UUID (represented in Base62-encoded text) of the journal export job.

      • ExportCreationTime — required — (Date)

        The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

      • Status — required — (String)

        The current state of the journal export job.

        Possible values include:
        • "IN_PROGRESS"
        • "COMPLETED"
        • "CANCELLED"
      • InclusiveStartTime — required — (Date)

        The inclusive start date and time for the range of journal contents that was specified in the original export request.

      • ExclusiveEndTime — required — (Date)

        The exclusive end date and time for the range of journal contents that was specified in the original export request.

      • S3ExportConfiguration — required — (map)

        The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.

        • Bucket — required — (String)

          The Amazon S3 bucket name in which a journal export job writes the journal contents.

          The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.

        • Prefix — required — (String)

          The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.

          The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.

          The following are examples of valid Prefix values:

          • JournalExports-ForMyLedger/Testing/

          • JournalExports

          • My:Tests/

        • EncryptionConfiguration — required — (map)

          The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.

          • ObjectEncryptionType — required — (String)

            The Amazon S3 object encryption type.

            To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.

            Possible values include:
            • "SSE_KMS"
            • "SSE_S3"
            • "NO_ENCRYPTION"
          • KmsKeyArn — (String)

            The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.

            You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.

            KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

        • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

        • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

      • OutputFormat — (String)

        The output format of the exported journal data.

        Possible values include:
        • "ION_BINARY"
        • "ION_TEXT"
        • "JSON"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
qldb.describeLedger(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger that you want to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the ledger.

    • Arn — (String)

      The Amazon Resource Name (ARN) for the ledger.

    • State — (String)

      The current status of the ledger.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
    • CreationDateTime — (Date)

      The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    • PermissionsMode — (String)

      The permissions mode of the ledger.

      Possible values include:
      • "ALLOW_ALL"
      • "STANDARD"
    • DeletionProtection — (Boolean)

      The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

      If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

    • EncryptionDescription — (map)

      Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error).

      • KmsKeyArn — required — (String)

        The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

      • EncryptionStatus — required — (String)

        The current state of encryption at rest for the ledger. This can be one of the following values:

        • ENABLED: Encryption is fully enabled using the specified key.

        • UPDATING: The ledger is actively processing the specified key change.

          Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

        • KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

          An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

        Possible values include:
        • "ENABLED"
        • "UPDATING"
        • "KMS_KEY_INACCESSIBLE"
      • InaccessibleKmsKeyDateTime — (Date)

        The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)

        This parameter is undefined if the KMS key is accessible.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExclusiveEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  InclusiveStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  S3ExportConfiguration: { /* required */
    Bucket: 'STRING_VALUE', /* required */
    EncryptionConfiguration: { /* required */
      ObjectEncryptionType: SSE_KMS | SSE_S3 | NO_ENCRYPTION, /* required */
      KmsKeyArn: 'STRING_VALUE'
    },
    Prefix: 'STRING_VALUE' /* required */
  },
  OutputFormat: ION_BINARY | ION_TEXT | JSON
};
qldb.exportJournalToS3(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger.

  • InclusiveStartTime — (Date)

    The inclusive start date and time for the range of journal contents to export.

    The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

    The InclusiveStartTime must be before ExclusiveEndTime.

    If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

  • ExclusiveEndTime — (Date)

    The exclusive end date and time for the range of journal contents to export.

    The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

    The ExclusiveEndTime must be less than or equal to the current UTC date and time.

  • S3ExportConfiguration — (map)

    The configuration settings of the Amazon S3 bucket destination for your export request.

    • Bucket — required — (String)

      The Amazon S3 bucket name in which a journal export job writes the journal contents.

      The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.

    • Prefix — required — (String)

      The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.

      The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.

      The following are examples of valid Prefix values:

      • JournalExports-ForMyLedger/Testing/

      • JournalExports

      • My:Tests/

    • EncryptionConfiguration — required — (map)

      The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.

      • ObjectEncryptionType — required — (String)

        The Amazon S3 object encryption type.

        To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.

        Possible values include:
        • "SSE_KMS"
        • "SSE_S3"
        • "NO_ENCRYPTION"
      • KmsKeyArn — (String)

        The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.

        You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.

        KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.

  • RoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

    • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

    • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

    To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.

  • OutputFormat — (String)

    The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.

    Possible values include:
    • "ION_BINARY"
    • "ION_TEXT"
    • "JSON"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ExportId — (String)

      The UUID (represented in Base62-encoded text) that QLDB assigns to each journal export job.

      To describe your export request and check the status of the job, you can use ExportId to call DescribeJournalS3Export.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BlockAddress: { /* required */
    IonText: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE', /* required */
  DigestTipAddress: {
    IonText: 'STRING_VALUE'
  }
};
qldb.getBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger.

  • BlockAddress — (map)

    The location of the block that you want to request. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.

    • IonText — (String)

      An Amazon Ion plaintext value contained in a ValueHolder structure.

  • DigestTipAddress — (map)

    The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.

    • IonText — (String)

      An Amazon Ion plaintext value contained in a ValueHolder structure.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Block — (map)

      The block data object in Amazon Ion format.

      • IonText — (String)

        An Amazon Ion plaintext value contained in a ValueHolder structure.

    • Proof — (map)

      The proof object in Amazon Ion format returned by a GetBlock request. A proof contains the list of hash values required to recalculate the specified digest using a Merkle tree, starting with the specified block.

      • IonText — (String)

        An Amazon Ion plaintext value contained in a ValueHolder structure.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
qldb.getDigest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Digest — (Buffer(Node.js), Typed Array(Browser))

      The 256-bit hash value representing the digest returned by a GetDigest request.

    • DigestTipAddress — (map)

      The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

      • IonText — (String)

        An Amazon Ion plaintext value contained in a ValueHolder structure.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BlockAddress: { /* required */
    IonText: 'STRING_VALUE'
  },
  DocumentId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  DigestTipAddress: {
    IonText: 'STRING_VALUE'
  }
};
qldb.getRevision(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger.

  • BlockAddress — (map)

    The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.

    • IonText — (String)

      An Amazon Ion plaintext value contained in a ValueHolder structure.

  • DocumentId — (String)

    The UUID (represented in Base62-encoded text) of the document to be verified.

  • DigestTipAddress — (map)

    The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.

    • IonText — (String)

      An Amazon Ion plaintext value contained in a ValueHolder structure.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Proof — (map)

      The proof object in Amazon Ion format returned by a GetRevision request. A proof contains the list of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the specified document revision.

      • IonText — (String)

        An Amazon Ion plaintext value contained in a ValueHolder structure.

    • Revision — (map)

      The document revision data object in Amazon Ion format.

      • IonText — (String)

        An Amazon Ion plaintext value contained in a ValueHolder structure.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  LedgerName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
qldb.listJournalKinesisStreamsForLedger(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LedgerName — (String)

    The name of the ledger.

  • MaxResults — (Integer)

    The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)

  • NextToken — (String)

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalKinesisStreamsForLedger call, you should use that value as input here.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Streams — (Array<map>)

      The array of QLDB journal stream descriptors that are associated with the given ledger.

      • LedgerName — required — (String)

        The name of the ledger.

      • CreationTime — (Date)

        The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

      • InclusiveStartTime — (Date)

        The inclusive start date and time from which to start streaming journal data.

      • ExclusiveEndTime — (Date)

        The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

      • StreamId — required — (String)

        The UUID (represented in Base62-encoded text) of the QLDB journal stream.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the QLDB journal stream.

      • Status — required — (String)

        The current state of the QLDB journal stream.

        Possible values include:
        • "ACTIVE"
        • "COMPLETED"
        • "CANCELED"
        • "FAILED"
        • "IMPAIRED"
      • KinesisConfiguration — required — (map)

        The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

        • StreamArn — required — (String)

          The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

        • AggregationEnabled — (Boolean)

          Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

          This option is enabled by default. Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide.

      • ErrorCause — (String)

        The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

        Possible values include:
        • "KINESIS_STREAM_NOT_FOUND"
        • "IAM_PERMISSION_REVOKED"
      • StreamName — required — (String)

        The user-defined name of the QLDB journal stream.

    • NextToken — (String)

      • If NextToken is empty, the last page of results has been processed and there are no more results to be retrieved.

      • If NextToken is not empty, more results are available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalKinesisStreamsForLedger call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
qldb.listJournalS3Exports(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    The maximum number of results to return in a single ListJournalS3Exports request. (The actual number of results returned might be fewer.)

  • NextToken — (String)

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3Exports call, then you should use that value as input here.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JournalS3Exports — (Array<map>)

      The array of journal export job descriptions for all ledgers that are associated with the current Amazon Web Services account and Region.

      • LedgerName — required — (String)

        The name of the ledger.

      • ExportId — required — (String)

        The UUID (represented in Base62-encoded text) of the journal export job.

      • ExportCreationTime — required — (Date)

        The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

      • Status — required — (String)

        The current state of the journal export job.

        Possible values include:
        • "IN_PROGRESS"
        • "COMPLETED"
        • "CANCELLED"
      • InclusiveStartTime — required — (Date)

        The inclusive start date and time for the range of journal contents that was specified in the original export request.

      • ExclusiveEndTime — required — (Date)

        The exclusive end date and time for the range of journal contents that was specified in the original export request.

      • S3ExportConfiguration — required — (map)

        The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.

        • Bucket — required — (String)

          The Amazon S3 bucket name in which a journal export job writes the journal contents.

          The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.

        • Prefix — required — (String)

          The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.

          The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.

          The following are examples of valid Prefix values:

          • JournalExports-ForMyLedger/Testing/

          • JournalExports

          • My:Tests/

        • EncryptionConfiguration — required — (map)

          The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.

          • ObjectEncryptionType — required — (String)

            The Amazon S3 object encryption type.

            To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.

            Possible values include:
            • "SSE_KMS"
            • "SSE_S3"
            • "NO_ENCRYPTION"
          • KmsKeyArn — (String)

            The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.

            You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.

            KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

        • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

        • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

      • OutputFormat — (String)

        The output format of the exported journal data.

        Possible values include:
        • "ION_BINARY"
        • "ION_TEXT"
        • "JSON"
    • NextToken — (String)

      • If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved.

      • If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalS3Exports call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
qldb.listJournalS3ExportsForLedger(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger.

  • MaxResults — (Integer)

    The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The actual number of results returned might be fewer.)

  • NextToken — (String)

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3ExportsForLedger call, then you should use that value as input here.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JournalS3Exports — (Array<map>)

      The array of journal export job descriptions that are associated with the specified ledger.

      • LedgerName — required — (String)

        The name of the ledger.

      • ExportId — required — (String)

        The UUID (represented in Base62-encoded text) of the journal export job.

      • ExportCreationTime — required — (Date)

        The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

      • Status — required — (String)

        The current state of the journal export job.

        Possible values include:
        • "IN_PROGRESS"
        • "COMPLETED"
        • "CANCELLED"
      • InclusiveStartTime — required — (Date)

        The inclusive start date and time for the range of journal contents that was specified in the original export request.

      • ExclusiveEndTime — required — (Date)

        The exclusive end date and time for the range of journal contents that was specified in the original export request.

      • S3ExportConfiguration — required — (map)

        The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.

        • Bucket — required — (String)

          The Amazon S3 bucket name in which a journal export job writes the journal contents.

          The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.

        • Prefix — required — (String)

          The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.

          The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.

          The following are examples of valid Prefix values:

          • JournalExports-ForMyLedger/Testing/

          • JournalExports

          • My:Tests/

        • EncryptionConfiguration — required — (map)

          The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.

          • ObjectEncryptionType — required — (String)

            The Amazon S3 object encryption type.

            To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.

            Possible values include:
            • "SSE_KMS"
            • "SSE_S3"
            • "NO_ENCRYPTION"
          • KmsKeyArn — (String)

            The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.

            You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.

            KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

        • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

        • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

      • OutputFormat — (String)

        The output format of the exported journal data.

        Possible values include:
        • "ION_BINARY"
        • "ION_TEXT"
        • "JSON"
    • NextToken — (String)

      • If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved.

      • If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalS3ExportsForLedger call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
qldb.listLedgers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    The maximum number of results to return in a single ListLedgers request. (The actual number of results returned might be fewer.)

  • NextToken — (String)

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListLedgers call, then you should use that value as input here.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Ledgers — (Array<map>)

      The array of ledger summaries that are associated with the current Amazon Web Services account and Region.

      • Name — (String)

        The name of the ledger.

      • State — (String)

        The current status of the ledger.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "DELETED"
      • CreationDateTime — (Date)

        The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    • NextToken — (String)

      A pagination token, indicating whether there are more results available:

      • If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved.

      • If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListLedgers call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
qldb.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) for which to list the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (map<String>)

      The tags that are currently associated with the specified Amazon QLDB resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InclusiveStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  KinesisConfiguration: { /* required */
    StreamArn: 'STRING_VALUE', /* required */
    AggregationEnabled: true || false
  },
  LedgerName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  StreamName: 'STRING_VALUE', /* required */
  ExclusiveEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
qldb.streamJournalToKinesis(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • LedgerName — (String)

    The name of the ledger.

  • RoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

    To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

  • Tags — (map<String>)

    The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

  • InclusiveStartTime — (Date)

    The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

    The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

    If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

  • ExclusiveEndTime — (Date)

    The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

    The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

  • KinesisConfiguration — (map)

    The configuration settings of the Kinesis Data Streams destination for your stream request.

    • StreamArn — required — (String)

      The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

    • AggregationEnabled — (Boolean)

      Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

      This option is enabled by default. Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide.

  • StreamName — (String)

    The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

    Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • StreamId — (String)

      The UUID (represented in Base62-encoded text) that QLDB assigns to each QLDB journal stream.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
qldb.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) to which you want to add the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

  • Tags — (map<String>)

    The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
qldb.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) from which to remove the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

  • TagKeys — (Array<String>)

    The list of tag keys to remove.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  DeletionProtection: true || false,
  KmsKey: 'STRING_VALUE'
};
qldb.updateLedger(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger.

  • DeletionProtection — (Boolean)

    The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

    If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

  • KmsKey — (String)

    The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see Encryption at rest in the Amazon QLDB Developer Guide.

    Use one of the following options to specify this parameter:

    • AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.

    • Undefined: Make no changes to the KMS key of the ledger.

    • A valid symmetric customer managed KMS key: Use the specified KMS key in your account that you create, own, and manage.

      Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

    To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • Alias name: alias/ExampleAlias

    • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

    For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the ledger.

    • Arn — (String)

      The Amazon Resource Name (ARN) for the ledger.

    • State — (String)

      The current status of the ledger.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
    • CreationDateTime — (Date)

      The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    • DeletionProtection — (Boolean)

      The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

      If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

    • EncryptionDescription — (map)

      Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error).

      • KmsKeyArn — required — (String)

        The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

      • EncryptionStatus — required — (String)

        The current state of encryption at rest for the ledger. This can be one of the following values:

        • ENABLED: Encryption is fully enabled using the specified key.

        • UPDATING: The ledger is actively processing the specified key change.

          Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

        • KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

          An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

        Possible values include:
        • "ENABLED"
        • "UPDATING"
        • "KMS_KEY_INACCESSIBLE"
      • InaccessibleKmsKeyDateTime — (Date)

        The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)

        This parameter is undefined if the KMS key is accessible.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  PermissionsMode: ALLOW_ALL | STANDARD /* required */
};
qldb.updateLedgerPermissionsMode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ledger.

  • PermissionsMode — (String)

    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.
    Possible values include:
    • "ALLOW_ALL"
    • "STANDARD"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      Possible values include:
      • "ALLOW_ALL"
      • "STANDARD"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.