aws_sdk_athena/client/

get_query_results.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetQueryResults`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`query_execution_id(impl Into<String>)`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::query_execution_id) / [`set_query_execution_id(Option<String>)`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::set_query_execution_id):<br>required: **true**<br><p>The unique ID of the query execution.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results (rows) to return in this request.</p><br>
    ///   - [`query_result_type(QueryResultType)`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::query_result_type) / [`set_query_result_type(Option<QueryResultType>)`](crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::set_query_result_type):<br>required: **false**<br><p>When you set this to <code>DATA_ROWS</code> or empty, <code>GetQueryResults</code> returns the query results in rows. If set to <code>DATA_MANIFEST</code>, it returns the manifest file in rows. Only the query types <code>CREATE TABLE AS SELECT</code>, <code>UNLOAD</code>, and <code>INSERT</code> can generate a manifest file. If you use <code>DATA_MANIFEST</code> for other query types, the query will fail.</p><br>
    /// - On success, responds with [`GetQueryResultsOutput`](crate::operation::get_query_results::GetQueryResultsOutput) with field(s):
    ///   - [`update_count(Option<i64>)`](crate::operation::get_query_results::GetQueryResultsOutput::update_count): <p>The number of rows inserted with a <code>CREATE TABLE AS SELECT</code>, <code>INSERT INTO</code>, or <code>UPDATE</code> statement.</p>
    ///   - [`result_set(Option<ResultSet>)`](crate::operation::get_query_results::GetQueryResultsOutput::result_set): <p>The results of the query execution.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_query_results::GetQueryResultsOutput::next_token): <p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p>
    /// - On failure, responds with [`SdkError<GetQueryResultsError>`](crate::operation::get_query_results::GetQueryResultsError)
    pub fn get_query_results(&self) -> crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder {
        crate::operation::get_query_results::builders::GetQueryResultsFluentBuilder::new(self.handle.clone())
    }
}