[ aws . dax ]

describe-parameters

Description

Returns the detailed parameter list for a particular parameter group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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>
[--source <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--parameter-group-name (string)

The name of the parameter group.

--source (string)

How the parameter is defined. For example, system denotes a system-defined parameter.

--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 NextToken from 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 NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response 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.

See ‘aws help’ for descriptions of global 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 describe the parameters defined in a DAX parameter group

The following describe-parameters example retrieves details about the parameters that are defined in the specified DAX parameter group.

aws dax describe-parameters \
    --parameter-group-name default.dax1.0

Output:

{
    "Parameters": [
        {
            "ParameterName": "query-ttl-millis",
            "ParameterType": "DEFAULT",
            "ParameterValue": "300000",
            "NodeTypeSpecificValues": [],
            "Description": "Duration in milliseconds for queries to remain cached",
            "Source": "user",
            "DataType": "integer",
            "AllowedValues": "0-",
            "IsModifiable": "TRUE",
            "ChangeType": "IMMEDIATE"
        },
        {
            "ParameterName": "record-ttl-millis",
            "ParameterType": "DEFAULT",
            "ParameterValue": "300000",
            "NodeTypeSpecificValues": [],
            "Description": "Duration in milliseconds for records to remain valid in cache (Default: 0 = infinite)",
            "Source": "user",
            "DataType": "integer",
            "AllowedValues": "0-",
            "IsModifiable": "TRUE",
            "ChangeType": "IMMEDIATE"
        }
    ]
}

For more information, see Managing DAX Clusters in the Amazon DynamoDB Developer Guide.

Output

NextToken -> (string)

Provides an identifier to allow retrieval of paginated results.

Parameters -> (list)

A list of parameters within a parameter group. Each element in the list represents one parameter.

(structure)

Describes an individual setting that controls some aspect of DAX behavior.

ParameterName -> (string)

The name of the parameter.

ParameterType -> (string)

Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

ParameterValue -> (string)

The value for the parameter.

NodeTypeSpecificValues -> (list)

A list of node types, and specific parameter values for each node.

(structure)

Represents a parameter value that is applicable to a particular node type.

NodeType -> (string)

A node type to which the parameter value applies.

Value -> (string)

The parameter value for this node type.

Description -> (string)

A description of the parameter

Source -> (string)

How the parameter is defined. For example, system denotes a system-defined parameter.

DataType -> (string)

The data type of the parameter. For example, integer :

AllowedValues -> (string)

A range of values within which the parameter can be set.

IsModifiable -> (string)

Whether the customer is allowed to modify the parameter.

ChangeType -> (string)

The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.