Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

list-log-groups

Описание

Возвращает список групп журналов в Регионе в вашей учетной записи. Если вы выполняете это действие в учетной записи мониторинга, вы можете выбрать также вернуть группы журналов из исходных учетных записей, связанных с учетной записью мониторинга. Дополнительную информацию об использовании межсчётной наблюдательности для настройки учетных записей мониторинга и исходных учетных записей см. в разделе Межсчётная наблюдательность CloudWatch.

Вы можете необязательно отфильтровать список по классу группы журналов и используя регулярные выражения в вашем запросе для сопоставления строк в именах групп журналов.

Данная операция имеет постраничную навигацию. По умолчанию первое использование этой операции возвращает 50 результатов и включает маркер для использования в последующей операции для возвращения большего количества результатов.

См. также: Документация API AWS

Синтаксис

  list-log-groups
[--log-group-name-pattern <value>]
[--log-group-class <value>]
[--include-linked-accounts | --no-include-linked-accounts]
[--account-identifiers <value>]
[--next-token <value>]
[--limit <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--log-group-name-pattern (строка)

Используйте этот параметр для ограничения возвращаемых групп журналов только теми, чьи имена соответствуют заданному шаблону. Этот параметр представляет собой регулярное выражение, которое может сопоставлять префиксы и подстроки, а также поддерживает подстановочные знаки и сопоставление нескольких шаблонов, как показано в следующих примерах.

  • Используйте ^ для сопоставления имён групп журналов по префиксу.
  • Для сопоставления по подстроке укажите строку для сопоставления. Все сопоставления регистрозависимые.
  • Для сопоставления нескольких шаблонов разделяйте их символом |, как в примере ^/aws/lambda|discovery

Вы можете указать до пяти различных шаблонов регулярных выражений в этом поле, каждое из которых должно содержать от 3 до 24 символов. Вы можете включить символ ^ до пяти раз и символ | до четырёх раз.

--log-group-class (строка)

Используйте этот параметр для ограничения результатов только теми группами журналов, которые принадлежат указанному классу группы журналов. Если вы опустите этот параметр, могут быть возвращены группы журналов всех классов.

Возможные значения:

  • STANDARD
  • INFREQUENT_ACCESS
  • DELIVERY

--include-linked-accounts | --no-include-linked-accounts (логическое значение)

Если вы используете учетную запись мониторинга, установите это значение в true, чтобы операция возвращала группы журналов в учетных записях, перечисленных в accountIdentifiers.

Если этот параметр установлен в true, а accountIdentifiers содержит значение null, операция возвращает все группы журналов в учетной записи мониторинга и все группы журналов во всех исходных учетных записях, связанных с учетной записью мониторинга.

Значение по умолчанию для этого параметра — false.

--account-identifiers (список)

Когда includeLinkedAccounts установлено в true, используйте этот параметр для указания списка учетных записей для поиска. Вы можете указать до 20 идентификаторов учетных записей в массиве.

(строка)

Синтаксис:

"string" "string" ...

--next-token (строка)

Маркер для следующего набора элементов для возврата. Маркер действует в течение 24 часов.

--limit (целое число)

Максимальное количество групп журналов для возврата. Если вы опустите этот параметр, значение по умолчанию — до 50 групп журналов.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет принята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано со значением output, выполняет валидацию входных данных команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включает отладочную запись журнала.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использование конкретного профиля из файла с данными учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/отключение цветного вывода.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с сертификатами CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, который будет использоваться для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок fileb://, всегда будет обрабатываться как двоичный и будет использоваться содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

logGroups -> (список)

Массив структур, где каждая структура содержит информацию об одной группе журналов.

(структура)

Эта структура содержит информацию об одной группе журналов в вашей учетной записи.

logGroupName -> (строка)

Имя группы журналов.

logGroupArn -> (строка)

Amazon Resource Name (ARN) группы журналов.

logGroupClass -> (строка)

Класс группы журналов для этой группы журналов. Подробную информацию о функциях, поддерживаемых каждым классом группы журналов, см. в разделе Классы групп журналов

nextToken -> (строка)

Маркер для следующего набора элементов для возврата. Маркер действует в течение 24 часов.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API