Struct aws_sdk_rdsdata::Client

pub struct Client { /* private fields */ }

Client for AWS RDS DataService

Client for invoking operations on AWS RDS DataService. Each operation on AWS RDS DataService is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_rdsdata::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_rdsdata::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the BatchExecuteStatement operation has a Client::batch_execute_statement, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.batch_execute_statement()
    .resource_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_execute_statement(&self) -> BatchExecuteStatementFluentBuilder

Constructs a fluent builder for the BatchExecuteStatement operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: true
    

    The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

    For information about creating the secret, see Create a database secret.

    
    
  • sql(impl Into<String>) / set_sql(Option<String>):
    required: true
    

    The SQL statement to run. Don’t include a semicolon (;) at the end of the SQL statement.

    
    
  • database(impl Into<String>) / set_database(Option<String>):
    required: false
    

    The name of the database.

    
    
  • schema(impl Into<String>) / set_schema(Option<String>):
    required: false
    

    The name of the database schema.

    Currently, the schema parameter isn’t supported.

    
    
  • parameter_sets(Vec::<SqlParameter>) / set_parameter_sets(Option<Vec::<Vec::<SqlParameter>>>):
    required: false
    

    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.

    Array parameters are not supported.

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with BatchExecuteStatementOutput with field(s):
  • update_results(Option<Vec::<UpdateResult>>):

    The execution results of each batch entry.

• On failure, responds with SdkError<BatchExecuteStatementError>

impl Client

pub fn begin_transaction(&self) -> BeginTransactionFluentBuilder

Constructs a fluent builder for the BeginTransaction operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: true
    

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

    
    
  • database(impl Into<String>) / set_database(Option<String>):
    required: false
    

    The name of the database.

    
    
  • schema(impl Into<String>) / set_schema(Option<String>):
    required: false
    

    The name of the database schema.

    
    
• On success, responds with BeginTransactionOutput with field(s):
  • transaction_id(Option<String>):

    The transaction ID of the transaction started by the call.

• On failure, responds with SdkError<BeginTransactionError>

impl Client

pub fn commit_transaction(&self) -> CommitTransactionFluentBuilder

Constructs a fluent builder for the CommitTransaction operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: true
    

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

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: true
    

    The identifier of the transaction to end and commit.

    
    
• On success, responds with CommitTransactionOutput with field(s):
  • transaction_status(Option<String>):

    The status of the commit operation.

• On failure, responds with SdkError<CommitTransactionError>

impl Client

pub fn execute_sql(&self) -> ExecuteSqlFluentBuilder

👎Deprecated since 2019-03-21: The ExecuteSql API is deprecated, please use the ExecuteStatement API.

Constructs a fluent builder for the ExecuteSql operation.

• The fluent builder is configurable:
  • db_cluster_or_instance_arn(impl Into<String>) / set_db_cluster_or_instance_arn(Option<String>):
    required: true
    

    The ARN of the Aurora Serverless DB cluster.

    
    
  • aws_secret_store_arn(impl Into<String>) / set_aws_secret_store_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

    For information about creating the secret, see Create a database secret.

    
    
  • sql_statements(impl Into<String>) / set_sql_statements(Option<String>):
    required: true
    

    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.

    
    
  • database(impl Into<String>) / set_database(Option<String>):
    required: false
    

    The name of the database.

    
    
  • schema(impl Into<String>) / set_schema(Option<String>):
    required: false
    

    The name of the database schema.

    
    
• On success, responds with ExecuteSqlOutput with field(s):
  • sql_statement_results(Option<Vec::<SqlStatementResult>>):

    The results of the SQL statement or statements.

• On failure, responds with SdkError<ExecuteSqlError>

impl Client

pub fn execute_statement(&self) -> ExecuteStatementFluentBuilder

Constructs a fluent builder for the ExecuteStatement operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: true
    

    The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

    For information about creating the secret, see Create a database secret.

    
    
  • sql(impl Into<String>) / set_sql(Option<String>):
    required: true
    

    The SQL statement to run.

    
    
  • database(impl Into<String>) / set_database(Option<String>):
    required: false
    

    The name of the database.

    
    
  • schema(impl Into<String>) / set_schema(Option<String>):
    required: false
    

    The name of the database schema.

    Currently, the schema parameter isn’t supported.

    
    
  • parameters(SqlParameter) / set_parameters(Option<Vec::<SqlParameter>>):
    required: false
    

    The parameters for the SQL statement.

    Array parameters are not supported.

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: false
    

    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.

    
    
  • include_result_metadata(bool) / set_include_result_metadata(Option<bool>):
    required: false
    

    A value that indicates whether to include metadata in the results.

    
    
  • continue_after_timeout(bool) / set_continue_after_timeout(Option<bool>):
    required: false
    

    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.

    
    
  • result_set_options(ResultSetOptions) / set_result_set_options(Option<ResultSetOptions>):
    required: false
    

    Options that control how the result set is returned.

    
    
  • format_records_as(RecordsFormatType) / set_format_records_as(Option<RecordsFormatType>):
    required: false
    

    A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON. The default value is NONE. The result is returned in the formattedRecords field.

    For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.

    
    
• On success, responds with ExecuteStatementOutput with field(s):
  • records(Option<Vec::<Vec::<Field>>>):

    The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.

  • column_metadata(Option<Vec::<ColumnMetadata>>):

    Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

  • number_of_records_updated(i64):

    The number of records updated by the request.

  • generated_fields(Option<Vec::<Field>>):

    Values for fields generated during a DML request.

    The generatedFields data isn’t supported by Aurora PostgreSQL. To get the values of generated fields, use the RETURNING clause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.

  • formatted_records(Option<String>):

    A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON.

    The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.

• On failure, responds with SdkError<ExecuteStatementError>

impl Client

pub fn rollback_transaction(&self) -> RollbackTransactionFluentBuilder

Constructs a fluent builder for the RollbackTransaction operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: true
    

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

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: true
    

    The identifier of the transaction to roll back.

    
    
• On success, responds with RollbackTransactionOutput with field(s):
  • transaction_status(Option<String>):

    The status of the rollback operation.

• On failure, responds with SdkError<RollbackTransactionError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.