Skip to content

iter_describe_log_groups

iter_describe_log_groups(
    *,
    config_overrides: Optional[CloudWatchLogsClientConfig] = None,
    account_identifiers: Optional[AccountIds] = None,
    log_group_name_prefix: Optional[LogGroupName] = None,
    log_group_name_pattern: Optional[LogGroupNamePattern] = None,
    next_token: Optional[NextToken] = None,
    limit: Optional[DescribeLimit] = None,
    include_linked_accounts: Optional[IncludeLinkedAccounts] = None,
    log_group_class: Optional[LogGroupClass] = None,
    log_group_identifiers: Optional[DescribeLogGroupsLogGroupIdentifiers] = None,
) -> Iterator[LogGroup]
Source code in docs_src/capo_cloudwatch_logs/_services/cloud_watch_logs.py
def iter_describe_log_groups(
    self,
    *,
    config_overrides: Optional[CloudWatchLogsClientConfig] = None,
    account_identifiers: Optional[
        "capo_cloudwatch_logs.types.account_ids.AccountIds"
    ] = None,
    log_group_name_prefix: Optional[
        "capo_cloudwatch_logs.types.log_group_name.LogGroupName"
    ] = None,
    log_group_name_pattern: Optional[
        "capo_cloudwatch_logs.types.log_group_name_pattern.LogGroupNamePattern"
    ] = None,
    next_token: Optional["capo_cloudwatch_logs.types.next_token.NextToken"] = None,
    limit: Optional[
        "capo_cloudwatch_logs.types.describe_limit.DescribeLimit"
    ] = None,
    include_linked_accounts: Optional[
        "capo_cloudwatch_logs.types.include_linked_accounts.IncludeLinkedAccounts"
    ] = None,
    log_group_class: Optional[
        "capo_cloudwatch_logs.types.log_group_class.LogGroupClass"
    ] = None,
    log_group_identifiers: Optional[
        "capo_cloudwatch_logs.types.describe_log_groups_log_group_identifiers.DescribeLogGroupsLogGroupIdentifiers"
    ] = None,
) -> "Iterator[capo_cloudwatch_logs.types.log_group.LogGroup]":
    _token = next_token
    while True:
        _response = self.describe_log_groups(
            config_overrides=config_overrides,
            account_identifiers=account_identifiers,
            log_group_name_prefix=log_group_name_prefix,
            log_group_name_pattern=log_group_name_pattern,
            next_token=_token,
            limit=limit,
            include_linked_accounts=include_linked_accounts,
            log_group_class=log_group_class,
            log_group_identifiers=log_group_identifiers,
        )
        _page = _resolve_path(_response, ("log_groups",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break