Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

получить-доставку

Описание

Возвращает полную информацию об одной логической доставке. Доставка — это соединение между источником доставки 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.

В данной операции необходимо указать идентификатор доставки id. Идентификаторы доставок в вашем аккаунте можно найти с помощью операции DescribeDeliveries.

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

Синтаксис

  get-delivery
--id <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]

Параметры

--id (строка)

Идентификатор доставки, которую нужно получить.

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

Вывод

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

Структура, содержащая информацию о доставке.

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 -> (строка)

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

Spec-Zone.ru

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