Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-transit-gateway-peering-attachments

Описание

Описывает ваши присоединения к транзитной шлюзу.

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

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

Синтаксис

  describe-transit-gateway-peering-attachments
[--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 (список)

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

  • transit-gateway-attachment-id - Идентификатор присоединения к транзитному шлюзу.
  • local-owner-id - Идентификатор вашей учетной записи Amazon Web Services.
  • remote-owner-id - Идентификатор учетной записи Amazon Web Services в удаленном регионе, владеющей транзитным шлюзом.
  • state - Состояние присоединения к транзитному шлюзу. Допустимые значения: available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
  • tag :<ключ> - Пара ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA, укажите tag:Owner для имени фильтра и TeamA для значения фильтра.
  • tag-key - Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, имеющие тег со специфическим ключом, независимо от значения тега.
  • transit-gateway-id - Идентификатор транзитного шлюза.

(структура)

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

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

Дополнительную информацию см. в разделе «Список и фильтрация с помощью CLI и 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 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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время соединения сокета в секундах. Если значение установлено в 0, соединение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут представлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.

Для описания присоединений к транзитному шлюзу

Следующий пример describe-transit-gateway-peering-attachments отображает данные для всех ваших присоединений к транзитному шлюзу.

aws ec2 describe-transit-gateway-peering-attachments

Вывод:

{
    "TransitGatewayPeeringAttachments": [
        {
            "TransitGatewayAttachmentId": "tgw-attach-4455667788aabbccd",
            "RequesterTgwInfo": {
                "TransitGatewayId": "tgw-123abc05e04123abc",
                "OwnerId": "123456789012",
                "Region": "us-west-2"
            },
            "AccepterTgwInfo": {
                "TransitGatewayId": "tgw-11223344aabbcc112",
                "OwnerId": "123456789012",
                "Region": "us-east-2"
            },
            "State": "pendingAcceptance",
            "CreationTime": "2019-12-09T11:38:05.000Z",
            "Tags": []
        }
    ]
}

Дополнительную информацию см. в разделе «Присоединения к транзитному шлюзу» в руководстве пользователя Transit Gateways.

Вывод

TransitGatewayPeeringAttachments -> (список)

Прикрепления взаимного подключения шлюзов транзита.

(структура)

Описание прикрепления взаимного подключения шлюзов транзита.

TransitGatewayAttachmentId -> (строка)

Идентификатор прикрепления взаимного подключения шлюзов транзита.

AccepterTransitGatewayAttachmentId -> (строка)

Идентификатор прикрепления взаимного подключения шлюза транзита со стороны получателя.

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

Информация о шлюзе транзита стороны запрашивающего.

TransitGatewayId -> (строка)

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

CoreNetworkId -> (строка)

Идентификатор сетевой основы, где расположен шлюз транзита-партнёр.

OwnerId -> (строка)

Идентификатор учётной записи Amazon Web Services, владеющей шлюзом транзита.

Region -> (строка)

Регион шлюза транзита.

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

Информация о шлюзе транзита стороны получателя.

TransitGatewayId -> (строка)

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

CoreNetworkId -> (строка)

Идентификатор сетевой основы, где расположен шлюз транзита-партнёр.

OwnerId -> (строка)

Идентификатор учётной записи Amazon Web Services, владеющей шлюзом транзита.

Region -> (строка)

Регион шлюза транзита.

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

Детали прикрепления взаимного подключения шлюзов транзита.

DynamicRouting -> (строка)

Описание того, включен или выключен динамический маршрутизация для прикрепления взаимного подключения шлюзов транзита.

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

Статус прикрепления взаимного подключения шлюзов транзита.

Code -> (строка)

Код статуса.

Message -> (строка)

Сообщение о статусе, если применимо.

State -> (строка)

Состояние прикрепления взаимного подключения шлюзов транзита. Обратите внимание, что состояние initiating устарело.

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

Время создания прикрепления взаимного подключения шлюзов транзита.

Tags -> (список)

Теги для прикрепления взаимного подключения шлюзов транзита.

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

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

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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