DAX / Client / describe_parameters

describe_parameters

DAX.Client.describe_parameters(**kwargs)

Returns the detailed parameter list for a particular parameter group.

See also: AWS API Documentation

Request Syntax

response = client.describe_parameters(
    ParameterGroupName='string',
    Source='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• ParameterGroupName (string) –

  [REQUIRED]

  The name of the parameter group.

• Source (string) – How the parameter is defined. For example, system denotes a system-defined parameter.

• MaxResults (integer) –

  The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  The value for MaxResults must be between 20 and 100.

• NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Parameters': [
        {
            'ParameterName': 'string',
            'ParameterType': 'DEFAULT'|'NODE_TYPE_SPECIFIC',
            'ParameterValue': 'string',
            'NodeTypeSpecificValues': [
                {
                    'NodeType': 'string',
                    'Value': 'string'
                },
            ],
            'Description': 'string',
            'Source': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'IsModifiable': 'TRUE'|'FALSE'|'CONDITIONAL',
            'ChangeType': 'IMMEDIATE'|'REQUIRES_REBOOT'
        },
    ]
}

Response Structure

• (dict) –

  • 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.

    • (dict) –

      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.

        • (dict) –

          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.

Exceptions

• DAX.Client.exceptions.ParameterGroupNotFoundFault

• DAX.Client.exceptions.ServiceLinkedRoleNotFoundFault

• DAX.Client.exceptions.InvalidParameterValueException

• DAX.Client.exceptions.InvalidParameterCombinationException