Struct aws_sdk_cloudwatchlogs::client::fluent_builders::FilterLogEvents

pub struct FilterLogEvents { /* private fields */ }

Fluent builder constructing a request to FilterLogEvents.

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

Implementations

impl FilterLogEvents

pub async fn send(
    self
) -> Result<FilterLogEventsOutput, SdkError<FilterLogEventsError>>

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 into_paginator(self) -> FilterLogEventsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

The name of the log group to search.

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

The name of the log group to search.

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

Appends an item to logStreamNames.

To override the contents of this collection use set_log_stream_names.

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

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

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

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

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

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

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

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

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

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

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

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

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

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

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

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

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

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

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

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

The token for the next set of events to return. (You received this token from a previous call.)

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

The token for the next set of events to return. (You received this token from a previous call.)

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

The maximum number of events to return. The default is 10,000 events.

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

The maximum number of events to return. The default is 10,000 events.

pub fn interleaved(self, input: bool) -> Self

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

pub fn set_interleaved(self, input: Option<bool>) -> Self

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Trait Implementations

impl Clone for FilterLogEvents

fn clone(&self) -> FilterLogEvents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilterLogEvents

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

Formats the value using the given formatter.