Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

получить-направление-правила-темы

Описание

Получает информацию о направлении правила темы.

Требуется разрешение на доступ к действию GetTopicRuleDestination.

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

Синтаксис

  get-topic-rule-destination
--arn <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]

Параметры

--arn (строка)

ARN направления правила темы.

--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
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для получения направления правила темы

Следующий get-topic-rule-destination пример получает информацию о направлении правила темы.

aws iot get-topic-rule-destination \
    --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"

Вывод:

{
    "topicRuleDestination": {
        "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "status": "DISABLED",
        "httpUrlProperties": {
            "confirmationUrl": "https://example.com"
        }
    }
}

Дополнительную информацию можно найти в разделе Работа с направлениями правил темы в Руководстве разработчика AWS IoT.

Вывод

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

Направление правила темы.

arn -> (строка)

URL направления правила темы.

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

Статус направления правила темы. Допустимые значения:

В_ПРОЦЕССЕ

Направление правила темы было создано, но не подтверждено. Вы можете установить status на IN_PROGRESS, вызвав UpdateTopicRuleDestination. Вызов UpdateTopicRuleDestination приводит к отправке нового вызова подтверждения на ваш конечный пункт подтверждения.

ВКЛЮЧЕНО

Подтверждение завершено, и трафик в это направление разрешен. Вы можете установить status на DISABLED, вызвав UpdateTopicRuleDestination.

ВЫКЛЮЧЕНО

Подтверждение завершено, и трафик в это направление запрещен. Вы можете установить status на ENABLED, вызвав UpdateTopicRuleDestination.

ОШИБКА

Подтверждение не удалось выполнить, например, если подтверждение истекло. Вы можете вызвать GetTopicRuleDestination для получения подробностей об ошибке. Вы можете установить status на IN_PROGRESS, вызвав UpdateTopicRuleDestination. Вызов UpdateTopicRuleDestination приводит к отправке нового вызова подтверждения на ваш конечный пункт подтверждения.

createdAt -> (метка времени)

Дата и время создания направления правила темы.

lastUpdatedAt -> (метка времени)

Дата и время последнего обновления направления правила темы.

statusReason -> (строка)

Дополнительные сведения или причина, по которой направление правила темы находится в текущем состоянии.

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

Свойства URL HTTP.

confirmationUrl -> (строка)

URL, используемый для подтверждения URL HTTP направления правила темы.

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

Свойства подключения виртуальной частной сети (VPC).

subnetIds -> (список)

Идентификаторы подсетей назначения VPC.

(строка)

securityGroups -> (список)

Группы безопасности назначения VPC.

(строка)

vpcId -> (строка)

Идентификатор VPC.

roleArn -> (строка)

ARN роли, имеющей разрешение на создание и подключение к интерфейсам эластичной сети (ENI).

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

Spec-Zone.ru

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