You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDSDataService::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails 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 search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.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.

  • :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.

  • :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 endpoints. This should be avalid 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. Defaults to false.

  • :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.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :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.

    @see https://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 and auth errors from expired credentials.

  • :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.

  • :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 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing 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 yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble 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 yeidled by #session_for.

  • :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.



251
252
253
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 251

def initialize(*args)
  super
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",
        value: {
          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].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.

  • :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:

See Also:



341
342
343
344
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 341

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.

A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.

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.

DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled.

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:

See Also:



394
395
396
397
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 394

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

See Also:



431
432
433
434
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 431

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..column_count #=> Integer
resp.sql_statement_results[0].result_frame.. #=> Array
resp.sql_statement_results[0].result_frame..[0].array_base_column_type #=> Integer
resp.sql_statement_results[0].result_frame..[0].is_auto_increment #=> Boolean
resp.sql_statement_results[0].result_frame..[0].is_case_sensitive #=> Boolean
resp.sql_statement_results[0].result_frame..[0].is_currency #=> Boolean
resp.sql_statement_results[0].result_frame..[0].is_signed #=> Boolean
resp.sql_statement_results[0].result_frame..[0].label #=> String
resp.sql_statement_results[0].result_frame..[0].name #=> String
resp.sql_statement_results[0].result_frame..[0].nullable #=> Integer
resp.sql_statement_results[0].result_frame..[0].precision #=> Integer
resp.sql_statement_results[0].result_frame..[0].scale #=> Integer
resp.sql_statement_results[0].result_frame..[0].schema_name #=> String
resp.sql_statement_results[0].result_frame..[0].table_name #=> String
resp.sql_statement_results[0].result_frame..[0].type #=> Integer
resp.sql_statement_results[0].result_frame..[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:

See Also:



516
517
518
519
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 516

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 or 1,000 records. If the call returns more than 1 MB of response data or over 1,000 records, 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",
      value: {
        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. #=> Array
resp.[0].array_base_column_type #=> Integer
resp.[0].is_auto_increment #=> Boolean
resp.[0].is_case_sensitive #=> Boolean
resp.[0].is_currency #=> Boolean
resp.[0].is_signed #=> Boolean
resp.[0].label #=> String
resp.[0].name #=> String
resp.[0].nullable #=> Integer
resp.[0].precision #=> Integer
resp.[0].scale #=> Integer
resp.[0].schema_name #=> String
resp.[0].table_name #=> String
resp.[0].type #=> Integer
resp.[0].type_name #=> String
resp.generated_fields #=> Array
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].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.

  • :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:

See Also:



645
646
647
648
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 645

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:

See Also:



682
683
684
685
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 682

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