describe-parameters
Описание
Возвращает подробный список параметров для определённой группы параметров.
См. также: Документация API AWS
describe-parameters является постраничной операцией. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запросов: Parameters
Синтаксис
describe-parameters
--parameter-group-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]
Параметры
--parameter-group-name (строка)
--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.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
За исключением случаев, когда указано иначе, все примеры используют правила цитирования, аналогичные правилам UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для возврата списка параметров
Следующий describe-parameters` возвращает список параметров.
aws memorydb describe-parameters
Вывод:
{
"Parameters": [
{
"Name": "acllog-max-len",
"Value": "128",
"Description": "The maximum length of the ACL Log",
"DataType": "integer",
"AllowedValues": "1-10000",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "activedefrag",
"Value": "no",
"Description": "Enabled active memory defragmentation",
"DataType": "string",
"AllowedValues": "yes,no",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "active-defrag-cycle-max",
"Value": "75",
"Description": "Maximal effort for defrag in CPU percentage",
"DataType": "integer",
"AllowedValues": "1-75",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "active-defrag-cycle-min",
"Value": "5",
"Description": "Minimal effort for defrag in CPU percentage",
"DataType": "integer",
"AllowedValues": "1-75",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "active-defrag-ignore-bytes",
"Value": "104857600",
"Description": "Minimum amount of fragmentation waste to start active defrag",
"DataType": "integer",
"AllowedValues": "1048576-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "active-defrag-max-scan-fields",
"Value": "1000",
"Description": "Maximum number of set/hash/zset/list fields that will be processed from the main dictionary scan",
"DataType": "integer",
"AllowedValues": "1-1000000",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "active-defrag-threshold-lower",
"Value": "10",
"Description": "Minimum percentage of fragmentation to start active defrag",
"DataType": "integer",
"AllowedValues": "1-100",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "active-defrag-threshold-upper",
"Value": "100",
"Description": "Maximum percentage of fragmentation at which we use maximum effort",
"DataType": "integer",
"AllowedValues": "1-100",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "active-expire-effort",
"Value": "1",
"Description": "The amount of effort that redis uses to expire items in the active expiration job",
"DataType": "integer",
"AllowedValues": "1-10",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "activerehashing",
"Value": "yes",
"Description": "Apply rehashing or not",
"DataType": "string",
"AllowedValues": "yes,no",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "client-output-buffer-limit-normal-hard-limit",
"Value": "0",
"Description": "Normal client output buffer hard limit in bytes",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "client-output-buffer-limit-normal-soft-limit",
"Value": "0",
"Description": "Normal client output buffer soft limit in bytes",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "client-output-buffer-limit-normal-soft-seconds",
"Value": "0",
"Description": "Normal client output buffer soft limit in seconds",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "client-output-buffer-limit-pubsub-hard-limit",
"Value": "33554432",
"Description": "Pubsub client output buffer hard limit in bytes",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "client-output-buffer-limit-pubsub-soft-limit",
"Value": "8388608",
"Description": "Pubsub client output buffer soft limit in bytes",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "client-output-buffer-limit-pubsub-soft-seconds",
"Value": "60",
"Description": "Pubsub client output buffer soft limit in seconds",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "hash-max-ziplist-entries",
"Value": "512",
"Description": "The maximum number of hash entries in order for the dataset to be compressed",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "hash-max-ziplist-value",
"Value": "64",
"Description": "The threshold of biggest hash entries in order for the dataset to be compressed",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "hll-sparse-max-bytes",
"Value": "3000",
"Description": "HyperLogLog sparse representation bytes limit",
"DataType": "integer",
"AllowedValues": "1-16000",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "lazyfree-lazy-eviction",
"Value": "no",
"Description": "Perform an asynchronous delete on evictions",
"DataType": "string",
"AllowedValues": "yes,no",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "lazyfree-lazy-expire",
"Value": "no",
"Description": "Perform an asynchronous delete on expired keys",
"DataType": "string",
"AllowedValues": "yes,no",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "lazyfree-lazy-server-del",
"Value": "no",
"Description": "Perform an asynchronous delete on key updates",
"DataType": "string",
"AllowedValues": "yes,no",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "lazyfree-lazy-user-del",
"Value": "no",
"Description": "Specifies whether the default behavior of DEL command acts the same as UNLINK",
"DataType": "string",
"AllowedValues": "yes,no",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "lfu-decay-time",
"Value": "1",
"Description": "The amount of time in minutes to decrement the key counter for LFU eviction policyd",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "lfu-log-factor",
"Value": "10",
"Description": "The log factor for incrementing key counter for LFU eviction policy",
"DataType": "integer",
"AllowedValues": "1-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "list-compress-depth",
"Value": "0",
"Description": "Number of quicklist ziplist nodes from each side of the list to exclude from compression. The head and tail of the list are always uncompressed for fast push/pop operations",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "maxmemory-policy",
"Value": "noeviction",
"Description": "Max memory policy",
"DataType": "string",
"AllowedValues": "volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "maxmemory-samples",
"Value": "3",
"Description": "Max memory samples",
"DataType": "integer",
"AllowedValues": "1-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "notify-keyspace-events",
"Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled",
"DataType": "string",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "set-max-intset-entries",
"Value": "512",
"Description": "The limit in the size of the set in order for the dataset to be compressed",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "slowlog-log-slower-than",
"Value": "10000",
"Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command",
"DataType": "integer",
"AllowedValues": "-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "slowlog-max-len",
"Value": "128",
"Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "stream-node-max-bytes",
"Value": "4096",
"Description": "The maximum size of a single node in a stream in bytes",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "stream-node-max-entries",
"Value": "100",
"Description": "The maximum number of items a single node in a stream can contain",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "tcp-keepalive",
"Value": "300",
"Description": "If non-zero, send ACKs every given number of seconds",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "timeout",
"Value": "0",
"Description": "Close connection if client is idle for a given number of seconds, or never if 0",
"DataType": "integer",
"AllowedValues": "0,20-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "tracking-table-max-keys",
"Value": "1000000",
"Description": "The maximum number of keys allowed for the tracking table for client side caching",
"DataType": "integer",
"AllowedValues": "1-100000000",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "zset-max-ziplist-entries",
"Value": "128",
"Description": "The maximum number of sorted set entries in order for the dataset to be compressed",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
},
{
"Name": "zset-max-ziplist-value",
"Value": "64",
"Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed",
"DataType": "integer",
"AllowedValues": "0-",
"MinimumEngineVersion": "6.2.4"
}
]
}
Дополнительную информацию см. в разделе Настройка параметров движка с использованием групп параметров в Руководстве пользователя MemoryDB.
Вывод
NextToken -> (строка)
Parameters -> (список)
Список параметров, специфичных для конкретной группы параметров. Каждый элемент списка содержит подробную информацию об одном параметре.
(структура)
Описание отдельной настройки, которая контролирует какой-либо аспект поведения MemoryDB.
Name -> (строка)
Value -> (строка)
Description -> (строка)
DataType -> (строка)
AllowedValues -> (строка)
MinimumEngineVersion -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
