aws_sdk_timestreamquery/client/
cancel_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 [`CancelQuery`](crate::operation::cancel_query::builders::CancelQueryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`query_id(impl Into<String>)`](crate::operation::cancel_query::builders::CancelQueryFluentBuilder::query_id) / [`set_query_id(Option<String>)`](crate::operation::cancel_query::builders::CancelQueryFluentBuilder::set_query_id):<br>required: **true**<br><p>The ID of the query that needs to be cancelled. <code>QueryID</code> is returned as part of the query result.</p><br>
7    /// - On success, responds with [`CancelQueryOutput`](crate::operation::cancel_query::CancelQueryOutput) with field(s):
8    ///   - [`cancellation_message(Option<String>)`](crate::operation::cancel_query::CancelQueryOutput::cancellation_message): <p>A <code>CancellationMessage</code> is returned when a <code>CancelQuery</code> request for the query specified by <code>QueryId</code> has already been issued.</p>
9    /// - On failure, responds with [`SdkError<CancelQueryError>`](crate::operation::cancel_query::CancelQueryError)
10    pub fn cancel_query(&self) -> crate::operation::cancel_query::builders::CancelQueryFluentBuilder {
11        crate::operation::cancel_query::builders::CancelQueryFluentBuilder::new(self.handle.clone())
12    }
13}