Class: Aws::QLDBSession::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::QLDBSession::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-qldbsession/client.rb
Overview
An API client for QLDBSession. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::QLDBSession::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#send_command(params = {}) ⇒ Types::SendCommandResult
Sends a command to an Amazon QLDB ledger.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
419 420 421 |
# File 'lib/aws-sdk-qldbsession/client.rb', line 419 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
586 587 588 |
# File 'lib/aws-sdk-qldbsession/client.rb', line 586 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
589 590 591 |
# File 'lib/aws-sdk-qldbsession/client.rb', line 589 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
564 565 566 567 568 569 570 571 572 573 574 575 |
# File 'lib/aws-sdk-qldbsession/client.rb', line 564 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-qldbsession' context[:gem_version] = '1.35.0' Seahorse::Client::Request.new(handlers, context) end |
#send_command(params = {}) ⇒ Types::SendCommandResult
Sends a command to an Amazon QLDB ledger.
<note markdown=“1”> Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.
* If you are working with an AWS SDK, use the QLDB driver. The driver
provides a high-level abstraction layer above this *QLDB Session*
data plane and manages `SendCommand` API calls for you. For
information and a list of supported programming languages, see
[Getting started with the driver][1] in the *Amazon QLDB Developer
Guide*.
-
If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB shell. The shell is a command line interface that uses the QLDB driver to interact with a ledger. For information, see [Accessing Amazon QLDB using the QLDB shell].
</note>
[1]: docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html [2]: docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html
555 556 557 558 |
# File 'lib/aws-sdk-qldbsession/client.rb', line 555 def send_command(params = {}, = {}) req = build_request(:send_command, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
579 580 581 |
# File 'lib/aws-sdk-qldbsession/client.rb', line 579 def waiter_names [] end |