Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

описание-соединений-шлюза-транзита

Описание

Описывает одно или несколько подключений Connect.

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

describe-transit-gateway-connects это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: TransitGatewayConnects

Синтаксис

  describe-transit-gateway-connects
[--transit-gateway-attachment-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--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]

Параметры

--transit-gateway-attachment-ids (список)

Идентификаторы подключений.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Один или несколько фильтров. Возможные значения:

  • options.protocol - Протокол туннеля (gre ).
  • state - Состояние подключения (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing ).
  • transit-gateway-attachment-id - Идентификатор подключения Connect.
  • transit-gateway-id - Идентификатор шлюза транзита.
  • transport-transit-gateway-attachment-id - Идентификатор подключения шлюза транзита, из которого было создано подключение Connect.

(структура)

Пара имя-значение фильтра, используемая для возврата более конкретного списка результатов операции описания. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

Если вы указываете несколько фильтров, фильтры соединяются с AND, и запрос возвращает только результаты, которые соответствуют всем указанным фильтрам.

Для получения дополнительной информации см. Список и фильтрация с помощью командной строки и API в Руководстве пользователя Amazon EC2.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

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

(строка)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--dry-run | --no-dry-run (булево)

Проверяет, имеете ли вы необходимые разрешения для действия, не отправляя фактический запрос, и предоставляет ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке — DryRunOperation. В противном случае — UnauthorizedOperation.

--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 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.

Для описания подключения Connect шлюза транзита

Следующий пример описывает указанное подключение Connect.

aws ec2 describe-transit-gateway-connects \
    --transit-gateway-attachment-ids tgw-attach-037012e5dcEXAMPLE

Вывод:

{
    "TransitGatewayConnects": [
        {
            "TransitGatewayAttachmentId": "tgw-attach-037012e5dcEXAMPLE",
            "TransportTransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE",
            "TransitGatewayId": "tgw-02f776b1a7EXAMPLE",
            "State": "available",
            "CreationTime": "2021-03-09T19:59:17+00:00",
            "Options": {
                "Protocol": "gre"
            },
            "Tags": []
        }
    ]
}

Дополнительную информацию см. в разделах Подключения Connect шлюза транзита и Партнеры Connect Transit Gateway в Руководстве по шлюзам транзита.

Вывод

TransitGatewayConnects -> (список)

Информация о подключениях Connect.

(структура)

Описывает подключение Connect шлюза транзита.

TransitGatewayAttachmentId -> (строка)

Идентификатор подключения Connect.

TransportTransitGatewayAttachmentId -> (строка)

Идентификатор подключения, из которого было создано подключение Connect.

TransitGatewayId -> (строка)

Идентификатор шлюза транзита.

Состояние -> (строка)

Состояние подключения.

Время создания -> (временная метка)

Время создания.

Параметры -> (структура)

Параметры подключения Connect.

Протокол -> (строка)

Протокол туннеля.

Теги -> (список)

Теги для подключения.

(структура)

Описывает тег.

Ключ -> (строка)

Ключ тега.

Ограничения: Ключи тегов чувствительны к регистру и принимают максимальное количество 127 символов Юникода. Не может начинаться с aws:.

Значение -> (строка)

Значение тега.

Ограничения: Значения тегов чувствительны к регистру и принимают максимальное количество 256 символов Юникода.

NextToken -> (строка)

Токен для получения следующей страницы результатов. Это null, когда больше результатов нет для возврата.

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

Spec-Zone.ru

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