Struct aws_sdk_cloudwatchlogs::operation::start_query::builders::StartQueryFluentBuilder

pub struct StartQueryFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartQuery.

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax.

After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the queryId that StartQuery returns.

If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.

Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.

You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.

Implementations

impl StartQueryFluentBuilder

pub fn as_input(&self) -> &StartQueryInputBuilder

Access the StartQuery as a reference.

pub async fn send( self, ) -> Result<StartQueryOutput, SdkError<StartQueryError, 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<StartQueryOutput, StartQueryError, Self>

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

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

The log group on which to perform the query.

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

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

The log group on which to perform the query.

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

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

The log group on which to perform the query.

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

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

Appends an item to logGroupNames.

To override the contents of this collection use set_log_group_names.

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

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

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

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

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

pub fn get_log_group_names(&self) -> &Option<Vec<String>>

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

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

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

Appends an item to logGroupIdentifiers.

To override the contents of this collection use set_log_group_identifiers.

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, the ARN can't end with an asterisk (*).

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

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

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, the ARN can't end with an asterisk (*).

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

pub fn get_log_group_identifiers(&self) -> &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, the ARN can't end with an asterisk (*).

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

pub fn start_time(self, input: i64) -> Self

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 set_start_time(self, input: Option<i64>) -> Self

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 get_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, input: i64) -> Self

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 set_end_time(self, input: Option<i64>) -> Self

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 get_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, input: impl Into<String>) -> Self

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

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

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

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

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

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

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 1000.

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

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 1000.

pub fn get_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 1000.

Trait Implementations

impl Clone for StartQueryFluentBuilder

fn clone(&self) -> StartQueryFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartQueryFluentBuilder

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

Formats the value using the given formatter.