Class: Aws::RDSDataService::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::RDSDataService::Client

Includes:: ClientStubs

Defined in:: lib/aws-sdk-rdsdataservice/client.rb

Overview

An API client for RDSDataService. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::RDSDataService::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

#batch_execute_statement(params = {}) ⇒ Types::BatchExecuteStatementResponse

Runs a batch SQL statement over an array of data.
#begin_transaction(params = {}) ⇒ Types::BeginTransactionResponse

Starts a SQL transaction.
#commit_transaction(params = {}) ⇒ Types::CommitTransactionResponse

Ends a SQL transaction started with the ‘BeginTransaction` operation and commits the changes.
#execute_sql(params = {}) ⇒ Types::ExecuteSqlResponse

Runs one or more SQL statements.
#execute_statement(params = {}) ⇒ Types::ExecuteStatementResponse

Runs a SQL statement against a database.
#rollback_transaction(params = {}) ⇒ Types::RollbackTransactionResponse

Performs a rollback of a transaction.

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.

Parameters:

options (Hash)

Options Hash (options):

:credentials (required, Aws::CredentialProvider) —
Your AWS credentials. This can be an instance of any one of the following classes:
- ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.
- ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.
- ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.
- ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.
- ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.
- ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.
- ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.
- ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.
When ‘:credentials` are not configured directly, the following locations will be searched for credentials:
- ‘Aws.config`
- The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.
- ENV, ENV
- ‘~/.aws/credentials`
- ‘~/.aws/config`
- EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts.
:region (required, String) —
The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:
- ‘Aws.config`
- ‘ENV`
- ‘ENV`
- ‘ENV`
- ‘~/.aws/credentials`
- ‘~/.aws/config`
:access_key_id (String)
:active_endpoint_cache (Boolean) — default: false —

When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.
:adaptive_retry_wait_to_fill (Boolean) — default: true —

Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.
:client_side_monitoring (Boolean) — default: false —

When ‘true`, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —

Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "127.0.0.1" —

Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_port (Integer) — default: 31000 —

Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —

When ‘true`, an attempt is made to coerce request parameters into the required types.
:correct_clock_skew (Boolean) — default: true —

Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.
:disable_host_prefix_injection (Boolean) — default: false —

Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:endpoint (String) —

The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.
:endpoint_cache_max_entries (Integer) — default: 1000 —

Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —

Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —

When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —

When set to ‘true`, endpoint discovery will be enabled for operations when available.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

The log formatter.
:log_level (Symbol) — default: :info —

The log level to send messages to the ‘:logger` at.
:logger (Logger) —

The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:max_attempts (Integer) — default: 3 —

An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.
:profile (String) — default: "default" —

Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.
:retry_backoff (Proc) —

A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.
:retry_base_delay (Float) — default: 0.3 —

The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_jitter (Symbol) — default: :none —

A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

@see www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —

The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.
:retry_max_delay (Integer) — default: 0 —

The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_mode (String) — default: "legacy" —
Specifies which retry algorithm to use. Values are:
- ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.
- ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.
- ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
:secret_access_key (String)
:session_token (String)
:stub_responses (Boolean) — default: false —

Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
:validate_params (Boolean) — default: true —

When ‘true`, request parameters are validated before sending the request.
:http_proxy (URI::HTTP, String) —

A proxy to send requests through. Formatted like ‘proxy.com:123’.
:http_open_timeout (Float) — default: 15 —

The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.
:http_read_timeout (Integer) — default: 60 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_idle_timeout (Float) — default: 5 —

The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
:http_continue_timeout (Float) — default: 1 —

The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.
:http_wire_trace (Boolean) — default: false —

When ‘true`, HTTP debug output will be sent to the `:logger`.
:ssl_verify_peer (Boolean) — default: true —

When ‘true`, SSL peer certificates are verified when establishing a connection.
:ssl_ca_bundle (String) —

Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
:ssl_ca_directory (String) —

Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.



324
325
326

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 324

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.



843
844
845

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 843

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.



846
847
848

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 846

def errors_module
  Errors
end

Instance Method Details

#batch_execute_statement(params = {}) ⇒ `Types::BatchExecuteStatementResponse`

Runs a batch SQL statement over an array of data.

You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

If a call isn’t part of a transaction because it doesn’t include the ‘transactionID` parameter, changes that result from the call are committed automatically.

Examples:

Request syntax with placeholder values


resp = client.batch_execute_statement({
  database: "DbName",
  parameter_sets: [
    [
      {
        name: "ParameterName",
        type_hint: "DATE", # accepts DATE, DECIMAL, TIME, TIMESTAMP
        value: {
          array_value: {
            array_values: [
              {
                # recursive ArrayValue
              },
            ],
            boolean_values: [false],
            double_values: [1.0],
            long_values: [1],
            string_values: ["String"],
          },
          blob_value: "data",
          boolean_value: false,
          double_value: 1.0,
          is_null: false,
          long_value: 1,
          string_value: "String",
        },
      },
    ],
  ],
  resource_arn: "Arn", # required
  schema: "DbName",
  secret_arn: "Arn", # required
  sql: "SqlStatement", # required
  transaction_id: "Id",
})

Response structure


resp.update_results #=> Array
resp.update_results[0].generated_fields #=> Array
resp.update_results[0].generated_fields[0].array_value.array_values #=> Array
resp.update_results[0].generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
resp.update_results[0].generated_fields[0].array_value.boolean_values #=> Array
resp.update_results[0].generated_fields[0].array_value.boolean_values[0] #=> Boolean
resp.update_results[0].generated_fields[0].array_value.double_values #=> Array
resp.update_results[0].generated_fields[0].array_value.double_values[0] #=> Float
resp.update_results[0].generated_fields[0].array_value.long_values #=> Array
resp.update_results[0].generated_fields[0].array_value.long_values[0] #=> Integer
resp.update_results[0].generated_fields[0].array_value.string_values #=> Array
resp.update_results[0].generated_fields[0].array_value.string_values[0] #=> String
resp.update_results[0].generated_fields[0].blob_value #=> String
resp.update_results[0].generated_fields[0].boolean_value #=> Boolean
resp.update_results[0].generated_fields[0].double_value #=> Float
resp.update_results[0].generated_fields[0].is_null #=> Boolean
resp.update_results[0].generated_fields[0].long_value #=> Integer
resp.update_results[0].generated_fields[0].string_value #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:database (String) —

The name of the database.
:parameter_sets (Array<Array>) —
The parameter set for the batch operation.

The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:
- Specify one or more empty parameter sets.
- Use the ‘ExecuteStatement` operation instead of the `BatchExecuteStatement` operation.
<note markdown=“1”> Array parameters are not supported.
```
</note>
```
:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
:schema (String) —

The name of the database schema.
:secret_arn (required, String) —

The name or ARN of the secret that enables access to the DB cluster.
:sql (required, String) —

The SQL statement to run.
:transaction_id (String) —

The identifier of a transaction that was started by using the ‘BeginTransaction` operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don’t set this parameter.

Returns:

(Types::BatchExecuteStatementResponse) —
Returns a response object which responds to the following methods:
- #update_results => Array<Types::UpdateResult>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 447

def batch_execute_statement(params = {}, options = {})
  req = build_request(:batch_execute_statement, params)
  req.send_request(options)
end

#begin_transaction(params = {}) ⇒ `Types::BeginTransactionResponse`

Starts a SQL transaction.

<important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.</p> <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.</p> <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important>

Examples:

Request syntax with placeholder values


resp = client.begin_transaction({
  database: "DbName",
  resource_arn: "Arn", # required
  schema: "DbName",
  secret_arn: "Arn", # required
})

Response structure


resp.transaction_id #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:database (String) —

The name of the database.
:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
:schema (String) —

The name of the database schema.
:secret_arn (required, String) —

The name or ARN of the secret that enables access to the DB cluster.

Returns:

(Types::BeginTransactionResponse) —
Returns a response object which responds to the following methods:
- #transaction_id => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 489

def begin_transaction(params = {}, options = {})
  req = build_request(:begin_transaction, params)
  req.send_request(options)
end

#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.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 821

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-rdsdataservice'
  context[:gem_version] = '1.23.0'
  Seahorse::Client::Request.new(handlers, context)
end

#commit_transaction(params = {}) ⇒ `Types::CommitTransactionResponse`

Ends a SQL transaction started with the ‘BeginTransaction` operation and commits the changes.

Examples:

Request syntax with placeholder values


resp = client.commit_transaction({
  resource_arn: "Arn", # required
  secret_arn: "Arn", # required
  transaction_id: "Id", # required
})

Response structure


resp.transaction_status #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
:secret_arn (required, String) —

The name or ARN of the secret that enables access to the DB cluster.
:transaction_id (required, String) —

The identifier of the transaction to end and commit.

Returns:

(Types::CommitTransactionResponse) —
Returns a response object which responds to the following methods:
- #transaction_status => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 526

def commit_transaction(params = {}, options = {})
  req = build_request(:commit_transaction, params)
  req.send_request(options)
end

#execute_sql(params = {}) ⇒ `Types::ExecuteSqlResponse`

Runs one or more SQL statements.

This operation is deprecated. Use the ‘BatchExecuteStatement` or `ExecuteStatement` operation.

Examples:

Request syntax with placeholder values


resp = client.execute_sql({
  aws_secret_store_arn: "Arn", # required
  database: "DbName",
  db_cluster_or_instance_arn: "Arn", # required
  schema: "DbName",
  sql_statements: "SqlStatement", # required
})

Response structure


resp.sql_statement_results #=> Array
resp.sql_statement_results[0].number_of_records_updated #=> Integer
resp.sql_statement_results[0].result_frame.records #=> Array
resp.sql_statement_results[0].result_frame.records[0].values #=> Array
resp.sql_statement_results[0].result_frame.records[0].values[0].array_values #=> Array
resp.sql_statement_results[0].result_frame.records[0].values[0].array_values[0] #=> Types::Value
resp.sql_statement_results[0].result_frame.records[0].values[0].big_int_value #=> Integer
resp.sql_statement_results[0].result_frame.records[0].values[0].bit_value #=> Boolean
resp.sql_statement_results[0].result_frame.records[0].values[0].blob_value #=> String
resp.sql_statement_results[0].result_frame.records[0].values[0].double_value #=> Float
resp.sql_statement_results[0].result_frame.records[0].values[0].int_value #=> Integer
resp.sql_statement_results[0].result_frame.records[0].values[0].is_null #=> Boolean
resp.sql_statement_results[0].result_frame.records[0].values[0].real_value #=> Float
resp.sql_statement_results[0].result_frame.records[0].values[0].string_value #=> String
resp.sql_statement_results[0].result_frame.records[0].values[0].struct_value.attributes #=> Array
resp.sql_statement_results[0].result_frame.records[0].values[0].struct_value.attributes[0] #=> Types::Value
resp.sql_statement_results[0].result_frame.result_set_metadata.column_count #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata #=> Array
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].array_base_column_type #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_auto_increment #=> Boolean
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_case_sensitive #=> Boolean
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_currency #=> Boolean
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_signed #=> Boolean
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].label #=> String
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].name #=> String
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].nullable #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].precision #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].scale #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].schema_name #=> String
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].table_name #=> String
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:aws_secret_store_arn (required, String) —

The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.
:database (String) —

The name of the database.
:db_cluster_or_instance_arn (required, String) —

The ARN of the Aurora Serverless DB cluster.
:schema (String) —

The name of the database schema.
:sql_statements (required, String) —

One or more SQL statements to run on the DB cluster.

You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements.

Returns:

(Types::ExecuteSqlResponse) —
Returns a response object which responds to the following methods:
- #sql_statement_results => Array<Types::SqlStatementResult>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 609

def execute_sql(params = {}, options = {})
  req = build_request(:execute_sql, params)
  req.send_request(options)
end

#execute_statement(params = {}) ⇒ `Types::ExecuteStatementResponse`

Runs a SQL statement against a database.

If a call isn’t part of a transaction because it doesn’t include the ‘transactionID` parameter, changes that result from the call are committed automatically.

The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

Examples:

Request syntax with placeholder values


resp = client.execute_statement({
  continue_after_timeout: false,
  database: "DbName",
  include_result_metadata: false,
  parameters: [
    {
      name: "ParameterName",
      type_hint: "DATE", # accepts DATE, DECIMAL, TIME, TIMESTAMP
      value: {
        array_value: {
          array_values: [
            {
              # recursive ArrayValue
            },
          ],
          boolean_values: [false],
          double_values: [1.0],
          long_values: [1],
          string_values: ["String"],
        },
        blob_value: "data",
        boolean_value: false,
        double_value: 1.0,
        is_null: false,
        long_value: 1,
        string_value: "String",
      },
    },
  ],
  resource_arn: "Arn", # required
  result_set_options: {
    decimal_return_type: "DOUBLE_OR_LONG", # accepts DOUBLE_OR_LONG, STRING
  },
  schema: "DbName",
  secret_arn: "Arn", # required
  sql: "SqlStatement", # required
  transaction_id: "Id",
})

Response structure


resp.column_metadata #=> Array
resp.column_metadata[0].array_base_column_type #=> Integer
resp.column_metadata[0].is_auto_increment #=> Boolean
resp.column_metadata[0].is_case_sensitive #=> Boolean
resp.column_metadata[0].is_currency #=> Boolean
resp.column_metadata[0].is_signed #=> Boolean
resp.column_metadata[0].label #=> String
resp.column_metadata[0].name #=> String
resp.column_metadata[0].nullable #=> Integer
resp.column_metadata[0].precision #=> Integer
resp.column_metadata[0].scale #=> Integer
resp.column_metadata[0].schema_name #=> String
resp.column_metadata[0].table_name #=> String
resp.column_metadata[0].type #=> Integer
resp.column_metadata[0].type_name #=> String
resp.generated_fields #=> Array
resp.generated_fields[0].array_value.array_values #=> Array
resp.generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
resp.generated_fields[0].array_value.boolean_values #=> Array
resp.generated_fields[0].array_value.boolean_values[0] #=> Boolean
resp.generated_fields[0].array_value.double_values #=> Array
resp.generated_fields[0].array_value.double_values[0] #=> Float
resp.generated_fields[0].array_value.long_values #=> Array
resp.generated_fields[0].array_value.long_values[0] #=> Integer
resp.generated_fields[0].array_value.string_values #=> Array
resp.generated_fields[0].array_value.string_values[0] #=> String
resp.generated_fields[0].blob_value #=> String
resp.generated_fields[0].boolean_value #=> Boolean
resp.generated_fields[0].double_value #=> Float
resp.generated_fields[0].is_null #=> Boolean
resp.generated_fields[0].long_value #=> Integer
resp.generated_fields[0].string_value #=> String
resp.number_of_records_updated #=> Integer
resp.records #=> Array
resp.records[0] #=> Array
resp.records[0][0].array_value.array_values #=> Array
resp.records[0][0].array_value.array_values[0] #=> Types::ArrayValue
resp.records[0][0].array_value.boolean_values #=> Array
resp.records[0][0].array_value.boolean_values[0] #=> Boolean
resp.records[0][0].array_value.double_values #=> Array
resp.records[0][0].array_value.double_values[0] #=> Float
resp.records[0][0].array_value.long_values #=> Array
resp.records[0][0].array_value.long_values[0] #=> Integer
resp.records[0][0].array_value.string_values #=> Array
resp.records[0][0].array_value.string_values[0] #=> String
resp.records[0][0].blob_value #=> String
resp.records[0][0].boolean_value #=> Boolean
resp.records[0][0].double_value #=> Float
resp.records[0][0].is_null #=> Boolean
resp.records[0][0].long_value #=> Integer
resp.records[0][0].string_value #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:continue_after_timeout (Boolean) —

A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.
:database (String) —

The name of the database.
:include_result_metadata (Boolean) —

A value that indicates whether to include metadata in the results.
:parameters (Array<Types::SqlParameter>) —
The parameters for the SQL statement.

<note markdown=“1”> Array parameters are not supported.
```
</note>
```
:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
:result_set_options (Types::ResultSetOptions) —

Options that control how the result set is returned.
:schema (String) —

The name of the database schema.
:secret_arn (required, String) —

The name or ARN of the secret that enables access to the DB cluster.
:sql (required, String) —

The SQL statement to run.
:transaction_id (String) —

The identifier of a transaction that was started by using the ‘BeginTransaction` operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don’t set this parameter.

Returns:

(Types::ExecuteStatementResponse) —
Returns a response object which responds to the following methods:
- #column_metadata => Array<Types::ColumnMetadata>
- #generated_fields => Array<Types::Field>
- #number_of_records_updated => Integer
- #records => Array<Array<Types::Field>>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 775

def execute_statement(params = {}, options = {})
  req = build_request(:execute_statement, params)
  req.send_request(options)
end

#rollback_transaction(params = {}) ⇒ `Types::RollbackTransactionResponse`

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

Examples:

Request syntax with placeholder values


resp = client.rollback_transaction({
  resource_arn: "Arn", # required
  secret_arn: "Arn", # required
  transaction_id: "Id", # required
})

Response structure


resp.transaction_status #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
:secret_arn (required, String) —

The name or ARN of the secret that enables access to the DB cluster.
:transaction_id (required, String) —

The identifier of the transaction to roll back.

Returns:

(Types::RollbackTransactionResponse) —
Returns a response object which responds to the following methods:
- #transaction_status => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 812

def rollback_transaction(params = {}, options = {})
  req = build_request(:rollback_transaction, params)
  req.send_request(options)
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.

Deprecated.



836
837
838

# File 'lib/aws-sdk-rdsdataservice/client.rb', line 836

def waiter_names
  []
end

Class: Aws::RDSDataService::Client

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#batch_execute_statement(params = {}) ⇒ Types::BatchExecuteStatementResponse

Examples:

Request syntax with placeholder values

Response structure

#begin_transaction(params = {}) ⇒ Types::BeginTransactionResponse

Examples:

Request syntax with placeholder values

Response structure

#build_request(operation_name, params = {}) ⇒ Object

#commit_transaction(params = {}) ⇒ Types::CommitTransactionResponse

Examples:

Request syntax with placeholder values

Response structure

#execute_sql(params = {}) ⇒ Types::ExecuteSqlResponse

Examples:

Request syntax with placeholder values

Response structure

#execute_statement(params = {}) ⇒ Types::ExecuteStatementResponse

Examples:

Request syntax with placeholder values

Response structure

#rollback_transaction(params = {}) ⇒ Types::RollbackTransactionResponse

Examples:

Request syntax with placeholder values

Response structure

#waiter_names ⇒ Object

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#batch_execute_statement(params = {}) ⇒ `Types::BatchExecuteStatementResponse`

#begin_transaction(params = {}) ⇒ `Types::BeginTransactionResponse`

#build_request(operation_name, params = {}) ⇒ `Object`

#commit_transaction(params = {}) ⇒ `Types::CommitTransactionResponse`

#execute_sql(params = {}) ⇒ `Types::ExecuteSqlResponse`

#execute_statement(params = {}) ⇒ `Types::ExecuteStatementResponse`

#rollback_transaction(params = {}) ⇒ `Types::RollbackTransactionResponse`

#waiter_names ⇒ `Object`