Spec-Zone.ru › AWS CLI v2

[ aws . networkmanager ]

list-attachments

Описание

Возвращает список прикреплений к сетевому ядру.

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

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

Синтаксис

  list-attachments
[--core-network-id <value>]
[--attachment-type <value>]
[--edge-location <value>]
[--state <value>]
[--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]

Параметры

--core-network-id (строка)

Идентификатор сетевого ядра.

--attachment-type (строка)

Тип прикрепления.

Возможные значения:

  • CONNECT
  • SITE_TO_SITE_VPN
  • VPC
  • DIRECT_CONNECT_GATEWAY
  • TRANSIT_GATEWAY_ROUTE_TABLE

--edge-location (строка)

Регион расположения узла.

--state (строка)

Состояние прикрепления.

Возможные значения:

  • REJECTED
  • PENDING_ATTACHMENT_ACCEPTANCE
  • CREATING
  • FAILED
  • AVAILABLE
  • UPDATING
  • PENDING_NETWORK_UPDATE
  • PENDING_TAG_ACCEPTANCE
  • DELETING

--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
  • text
  • таблица
  • 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.

Вывод

Прикрепления -> (список)

Описание списка прикреплений.

(структура)

Описание прикрепления к сетевому ядру.

CoreNetworkId -> (строка)

Идентификатор сетевого ядра.

CoreNetworkArn -> (строка)

ARN сетевого ядра.

AttachmentId -> (строка)

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

OwnerAccountId -> (строка)

Идентификатор владельца учетной записи прикрепления.

AttachmentType -> (строка)

Тип прикрепления.

State -> (строка)

Состояние прикрепления.

EdgeLocation -> (строка)

Регион расположения узла. Возвращается для всех типов прикреплений, кроме прикрепления шлюза Direct Connect, который вместо этого возвращает EdgeLocations.

EdgeLocations -> (список)

Расположения узлов, к которым прикреплён шлюз Direct Connect. Возвращается только для прикреплений шлюза Direct Connect. Все другие типы прикреплений возвращают EdgeLocation.

(строка)

ResourceArn -> (строка)

ARN ресурса прикрепления.

AttachmentPolicyRuleNumber -> (целое число)

Номер правила политики, связанный с прикреплением.

SegmentName -> (строка)

Имя прикрепления сегмента.

NetworkFunctionGroupName -> (строка)

Имя группы сетевых функций.

Tags -> (список)

Теги, связанные с прикреплением.

(структура)

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

Key -> (строка)

Ключ тега.

Ограничения: максимальная длина 128 символов.

Value -> (строка)

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

Ограничения: максимальная длина 256 символов.

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

Прикрепление для перемещения из одного сегмента в другой.

Tags -> (список)

Список пар ключ-значение тегов, изменённых для сегмента.

(структура)

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

Key -> (строка)

Ключ тега.

Ограничения: максимальная длина 128 символов.

Value -> (строка)

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

Ограничения: максимальная длина 256 символов.

AttachmentPolicyRuleNumber -> (целое число)

Номер правила в документе политики, применимый к этому изменению.

SegmentName -> (строка)

Название сегмента, который необходимо изменить.

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

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

Tags -> (список)

Список предложенных изменений пар ключ-значение тегов, связанных с группой сетевых функций.

(структура)

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

Key -> (строка)

Ключ тега.

Ограничения: максимальная длина 128 символов.

Value -> (строка)

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

Ограничения: максимальная длина 256 символов.

AttachmentPolicyRuleNumber -> (целое число)

Предлагаемый новый номер правила политики прикрепления для группы сетевых функций.

NetworkFunctionGroupName -> (строка)

Предлагаемое новое имя группы сетевых функций.

CreatedAt -> (временная метка)

Временная метка создания прикрепления.

UpdatedAt -> (временная метка)

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

LastModificationErrors -> (список)

Описание ошибки, связанной с запросом прикрепления.

(структура)

Описание ошибки, связанной с запросом прикрепления.

Code -> (строка)

Код ошибки для запроса прикрепления.

Message -> (строка)

Сообщение, связанное с ошибкой code.

ResourceArn -> (строка)

ARN запрошенного ресурса прикрепления.

RequestId -> (строка)

Идентификатор запроса прикрепления.

NextToken -> (строка)

Токен для следующей страницы результатов.

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

Spec-Zone.ru

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