lib/aws-sdk-qldb/client.rb in aws-sdk-qldb-1.14.0 vs lib/aws-sdk-qldb/client.rb in aws-sdk-qldb-1.15.0

- old
+ new

@@ -336,11 +336,12 @@ # # @option params [required, String] :ledger_name # The name of the ledger. # # @option params [required, String] :stream_id - # The unique ID that QLDB assigns to each QLDB journal stream. + # The UUID (represented in Base62-encoded text) of the QLDB journal + # stream to be canceled. # # @return [Types::CancelJournalKinesisStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CancelJournalKinesisStreamResponse#stream_id #stream_id} => String # @@ -362,11 +363,11 @@ def cancel_journal_kinesis_stream(params = {}, options = {}) req = build_request(:cancel_journal_kinesis_stream, params) req.send_request(options) end - # Creates a new ledger in your AWS account. + # Creates a new ledger in your AWS account in the current Region. # # @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. # @@ -387,12 +388,12 @@ # This parameter can have one of the following values: # # * `ALLOW_ALL`\: A legacy permissions mode that enables access control # with API-level granularity for ledgers. # - # This mode allows users who have `SendCommand` permissions for this - # ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any + # 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 @@ -400,28 +401,32 @@ # 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 # run, you must create IAM permissions policies for specific table - # resources and PartiQL actions, in addition to `SendCommand` API - # permissions for the ledger. + # resources and PartiQL actions, in addition to the `SendCommand` API + # permission for the ledger. For information, see [Getting started + # with the standard permissions mode][1] in the *Amazon QLDB Developer + # Guide*. # # <note markdown="1"> We strongly recommend using the `STANDARD` permissions mode to # maximize the security of your ledger data. # # </note> # + # + # + # [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. # # If deletion protection is enabled, you must first disable it before - # you can delete the ledger using the QLDB API or the AWS Command Line - # Interface (AWS CLI). You can disable it by calling the `UpdateLedger` - # operation to set the flag to `false`. The QLDB console disables - # deletion protection for you when you use it to delete a ledger. + # you can delete the ledger. You can disable it by calling the + # `UpdateLedger` operation to set the flag to `false`. # # @return [Types::CreateLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateLedgerResponse#name #name} => String # * {Types::CreateLedgerResponse#arn #arn} => String @@ -460,14 +465,12 @@ end # 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 using the QLDB API or the AWS Command Line - # Interface (AWS CLI). You can disable it by calling the `UpdateLedger` - # operation to set the flag to `false`. The QLDB console disables - # deletion protection for you when you use it to delete a ledger. + # you can delete the ledger. You can disable it by calling the + # `UpdateLedger` operation to set the flag 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}. @@ -487,18 +490,27 @@ req.send_request(options) end # 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 your original + # 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][1] in the *Amazon + # QLDB Developer Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration + # # @option params [required, String] :ledger_name # The name of the ledger. # # @option params [required, String] :stream_id - # The unique ID that QLDB assigns to each QLDB journal stream. + # The UUID (represented in Base62-encoded text) of the QLDB journal + # stream to describe. # # @return [Types::DescribeJournalKinesisStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeJournalKinesisStreamResponse#stream #stream} => Types::JournalKinesisStreamDescription # @@ -532,15 +544,15 @@ req = build_request(:describe_journal_kinesis_stream, params) req.send_request(options) end # Returns information about a journal export job, including the ledger - # name, export ID, when it was created, current status, and its start - # and end time export parameters. + # 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][1] in the *Amazon QLDB + # information, see [Export job expiration][1] in the *Amazon QLDB # Developer Guide*. # # If the export job with the given `ExportId` doesn't exist, then # throws `ResourceNotFoundException`. # @@ -553,11 +565,12 @@ # # @option params [required, String] :name # The name of the ledger. # # @option params [required, String] :export_id - # The unique ID of the journal export job that you want to describe. + # The UUID (represented in Base62-encoded text) of the journal export + # job to describe. # # @return [Types::DescribeJournalS3ExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeJournalS3ExportResponse#export_description #export_description} => Types::JournalS3ExportDescription # @@ -646,30 +659,30 @@ # # @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 - # that you want to export. + # The inclusive start date and time for the range of journal contents to + # export. # # The `InclusiveStartTime` must be in `ISO 8601` date and time format # and in Universal Coordinated Time (UTC). For example: - # `2019-06-13T21:36:34Z` + # `2019-06-13T21:36:34Z`. # # The `InclusiveStartTime` must be before `ExclusiveEndTime`. # # If you provide an `InclusiveStartTime` that is before the ledger's # `CreationDateTime`, Amazon QLDB defaults it to the ledger's # `CreationDateTime`. # # @option params [required, Time,DateTime,Date,Integer,String] :exclusive_end_time - # The exclusive end date and time for the range of journal contents that - # you want to export. + # The exclusive end date and time for the range of journal contents to + # export. # # The `ExclusiveEndTime` must be in `ISO 8601` date and time format and # in Universal Coordinated Time (UTC). For example: - # `2019-06-13T21:36:34Z` + # `2019-06-13T21:36:34Z`. # # The `ExclusiveEndTime` must be less than or equal to the current UTC # date and time. # # @option params [required, Types::S3ExportConfiguration] :s3_export_configuration @@ -745,18 +758,18 @@ # # @option params [required, Types::ValueHolder] :block_address # The location of the block that you want to request. An address is an # Amazon Ion structure that has two fields: `strandId` and `sequenceNo`. # - # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}` + # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`. # # @option params [Types::ValueHolder] :digest_tip_address # The latest block location covered by the digest for which to request a # proof. An address is an Amazon Ion structure that has two fields: # `strandId` and `sequenceNo`. # - # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}` + # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`. # # @return [Types::GetBlockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetBlockResponse#block #block} => Types::ValueHolder # * {Types::GetBlockResponse#proof #proof} => Types::ValueHolder @@ -829,21 +842,22 @@ # @option params [required, Types::ValueHolder] :block_address # The block location of the document revision to be verified. An address # is an Amazon Ion structure that has two fields: `strandId` and # `sequenceNo`. # - # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}` + # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`. # # @option params [required, String] :document_id - # The unique ID of the document to be verified. + # The UUID (represented in Base62-encoded text) of the document to be + # verified. # # @option params [Types::ValueHolder] :digest_tip_address # The latest block location covered by the digest for which to request a # proof. An address is an Amazon Ion structure that has two fields: # `strandId` and `sequenceNo`. # - # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}` + # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`. # # @return [Types::GetRevisionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetRevisionResponse#proof #proof} => Types::ValueHolder # * {Types::GetRevisionResponse#revision #revision} => Types::ValueHolder @@ -877,14 +891,22 @@ # 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][1] 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. # + # + # + # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration + # # @option params [required, String] :ledger_name # The name of the ledger. # # @option params [Integer] :max_results # The maximum number of results to return in a single @@ -944,11 +966,11 @@ # 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][1] in the *Amazon QLDB + # information, see [Export job expiration][1] in the *Amazon QLDB # Developer Guide*. # # # # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration @@ -1009,11 +1031,11 @@ # 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][1] in the *Amazon QLDB + # information, see [Export job expiration][1] in the *Amazon QLDB # Developer Guide*. # # # # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration @@ -1121,12 +1143,12 @@ end # Returns all tags for a specified Amazon QLDB resource. # # @option params [required, String] :resource_arn - # The Amazon Resource Name (ARN) for which you want to list the tags. - # For example: + # The Amazon Resource Name (ARN) for which to list the tags. For + # example: # # `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger` # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1172,11 +1194,11 @@ # # @option params [required, Time,DateTime,Date,Integer,String] :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` + # `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 @@ -1188,11 +1210,11 @@ # 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` + # `2019-06-13T21:36:34Z`. # # @option params [required, Types::KinesisConfiguration] :kinesis_configuration # The configuration settings of the Kinesis Data Streams destination for # your stream request. # @@ -1283,17 +1305,17 @@ # Removes one or more tags from a specified Amazon QLDB resource. You # can specify up to 50 tag keys to remove. # # @option params [required, String] :resource_arn - # The Amazon Resource Name (ARN) from which you want to remove the tags. - # For example: + # The Amazon Resource Name (ARN) from which to remove the tags. For + # example: # # `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger` # # @option params [required, Array<String>] :tag_keys - # The list of tag keys that you want to remove. + # The list of tag keys to remove. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -1320,14 +1342,12 @@ # 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. # # If deletion protection is enabled, you must first disable it before - # you can delete the ledger using the QLDB API or the AWS Command Line - # Interface (AWS CLI). You can disable it by calling the `UpdateLedger` - # operation to set the flag to `false`. The QLDB console disables - # deletion protection for you when you use it to delete a ledger. + # you can delete the ledger. You can disable it by calling the + # `UpdateLedger` operation to set the flag to `false`. # # @return [Types::UpdateLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateLedgerResponse#name #name} => String # * {Types::UpdateLedgerResponse#arn #arn} => String @@ -1359,22 +1379,31 @@ req.send_request(options) end # 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][1] in the *Amazon QLDB Developer Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating + # # @option params [required, String] :name # The name of the ledger. # # @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 # with API-level granularity for ledgers. # - # This mode allows users who have `SendCommand` permissions for this - # ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any + # 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 @@ -1382,18 +1411,24 @@ # 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 # run, you must create IAM permissions policies for specific table - # resources and PartiQL actions, in addition to `SendCommand` API - # permissions for the ledger. + # resources and PartiQL actions, in addition to the `SendCommand` API + # permission for the ledger. For information, see [Getting started + # with the standard permissions mode][1] in the *Amazon QLDB Developer + # Guide*. # # <note markdown="1"> We strongly recommend using the `STANDARD` permissions mode to # maximize the security of your ledger data. # # </note> # + # + # + # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html + # # @return [Types::UpdateLedgerPermissionsModeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateLedgerPermissionsModeResponse#name #name} => String # * {Types::UpdateLedgerPermissionsModeResponse#arn #arn} => String # * {Types::UpdateLedgerPermissionsModeResponse#permissions_mode #permissions_mode} => String @@ -1431,10 +1466,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-qldb' - context[:gem_version] = '1.14.0' + context[:gem_version] = '1.15.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated