aws-sdk-qldb 1.3.0 → 1.8.0

data/lib/aws-sdk-qldb/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

data/lib/aws-sdk-qldb/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

data/lib/aws-sdk-qldb/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -8,6 +10,43 @@
 module Aws::QLDB
   module Types
 
+    # @note When making an API call, you may pass CancelJournalKinesisStreamRequest
+    #   data as a hash:
+    #
+    #       {
+    #         ledger_name: "LedgerName", # required
+    #         stream_id: "UniqueId", # required
+    #       }
+    #
+    # @!attribute [rw] ledger_name
+    #   The name of the ledger.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_id
+    #   The unique ID that QLDB assigns to each QLDB journal stream.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CancelJournalKinesisStreamRequest AWS API Documentation
+    #
+    class CancelJournalKinesisStreamRequest < Struct.new(
+      :ledger_name,
+      :stream_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] stream_id
+    #   The unique ID that QLDB assigns to each QLDB journal stream.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CancelJournalKinesisStreamResponse AWS API Documentation
+    #
+    class CancelJournalKinesisStreamResponse < Struct.new(
+      :stream_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateLedgerRequest
     #   data as a hash:
     #
@@ -23,6 +62,13 @@ module Aws::QLDB
     # @!attribute [rw] 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
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -56,6 +102,7 @@ module Aws::QLDB
       :tags,
       :permissions_mode,
       :deletion_protection)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -98,6 +145,7 @@ module Aws::QLDB
       :state,
       :creation_date_time,
       :deletion_protection)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -116,6 +164,45 @@ module Aws::QLDB
     #
     class DeleteLedgerRequest < Struct.new(
       :name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass DescribeJournalKinesisStreamRequest
+    #   data as a hash:
+    #
+    #       {
+    #         ledger_name: "LedgerName", # required
+    #         stream_id: "UniqueId", # required
+    #       }
+    #
+    # @!attribute [rw] ledger_name
+    #   The name of the ledger.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_id
+    #   The unique ID that QLDB assigns to each QLDB journal stream.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalKinesisStreamRequest AWS API Documentation
+    #
+    class DescribeJournalKinesisStreamRequest < Struct.new(
+      :ledger_name,
+      :stream_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] stream
+    #   Information about the QLDB journal stream returned by a
+    #   `DescribeJournalS3Export` request.
+    #   @return [Types::JournalKinesisStreamDescription]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalKinesisStreamResponse AWS API Documentation
+    #
+    class DescribeJournalKinesisStreamResponse < Struct.new(
+      :stream)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -140,6 +227,7 @@ module Aws::QLDB
     class DescribeJournalS3ExportRequest < Struct.new(
       :name,
       :export_id)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -152,6 +240,7 @@ module Aws::QLDB
     #
     class DescribeJournalS3ExportResponse < Struct.new(
       :export_description)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -170,6 +259,7 @@ module Aws::QLDB
     #
     class DescribeLedgerRequest < Struct.new(
       :name)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -212,6 +302,7 @@ module Aws::QLDB
       :state,
       :creation_date_time,
       :deletion_protection)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -289,6 +380,7 @@ module Aws::QLDB
       :exclusive_end_time,
       :s3_export_configuration,
       :role_arn)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -303,6 +395,7 @@ module Aws::QLDB
     #
     class ExportJournalToS3Response < Struct.new(
       :export_id)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -345,6 +438,7 @@ module Aws::QLDB
       :name,
       :block_address,
       :digest_tip_address)
+      SENSITIVE = [:block_address, :digest_tip_address]
       include Aws::Structure
     end
 
@@ -364,6 +458,7 @@ module Aws::QLDB
     class GetBlockResponse < Struct.new(
       :block,
       :proof)
+      SENSITIVE = [:block, :proof]
       include Aws::Structure
     end
 
@@ -382,6 +477,7 @@ module Aws::QLDB
     #
     class GetDigestRequest < Struct.new(
       :name)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -401,6 +497,7 @@ module Aws::QLDB
     class GetDigestResponse < Struct.new(
       :digest,
       :digest_tip_address)
+      SENSITIVE = [:digest_tip_address]
       include Aws::Structure
     end
 
@@ -449,6 +546,7 @@ module Aws::QLDB
       :block_address,
       :document_id,
       :digest_tip_address)
+      SENSITIVE = [:block_address, :digest_tip_address]
       include Aws::Structure
     end
 
@@ -468,6 +566,7 @@ module Aws::QLDB
     class GetRevisionResponse < Struct.new(
       :proof,
       :revision)
+      SENSITIVE = [:proof, :revision]
       include Aws::Structure
     end
 
@@ -485,6 +584,83 @@ module Aws::QLDB
     class InvalidParameterException < Struct.new(
       :message,
       :parameter_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The information about an Amazon QLDB journal stream, including the
+    # Amazon Resource Name (ARN), stream name, creation time, current
+    # status, and the parameters of your original stream creation request.
+    #
+    # @!attribute [rw] ledger_name
+    #   The name of the ledger.
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_time
+    #   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.)
+    #   @return [Time]
+    #
+    # @!attribute [rw] inclusive_start_time
+    #   The inclusive start date and time from which to start streaming
+    #   journal data.
+    #   @return [Time]
+    #
+    # @!attribute [rw] exclusive_end_time
+    #   The exclusive date and time that specifies when the stream ends. If
+    #   this parameter is blank, the stream runs indefinitely until you
+    #   cancel it.
+    #   @return [Time]
+    #
+    # @!attribute [rw] role_arn
+    #   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.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_id
+    #   The unique ID that QLDB assigns to each QLDB journal stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] arn
+    #   The Amazon Resource Name (ARN) of the QLDB journal stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The current state of the QLDB journal stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] kinesis_configuration
+    #   The configuration settings of the Amazon Kinesis Data Streams
+    #   destination for your QLDB journal stream.
+    #   @return [Types::KinesisConfiguration]
+    #
+    # @!attribute [rw] error_cause
+    #   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.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_name
+    #   The user-defined name of the QLDB journal stream.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/JournalKinesisStreamDescription AWS API Documentation
+    #
+    class JournalKinesisStreamDescription < Struct.new(
+      :ledger_name,
+      :creation_time,
+      :inclusive_start_time,
+      :exclusive_end_time,
+      :role_arn,
+      :stream_id,
+      :arn,
+      :status,
+      :kinesis_configuration,
+      :error_cause,
+      :stream_name)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -548,6 +724,41 @@ module Aws::QLDB
       :exclusive_end_time,
       :s3_export_configuration,
       :role_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The configuration settings of the Amazon Kinesis Data Streams
+    # destination for your Amazon QLDB journal stream.
+    #
+    # @note When making an API call, you may pass KinesisConfiguration
+    #   data as a hash:
+    #
+    #       {
+    #         stream_arn: "Arn", # required
+    #         aggregation_enabled: false,
+    #       }
+    #
+    # @!attribute [rw] stream_arn
+    #   The Amazon Resource Name (ARN) of the Kinesis data stream resource.
+    #   @return [String]
+    #
+    # @!attribute [rw] aggregation_enabled
+    #   Enables QLDB to publish multiple data records in a single Kinesis
+    #   Data Streams record. To learn more, see [KPL Key Concepts][1] in the
+    #   *Amazon Kinesis Data Streams Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/KinesisConfiguration AWS API Documentation
+    #
+    class KinesisConfiguration < Struct.new(
+      :stream_arn,
+      :aggregation_enabled)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -574,6 +785,7 @@ module Aws::QLDB
       :name,
       :state,
       :creation_date_time)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -591,6 +803,66 @@ module Aws::QLDB
     class LimitExceededException < Struct.new(
       :message,
       :resource_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass ListJournalKinesisStreamsForLedgerRequest
+    #   data as a hash:
+    #
+    #       {
+    #         ledger_name: "LedgerName", # required
+    #         max_results: 1,
+    #         next_token: "NextToken",
+    #       }
+    #
+    # @!attribute [rw] ledger_name
+    #   The name of the ledger.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return in a single
+    #   `ListJournalKinesisStreamsForLedger` request. (The actual number of
+    #   results returned might be fewer.)
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   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.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalKinesisStreamsForLedgerRequest AWS API Documentation
+    #
+    class ListJournalKinesisStreamsForLedgerRequest < Struct.new(
+      :ledger_name,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] streams
+    #   The array of QLDB journal stream descriptors that are associated
+    #   with the given ledger.
+    #   @return [Array<Types::JournalKinesisStreamDescription>]
+    #
+    # @!attribute [rw] next_token
+    #   * 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.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalKinesisStreamsForLedgerResponse AWS API Documentation
+    #
+    class ListJournalKinesisStreamsForLedgerResponse < Struct.new(
+      :streams,
+      :next_token)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -626,6 +898,7 @@ module Aws::QLDB
       :name,
       :max_results,
       :next_token)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -648,6 +921,7 @@ module Aws::QLDB
     class ListJournalS3ExportsForLedgerResponse < Struct.new(
       :journal_s3_exports,
       :next_token)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -677,6 +951,7 @@ module Aws::QLDB
     class ListJournalS3ExportsRequest < Struct.new(
       :max_results,
       :next_token)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -699,6 +974,7 @@ module Aws::QLDB
     class ListJournalS3ExportsResponse < Struct.new(
       :journal_s3_exports,
       :next_token)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -727,6 +1003,7 @@ module Aws::QLDB
     class ListLedgersRequest < Struct.new(
       :max_results,
       :next_token)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -752,6 +1029,7 @@ module Aws::QLDB
     class ListLedgersResponse < Struct.new(
       :ledgers,
       :next_token)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -773,6 +1051,7 @@ module Aws::QLDB
     #
     class ListTagsForResourceRequest < Struct.new(
       :resource_arn)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -785,6 +1064,7 @@ module Aws::QLDB
     #
     class ListTagsForResourceResponse < Struct.new(
       :tags)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -807,6 +1087,7 @@ module Aws::QLDB
       :message,
       :resource_type,
       :resource_name)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -829,6 +1110,7 @@ module Aws::QLDB
       :message,
       :resource_type,
       :resource_name)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -851,6 +1133,7 @@ module Aws::QLDB
       :message,
       :resource_type,
       :resource_name)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -873,6 +1156,7 @@ module Aws::QLDB
       :message,
       :resource_type,
       :resource_name)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -900,8 +1184,9 @@ module Aws::QLDB
     #   @return [String]
     #
     # @!attribute [rw] kms_key_arn
-    #   The Amazon Resource Name (ARN) for a customer master key (CMK) in
-    #   AWS Key Management Service (AWS KMS).
+    #   The Amazon Resource Name (ARN) for a symmetric customer master key
+    #   (CMK) in AWS Key Management Service (AWS KMS). Amazon QLDB does not
+    #   support asymmetric CMKs.
     #
     #   You must provide a `KmsKeyArn` if you specify `SSE_KMS` as the
     #   `ObjectEncryptionType`.
@@ -915,6 +1200,7 @@ module Aws::QLDB
     class S3EncryptionConfiguration < Struct.new(
       :object_encryption_type,
       :kms_key_arn)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -978,6 +1264,111 @@ module Aws::QLDB
       :bucket,
       :prefix,
       :encryption_configuration)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass StreamJournalToKinesisRequest
+    #   data as a hash:
+    #
+    #       {
+    #         ledger_name: "LedgerName", # required
+    #         role_arn: "Arn", # required
+    #         tags: {
+    #           "TagKey" => "TagValue",
+    #         },
+    #         inclusive_start_time: Time.now, # required
+    #         exclusive_end_time: Time.now,
+    #         kinesis_configuration: { # required
+    #           stream_arn: "Arn", # required
+    #           aggregation_enabled: false,
+    #         },
+    #         stream_name: "StreamName", # required
+    #       }
+    #
+    # @!attribute [rw] ledger_name
+    #   The name of the ledger.
+    #   @return [String]
+    #
+    # @!attribute [rw] role_arn
+    #   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.
+    #   @return [String]
+    #
+    # @!attribute [rw] tags
+    #   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.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] inclusive_start_time
+    #   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`.
+    #   @return [Time]
+    #
+    # @!attribute [rw] exclusive_end_time
+    #   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`
+    #   @return [Time]
+    #
+    # @!attribute [rw] kinesis_configuration
+    #   The configuration settings of the Kinesis Data Streams destination
+    #   for your stream request.
+    #   @return [Types::KinesisConfiguration]
+    #
+    # @!attribute [rw] stream_name
+    #   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][1] in the
+    #   *Amazon QLDB Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/StreamJournalToKinesisRequest AWS API Documentation
+    #
+    class StreamJournalToKinesisRequest < Struct.new(
+      :ledger_name,
+      :role_arn,
+      :tags,
+      :inclusive_start_time,
+      :exclusive_end_time,
+      :kinesis_configuration,
+      :stream_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] stream_id
+    #   The unique ID that QLDB assigns to each QLDB journal stream.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/StreamJournalToKinesisResponse AWS API Documentation
+    #
+    class StreamJournalToKinesisResponse < Struct.new(
+      :stream_id)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -1010,6 +1401,7 @@ module Aws::QLDB
     class TagResourceRequest < Struct.new(
       :resource_arn,
       :tags)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -1041,6 +1433,7 @@ module Aws::QLDB
     class UntagResourceRequest < Struct.new(
       :resource_arn,
       :tag_keys)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -1078,6 +1471,7 @@ module Aws::QLDB
     class UpdateLedgerRequest < Struct.new(
       :name,
       :deletion_protection)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -1120,11 +1514,11 @@ module Aws::QLDB
       :state,
       :creation_date_time,
       :deletion_protection)
+      SENSITIVE = []
       include Aws::Structure
     end
 
-    # A structure that can contain an Amazon Ion value in multiple encoding
-    # formats.
+    # A structure that can contain a value in multiple encoding formats.
     #
     # @note When making an API call, you may pass ValueHolder
     #   data as a hash:
@@ -1142,6 +1536,7 @@ module Aws::QLDB
     #
     class ValueHolder < Struct.new(
       :ion_text)
+      SENSITIVE = [:ion_text]
       include Aws::Structure
     end