Struct aws_sdk_cloudwatchlogs::operation::get_log_events::builders::GetLogEventsFluentBuilder

pub struct GetLogEventsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetLogEvents.

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

Implementations

impl GetLogEventsFluentBuilder

pub fn as_input(&self) -> &GetLogEventsInputBuilder

Access the GetLogEvents as a reference.

pub async fn send( self, ) -> Result<GetLogEventsOutput, SdkError<GetLogEventsError, HttpResponse>>

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 customize( self, ) -> CustomizableOperation<GetLogEventsOutput, GetLogEventsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> GetLogEventsPaginator

Create a paginator for this request

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

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

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

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

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

pub fn get_log_group_name(&self) -> &Option<String>

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

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

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

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

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

pub fn get_log_group_identifier(&self) -> &Option<String>

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

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

The name of the log stream.

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

The name of the log stream.

pub fn get_log_stream_name(&self) -> &Option<String>

The name of the log stream.

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 equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

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 equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

pub fn get_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 equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

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 equal to or later than this time are not included.

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 equal to or later than this time are not included.

pub fn get_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 equal to or later than this time are not included.

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

The token for the next set of items 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 items to return. (You received this token from a previous call.)

pub fn get_next_token(&self) -> &Option<String>

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

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

The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

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

The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

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

The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

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

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

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

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

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

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Trait Implementations

impl Clone for GetLogEventsFluentBuilder

fn clone(&self) -> GetLogEventsFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetLogEventsFluentBuilder

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

Formats the value using the given formatter.