Struct DescribeLogGroupsFluentBuilder

pub struct DescribeLogGroupsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to DescribeLogGroups.

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

CloudWatch Logs doesn't support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

Implementations

impl DescribeLogGroupsFluentBuilder

pub fn as_input(&self) -> &DescribeLogGroupsInputBuilder

Access the DescribeLogGroups as a reference.

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

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

pub fn into_paginator(self) -> DescribeLogGroupsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

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

Appends an item to accountIdentifiers.

To override the contents of this collection use set_account_identifiers.

When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

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

When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

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

When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

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

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

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

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

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

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

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

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

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

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

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

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

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

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

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

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

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

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

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

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

pub fn include_linked_accounts(self, input: bool) -> Self

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers 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.

pub fn set_include_linked_accounts(self, input: Option<bool>) -> Self

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers 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.

pub fn get_include_linked_accounts(&self) -> &Option<bool>

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers 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.

pub fn log_group_class(self, input: LogGroupClass) -> Self

Specifies the log group class for this log group. There are two classes:

• The Standard log class supports all CloudWatch Logs features.

• The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

For details about the features supported by each class, see Log classes

pub fn set_log_group_class(self, input: Option<LogGroupClass>) -> Self

Specifies the log group class for this log group. There are two classes:

• The Standard log class supports all CloudWatch Logs features.

• The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

For details about the features supported by each class, see Log classes

pub fn get_log_group_class(&self) -> &Option<LogGroupClass>

Specifies the log group class for this log group. There are two classes:

• The Standard log class supports all CloudWatch Logs features.

• The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

For details about the features supported by each class, see Log classes

Trait Implementations

impl Clone for DescribeLogGroupsFluentBuilder

fn clone(&self) -> DescribeLogGroupsFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeLogGroupsFluentBuilder

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

Formats the value using the given formatter.