aws_sdk_cloudwatchlogs/client/get_scheduled_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 [`GetScheduledQuery`](crate::operation::get_scheduled_query::builders::GetScheduledQueryFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`identifier(impl Into<String>)`](crate::operation::get_scheduled_query::builders::GetScheduledQueryFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::get_scheduled_query::builders::GetScheduledQueryFluentBuilder::set_identifier):<br>required: **true**<br><p>The ARN or name of the scheduled query to retrieve.</p><br>
7 /// - On success, responds with [`GetScheduledQueryOutput`](crate::operation::get_scheduled_query::GetScheduledQueryOutput) with field(s):
8 /// - [`scheduled_query_arn(Option<String>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::scheduled_query_arn): <p>The ARN of the scheduled query.</p>
9 /// - [`name(Option<String>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::name): <p>The name of the scheduled query.</p>
10 /// - [`description(Option<String>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::description): <p>The description of the scheduled query.</p>
11 /// - [`query_language(Option<QueryLanguage>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::query_language): <p>The query language used by the scheduled query.</p>
12 /// - [`query_string(Option<String>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::query_string): <p>The query string executed by the scheduled query.</p>
13 /// - [`log_group_identifiers(Option<Vec::<String>>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::log_group_identifiers): <p>The log groups queried by the scheduled query.</p>
14 /// - [`schedule_expression(Option<String>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::schedule_expression): <p>The cron expression that defines when the scheduled query runs.</p>
15 /// - [`timezone(Option<String>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::timezone): <p>The timezone used for evaluating the schedule expression.</p>
16 /// - [`start_time_offset(Option<i64>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::start_time_offset): <p>The time offset in seconds that defines the lookback period for the query.</p>
17 /// - [`destination_configuration(Option<DestinationConfiguration>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::destination_configuration): <p>Configuration for where query results are delivered.</p>
18 /// - [`state(Option<ScheduledQueryState>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::state): <p>The current state of the scheduled query.</p>
19 /// - [`last_triggered_time(Option<i64>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::last_triggered_time): <p>The timestamp when the scheduled query was last executed.</p>
20 /// - [`last_execution_status(Option<ExecutionStatus>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::last_execution_status): <p>The status of the most recent execution of the scheduled query.</p>
21 /// - [`schedule_start_time(Option<i64>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::schedule_start_time): <p>The start time for the scheduled query in Unix epoch format.</p>
22 /// - [`schedule_end_time(Option<i64>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::schedule_end_time): <p>The end time for the scheduled query in Unix epoch format.</p>
23 /// - [`execution_role_arn(Option<String>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::execution_role_arn): <p>The ARN of the IAM role used to execute the query and deliver results.</p>
24 /// - [`creation_time(Option<i64>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::creation_time): <p>The timestamp when the scheduled query was created.</p>
25 /// - [`last_updated_time(Option<i64>)`](crate::operation::get_scheduled_query::GetScheduledQueryOutput::last_updated_time): <p>The timestamp when the scheduled query was last updated.</p>
26 /// - On failure, responds with [`SdkError<GetScheduledQueryError>`](crate::operation::get_scheduled_query::GetScheduledQueryError)
27 pub fn get_scheduled_query(&self) -> crate::operation::get_scheduled_query::builders::GetScheduledQueryFluentBuilder {
28 crate::operation::get_scheduled_query::builders::GetScheduledQueryFluentBuilder::new(self.handle.clone())
29 }
30}