Spec-Zone.ru › AWS CLI v2

[ aws . storagegateway ]

list-tape-pools

Описание

Отображает пользовательские ленточные пулы. Вы указываете пользовательские ленточные пулы для отображения, указав один или несколько пользовательских ленточных пулов Amazon Resource Names (ARN). Если вы не указываете ARN пользовательского ленточного пула, операция отображает все пользовательские ленточные пулы.

Данная операция поддерживает постраничный вывод. Вы можете необязательно указать параметр Limit в теле запроса, чтобы ограничить количество ленточных пулов в ответе. Если количество ленточных пулов в ответе усечено, ответ включает элемент Marker, который вы можете использовать в последующем запросе для получения следующей части ленточных пулов.

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

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

Синтаксис

  list-tape-pools
[--pool-arns <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]

Параметры

--pool-arns (список)

Amazon Resource Name (ARN) каждого из пользовательских ленточных пулов, которые вы хотите отобразить. Если вы не указываете ARN пользовательского ленточного пула, в ответе отображаются все пользовательские ленточные пулы.

(строка)

Синтаксис:

"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
  • текст
  • таблица
  • 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 версии 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.

Вывод

PoolInfos -> (список)

Массив объектов PoolInfo, где каждый объект описывает один пользовательский ленточный пул. Если пользовательских ленточных пулов нет, PoolInfos является пустым массивом.

(структура)

Описание пользовательского ленточного пула.

PoolARN -> (строка)

Amazon Resource Name (ARN) пользовательского ленточного пула. Используйте операцию ListTapePools, чтобы вернуть список пользовательских ленточных пулов для вашей учетной записи и региона Amazon Web Services.

PoolName -> (строка)

Имя пользовательского ленточного пула. PoolName может использовать все ASCII-символы, кроме «/» и «'.

StorageClass -> (строка)

Класс хранения, связанный с пользовательским пулом. Когда вы используете свое приложение резервного копирования для извлечения ленты, лента архивируется непосредственно в класс хранения (S3 Glacier или S3 Glacier Deep Archive), соответствующий пулу.

RetentionLockType -> (строка)

Тип блокировки удержания ленты, который может быть настроен в двух режимах. При настройке в режиме управления учетные записи Amazon Web Services с определенными разрешениями IAM разрешается снять блокировку удержания ленты с архивных виртуальных лент. При настройке в режиме соответствия блокировка удержания ленты не может быть снята ни одним пользователем, включая корневую учетную запись Amazon Web Services.

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

Время блокировки удержания ленты устанавливается в днях. Блокировка удержания ленты может быть включена до 100 лет (36 500 дней).

PoolStatus -> (строка)

Статус пользовательского ленточного пула. Пул может быть ACTIVE или DELETED.

Marker -> (строка)

Строка, указывающая позицию для начала возвращаемого списка ленточных пулов. Используйте маркер в следующем запросе, чтобы продолжить постраничный вывод ленточных пулов. Если больше ленточных пулов для отображения нет, этот элемент не отображается в теле ответа.

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

Spec-Zone.ru

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