describe-parameters¶
Description¶
Returns the detailed parameter list for a particular parameter group.
See also: AWS API Documentation
describe-parameters is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Parameters
Synopsis¶
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]
Options¶
--parameter-group-name (string)
he name of a specific parameter group to return details for.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To return a list of parameters
The following describe-parameters` returns a list of parameters.
aws memorydb describe-parameters
Output:
{
"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"
}
]
}
For more information, see Configuring engine parameters using parameter groups in the MemoryDB User Guide.
Output¶
NextToken -> (string)
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Parameters -> (list)
A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.
(structure)
Describes an individual setting that controls some aspect of MemoryDB behavior.
Name -> (string)
The name of the parameter
Value -> (string)
The value of the parameter
Description -> (string)
A description of the parameter
DataType -> (string)
The parameter’s data type
AllowedValues -> (string)
The valid range of values for the parameter.
MinimumEngineVersion -> (string)
The earliest engine version to which the parameter can apply.