Struct aws_sdk_cloudwatchlogs::operation::get_log_events::GetLogEventsInput

#[non_exhaustive]
pub struct GetLogEventsInput {
    pub log_group_name: Option<String>,
    pub log_group_identifier: Option<String>,
    pub log_stream_name: Option<String>,
    pub start_time: Option<i64>,
    pub end_time: Option<i64>,
    pub next_token: Option<String>,
    pub limit: Option<i32>,
    pub start_from_head: Option<bool>,
    pub unmask: 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.

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

log_group_identifier: 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.

log_stream_name: Option<String>

The name of the log stream.

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

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

next_token: Option<String>

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

limit: 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).

start_from_head: 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.

unmask: 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.

Implementations

impl GetLogEventsInput

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

The name of the log group.

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

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

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

The name of the log stream.

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

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

pub fn 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) -> 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) -> 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.

impl GetLogEventsInput

pub fn builder() -> GetLogEventsInputBuilder

Creates a new builder-style object to manufacture GetLogEventsInput.

Trait Implementations

impl Clone for GetLogEventsInput

fn clone(&self) -> GetLogEventsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetLogEventsInput

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

Formats the value using the given formatter.

impl PartialEq for GetLogEventsInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetLogEventsInput