aws_sdk_iotsitewise/client/
execute_query.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ExecuteQuery`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`query_statement(impl Into<String>)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::query_statement) / [`set_query_statement(Option<String>)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::set_query_statement):<br>required: **true**<br><p>The IoT SiteWise query statement.</p><br>
7    ///   - [`next_token(impl Into<String>)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies the next page of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return at one time.</p> <ul>  <li>   <p>Minimum is 1</p></li>  <li>   <p>Maximum is 20000</p></li>  <li>   <p>Default is 20000</p></li> </ul><br>
9    ///   - [`client_token(impl Into<String>)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p><br>
10    /// - On success, responds with [`ExecuteQueryOutput`](crate::operation::execute_query::ExecuteQueryOutput) with field(s):
11    ///   - [`columns(Option<Vec::<ColumnInfo>>)`](crate::operation::execute_query::ExecuteQueryOutput::columns): <p>Represents a single column in the query results.</p>
12    ///   - [`rows(Option<Vec::<Row>>)`](crate::operation::execute_query::ExecuteQueryOutput::rows): <p>Represents a single row in the query results.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::execute_query::ExecuteQueryOutput::next_token): <p>The string that specifies the next page of results.</p>
14    /// - On failure, responds with [`SdkError<ExecuteQueryError>`](crate::operation::execute_query::ExecuteQueryError)
15    pub fn execute_query(&self) -> crate::operation::execute_query::builders::ExecuteQueryFluentBuilder {
16        crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::new(self.handle.clone())
17    }
18}