lib/aws-sdk-qldb/client.rb in aws-sdk-qldb-1.27.0 vs lib/aws-sdk-qldb/client.rb in aws-sdk-qldb-1.28.0

- old
+ new

@@ -428,20 +428,20 @@ # # @option params [required, String] :permissions_mode # The permissions mode to assign to the ledger that you want to create. # This parameter can have one of the following values: # - # * `ALLOW_ALL`\: A legacy permissions mode that enables access control + # * `ALLOW_ALL`: A legacy permissions mode that enables access control # with API-level granularity for ledgers. # # This mode allows users who have the `SendCommand` API permission for # this ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any # tables in the specified ledger. This mode disregards any table-level # or command-level IAM permissions policies that you create for the # ledger. # - # * `STANDARD`\: (*Recommended*) A permissions mode that enables access + # * `STANDARD`: (*Recommended*) A permissions mode that enables access # control with finer granularity for ledgers, tables, and PartiQL # commands. # # By default, this mode denies all user requests to run any PartiQL # commands on any tables in this ledger. To allow PartiQL commands to @@ -459,33 +459,33 @@ # # # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html # # @option params [Boolean] :deletion_protection - # The flag that prevents a ledger from being deleted by any user. If not - # provided on ledger creation, this feature is enabled (`true`) by - # default. + # Specifies whether the ledger is protected from being deleted by any + # user. If not defined during ledger creation, this feature is enabled + # (`true`) by default. # # 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`. + # `UpdateLedger` operation to set this parameter to `false`. # # @option params [String] :kms_key # The key in Key Management Service (KMS) to use for encryption of data # at rest in the ledger. For more information, see [Encryption at # rest][1] in the *Amazon QLDB Developer Guide*. # # Use one of the following options to specify this parameter: # - # * `AWS_OWNED_KMS_KEY`\: Use an KMS key that is owned and managed by + # * `AWS_OWNED_KMS_KEY`: Use an KMS key that is owned and managed by # Amazon Web Services on your behalf. # - # * **Undefined**\: By default, use an Amazon Web Services owned KMS - # key. + # * **Undefined**: By default, use an Amazon Web Services owned KMS key. # - # * **A valid symmetric customer managed KMS key**\: Use the specified - # KMS key in your account that you create, own, and manage. + # * **A valid symmetric customer managed KMS key**: Use the specified + # symmetric encryption KMS key in your account that you create, own, + # and manage. # # Amazon QLDB does not support asymmetric keys. For more information, # see [Using symmetric and asymmetric keys][2] in the *Key Management # Service Developer Guide*. # @@ -557,11 +557,11 @@ # 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`. + # `UpdateLedger` operation to set this parameter to `false`. # # @option params [required, String] :name # The name of the ledger that you want to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -743,31 +743,20 @@ # 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. # - # In JSON Lines format, each journal block in the exported data object - # is a valid JSON object that is delimited by a newline. You can use - # this format to easily integrate JSON exports with analytics tools such - # as Glue and Amazon Athena because these services can parse - # newline-delimited JSON automatically. For more information about the - # format, see [JSON Lines][1]. - # # 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`. # - # - # - # [1]: https://jsonlines.org/ - # # @option params [required, String] :name # The name of the ledger. # # @option params [required, Time,DateTime,Date,Integer,String] :inclusive_start_time # The inclusive start date and time for the range of journal contents to @@ -800,24 +789,37 @@ # # @option params [required, String] :role_arn # The Amazon Resource Name (ARN) of the IAM role that grants QLDB # permissions for a journal export job to do the following: # - # * Write objects into your Amazon Simple Storage Service (Amazon S3) - # bucket. + # * Write objects into your Amazon S3 bucket. # # * (Optional) Use your customer managed key in Key Management Service # (KMS) for server-side encryption of your exported data. # # To pass a role to QLDB when requesting a journal export, you must have # permissions to perform the `iam:PassRole` action on the IAM role # resource. This is required for all journal export requests. # # @option params [String] :output_format - # The output format of your exported journal data. If this parameter is - # not specified, the exported data defaults to `ION_TEXT` format. + # The output format of your exported journal data. A journal export job + # can write the data objects in either the text or binary representation + # of [Amazon Ion][1] format, or in [JSON Lines][2] text format. # + # Default: `ION_TEXT` + # + # In JSON Lines format, each journal block in an exported data object is + # a valid JSON object that is delimited by a newline. You can use this + # format to directly integrate JSON exports with analytics tools such as + # Amazon Athena and Glue because these services can parse + # newline-delimited JSON automatically. + # + # + # + # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html + # [2]: https://jsonlines.org/ + # # @return [Types::ExportJournalToS3Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ExportJournalToS3Response#export_id #export_id} => String # # @example Request syntax with placeholder values @@ -1005,13 +1007,11 @@ def get_revision(params = {}, options = {}) req = build_request(:get_revision, params) req.send_request(options) end - # 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`. + # 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][1] in the *Amazon # QLDB Developer Guide*. # @@ -1076,13 +1076,12 @@ def list_journal_kinesis_streams_for_ledger(params = {}, options = {}) req = build_request(:list_journal_kinesis_streams_for_ledger, params) req.send_request(options) end - # Returns an array of journal export job descriptions for all ledgers - # that are associated with the current Amazon Web Services account and - # Region. + # 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. # @@ -1143,12 +1142,11 @@ def list_journal_s3_exports(params = {}, options = {}) req = build_request(:list_journal_s3_exports, params) req.send_request(options) end - # Returns an array of journal export job descriptions for a specified - # ledger. + # 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. # @@ -1213,16 +1211,16 @@ def list_journal_s3_exports_for_ledger(params = {}, options = {}) req = build_request(:list_journal_s3_exports_for_ledger, params) req.send_request(options) end - # Returns an array of ledger summaries that are associated with the - # current Amazon Web Services account and Region. + # Returns all ledgers that are associated with the current Amazon Web + # Services 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. + # This action returns a maximum of `MaxResults` items and is paginated + # so that you can retrieve all the items by calling `ListLedgers` + # multiple times. # # @option params [Integer] :max_results # The maximum number of results to return in a single `ListLedgers` # request. (The actual number of results returned might be fewer.) # @@ -1462,32 +1460,33 @@ # # @option params [required, String] :name # The name of the ledger. # # @option params [Boolean] :deletion_protection - # The flag that prevents a ledger from being deleted by any user. If not - # provided on ledger creation, this feature is enabled (`true`) by - # default. + # Specifies whether the ledger is protected from being deleted by any + # user. If not defined during ledger creation, this feature is enabled + # (`true`) by default. # # 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`. + # `UpdateLedger` operation to set this parameter to `false`. # # @option params [String] :kms_key # The key in Key Management Service (KMS) to use for encryption of data # at rest in the ledger. For more information, see [Encryption at # rest][1] in the *Amazon QLDB Developer Guide*. # # Use one of the following options to specify this parameter: # - # * `AWS_OWNED_KMS_KEY`\: Use an KMS key that is owned and managed by + # * `AWS_OWNED_KMS_KEY`: Use an KMS key that is owned and managed by # Amazon Web Services on your behalf. # - # * **Undefined**\: Make no changes to the KMS key of the ledger. + # * **Undefined**: Make no changes to the KMS key of the ledger. # - # * **A valid symmetric customer managed KMS key**\: Use the specified - # KMS key in your account that you create, own, and manage. + # * **A valid symmetric customer managed KMS key**: Use the specified + # symmetric encryption KMS key in your account that you create, own, + # and manage. # # Amazon QLDB does not support asymmetric keys. For more information, # see [Using symmetric and asymmetric keys][2] in the *Key Management # Service Developer Guide*. # @@ -1569,20 +1568,20 @@ # # @option params [required, String] :permissions_mode # The permissions mode to assign to the ledger. This parameter can have # one of the following values: # - # * `ALLOW_ALL`\: A legacy permissions mode that enables access control + # * `ALLOW_ALL`: A legacy permissions mode that enables access control # with API-level granularity for ledgers. # # This mode allows users who have the `SendCommand` API permission for # this ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any # tables in the specified ledger. This mode disregards any table-level # or command-level IAM permissions policies that you create for the # ledger. # - # * `STANDARD`\: (*Recommended*) A permissions mode that enables access + # * `STANDARD`: (*Recommended*) A permissions mode that enables access # control with finer granularity for ledgers, tables, and PartiQL # commands. # # By default, this mode denies all user requests to run any PartiQL # commands on any tables in this ledger. To allow PartiQL commands to @@ -1640,10 +1639,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-qldb' - context[:gem_version] = '1.27.0' + context[:gem_version] = '1.28.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated