Struct aws_sdk_cloudwatchlogs::client::fluent_builders::FilterLogEvents [−][src]
pub struct FilterLogEvents<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
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<C, M, R> FilterLogEvents<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> FilterLogEvents<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<FilterLogEventsOutput, SdkError<FilterLogEventsError>> where
R::Policy: SmithyRetryPolicy<FilterLogEventsInputOperationOutputAlias, FilterLogEventsOutput, FilterLogEventsError, FilterLogEventsInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<FilterLogEventsOutput, SdkError<FilterLogEventsError>> where
R::Policy: SmithyRetryPolicy<FilterLogEventsInputOperationOutputAlias, FilterLogEventsOutput, FilterLogEventsError, FilterLogEventsInputOperationRetryAlias>,
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.
The name of the log group to search.
The name of the log group to search.
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.
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.
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.
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.
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.
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.
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.
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.
The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
The token for the next set of events to return. (You received this token from a previous call.)
The token for the next set of events to return. (You received this token from a previous call.)
The maximum number of events to return. The default is 10,000 events.
The maximum number of events to return. The default is 10,000 events.
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.
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
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for FilterLogEvents<C, M, R>
impl<C, M, R> Send for FilterLogEvents<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for FilterLogEvents<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for FilterLogEvents<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for FilterLogEvents<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more