// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_aggregate_log_group_summaries::_list_aggregate_log_group_summaries_input::ListAggregateLogGroupSummariesInputBuilder;
pub use crate::operation::list_aggregate_log_group_summaries::_list_aggregate_log_group_summaries_output::ListAggregateLogGroupSummariesOutputBuilder;
impl crate::operation::list_aggregate_log_group_summaries::builders::ListAggregateLogGroupSummariesInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.list_aggregate_log_group_summaries();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `ListAggregateLogGroupSummaries`.
///
/// <p>Returns an aggregate summary of all log groups in the Region grouped by specified data source characteristics. Supports optional filtering by log group class, name patterns, and data sources. If you perform this action in a monitoring account, you can also return aggregated summaries of log groups from source accounts that are linked to the monitoring account. For more information about using cross-account observability to set up monitoring accounts and source accounts, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
/// <p>The operation aggregates log groups by data source name and type and optionally format, providing counts of log groups that share these characteristics. The operation paginates results. By default, it returns up to 50 results and includes a token to retrieve more results.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListAggregateLogGroupSummariesFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::list_aggregate_log_group_summaries::builders::ListAggregateLogGroupSummariesInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesOutput,
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesError,
> for ListAggregateLogGroupSummariesFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesOutput,
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl ListAggregateLogGroupSummariesFluentBuilder {
/// Creates a new `ListAggregateLogGroupSummariesFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the ListAggregateLogGroupSummaries as a reference.
pub fn as_input(&self) -> &crate::operation::list_aggregate_log_group_summaries::builders::ListAggregateLogGroupSummariesInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummaries::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummaries::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesOutput,
crate::operation::list_aggregate_log_group_summaries::ListAggregateLogGroupSummariesError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::list_aggregate_log_group_summaries::paginator::ListAggregateLogGroupSummariesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
pub fn into_paginator(self) -> crate::operation::list_aggregate_log_group_summaries::paginator::ListAggregateLogGroupSummariesPaginator {
crate::operation::list_aggregate_log_group_summaries::paginator::ListAggregateLogGroupSummariesPaginator::new(self.handle, self.inner)
}
///
/// Appends an item to `accountIdentifiers`.
///
/// To override the contents of this collection use [`set_account_identifiers`](Self::set_account_identifiers).
///
/// <p>When <code>includeLinkedAccounts</code> is set to <code>true</code>, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.</p>
pub fn account_identifiers(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.account_identifiers(input.into());
self
}
/// <p>When <code>includeLinkedAccounts</code> is set to <code>true</code>, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.</p>
pub fn set_account_identifiers(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_account_identifiers(input);
self
}
/// <p>When <code>includeLinkedAccounts</code> is set to <code>true</code>, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.</p>
pub fn get_account_identifiers(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_account_identifiers()
}
/// <p>If you are using a monitoring account, set this to <code>true</code> to have the operation return log groups in the accounts listed in <code>accountIdentifiers</code>.</p>
/// <p>If this parameter is set to <code>true</code> and <code>accountIdentifiers</code> contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.</p>
/// <p>The default for this parameter is <code>false</code>.</p>
pub fn include_linked_accounts(mut self, input: bool) -> Self {
self.inner = self.inner.include_linked_accounts(input);
self
}
/// <p>If you are using a monitoring account, set this to <code>true</code> to have the operation return log groups in the accounts listed in <code>accountIdentifiers</code>.</p>
/// <p>If this parameter is set to <code>true</code> and <code>accountIdentifiers</code> contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.</p>
/// <p>The default for this parameter is <code>false</code>.</p>
pub fn set_include_linked_accounts(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_include_linked_accounts(input);
self
}
/// <p>If you are using a monitoring account, set this to <code>true</code> to have the operation return log groups in the accounts listed in <code>accountIdentifiers</code>.</p>
/// <p>If this parameter is set to <code>true</code> and <code>accountIdentifiers</code> contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.</p>
/// <p>The default for this parameter is <code>false</code>.</p>
pub fn get_include_linked_accounts(&self) -> &::std::option::Option<bool> {
self.inner.get_include_linked_accounts()
}
/// <p>Filters the results by log group class to include only log groups of the specified class.</p>
pub fn log_group_class(mut self, input: crate::types::LogGroupClass) -> Self {
self.inner = self.inner.log_group_class(input);
self
}
/// <p>Filters the results by log group class to include only log groups of the specified class.</p>
pub fn set_log_group_class(mut self, input: ::std::option::Option<crate::types::LogGroupClass>) -> Self {
self.inner = self.inner.set_log_group_class(input);
self
}
/// <p>Filters the results by log group class to include only log groups of the specified class.</p>
pub fn get_log_group_class(&self) -> &::std::option::Option<crate::types::LogGroupClass> {
self.inner.get_log_group_class()
}
/// <p>Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.</p>
/// <ul>
/// <li>
/// <p>Use <code>^</code> to match log group names by prefix.</p></li>
/// <li>
/// <p>For a substring match, specify the string to match. All matches are case sensitive</p></li>
/// <li>
/// <p>To match multiple patterns, separate them with a <code>|</code> as in the example <code>^/aws/lambda|discovery</code></p></li>
/// </ul>
/// <p>You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the <code>^</code> symbol as many as five times, and include the <code>|</code> symbol as many as four times.</p>
pub fn log_group_name_pattern(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.log_group_name_pattern(input.into());
self
}
/// <p>Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.</p>
/// <ul>
/// <li>
/// <p>Use <code>^</code> to match log group names by prefix.</p></li>
/// <li>
/// <p>For a substring match, specify the string to match. All matches are case sensitive</p></li>
/// <li>
/// <p>To match multiple patterns, separate them with a <code>|</code> as in the example <code>^/aws/lambda|discovery</code></p></li>
/// </ul>
/// <p>You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the <code>^</code> symbol as many as five times, and include the <code>|</code> symbol as many as four times.</p>
pub fn set_log_group_name_pattern(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_log_group_name_pattern(input);
self
}
/// <p>Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.</p>
/// <ul>
/// <li>
/// <p>Use <code>^</code> to match log group names by prefix.</p></li>
/// <li>
/// <p>For a substring match, specify the string to match. All matches are case sensitive</p></li>
/// <li>
/// <p>To match multiple patterns, separate them with a <code>|</code> as in the example <code>^/aws/lambda|discovery</code></p></li>
/// </ul>
/// <p>You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the <code>^</code> symbol as many as five times, and include the <code>|</code> symbol as many as four times.</p>
pub fn get_log_group_name_pattern(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_log_group_name_pattern()
}
///
/// Appends an item to `dataSources`.
///
/// To override the contents of this collection use [`set_data_sources`](Self::set_data_sources).
///
/// <p>Filters the results by data source characteristics to include only log groups associated with the specified data sources.</p>
pub fn data_sources(mut self, input: crate::types::DataSourceFilter) -> Self {
self.inner = self.inner.data_sources(input);
self
}
/// <p>Filters the results by data source characteristics to include only log groups associated with the specified data sources.</p>
pub fn set_data_sources(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DataSourceFilter>>) -> Self {
self.inner = self.inner.set_data_sources(input);
self
}
/// <p>Filters the results by data source characteristics to include only log groups associated with the specified data sources.</p>
pub fn get_data_sources(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DataSourceFilter>> {
self.inner.get_data_sources()
}
/// <p>Specifies how to group the log groups in the summary.</p>
pub fn group_by(mut self, input: crate::types::ListAggregateLogGroupSummariesGroupBy) -> Self {
self.inner = self.inner.group_by(input);
self
}
/// <p>Specifies how to group the log groups in the summary.</p>
pub fn set_group_by(mut self, input: ::std::option::Option<crate::types::ListAggregateLogGroupSummariesGroupBy>) -> Self {
self.inner = self.inner.set_group_by(input);
self
}
/// <p>Specifies how to group the log groups in the summary.</p>
pub fn get_group_by(&self) -> &::std::option::Option<crate::types::ListAggregateLogGroupSummariesGroupBy> {
self.inner.get_group_by()
}
/// <p>The token for the next set of items to return. The token expires after 24 hours.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>The token for the next set of items to return. The token expires after 24 hours.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The token for the next set of items to return. The token expires after 24 hours.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_token()
}
/// <p>The maximum number of aggregated summaries to return. If you omit this parameter, the default is up to 50 aggregated summaries.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of aggregated summaries to return. If you omit this parameter, the default is up to 50 aggregated summaries.</p>
pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>The maximum number of aggregated summaries to return. If you omit this parameter, the default is up to 50 aggregated summaries.</p>
pub fn get_limit(&self) -> &::std::option::Option<i32> {
self.inner.get_limit()
}
}