describe-configuration-templates
Описание
Используйте эту операцию, чтобы вернуть допустимые и значения по умолчанию, используемые при создании источников доставки, пунктов назначения доставки и доставок. Дополнительную информацию о доставках см. в разделе CreateDelivery .
См. также: Документация API AWS
describe-configuration-templates — это постраничная операция. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: configurationTemplates
Синтаксис
describe-configuration-templates
[--service <value>]
[--log-types <value>]
[--resource-types <value>]
[--delivery-destination-types <value>]
[--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]
Параметры
--service (строка)
--log-types (список)
Используйте этот параметр, чтобы отфильтровать ответ, включив только те шаблоны конфигурации, которые применяются к указанным здесь типам логов.
(строка)
Синтаксис:
"string" "string" ...
--resource-types (список)
Используйте этот параметр, чтобы отфильтровать ответ, включив только те шаблоны конфигурации, которые применяются к указанным здесь типам ресурсов.
(строка)
Синтаксис:
"string" "string" ...
--delivery-destination-types (список)
Используйте этот параметр, чтобы отфильтровать ответ, включив только те шаблоны конфигурации, которые применяются к указанным здесь типам пунктов назначения доставки.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
S3
CWL
FH
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения из JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания начальной точки постраничного вывода. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничный вывод, укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.
--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-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
configurationTemplates -> (список)
Массив объектов, где каждый объект описывает одну шаблонную конфигурацию, соответствующую фильтрам, указанным в запросе.
(структура)
Структура, содержащая информацию о параметрах по умолчанию и доступных параметрах, которые можно использовать для настройки доставки или места назначения доставки.
service -> (строка)
logType -> (строка)
resourceType -> (строка)
deliveryDestinationType -> (строка)
defaultDeliveryConfigValues -> (структура)
Отображение значения по умолчанию каждого свойства в конфигурации доставки, если оно не указано в запросе.
recordFields -> (список)
Поля записей по умолчанию, которые будут передаваться, когда список полей записей не предоставлен в операции CreateDelivery.
(строка)
fieldDelimiter -> (строка)
Plain, W3C или Raw.s3DeliveryConfiguration -> (структура)
Параметры доставки, используемые при создании доставки в место назначения доставки, являющееся ведром S3.
suffixPath -> (строка)
allowedSuffixPathFields в ответе.enableHiveCompatiblePath -> (булево)
allowedFields -> (список)
Разрешенные поля, которые вызывающий компонент может использовать в параметре recordFields операции CreateDelivery или UpdateDeliveryConfiguration.
(структура)
Структура, представляющая допустимый заголовок поля записи и является ли он обязательным.
name -> (строка)
mandatory -> (булево)
true, поле записи должно быть присутствовать в параметре recordFields, предоставляемом операциям CreateDelivery или UpdateDeliveryConfiguration.allowedOutputFormats -> (список)
Список форматов вывода места назначения доставки, поддерживаемых этим источником логов.
(строка)
allowedActionForAllowVendedLogsDeliveryForResource -> (строка)
allowedFieldDelimiters -> (список)
Допустимые значения, которые вызывающий компонент может использовать в качестве разделителей полей при вызове CreateDelivery или UpdateDeliveryConfiguration для доставки в формате Plain, W3C или Raw.
(строка)
allowedSuffixPathFields -> (список)
Список переменных полей, которые можно использовать в пути суффикса доставки, доставляющей данные в ведро S3.
(строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.