list-topic-rule-destinations
Описание
Выводит список всех пунктов назначения правил тем в вашей учетной записи Amazon Web Services.
Требуется разрешение на доступ к действию ListTopicRuleDestinations.
См. также: Документация API AWS
list-topic-rule-destinations является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: destinationSummaries
Синтаксис
list-topic-rule-destinations
[--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 (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
За исключением случаев, когда указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Более подробную информацию см. в разделе «Использование кавычек со строками» в Руководстве пользователя AWS CLI.
Для вывода списка пунктов назначения правил тем
Следующий list-topic-rule-destinations пример выводит все пункты назначения правил тем, которые вы определили в текущем регионе AWS.
aws iot list-topic-rule-destinations
Вывод:
{
"destinationSummaries": [
{
"arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"status": "ENABLED",
"httpUrlSummary": {
"confirmationUrl": "https://example.com"
}
}
]
}
Дополнительную информацию см. в разделе Работа с пунктами назначения правил тем в Руководстве разработчика AWS IoT.
Вывод
destinationSummaries -> (список)
Информация о пункте назначения правила темы.
(структура)
Информация о пункте назначения правила темы.
arn -> (строка)
status -> (строка)
Статус пункта назначения правила темы. Допустимые значения:
Пункт назначения правила темы был создан, но еще не подтвержден. Вы можете установить status на IN_PROGRESS, вызвав UpdateTopicRuleDestination. Вызов UpdateTopicRuleDestination отправляет новый вызов подтверждения на ваш адрес подтверждения.
Подтверждение завершено, и трафик в этот пункт назначения разрешен. Вы можете установить status на DISABLED, вызвав UpdateTopicRuleDestination.
Подтверждение завершено, и трафик в этот пункт назначения запрещен. Вы можете установить status на ENABLED, вызвав UpdateTopicRuleDestination.
Подтверждение не удалось завершить, например, если подтверждение истекло. Вы можете вызвать GetTopicRuleDestination для получения подробностей об ошибке. Вы можете установить status на IN_PROGRESS, вызвав UpdateTopicRuleDestination. Вызов UpdateTopicRuleDestination отправляет новый вызов подтверждения на ваш адрес подтверждения.
createdAt -> (отметка времени)
lastUpdatedAt -> (отметка времени)
statusReason -> (строка)
httpUrlSummary -> (структура)
Информация об HTTP-URL.
confirmationUrl -> (строка)
vpcDestinationSummary -> (структура)
Информация о подключении виртуальной частной сети (VPC).
subnetIds -> (список)
ID подсетей пункта назначения VPC.
(строка)
securityGroups -> (список)
Группы безопасности пункта назначения VPC.
(строка)
vpcId -> (строка)
roleArn -> (строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.