Struct aws_sdk_athena::operation::start_query_execution::StartQueryExecutionInput

#[non_exhaustive]
pub struct StartQueryExecutionInput {
    pub query_string: Option<String>,
    pub client_request_token: Option<String>,
    pub query_execution_context: Option<QueryExecutionContext>,
    pub result_configuration: Option<ResultConfiguration>,
    pub work_group: Option<String>,
    pub execution_parameters: Option<Vec<String>>,
    pub result_reuse_configuration: Option<ResultReuseConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query_string: Option<String>

The SQL query statements to be executed.

client_request_token: Option<String>

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. An error is returned if a parameter, such as QueryString, has changed. A call to StartQueryExecution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn't have permission on the tables specified in QueryString.

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.

query_execution_context: Option<QueryExecutionContext>

The database within which the query executes.

result_configuration: Option<ResultConfiguration>

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.

work_group: Option<String>

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

execution_parameters: Option<Vec<String>>

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.

result_reuse_configuration: Option<ResultReuseConfiguration>

Specifies the query result reuse behavior for the query.

Implementations

impl StartQueryExecutionInput

pub fn query_string(&self) -> Option<&str>

The SQL query statements to be executed.

pub fn client_request_token(&self) -> Option<&str>

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. An error is returned if a parameter, such as QueryString, has changed. A call to StartQueryExecution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn't have permission on the tables specified in QueryString.

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) -> Option<&QueryExecutionContext>

The database within which the query executes.

pub fn result_configuration(&self) -> Option<&ResultConfiguration>

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) -> Option<&str>

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

pub fn execution_parameters(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .execution_parameters.is_none().

pub fn result_reuse_configuration(&self) -> Option<&ResultReuseConfiguration>

Specifies the query result reuse behavior for the query.

impl StartQueryExecutionInput

pub fn builder() -> StartQueryExecutionInputBuilder

Creates a new builder-style object to manufacture StartQueryExecutionInput.

Trait Implementations

impl Clone for StartQueryExecutionInput

fn clone(&self) -> StartQueryExecutionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartQueryExecutionInput

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

Formats the value using the given formatter.

impl PartialEq for StartQueryExecutionInput

fn eq(&self, other: &StartQueryExecutionInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartQueryExecutionInput