lib/aws-sdk-qldb/client.rb in aws-sdk-qldb-1.6.1 vs lib/aws-sdk-qldb/client.rb in aws-sdk-qldb-1.7.0
- old
+ new
@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
#
@@ -351,10 +353,17 @@
#
# @option params [required, String] :name
# The name of the ledger that you want to create. The name must be
# unique among all of your ledgers in the current AWS Region.
#
+ # Naming constraints for ledger names are defined in [Quotas in Amazon
+ # QLDB][1] in the *Amazon QLDB Developer Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming
+ #
# @option params [Hash<String,String>] :tags
# 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.
#
@@ -665,23 +674,30 @@
def export_journal_to_s3(params = {}, options = {})
req = build_request(:export_journal_to_s3, params)
req.send_request(options)
end
- # Returns a journal block object at a specified address in a ledger.
- # Also returns a proof of the specified block for verification if
+ # 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][1] 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`.
#
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html
+ #
# @option params [required, String] :name
# The name of the ledger.
#
# @option params [required, Types::ValueHolder] :block_address
# The location of the block that you want to request. An address is an
@@ -1090,14 +1106,14 @@
def list_tags_for_resource(params = {}, options = {})
req = build_request(:list_tags_for_resource, params)
req.send_request(options)
end
- # Creates a stream for a given Amazon QLDB ledger that delivers the
- # journal data to a specified Amazon Kinesis Data Streams resource. The
- # stream captures every document revision that is committed to your
- # journal and sends it to the Kinesis data stream.
+ # 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.
#
# @option params [required, String] :ledger_name
# The name of the ledger.
#
# @option params [required, String] :role_arn
@@ -1123,12 +1139,12 @@
# `CreationDateTime`, QLDB effectively defaults it to the ledger's
# `CreationDateTime`.
#
# @option params [Time,DateTime,Date,Integer,String] :exclusive_end_time
# The exclusive date and time that specifies when the stream ends. If
- # you keep this parameter blank, the stream runs indefinitely until you
- # cancel it.
+ # 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`
#
@@ -1140,15 +1156,13 @@
# 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. If you try to create a stream with the same name and
- # configuration of an active, existing stream for the same ledger, QLDB
- # simply returns the existing stream. Stream names have the same naming
- # constraints as ledger names, as defined in [Quotas in Amazon QLDB][1]
- # in the *Amazon QLDB Developer Guide*.
+ # given ledger. Stream names have the same naming constraints as ledger
+ # names, as defined in [Quotas in Amazon QLDB][1] in the *Amazon QLDB
+ # Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming
#
@@ -1312,10 +1326,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-qldb'
- context[:gem_version] = '1.6.1'
+ context[:gem_version] = '1.7.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated