Struct aws_sdk_cloudwatchlogs::client::fluent_builders::StartQuery

pub struct StartQuery { /* private fields */ }

Fluent builder constructing a request to StartQuery.

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax.

Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

Implementations

impl StartQuery

pub async fn send(self) -> Result<StartQueryOutput, SdkError<StartQueryError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn log_group_name(self, input: impl Into<String>) -> Self

The log group on which to perform the query.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

pub fn set_log_group_name(self, input: Option<String>) -> Self

The log group on which to perform the query.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

pub fn log_group_names(self, input: impl Into<String>) -> Self

Appends an item to logGroupNames.

To override the contents of this collection use set_log_group_names.

The list of log groups to be queried. You can include up to 20 log groups.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

pub fn set_log_group_names(self, input: Option<Vec<String>>) -> Self

The list of log groups to be queried. You can include up to 20 log groups.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

pub fn start_time(self, input: i64) -> Self

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

pub fn set_start_time(self, input: Option<i64>) -> Self

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

pub fn end_time(self, input: i64) -> Self

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

pub fn set_end_time(self, input: Option<i64>) -> Self

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

pub fn query_string(self, input: impl Into<String>) -> Self

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

pub fn set_query_string(self, input: Option<String>) -> Self

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

pub fn limit(self, input: i32) -> Self

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

pub fn set_limit(self, input: Option<i32>) -> Self

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

Trait Implementations

impl Clone for StartQuery

fn clone(&self) -> StartQuery

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.