Spec-Zone.ru › AWS CLI v2

[ aws . glacier ]

describe-vault

Описание

Данная операция возвращает информацию о хранилище, включая Amazon Resource Name (ARN) хранилища, дату его создания, количество архивов, содержащихся в нём, и общий размер всех архивов в хранилище. Количество архивов и их общий размер указаны на момент последнего создания инвентаризации. Это означает, что если вы добавите или удалите архив из хранилища, а затем сразу же используете Describe Vault, изменение содержимого не будет сразу отражено. Если вы хотите получить последнюю инвентаризацию хранилища, используйте InitiateJob . Amazon S3 Glacier генерирует инвентаризацию хранилищ примерно ежедневно. Дополнительную информацию см. в разделе Загрузка инвентаризации хранилища в Amazon S3 Glacier.

У учётной записи AWS есть полные права на выполнение всех операций (действий). Однако пользователи AWS Identity and Access Management (IAM) по умолчанию не имеют никаких прав. Вам необходимо предоставить им явное разрешение на выполнение определённых действий. Дополнительную информацию см. в разделе Управление доступом с помощью AWS Identity and Access Management (IAM).

Справочную информацию и базовый REST API см. в разделе Получение метаданных хранилища в Amazon S3 Glacier и Describe Vault в Руководстве разработчика Amazon Glacier.

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

Синтаксис

  describe-vault
--account-id <value>
--vault-name <value>
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--account-id (строка)

Значение AccountId — это идентификатор учётной записи AWS, которая владеет хранилищем. Вы можете указать идентификатор учётной записи AWS или необязательно одиночный символ ‘-’ (тире), в этом случае Amazon S3 Glacier использует идентификатор учётной записи AWS, связанный с учётными данными, используемыми для подписания запроса. Если вы используете идентификатор учётной записи, не включайте в него тире (‘-’).

--vault-name (строка)

Имя хранилища.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставляемому --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения перепишут значения, полученные из JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

--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 для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Следующая команда извлекает данные о хранилище с именем my-vault:

aws glacier describe-vault --vault-name my-vault --account-id -

Amazon Glacier требует аргумент с идентификатором учётной записи при выполнении операций, но вы можете использовать тире для указания используемой учётной записи.

Вывод

VaultARN -> (строка)

Amazon Resource Name (ARN) хранилища.

VaultName -> (строка)

Имя хранилища.

CreationDate -> (строка)

Дата по всемирному координированному времени (UTC), когда хранилище было создано. Это значение должно быть строкой в формате даты ISO 8601, например 2012-03-20T17:03:43.221Z.

LastInventoryDate -> (строка)

Дата по всемирному координированному времени (UTC), когда Amazon S3 Glacier завершила последнюю инвентаризацию хранилища. Это значение должно быть строкой в формате даты ISO 8601, например 2012-03-20T17:03:43.221Z.

NumberOfArchives -> (длинное целое число)

Количество архивов в хранилище на дату последней инвентаризации. Это поле вернёт null, если инвентаризация ещё не была выполнена для хранилища, например, если вы только что создали хранилище.

SizeInBytes -> (длинное целое число)

Общий размер в байтах архивов в хранилище на дату последней инвентаризации. Это поле вернёт null, если инвентаризация ещё не была выполнена для хранилища, например, если вы только что создали хранилище.

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

Spec-Zone.ru

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