Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

describe-deliveries

Описание

Получает список поставок, созданных в учетной записи.

Доставка — это соединение между источником доставки ` https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html` и пунктом назначения доставки ` https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html`.

Источник доставки представляет собой ресурс Amazon Web Services, который отправляет журналы в пункт назначения доставки журналов. Пунктом назначения может быть CloudWatch Logs, Amazon S3 или Firehose. Только некоторые службы Amazon Web Services поддерживают настройку в качестве источника доставки. Эти службы перечислены в разделе «Включение ведения журналов из служб Amazon Web Services».

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

describe-deliveries — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query для постраничного ответа, аргумент --query должен извлечь данные из результатов следующих выражений запроса: deliveries

Синтаксис

  describe-deliveries
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

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

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

Маркер для указания начальной точки постраничной обработки. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймауты вызовов AWS-службы.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для продолжения постраничной обработки предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Выражение JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

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

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

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

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

deliveries -> (список)

Массив структур. Каждая структура содержит информацию об одной доставке в учетной записи.

(структура)

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

Доставка — это соединение между логическим источником доставки и логическим пунктом назначения доставки.

Дополнительную информацию см. в разделе Создание доставки.

Чтобы обновить существующую конфигурацию доставки, используйте UpdateDeliveryConfiguration.

id -> (строка)

Уникальный идентификатор, определяющий эту доставку в вашей учетной записи.

arn -> (строка)

Amazon Resource Name (ARN), который однозначно определяет эту доставку.

deliverySourceName -> (строка)

Имя источника доставки, связанного с этой доставкой.

deliveryDestinationArn -> (строка)

ARN пункта назначения доставки, связанного с этой доставкой.

deliveryDestinationType -> (строка)

Отображает, является ли пункт назначения доставки, связанный с этой доставкой, CloudWatch Logs, Amazon S3 или Firehose.

recordFields -> (список)

Поля записей, используемые в этой доставке.

(строка)

fieldDelimiter -> (строка)

Разделитель полей, используемый между полями записей, когда окончательный формат вывода доставки — в формате Plain, W3C или Raw.

s3DeliveryConfiguration -> (структура)

Эта структура содержит конфигурации доставки, которые применяются только в случае, если ресурс пункта назначения доставки — это ведро S3.

suffixPath -> (строка)

Эта строка позволяет перенастроить префикс объекта S3, чтобы он содержал статические или переменные разделы. Допустимые переменные, используемые в пути суффикса, будут отличаться для каждого источника журнала. Чтобы найти значения, поддерживаемые для пути суффикса для каждого источника журнала, используйте операцию DescribeConfigurationTemplates и проверьте поле allowedSuffixPathFields в ответе.

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

Этот параметр заставляет объекты S3, содержащие доставленные журналы, использовать структуру префикса, которая позволяет интегрироваться с Apache Hive.

tags -> (карта)

Теги, назначенные этой доставке.

key -> (строка)

value -> (строка)

nextToken -> (строка)

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

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

Spec-Zone.ru

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