aws_sdk_cloudtrail/client/
describe_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 [`DescribeQuery`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`event_data_store(impl Into<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::event_data_store) / [`set_event_data_store(Option<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::set_event_data_store):<br>required: **false**<br><p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.</p><br>
7    ///   - [`query_id(impl Into<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::query_id) / [`set_query_id(Option<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::set_query_id):<br>required: **false**<br><p>The query ID.</p><br>
8    ///   - [`query_alias(impl Into<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::query_alias) / [`set_query_alias(Option<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::set_query_alias):<br>required: **false**<br><p>The alias that identifies a query template.</p><br>
9    ///   - [`refresh_id(impl Into<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::refresh_id) / [`set_refresh_id(Option<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::set_refresh_id):<br>required: **false**<br><p>The ID of the dashboard refresh.</p><br>
10    ///   - [`event_data_store_owner_account_id(impl Into<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::event_data_store_owner_account_id) / [`set_event_data_store_owner_account_id(Option<String>)`](crate::operation::describe_query::builders::DescribeQueryFluentBuilder::set_event_data_store_owner_account_id):<br>required: **false**<br><p>The account ID of the event data store owner.</p><br>
11    /// - On success, responds with [`DescribeQueryOutput`](crate::operation::describe_query::DescribeQueryOutput) with field(s):
12    ///   - [`query_id(Option<String>)`](crate::operation::describe_query::DescribeQueryOutput::query_id): <p>The ID of the query.</p>
13    ///   - [`query_string(Option<String>)`](crate::operation::describe_query::DescribeQueryOutput::query_string): <p>The SQL code of a query.</p>
14    ///   - [`query_status(Option<QueryStatus>)`](crate::operation::describe_query::DescribeQueryOutput::query_status): <p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code></p>
15    ///   - [`query_statistics(Option<QueryStatisticsForDescribeQuery>)`](crate::operation::describe_query::DescribeQueryOutput::query_statistics): <p>Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.</p>
16    ///   - [`error_message(Option<String>)`](crate::operation::describe_query::DescribeQueryOutput::error_message): <p>The error message returned if a query failed.</p>
17    ///   - [`delivery_s3_uri(Option<String>)`](crate::operation::describe_query::DescribeQueryOutput::delivery_s3_uri): <p>The URI for the S3 bucket where CloudTrail delivered query results, if applicable.</p>
18    ///   - [`delivery_status(Option<DeliveryStatus>)`](crate::operation::describe_query::DescribeQueryOutput::delivery_status): <p>The delivery status.</p>
19    ///   - [`prompt(Option<String>)`](crate::operation::describe_query::DescribeQueryOutput::prompt): <p>The prompt used for a generated query. For information about generated queries, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-query-generator.html">Create CloudTrail Lake queries from natural language prompts</a> in the <i>CloudTrail </i> user guide.</p>
20    ///   - [`event_data_store_owner_account_id(Option<String>)`](crate::operation::describe_query::DescribeQueryOutput::event_data_store_owner_account_id): <p>The account ID of the event data store owner.</p>
21    /// - On failure, responds with [`SdkError<DescribeQueryError>`](crate::operation::describe_query::DescribeQueryError)
22    pub fn describe_query(&self) -> crate::operation::describe_query::builders::DescribeQueryFluentBuilder {
23        crate::operation::describe_query::builders::DescribeQueryFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_cloudtrail/client/describe_query.rs

aws_sdk_cloudtrail/client/
describe_query.rs
