nat-gateway-available
Описание
Ожидание, пока JMESPath-запрос NatGateways[].State вернёт значение available для всех элементов при опросе с помощью describe-nat-gateways. Будет осуществляться опрос каждые 15 секунд до достижения успешного состояния. Код возврата будет 255 после 40 неудачных проверок.
См. также: Документацию API AWS
nat-gateway-available является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько API-запросов. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: NatGateways
Синтаксис
nat-gateway-available
[--dry-run | --no-dry-run]
[--filter <value>]
[--nat-gateway-ids <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]
Параметры
--dry-run | --no-dry-run (логический)
DryRunOperation. В противном случае — UnauthorizedOperation.--filter (список)
Фильтры.
-
nat-gateway-id— Идентификатор шлюза NAT. -
state— Состояние шлюза NAT (pending|failed|available|deleting|deleted). -
subnet-id— Идентификатор подсети, в которой находится шлюз NAT. -
tag— Пара ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключомOwnerи значениемTeamA, укажитеtag:Ownerв качестве имени фильтра иTeamAв качестве значения фильтра. -
tag-key— Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с определённым ключом, независимо от значения тега. -
vpc-id— Идентификатор VPC, в котором находится шлюз NAT.
(структура)
Пара имя/значение фильтра, используемая для возвращения более конкретного списка результатов операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определённым критериям, таким как теги, атрибуты или идентификаторы.
Если вы указываете несколько фильтров, фильтры соединяются с помощью AND, и запрос возвращает только результаты, которые соответствуют всем указанным фильтрам.
Для получения дополнительной информации см. раздел «Список и фильтрация с помощью CLI и API» в Руководстве пользователя Amazon EC2.
Name -> (строка)
Values -> (список)
Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения соединяются с помощью OR, и запрос возвращает все результаты, которые соответствуют любому из указанных значений.
(строка)
Сокращённый синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--nat-gateway-ids (список)
Идентификаторы шлюзов NAT.
(строка)
Синтаксис:
"string" "string" ...
--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
- 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-auto-prompt (логический)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логический)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, у вас должна быть установлена и настроена AWS CLI. Подробнее см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры имеют правила кавычек, аналогичные правилам Unix. Эти примеры необходимо адаптировать к правилам кавычек вашей оболочки терминала. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Ожидание, пока шлюз NAT будет доступен
Следующий wait nat-gateway-available пример приостанавливает и возобновляет выполнение только после подтверждения, что указанный шлюз NAT доступен. Он не генерирует вывод.
aws ec2 wait nat-gateway-available \
--nat-gateway-ids nat-1234567890abcdef0
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.