NAME
Paws::QLDB - Perl Interface to AWS Amazon QLDB
SYNOPSIS
use Paws;
my $obj = Paws->service('QLDB');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
The control plane for Amazon QLDB
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02
METHODS
CancelJournalKinesisStream
Each argument is described in detail in: Paws::QLDB::CancelJournalKinesisStream
Returns: a Paws::QLDB::CancelJournalKinesisStreamResponse instance
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.
CreateLedger
- Name => Str
- PermissionsMode => Str
- [DeletionProtection => Bool]
- [Tags => Paws::QLDB::Tags]
Each argument is described in detail in: Paws::QLDB::CreateLedger
Returns: a Paws::QLDB::CreateLedgerResponse instance
Creates a new ledger in your AWS account in the current Region.
DeleteLedger
Each argument is described in detail in: Paws::QLDB::DeleteLedger
Returns: nothing
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 the flag to false.
DescribeJournalKinesisStream
Each argument is described in detail in: Paws::QLDB::DescribeJournalKinesisStream
Returns: a Paws::QLDB::DescribeJournalKinesisStreamResponse instance
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 (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) in the Amazon QLDB Developer Guide.
DescribeJournalS3Export
Each argument is described in detail in: Paws::QLDB::DescribeJournalS3Export
Returns: a Paws::QLDB::DescribeJournalS3ExportResponse instance
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 (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.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.
DescribeLedger
Each argument is described in detail in: Paws::QLDB::DescribeLedger
Returns: a Paws::QLDB::DescribeLedgerResponse instance
Returns information about a ledger, including its state and when it was created.
ExportJournalToS3
- ExclusiveEndTime => Str
- InclusiveStartTime => Str
- Name => Str
- RoleArn => Str
- S3ExportConfiguration => Paws::QLDB::S3ExportConfiguration
Each argument is described in detail in: Paws::QLDB::ExportJournalToS3
Returns: a Paws::QLDB::ExportJournalToS3Response instance
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion 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.
GetBlock
- BlockAddress => Paws::QLDB::ValueHolder
- Name => Str
- [DigestTipAddress => Paws::QLDB::ValueHolder]
Each argument is described in detail in: Paws::QLDB::GetBlock
Returns: a Paws::QLDB::GetBlockResponse instance
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 (https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html) 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.
GetDigest
Each argument is described in detail in: Paws::QLDB::GetDigest
Returns: a Paws::QLDB::GetDigestResponse instance
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.
GetRevision
- BlockAddress => Paws::QLDB::ValueHolder
- DocumentId => Str
- Name => Str
- [DigestTipAddress => Paws::QLDB::ValueHolder]
Each argument is described in detail in: Paws::QLDB::GetRevision
Returns: a Paws::QLDB::GetRevisionResponse instance
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.
ListJournalKinesisStreamsForLedger
Each argument is described in detail in: Paws::QLDB::ListJournalKinesisStreamsForLedger
Returns: a Paws::QLDB::ListJournalKinesisStreamsForLedgerResponse instance
Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) 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.
ListJournalS3Exports
Each argument is described in detail in: Paws::QLDB::ListJournalS3Exports
Returns: a Paws::QLDB::ListJournalS3ExportsResponse instance
Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS 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 (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) in the Amazon QLDB Developer Guide.
ListJournalS3ExportsForLedger
Each argument is described in detail in: Paws::QLDB::ListJournalS3ExportsForLedger
Returns: a Paws::QLDB::ListJournalS3ExportsForLedgerResponse instance
Returns an array of journal export job descriptions 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 (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) in the Amazon QLDB Developer Guide.
ListLedgers
Each argument is described in detail in: Paws::QLDB::ListLedgers
Returns: a Paws::QLDB::ListLedgersResponse instance
Returns an array of ledger summaries that are associated with the current AWS account and Region.
This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.
ListTagsForResource
Each argument is described in detail in: Paws::QLDB::ListTagsForResource
Returns: a Paws::QLDB::ListTagsForResourceResponse instance
Returns all tags for a specified Amazon QLDB resource.
StreamJournalToKinesis
- InclusiveStartTime => Str
- KinesisConfiguration => Paws::QLDB::KinesisConfiguration
- LedgerName => Str
- RoleArn => Str
- StreamName => Str
- [ExclusiveEndTime => Str]
- [Tags => Paws::QLDB::Tags]
Each argument is described in detail in: Paws::QLDB::StreamJournalToKinesis
Returns: a Paws::QLDB::StreamJournalToKinesisResponse instance
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.
TagResource
- ResourceArn => Str
- Tags => Paws::QLDB::Tags
Each argument is described in detail in: Paws::QLDB::TagResource
Returns: a Paws::QLDB::TagResourceResponse instance
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.
UntagResource
Each argument is described in detail in: Paws::QLDB::UntagResource
Returns: a Paws::QLDB::UntagResourceResponse instance
Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
UpdateLedger
Each argument is described in detail in: Paws::QLDB::UpdateLedger
Returns: a Paws::QLDB::UpdateLedgerResponse instance
Updates properties on a ledger.
UpdateLedgerPermissionsMode
Each argument is described in detail in: Paws::QLDB::UpdateLedgerPermissionsMode
Returns: a Paws::QLDB::UpdateLedgerPermissionsModeResponse instance
Updates the permissions mode of a ledger.
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 (https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating) in the Amazon QLDB Developer Guide.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues