Spec-Zone.ru › AWS CLI v2

[ aws . elasticache ]

describe-serverless-caches

Описание

Возвращает информацию о конкрешном кэше без сервера. Если идентификатор не указан, то API возвращает информацию обо всех кэшах без сервера, принадлежащих этому аккаунту Amazon Web Services.

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

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

Синтаксис

  describe-serverless-caches
[--serverless-cache-name <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 (строка)

Идентификатор кэша без сервера. Если этот параметр указан, возвращается только информация об этом конкретном кэше без сервера. По умолчанию: NULL

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

--starting-token (строка)

Маркер для указания, с какой точки начать постраничный вывод. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы при вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя командной строки AWS.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя командной строки AWS.

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

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

ServerlessCaches -> (список)

Кэши без сервера, связанные с заданным запросом описания.

(структура)

Ресурс, представляющий кэш без сервера.

ServerlessCacheName -> (строка)

Уникальный идентификатор кэша без сервера.

Description -> (строка)

Описание кэша без сервера.

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

Время создания кэша без сервера.

Status -> (строка)

Текущий статус кэша без сервера. Допустимые значения: CREATING, AVAILABLE, DELETING, CREATE-FAILED и MODIFYING.

Engine -> (строка)

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

MajorEngineVersion -> (строка)

Номер версии двигателя, с которым совместим кэш без сервера.

FullEngineVersion -> (строка)

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

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

Предел использования кэша для кэша без сервера.

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

Максимальный предел хранилища данных в кэше, выраженный в гигабайтах.

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

Верхний предел для хранения данных, используемый кэшем.

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

Нижний предел для хранения данных, используемый кэшем.

Unit -> (строка)

Единица измерения размера хранения, в ГБ.

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

Настройка количества единиц обработки ElastiCache (ECPU), которые кэш может потреблять в секунду.

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

Настройка максимального количества ECPU, которые кэш может потреблять в секунду.

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

Настройка минимального количества ECPU, которые кэш должен потреблять в секунду.

KmsKeyId -> (строка)

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

SecurityGroupIds -> (список)

Идентификаторы EC2-сетевых групп, связанных с кэшем без сервера.

(строка)

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

Представляет информацию, необходимую клиентским программам для подключения к узлу кэша. Это значение является только для чтения.

Address -> (строка)

DNS-имя хоста узла кэша.

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

Порт, на котором работает движок кэша.

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

Представляет информацию, необходимую клиентским программам для подключения к узлу кэша. Это значение является только для чтения.

Address -> (строка)

DNS-имя хоста узла кэша.

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

Порт, на котором работает движок кэша.

ARN -> (строка)

Amazon Resource Name (ARN) кэша без сервера.

UserGroupId -> (строка)

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

SubnetIds -> (список)

Если не указаны идентификаторы подсетей и ваша VPC находится в us-west-1, ElastiCache выберет 2 подсети по умолчанию по всему AZ в вашей VPC. Для всех других регионов, если не указаны идентификаторы подсетей, ElastiCache выберет 3 подсети по умолчанию по всему AZ в вашей VPC по умолчанию.

(строка)

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

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

DailySnapshotTime -> (строка)

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

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

Spec-Zone.ru

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