1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::execute_statement::_execute_statement_output::ExecuteStatementOutputBuilder;
pub use crate::operation::execute_statement::_execute_statement_input::ExecuteStatementInputBuilder;
/// Fluent builder constructing a request to `ExecuteStatement`.
///
/// <p>Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters: </p>
/// <ul>
/// <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li>
/// <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
/// <ul>
/// <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li>
/// <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li>
/// <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li>
/// </ul> </li>
/// </ul>
/// <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ExecuteStatementFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::execute_statement::builders::ExecuteStatementInputBuilder,
}
impl ExecuteStatementFluentBuilder {
/// Creates a new `ExecuteStatement`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// 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 customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::execute_statement::ExecuteStatement,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::execute_statement::ExecuteStatementError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::execute_statement::ExecuteStatementOutput,
aws_smithy_http::result::SdkError<
crate::operation::execute_statement::ExecuteStatementError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The SQL statement text to run. </p>
pub fn sql(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.sql(input.into());
self
}
/// <p>The SQL statement text to run. </p>
pub fn set_sql(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_sql(input);
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn cluster_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.cluster_identifier(input.into());
self
}
/// <p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_cluster_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_cluster_identifier(input);
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn secret_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.secret_arn(input.into());
self
}
/// <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
pub fn set_secret_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_secret_arn(input);
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
pub fn db_user(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.db_user(input.into());
self
}
/// <p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>
pub fn set_db_user(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_db_user(input);
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn database(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.database(input.into());
self
}
/// <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
pub fn set_database(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_database(input);
self
}
/// <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>
pub fn with_event(mut self, input: bool) -> Self {
self.inner = self.inner.with_event(input);
self
}
/// <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>
pub fn set_with_event(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_with_event(input);
self
}
/// <p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>
pub fn statement_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.statement_name(input.into());
self
}
/// <p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>
pub fn set_statement_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_statement_name(input);
self
}
/// Appends an item to `Parameters`.
///
/// To override the contents of this collection use [`set_parameters`](Self::set_parameters).
///
/// <p>The parameters for the SQL statement.</p>
pub fn parameters(mut self, input: crate::types::SqlParameter) -> Self {
self.inner = self.inner.parameters(input);
self
}
/// <p>The parameters for the SQL statement.</p>
pub fn set_parameters(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::SqlParameter>>,
) -> Self {
self.inner = self.inner.set_parameters(input);
self
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
pub fn workgroup_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.workgroup_name(input.into());
self
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>
pub fn set_workgroup_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_workgroup_name(input);
self
}
/// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
pub fn client_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_token(input.into());
self
}
/// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
pub fn set_client_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_client_token(input);
self
}
}