Struct aws_sdk_cloudwatchlogs::input::FilterLogEventsInput

#[non_exhaustive]
pub struct FilterLogEventsInput {
    pub log_group_name: Option<String>,
    pub log_stream_names: Option<Vec<String>>,
    pub log_stream_name_prefix: Option<String>,
    pub start_time: Option<i64>,
    pub end_time: Option<i64>,
    pub filter_pattern: Option<String>,
    pub next_token: Option<String>,
    pub limit: Option<i32>,
    pub interleaved: Option<bool>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

log_group_name: Option<String>

The name of the log group to search.

log_stream_names: Option<Vec<String>>

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.

log_stream_name_prefix: Option<String>

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.

start_time: Option<i64>

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.

end_time: Option<i64>

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.

filter_pattern: Option<String>

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

If not provided, all the events are matched.

next_token: Option<String>

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

limit: Option<i32>

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

interleaved: Option<bool>

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.

Implementations

impl FilterLogEventsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<FilterLogEvents, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<FilterLogEvents>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture FilterLogEventsInput

impl FilterLogEventsInput

pub fn log_group_name(&self) -> Option<&str>

The name of the log group to search.

pub fn log_stream_names(&self) -> Option<&[String]>

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) -> Option<&str>

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) -> Option<i64>

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) -> Option<i64>

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) -> Option<&str>

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) -> Option<&str>

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

pub fn limit(&self) -> Option<i32>

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

pub fn interleaved(&self) -> Option<bool>

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 FilterLogEventsInput

fn clone(&self) -> FilterLogEventsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilterLogEventsInput

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

Formats the value using the given formatter.

impl PartialEq<FilterLogEventsInput> for FilterLogEventsInput

fn eq(&self, other: &FilterLogEventsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FilterLogEventsInput) -> bool

This method tests for !=.

impl StructuralPartialEq for FilterLogEventsInput