Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

describe-delivery-channels

Описание

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

Примечание

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

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

Синтаксис

  describe-delivery-channels
[--delivery-channel-names <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]

Параметры

--delivery-channel-names (список)

Список имён каналов доставки.

(строка)

Синтаксис:

"string" "string" ...

--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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

Чтобы использовать следующие примеры, у вас должен быть установлен и настроен AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования по аналогии с Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Чтобы получить подробности о канале доставки

Следующая команда возвращает подробности о канале доставки:

aws configservice describe-delivery-channels

Вывод:

{
    "DeliveryChannels": [
        {
            "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic",
            "name": "default",
            "s3BucketName": "config-bucket-123456789012"
        }
    ]
}

Вывод

DeliveryChannels -> (список)

Список, содержащий описания заданного канала доставки.

(структура)

Канал, через который Config доставляет уведомления и обновлённые состояния конфигурации.

name -> (строка)

Имя канала доставки. По умолчанию Config присваивает имя «default» при создании канала доставки. Чтобы изменить имя канала доставки, необходимо использовать действие DeleteDeliveryChannel для удаления текущего канала доставки, а затем использовать команду PutDeliveryChannel для создания канала доставки с желаемым именем.

s3BucketName -> (строка)

Имя Amazon S3-ведёрка, в которое Config доставляет снимки конфигурации и файлы истории конфигурации.

Если вы указываете ведёрко, принадлежащее другой учётной записи Amazon Web Services, это ведёрко должно иметь политики, которые предоставляют разрешения доступа к Config. Подробнее см. Разрешения для Amazon S3-ведёрка в руководстве разработчика Config.

s3KeyPrefix -> (строка)

Префикс для указанного Amazon S3-ведёрка.

s3KmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа управления ключами (KMS) Key Management Service (KMS), используемого для шифрования объектов, доставленных Config. Должен принадлежать тому же региону, что и целевое S3-ведёрко.

snsTopicARN -> (строка)

Amazon Resource Name (ARN) Amazon SNS-темы, в которую Config отправляет уведомления о изменениях конфигурации.

Если вы выбираете тему из другой учётной записи, тема должна иметь политики, предоставляющие разрешения доступа к Config. Дополнительная информация см. в Разрешения для Amazon SNS-темы в руководстве разработчика Config.

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

Параметры для определения того, как часто Config доставляет снимки конфигурации в Amazon S3-ведёрко.

deliveryFrequency -> (строка)

Частота, с которой Config доставляет снимки конфигурации.

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

Spec-Zone.ru

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