CancelJournalKinesisStream

$result = $client->cancelJournalKinesisStream([/* ... */]);
$promise = $client->cancelJournalKinesisStreamAsync([/* ... */]);

Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE.

You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.

Parameter Syntax

$result = $client->cancelJournalKinesisStream([
    'LedgerName' => '<string>', // REQUIRED
    'StreamId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'StreamId' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

ResourcePreconditionNotMetException:

The operation failed because a condition wasn't satisfied in advance.

CreateLedger

$result = $client->createLedger([/* ... */]);
$promise = $client->createLedgerAsync([/* ... */]);

Creates a new ledger in your Amazon Web Services account in the current Region.

Parameter Syntax

$result = $client->createLedger([
    'DeletionProtection' => true || false,
    'KmsKey' => '<string>',
    'Name' => '<string>', // REQUIRED
    'PermissionsMode' => 'ALLOW_ALL|STANDARD', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationDateTime' => <DateTime>,
    'DeletionProtection' => true || false,
    'KmsKeyArn' => '<string>',
    'Name' => '<string>',
    'PermissionsMode' => 'ALLOW_ALL|STANDARD',
    'State' => 'CREATING|ACTIVE|DELETING|DELETED',
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

You have reached the limit on the maximum number of resources allowed.

ResourceInUseException:

The specified resource can't be modified at this time.

DeleteLedger

$result = $client->deleteLedger([/* ... */]);
$promise = $client->deleteLedgerAsync([/* ... */]);

Deletes a ledger and all of its contents. This action is irreversible.

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 this parameter to false.

Parameter Syntax

$result = $client->deleteLedger([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

ResourceInUseException:

The specified resource can't be modified at this time.

ResourcePreconditionNotMetException:

The operation failed because a condition wasn't satisfied in advance.

DescribeJournalKinesisStream

$result = $client->describeJournalKinesisStream([/* ... */]);
$promise = $client->describeJournalKinesisStreamAsync([/* ... */]);

Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.

This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.

Parameter Syntax

$result = $client->describeJournalKinesisStream([
    'LedgerName' => '<string>', // REQUIRED
    'StreamId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Stream' => [
        'Arn' => '<string>',
        'CreationTime' => <DateTime>,
        'ErrorCause' => 'KINESIS_STREAM_NOT_FOUND|IAM_PERMISSION_REVOKED',
        'ExclusiveEndTime' => <DateTime>,
        'InclusiveStartTime' => <DateTime>,
        'KinesisConfiguration' => [
            'AggregationEnabled' => true || false,
            'StreamArn' => '<string>',
        ],
        'LedgerName' => '<string>',
        'RoleArn' => '<string>',
        'Status' => 'ACTIVE|COMPLETED|CANCELED|FAILED|IMPAIRED',
        'StreamId' => '<string>',
        'StreamName' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

ResourcePreconditionNotMetException:

The operation failed because a condition wasn't satisfied in advance.

DescribeJournalS3Export

$result = $client->describeJournalS3Export([/* ... */]);
$promise = $client->describeJournalS3ExportAsync([/* ... */]);

Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.

If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

Parameter Syntax

$result = $client->describeJournalS3Export([
    'ExportId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ExportDescription' => [
        'ExclusiveEndTime' => <DateTime>,
        'ExportCreationTime' => <DateTime>,
        'ExportId' => '<string>',
        'InclusiveStartTime' => <DateTime>,
        'LedgerName' => '<string>',
        'OutputFormat' => 'ION_BINARY|ION_TEXT|JSON',
        'RoleArn' => '<string>',
        'S3ExportConfiguration' => [
            'Bucket' => '<string>',
            'EncryptionConfiguration' => [
                'KmsKeyArn' => '<string>',
                'ObjectEncryptionType' => 'SSE_KMS|SSE_S3|NO_ENCRYPTION',
            ],
            'Prefix' => '<string>',
        ],
        'Status' => 'IN_PROGRESS|COMPLETED|CANCELLED',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

DescribeLedger

$result = $client->describeLedger([/* ... */]);
$promise = $client->describeLedgerAsync([/* ... */]);

Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.

Parameter Syntax

$result = $client->describeLedger([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationDateTime' => <DateTime>,
    'DeletionProtection' => true || false,
    'EncryptionDescription' => [
        'EncryptionStatus' => 'ENABLED|UPDATING|KMS_KEY_INACCESSIBLE',
        'InaccessibleKmsKeyDateTime' => <DateTime>,
        'KmsKeyArn' => '<string>',
    ],
    'Name' => '<string>',
    'PermissionsMode' => 'ALLOW_ALL|STANDARD',
    'State' => 'CREATING|ACTIVE|DELETING|DELETED',
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

ExportJournalToS3

$result = $client->exportJournalToS3([/* ... */]);
$promise = $client->exportJournalToS3Async([/* ... */]);

Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException.

You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.

Parameter Syntax

$result = $client->exportJournalToS3([
    'ExclusiveEndTime' => <integer || string || DateTime>, // REQUIRED
    'InclusiveStartTime' => <integer || string || DateTime>, // REQUIRED
    'Name' => '<string>', // REQUIRED
    'OutputFormat' => 'ION_BINARY|ION_TEXT|JSON',
    'RoleArn' => '<string>', // REQUIRED
    'S3ExportConfiguration' => [ // REQUIRED
        'Bucket' => '<string>', // REQUIRED
        'EncryptionConfiguration' => [ // REQUIRED
            'KmsKeyArn' => '<string>',
            'ObjectEncryptionType' => 'SSE_KMS|SSE_S3|NO_ENCRYPTION', // REQUIRED
        ],
        'Prefix' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ExportId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ResourcePreconditionNotMetException:

The operation failed because a condition wasn't satisfied in advance.

GetBlock

$result = $client->getBlock([/* ... */]);
$promise = $client->getBlockAsync([/* ... */]);

Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided.

For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide.

If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException.

If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.

If no block exists with the specified address, then throws InvalidParameterException.

Parameter Syntax

$result = $client->getBlock([
    'BlockAddress' => [ // REQUIRED
        'IonText' => '<string>',
    ],
    'DigestTipAddress' => [
        'IonText' => '<string>',
    ],
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Block' => [
        'IonText' => '<string>',
    ],
    'Proof' => [
        'IonText' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

ResourcePreconditionNotMetException:

The operation failed because a condition wasn't satisfied in advance.

GetDigest

$result = $client->getDigest([/* ... */]);
$promise = $client->getDigestAsync([/* ... */]);

Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.

Parameter Syntax

$result = $client->getDigest([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Digest' => <string || resource || Psr\Http\Message\StreamInterface>,
    'DigestTipAddress' => [
        'IonText' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

ResourcePreconditionNotMetException:

The operation failed because a condition wasn't satisfied in advance.

GetRevision

$result = $client->getRevision([/* ... */]);
$promise = $client->getRevisionAsync([/* ... */]);

Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.

Parameter Syntax

$result = $client->getRevision([
    'BlockAddress' => [ // REQUIRED
        'IonText' => '<string>',
    ],
    'DigestTipAddress' => [
        'IonText' => '<string>',
    ],
    'DocumentId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Proof' => [
        'IonText' => '<string>',
    ],
    'Revision' => [
        'IonText' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

ResourcePreconditionNotMetException:

The operation failed because a condition wasn't satisfied in advance.

ListJournalKinesisStreamsForLedger

$result = $client->listJournalKinesisStreamsForLedger([/* ... */]);
$promise = $client->listJournalKinesisStreamsForLedgerAsync([/* ... */]);

Returns all Amazon QLDB journal streams for a given ledger.

This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.

This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

Parameter Syntax

$result = $client->listJournalKinesisStreamsForLedger([
    'LedgerName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Streams' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'ErrorCause' => 'KINESIS_STREAM_NOT_FOUND|IAM_PERMISSION_REVOKED',
            'ExclusiveEndTime' => <DateTime>,
            'InclusiveStartTime' => <DateTime>,
            'KinesisConfiguration' => [
                'AggregationEnabled' => true || false,
                'StreamArn' => '<string>',
            ],
            'LedgerName' => '<string>',
            'RoleArn' => '<string>',
            'Status' => 'ACTIVE|COMPLETED|CANCELED|FAILED|IMPAIRED',
            'StreamId' => '<string>',
            'StreamName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

ResourcePreconditionNotMetException:

The operation failed because a condition wasn't satisfied in advance.

ListJournalS3Exports

$result = $client->listJournalS3Exports([/* ... */]);
$promise = $client->listJournalS3ExportsAsync([/* ... */]);

Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times.

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.

Parameter Syntax

$result = $client->listJournalS3Exports([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'JournalS3Exports' => [
        [
            'ExclusiveEndTime' => <DateTime>,
            'ExportCreationTime' => <DateTime>,
            'ExportId' => '<string>',
            'InclusiveStartTime' => <DateTime>,
            'LedgerName' => '<string>',
            'OutputFormat' => 'ION_BINARY|ION_TEXT|JSON',
            'RoleArn' => '<string>',
            'S3ExportConfiguration' => [
                'Bucket' => '<string>',
                'EncryptionConfiguration' => [
                    'KmsKeyArn' => '<string>',
                    'ObjectEncryptionType' => 'SSE_KMS|SSE_S3|NO_ENCRYPTION',
                ],
                'Prefix' => '<string>',
            ],
            'Status' => 'IN_PROGRESS|COMPLETED|CANCELLED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListJournalS3ExportsForLedger

$result = $client->listJournalS3ExportsForLedger([/* ... */]);
$promise = $client->listJournalS3ExportsForLedgerAsync([/* ... */]);

Returns all journal export jobs for a specified ledger.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times.

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.

Parameter Syntax

$result = $client->listJournalS3ExportsForLedger([
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'JournalS3Exports' => [
        [
            'ExclusiveEndTime' => <DateTime>,
            'ExportCreationTime' => <DateTime>,
            'ExportId' => '<string>',
            'InclusiveStartTime' => <DateTime>,
            'LedgerName' => '<string>',
            'OutputFormat' => 'ION_BINARY|ION_TEXT|JSON',
            'RoleArn' => '<string>',
            'S3ExportConfiguration' => [
                'Bucket' => '<string>',
                'EncryptionConfiguration' => [
                    'KmsKeyArn' => '<string>',
                    'ObjectEncryptionType' => 'SSE_KMS|SSE_S3|NO_ENCRYPTION',
                ],
                'Prefix' => '<string>',
            ],
            'Status' => 'IN_PROGRESS|COMPLETED|CANCELLED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListLedgers

$result = $client->listLedgers([/* ... */]);
$promise = $client->listLedgersAsync([/* ... */]);

Returns all ledgers that are associated with the current Amazon Web Services account and Region.

This action returns a maximum of MaxResults items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

Parameter Syntax

$result = $client->listLedgers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Ledgers' => [
        [
            'CreationDateTime' => <DateTime>,
            'Name' => '<string>',
            'State' => 'CREATING|ACTIVE|DELETING|DELETED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns all tags for a specified Amazon QLDB resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

StreamJournalToKinesis

$result = $client->streamJournalToKinesis([/* ... */]);
$promise = $client->streamJournalToKinesisAsync([/* ... */]);

Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

Parameter Syntax

$result = $client->streamJournalToKinesis([
    'ExclusiveEndTime' => <integer || string || DateTime>,
    'InclusiveStartTime' => <integer || string || DateTime>, // REQUIRED
    'KinesisConfiguration' => [ // REQUIRED
        'AggregationEnabled' => true || false,
        'StreamArn' => '<string>', // REQUIRED
    ],
    'LedgerName' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'StreamName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'StreamId' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

ResourcePreconditionNotMetException:

The operation failed because a condition wasn't satisfied in advance.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to a specified Amazon QLDB resource.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

UpdateLedger

$result = $client->updateLedger([/* ... */]);
$promise = $client->updateLedgerAsync([/* ... */]);

Updates properties on a ledger.

Parameter Syntax

$result = $client->updateLedger([
    'DeletionProtection' => true || false,
    'KmsKey' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationDateTime' => <DateTime>,
    'DeletionProtection' => true || false,
    'EncryptionDescription' => [
        'EncryptionStatus' => 'ENABLED|UPDATING|KMS_KEY_INACCESSIBLE',
        'InaccessibleKmsKeyDateTime' => <DateTime>,
        'KmsKeyArn' => '<string>',
    ],
    'Name' => '<string>',
    'State' => 'CREATING|ACTIVE|DELETING|DELETED',
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.

UpdateLedgerPermissionsMode

$result = $client->updateLedgerPermissionsMode([/* ... */]);
$promise = $client->updateLedgerPermissionsModeAsync([/* ... */]);

Updates the permissions mode of a ledger.

Parameter Syntax

$result = $client->updateLedgerPermissionsMode([
    'Name' => '<string>', // REQUIRED
    'PermissionsMode' => 'ALLOW_ALL|STANDARD', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Name' => '<string>',
    'PermissionsMode' => 'ALLOW_ALL|STANDARD',
]

Result Details

Errors

InvalidParameterException:

One or more parameters in the request aren't valid.

ResourceNotFoundException:

The specified resource doesn't exist.