aws_sdk_iottwinmaker/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    /// This operation supports pagination; See [`into_paginator()`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workspace_id(impl Into<String>)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace.</p><br>
8    ///   - [`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 query statement.</p><br>
9    ///   - [`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. The default is 50.</p><br>
10    ///   - [`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>
11    /// - On success, responds with [`ExecuteQueryOutput`](crate::operation::execute_query::ExecuteQueryOutput) with field(s):
12    ///   - [`column_descriptions(Option<Vec::<ColumnDescription>>)`](crate::operation::execute_query::ExecuteQueryOutput::column_descriptions): <p>A list of ColumnDescription objects.</p>
13    ///   - [`rows(Option<Vec::<Row>>)`](crate::operation::execute_query::ExecuteQueryOutput::rows): <p>Represents a single row in the query results.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::execute_query::ExecuteQueryOutput::next_token): <p>The string that specifies the next page of results.</p>
15    /// - On failure, responds with [`SdkError<ExecuteQueryError>`](crate::operation::execute_query::ExecuteQueryError)
16    pub fn execute_query(&self) -> crate::operation::execute_query::builders::ExecuteQueryFluentBuilder {
17        crate::operation::execute_query::builders::ExecuteQueryFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_iottwinmaker/client/execute_query.rs

aws_sdk_iottwinmaker/client/
execute_query.rs
