aws_sdk_cloudwatchlogs/client/
get_log_group_fields.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetLogGroupFields`](crate::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`log_group_name(impl Into<String>)`](crate::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder::log_group_name) / [`set_log_group_name(Option<String>)`](crate::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder::set_log_group_name):<br>required: **false**<br><p>The name of the log group to search.</p><note>  <p>You must include either <code>logGroupIdentifier</code> or <code>logGroupName</code>, but not both.</p> </note><br>
    ///   - [`time(i64)`](crate::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder::time) / [`set_time(Option<i64>)`](crate::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder::set_time):<br>required: **false**<br><p>The time to set as the center of the query. If you specify <code>time</code>, the 8 minutes before and 8 minutes after this time are searched. If you omit <code>time</code>, the most recent 15 minutes up to the current time are searched.</p> <p>The <code>time</code> value is specified as epoch time, which is the number of seconds since <code>January 1, 1970, 00:00:00 UTC</code>.</p><br>
    ///   - [`log_group_identifier(impl Into<String>)`](crate::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder::log_group_identifier) / [`set_log_group_identifier(Option<String>)`](crate::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder::set_log_group_identifier):<br>required: **false**<br><p>Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.</p><note>  <p>You must include either <code>logGroupIdentifier</code> or <code>logGroupName</code>, but not both.</p> </note><br>
    /// - On success, responds with [`GetLogGroupFieldsOutput`](crate::operation::get_log_group_fields::GetLogGroupFieldsOutput) with field(s):
    ///   - [`log_group_fields(Option<Vec::<LogGroupField>>)`](crate::operation::get_log_group_fields::GetLogGroupFieldsOutput::log_group_fields): <p>The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried.</p>
    /// - On failure, responds with [`SdkError<GetLogGroupFieldsError>`](crate::operation::get_log_group_fields::GetLogGroupFieldsError)
    pub fn get_log_group_fields(&self) -> crate::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder {
        crate::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder::new(self.handle.clone())
    }
}