Struct StartQueryInput

#[non_exhaustive]
pub struct StartQueryInput {
    pub log_group_name: Option<String>,
    pub log_group_names: Option<Vec<String>>,
    pub log_group_identifiers: Option<Vec<String>>,
    pub start_time: Option<i64>,
    pub end_time: Option<i64>,
    pub query_string: Option<String>,
    pub limit: Option<i32>,
}

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 log group on which to perform the query.

log_group_names: Option<Vec<String>>

The list of log groups to be queried. You can include up to 50 log groups.

log_group_identifiers: Option<Vec<String>>

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

start_time: Option<i64>

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

end_time: Option<i64>

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

query_string: Option<String>

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

limit: Option<i32>

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 10,000.

Implementations

impl StartQueryInput

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

The log group on which to perform the query.

pub fn log_group_names(&self) -> &[String]

The list of log groups to be queried. You can include up to 50 log groups.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .log_group_names.is_none().

pub fn log_group_identifiers(&self) -> &[String]

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .log_group_identifiers.is_none().

pub fn start_time(&self) -> Option<i64>

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

pub fn end_time(&self) -> Option<i64>

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

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

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

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

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 10,000.

impl StartQueryInput

pub fn builder() -> StartQueryInputBuilder

Creates a new builder-style object to manufacture StartQueryInput.

Trait Implementations

impl Clone for StartQueryInput

fn clone(&self) -> StartQueryInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartQueryInput

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

Formats the value using the given formatter.

impl PartialEq for StartQueryInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StartQueryInput