Class: Aws::QLDB::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::QLDB::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb
Overview
An API client for QLDB. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::QLDB::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#cancel_journal_kinesis_stream(params = {}) ⇒ Types::CancelJournalKinesisStreamResponse
Ends a given Amazon QLDB journal stream.
-
#create_ledger(params = {}) ⇒ Types::CreateLedgerResponse
Creates a new ledger in your Amazon Web Services account in the current Region.
-
#delete_ledger(params = {}) ⇒ Struct
Deletes a ledger and all of its contents.
-
#describe_journal_kinesis_stream(params = {}) ⇒ Types::DescribeJournalKinesisStreamResponse
Returns detailed information about a given Amazon QLDB journal stream.
-
#describe_journal_s3_export(params = {}) ⇒ Types::DescribeJournalS3ExportResponse
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.
-
#describe_ledger(params = {}) ⇒ Types::DescribeLedgerResponse
Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
-
#export_journal_to_s3(params = {}) ⇒ Types::ExportJournalToS3Response
Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket.
-
#get_block(params = {}) ⇒ Types::GetBlockResponse
Returns a block object at a specified address in a journal.
-
#get_digest(params = {}) ⇒ Types::GetDigestResponse
Returns the digest of a ledger at the latest committed block in the journal.
-
#get_revision(params = {}) ⇒ Types::GetRevisionResponse
Returns a revision data object for a specified document ID and block address.
-
#list_journal_kinesis_streams_for_ledger(params = {}) ⇒ Types::ListJournalKinesisStreamsForLedgerResponse
Returns all Amazon QLDB journal streams for a given ledger.
-
#list_journal_s3_exports(params = {}) ⇒ Types::ListJournalS3ExportsResponse
Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.
-
#list_journal_s3_exports_for_ledger(params = {}) ⇒ Types::ListJournalS3ExportsForLedgerResponse
Returns all journal export jobs for a specified ledger.
-
#list_ledgers(params = {}) ⇒ Types::ListLedgersResponse
Returns all ledgers that are associated with the current Amazon Web Services account and Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns all tags for a specified Amazon QLDB resource.
-
#stream_journal_to_kinesis(params = {}) ⇒ Types::StreamJournalToKinesisResponse
Creates a journal stream for a given Amazon QLDB ledger.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to a specified Amazon QLDB resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a specified Amazon QLDB resource.
-
#update_ledger(params = {}) ⇒ Types::UpdateLedgerResponse
Updates properties on a ledger.
-
#update_ledger_permissions_mode(params = {}) ⇒ Types::UpdateLedgerPermissionsModeResponse
Updates the permissions mode of a ledger.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#cancel_journal_kinesis_stream(params = {}) ⇒ Types::CancelJournalKinesisStreamResponse
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.
461 462 463 464 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 461 def cancel_journal_kinesis_stream(params = {}, = {}) req = build_request(:cancel_journal_kinesis_stream, params) req.send_request() end |
#create_ledger(params = {}) ⇒ Types::CreateLedgerResponse
Creates a new ledger in your Amazon Web Services account in the current Region.
610 611 612 613 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 610 def create_ledger(params = {}, = {}) req = build_request(:create_ledger, params) req.send_request() end |
#delete_ledger(params = {}) ⇒ Struct
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
.
636 637 638 639 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 636 def delete_ledger(params = {}, = {}) req = build_request(:delete_ledger, params) req.send_request() end |
#describe_journal_kinesis_stream(params = {}) ⇒ Types::DescribeJournalKinesisStreamResponse
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.
691 692 693 694 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 691 def describe_journal_kinesis_stream(params = {}, = {}) req = build_request(:describe_journal_kinesis_stream, params) req.send_request() end |
#describe_journal_s3_export(params = {}) ⇒ Types::DescribeJournalS3ExportResponse
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
.
751 752 753 754 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 751 def describe_journal_s3_export(params = {}, = {}) req = build_request(:describe_journal_s3_export, params) req.send_request() end |
#describe_ledger(params = {}) ⇒ Types::DescribeLedgerResponse
Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
794 795 796 797 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 794 def describe_ledger(params = {}, = {}) req = build_request(:describe_ledger, params) req.send_request() end |
#export_journal_to_s3(params = {}) ⇒ Types::ExportJournalToS3Response
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
.
908 909 910 911 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 908 def export_journal_to_s3(params = {}, = {}) req = build_request(:export_journal_to_s3, params) req.send_request() end |
#get_block(params = {}) ⇒ Types::GetBlockResponse
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
.
975 976 977 978 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 975 def get_block(params = {}, = {}) req = build_request(:get_block, params) req.send_request() end |
#get_digest(params = {}) ⇒ Types::GetDigestResponse
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.
1007 1008 1009 1010 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1007 def get_digest(params = {}, = {}) req = build_request(:get_digest, params) req.send_request() end |
#get_revision(params = {}) ⇒ Types::GetRevisionResponse
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.
1064 1065 1066 1067 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1064 def get_revision(params = {}, = {}) req = build_request(:get_revision, params) req.send_request() end |
#list_journal_kinesis_streams_for_ledger(params = {}) ⇒ Types::ListJournalKinesisStreamsForLedgerResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1133 1134 1135 1136 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1133 def list_journal_kinesis_streams_for_ledger(params = {}, = {}) req = build_request(:list_journal_kinesis_streams_for_ledger, params) req.send_request() end |
#list_journal_s3_exports(params = {}) ⇒ Types::ListJournalS3ExportsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1199 1200 1201 1202 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1199 def list_journal_s3_exports(params = {}, = {}) req = build_request(:list_journal_s3_exports, params) req.send_request() end |
#list_journal_s3_exports_for_ledger(params = {}) ⇒ Types::ListJournalS3ExportsForLedgerResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1268 def list_journal_s3_exports_for_ledger(params = {}, = {}) req = build_request(:list_journal_s3_exports_for_ledger, params) req.send_request() end |
#list_ledgers(params = {}) ⇒ Types::ListLedgersResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1316 1317 1318 1319 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1316 def list_ledgers(params = {}, = {}) req = build_request(:list_ledgers, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns all tags for a specified Amazon QLDB resource.
1348 1349 1350 1351 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1348 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#stream_journal_to_kinesis(params = {}) ⇒ Types::StreamJournalToKinesisResponse
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.
1444 1445 1446 1447 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1444 def stream_journal_to_kinesis(params = {}, = {}) req = build_request(:stream_journal_to_kinesis, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1481 1482 1483 1484 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1481 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
1511 1512 1513 1514 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1511 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_ledger(params = {}) ⇒ Types::UpdateLedgerResponse
Updates properties on a ledger.
1607 1608 1609 1610 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1607 def update_ledger(params = {}, = {}) req = build_request(:update_ledger, params) req.send_request() end |
#update_ledger_permissions_mode(params = {}) ⇒ Types::UpdateLedgerPermissionsModeResponse
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 in the Amazon QLDB Developer Guide.
1683 1684 1685 1686 |
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1683 def (params = {}, = {}) req = build_request(:update_ledger_permissions_mode, params) req.send_request() end |