Spec-Zone.ru › AWS CLI v2

[ aws . elasticache ]

describe-serverless-cache-snapshots

Описание

Возвращает информацию о снимках бессерверных кэшей. По умолчанию этот API перечисляет все снимки бессерверных кэшей клиента. Он также может описать отдельный снимок бессерверного кэша или снимки, связанные с конкретным бессерверным кэшем. Доступно только для Valkey, Redis OSS и Serverless Memcached.

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

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

Синтаксис

  describe-serverless-cache-snapshots
[--serverless-cache-name <value>]
[--serverless-cache-snapshot-name <value>]
[--snapshot-type <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]

Параметры

--serverless-cache-name (строка)

Идентификатор бессерверного кэша. Если этот параметр указан, описываются только снимки, связанные с этим конкретным бессерверным кэшем. Доступно только для Valkey, Redis OSS и Serverless Memcached.

--serverless-cache-snapshot-name (строка)

Идентификатор снимка бессерверного кэша. Если этот параметр указан, описывается только этот снимок. Доступно только для Valkey, Redis OSS и Serverless Memcached.

--snapshot-type (строка)

Тип снимка, который описывается. Доступно только для Valkey, Redis OSS и Serverless Memcached.

--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 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 -> (строка)

Необязательный маркер, возвращенный в предыдущем запросе, для поддержки постраничной передачи результатов этого действия. Если этот параметр указан, ответ включает только записи, находящиеся за маркером, до значения, указанного параметром max-results. Доступно только для Valkey, Redis OSS и Serverless Memcached.

ServerlessCacheSnapshots -> (список)

Снимки бессерверных кэшей, связанные с заданным запросом описания. Доступно только для Valkey, Redis OSS и Serverless Memcached.

(структура)

Ресурс, представляющий снимок бессерверного кэша. Доступно только для Valkey, Redis OSS и Serverless Memcached.

ServerlessCacheSnapshotName -> (строка)

Идентификатор снимка бессерверного кэша. Доступно только для Valkey, Redis OSS и Serverless Memcached.

ARN -> (строка)

Amazon Resource Name (ARN) снимка бессерверного кэша. Доступно только для Valkey, Redis OSS и Serverless Memcached.

KmsKeyId -> (строка)

Идентификатор ключа Amazon Web Services Key Management Service (KMS) снимка бессерверного кэша. Доступно только для Valkey, Redis OSS и Serverless Memcached.

SnapshotType -> (строка)

Тип снимка бессерверного кэша. Доступно только для Valkey, Redis OSS и Serverless Memcached.

Status -> (строка)

Текущий статус бессерверного кэша. Доступно только для Valkey, Redis OSS и Serverless Memcached.

CreateTime -> (временная метка)

Дата и время получения метаданных и набора данных кэша исходного бессерверного кэша для снимка. Доступно только для Valkey, Redis OSS и Serverless Memcached.

ExpiryTime -> (временная метка)

Время истечения срока действия снимка бессерверного кэша. Доступно только для Valkey, Redis OSS и Serverless Memcached.

BytesUsedForCache -> (строка)

Общий размер снимка бессерверного кэша в байтах. Доступно только для Valkey, Redis OSS и Serverless Memcached.

ServerlessCacheConfiguration -> (структура)

Настройка бессерверного кэша на момент создания снимка. Доступно только для Valkey, Redis OSS и Serverless Memcached.

ServerlessCacheName -> (строка)

Идентификатор бессерверного кэша.

Engine -> (строка)

Двигатель, с которым настроен бессерверный кэш.

MajorEngineVersion -> (строка)

Версия двигателя, с которой настроен бессерверный кэш.

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

Spec-Zone.ru

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