Struct aws_sdk_redshiftdata::client::fluent_builders::BatchExecuteStatement

pub struct BatchExecuteStatement { /* private fields */ }

Fluent builder constructing a request to BatchExecuteStatement.

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

• Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Implementations

impl BatchExecuteStatement

pub async fn customize(
    self
) -> Result<CustomizableOperation<BatchExecuteStatement, AwsResponseRetryClassifier>, SdkError<BatchExecuteStatementError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<BatchExecuteStatementOutput, SdkError<BatchExecuteStatementError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn sqls(self, input: impl Into<String>) -> Self

Appends an item to Sqls.

To override the contents of this collection use set_sqls.

One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

pub fn set_sqls(self, input: Option<Vec<String>>) -> Self

One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

pub fn cluster_identifier(self, input: impl Into<String>) -> Self

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

pub fn set_cluster_identifier(self, input: Option<String>) -> Self

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

pub fn secret_arn(self, input: impl Into<String>) -> Self

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

pub fn set_secret_arn(self, input: Option<String>) -> Self

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

pub fn db_user(self, input: impl Into<String>) -> Self

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

pub fn set_db_user(self, input: Option<String>) -> Self

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

pub fn database(self, input: impl Into<String>) -> Self

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

pub fn set_database(self, input: Option<String>) -> Self

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

pub fn with_event(self, input: bool) -> Self

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

pub fn set_with_event(self, input: Option<bool>) -> Self

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

pub fn statement_name(self, input: impl Into<String>) -> Self

The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

pub fn set_statement_name(self, input: Option<String>) -> Self

The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

pub fn workgroup_name(self, input: impl Into<String>) -> Self

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

pub fn set_workgroup_name(self, input: Option<String>) -> Self

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

pub fn client_token(self, input: impl Into<String>) -> Self

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

pub fn set_client_token(self, input: Option<String>) -> Self

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Trait Implementations

impl Clone for BatchExecuteStatement

fn clone(&self) -> BatchExecuteStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchExecuteStatement

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

Formats the value using the given formatter.