Spec-Zone.ru › AWS CLI v2

[ aws . redshift-serverless ]

list-snapshots

Описание

Возвращает список снимков.

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

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

Синтаксис

  list-snapshots
[--end-time <value>]
[--namespace-arn <value>]
[--namespace-name <value>]
[--owner-account <value>]
[--start-time <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]

Параметры

--end-time (метка времени)

Метка времени, показывающая, когда завершилось создание снимка.

--namespace-arn (строка)

Amazon Resource Name (ARN) пространства имён, из которого нужно получить список всех снимков.

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

Пространство имён, из которого нужно получить список всех снимков.

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

Учётная запись Amazon Web Services владельца снимка.

--start-time (метка времени)

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

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров входных данных CLI.

Вывод

nextToken -> (строка)

Если возвращается nextToken, доступны дополнительные результаты. Значение nextToken — уникальный маркер постраничного вывода для каждой страницы. Повторите вызов, используя возвращённый маркер, чтобы получить следующую страницу.

snapshots -> (список)

Все возвращённые объекты снимка.

(структура)

Объект снимка, содержащий базы данных.

accountsWithProvisionedRestoreAccess -> (список)

Все учётные записи Amazon Web Services, имеющие доступ к восстановлению снимка в кластер с выделенными ресурсами.

(строка)

accountsWithRestoreAccess -> (список)

Все учётные записи Amazon Web Services, имеющие доступ к восстановлению снимка в пространство имён.

(строка)

actualIncrementalBackupSizeInMegaBytes -> (двойное)

Размер инкрементного резервного копирования в мегабайтах.

adminPasswordSecretArn -> (строка)

Amazon Resource Name (ARN) секрета учетных данных администратора пространства имён.

adminPasswordSecretKmsKeyId -> (строка)

Идентификатор ключа управления ключами (KMS) используемого для шифрования и хранения секрета учетных данных администратора пространства имён.

adminUsername -> (строка)

Имя пользователя базы данных в рамках снимка.

backupProgressInMegaBytes -> (двойное)

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

currentBackupRateInMegaBytesPerSecond -> (двойное)

Скорость резервного копирования данных в снимок в мегабайтах в секунду.

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

Время, затраченное на резервное копирование данных в снимок.

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

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

kmsKeyId -> (строка)

Уникальный идентификатор ключа KMS, используемого для шифрования снимка.

namespaceArn -> (строка)

Amazon Resource Name (ARN) пространства имён, из которого был создан снимок.

namespaceName -> (строка)

Название пространства имён.

ownerAccount -> (строка)

Владеющая учётная запись Amazon Web Services снимка.

snapshotArn -> (строка)

Amazon Resource Name (ARN) снимка.

snapshotCreateTime -> (метка времени)

Метка времени создания снимка.

snapshotName -> (строка)

Название снимка.

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

Количество дней до удаления снимка.

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

Срок хранения снимка в днях.

snapshotRetentionStartTime -> (метка времени)

Метка времени, когда началась сохранение данных в рамках снимка.

status -> (строка)

Статус снимка.

totalBackupSizeInMegaBytes -> (двойное)

Общий размер снимка в мегабайтах.

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

Spec-Zone.ru

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