Struct aws_sdk_athena::client::fluent_builders::StartQueryExecution

pub struct StartQueryExecution { /* private fields */ }

Fluent builder constructing a request to StartQueryExecution.

Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Implementations

impl StartQueryExecution

pub async fn send(
    self
) -> Result<StartQueryExecutionOutput, SdkError<StartQueryExecutionError>>

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 query_string(self, input: impl Into<String>) -> Self

The SQL query statements to be executed.

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

The SQL query statements to be executed.

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

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

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

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

pub fn query_execution_context(self, input: QueryExecutionContext) -> Self

The database within which the query executes.

pub fn set_query_execution_context(
    self,
    input: Option<QueryExecutionContext>
) -> Self

The database within which the query executes.

pub fn result_configuration(self, input: ResultConfiguration) -> Self

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

pub fn set_result_configuration(self, input: Option<ResultConfiguration>) -> Self

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

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

The name of the workgroup in which the query is being started.

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

The name of the workgroup in which the query is being started.

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

Appends an item to ExecutionParameters.

To override the contents of this collection use set_execution_parameters.

A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

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

A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

Trait Implementations

impl Clone for StartQueryExecution

fn clone(&self) -> StartQueryExecution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartQueryExecution

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

Formats the value using the given formatter.