Spec-Zone.ru › AWS CLI v2

[ aws . events ]

list-archives

Описание

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

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

Синтаксис

  list-archives
[--name-prefix <value>]
[--event-source-arn <value>]
[--state <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]

Параметры

--name-prefix (строка)

Префикс имени для фильтрации возвращаемых архивов. Возвращаются только архивы, имена которых соответствуют префиксу.

--event-source-arn (строка)

ARN источника событий, связанного с архивом.

--state (строка)

Состояние архива.

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

  • ENABLED
  • DISABLED
  • CREATING
  • UPDATING
  • CREATE_FAILED
  • UPDATE_FAILED

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

Токен, возвращённый предыдущим запросом, который можно использовать для получения следующего набора результатов.

Значение nextToken — уникальный токен постраничной навигации для каждой страницы. Чтобы получить следующую страницу результатов, выполните вызов снова с возвращённым токеном. Все остальные аргументы остаются неизменными.

Использование истекшего токена постраничной навигации приводит к ошибке HTTP 400 InvalidToken.

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

Максимальное количество возвращаемых результатов.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

Вывод

Архивы -> (список)

Массив объектов Archive, содержащих данные об архиве.

(структура)

Объект Archive, содержащий данные об архиве.

ArchiveName -> (строка)

Имя архива.

EventSourceArn -> (строка)

ARN канала событий, связанного с архивом. Только события из этого канала событий отправляются в архив.

State -> (строка)

Текущее состояние архива.

StateReason -> (строка)

Описание причины, по которой архив находится в текущем состоянии.

RetentionDays -> (целое число)

Количество дней хранения событий в архиве до их удаления.

SizeBytes -> (длинное целое число)

Размер архива в байтах.

EventCount -> (длинное целое число)

Количество событий в архиве.

CreationTime -> (метка времени)

Отметка времени создания архива.

NextToken -> (строка)

Токен, указывающий на наличие дополнительных результатов. Если дополнительных результатов нет, токен не включён в ответ.

Значение nextToken — уникальный токен постраничной навигации для каждой страницы. Чтобы получить следующую страницу результатов, выполните вызов снова с возвращённым токеном. Все остальные аргументы остаются неизменными.

Использование истекшего токена постраничной навигации приводит к ошибке HTTP 400 InvalidToken.

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

Spec-Zone.ru

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