:doc:`DAX <../../dax>` / Paginator / DescribeParameters

******************
DescribeParameters
******************



.. py:class:: DAX.Paginator.DescribeParameters

  ::

    
    paginator = client.get_paginator('describe_parameters')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DAX.Client.describe_parameters`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeParameters>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ParameterGroupName='string',
          Source='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ParameterGroupName: string
    :param ParameterGroupName: **[REQUIRED]** 

      The name of the parameter group.

      

    
    :type Source: string
    :param Source: 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            '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) --* 
        

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

              
        
      
    