Spec-Zone.ru › AWS CLI v2

[ aws . ec2 . wait ]

volume-in-use

Описание

Ожидание, пока запрос JMESPath Volumes[].State вернёт значение in-use для всех элементов при опросе с помощью describe-volumes. Будет происходить опрос каждые 15 секунд до достижения успешного состояния. Код возврата будет 255 после 40 неудачных проверок.

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

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

Синтаксис

  volume-in-use
[--volume-ids <value>]
[--dry-run | --no-dry-run]
[--filters <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]

Параметры

--volume-ids (список)

Идентификаторы томов. Если не указано, то во всех ответах будут включены все тома.

(строка)

Синтаксис:

"string" "string" ...

--dry-run | --no-dry-run (логическое значение)

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

--filters (список)

Фильтры.

  • attachment.attach-time — отметка времени, когда началось подключение.
  • attachment.delete-on-termination — удаляется ли том при завершении работы экземпляра.
  • attachment.device — имя устройства, указанное в отображении блочного устройства (например, /dev/sda1).
  • attachment.instance-id — идентификатор экземпляра, к которому подключён том.
  • attachment.status — состояние подключения (attaching | attached | detaching).
  • availability-zone — зона доступности, в которой был создан том.
  • create-time — отметка времени создания тома.
  • encrypted — указывает, зашифрован ли том (true | false).
  • fast-restored — указывает, был ли том создан из моментального снимка, который включен для быстрого восстановления моментальных снимков (true | false).
  • multi-attach-enabled — указывает, включен ли для тома Multi-Attach (true | false).
  • operator.managed — логическое значение, указывающее, является ли это управляемым томом.
  • operator.principal — субъект, управляющий томом. Действителен только для управляемых томов, где managed равен true.
  • size — размер тома в ГБ.
  • snapshot-id — моментальный снимок, из которого был создан том.
  • status — состояние тома (creating | available | in-use | deleting | deleted | error).
  • tag :<key> — комбинация ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега как значение фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA, укажите tag:Owner в качестве имени фильтра и TeamA в качестве значения фильтра.
  • tag-key — ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег со специфическим ключом, независимо от значения тега.
  • volume-id — идентификатор тома.
  • volume-type — тип тома Amazon EBS (gp2 | gp3 | io1 | io2 | st1 | sc1 | standard).

(структура)

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

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

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

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

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

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

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

(строка)

Укороченный синтаксис:

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

Синтаксис JSON:

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

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

Для ожидания, пока том находится в использовании

Следующий wait volume-in-use пример приостанавливает и возобновляет выполнение только после подтверждения того, что указанный том находится в использовании. Он не выводит никаких данных.

aws ec2 wait volume-in-use \
    --volume-ids vol-1234567890abcdef0

Вывод

Нет

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

Spec-Zone.ru

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