:doc:`Neptune <../../neptune>` / Client / describe_engine_default_cluster_parameters

******************************************
describe_engine_default_cluster_parameters
******************************************



.. py:method:: Neptune.Client.describe_engine_default_cluster_parameters(**kwargs)

  

  Returns the default engine and system parameter information for the cluster database engine.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DescribeEngineDefaultClusterParameters>`_  


  **Request Syntax**
  ::

    response = client.describe_engine_default_cluster_parameters(
        DBParameterGroupFamily='string',
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        Marker='string'
    )
    
  :type DBParameterGroupFamily: string
  :param DBParameterGroupFamily: **[REQUIRED]** 

    The name of the DB cluster parameter group family to return engine parameter information for.

    

  
  :type Filters: list
  :param Filters: 

    This parameter is not currently supported.

    

  
    - *(dict) --* 

      This type is not currently supported.

      

    
      - **Name** *(string) --* **[REQUIRED]** 

        This parameter is not currently supported.

        

      
      - **Values** *(list) --* **[REQUIRED]** 

        This parameter is not currently supported.

        

      
        - *(string) --* 

        
    
    

  :type MaxRecords: integer
  :param MaxRecords: 

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

     

    Default: 100

     

    Constraints: Minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous ``DescribeEngineDefaultClusterParameters`` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

    

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

    
    ::

      {
          'EngineDefaults': {
              'DBParameterGroupFamily': 'string',
              'Marker': 'string',
              'Parameters': [
                  {
                      'ParameterName': 'string',
                      'ParameterValue': 'string',
                      'Description': 'string',
                      'Source': 'string',
                      'ApplyType': 'string',
                      'DataType': 'string',
                      'AllowedValues': 'string',
                      'IsModifiable': True|False,
                      'MinimumEngineVersion': 'string',
                      'ApplyMethod': 'immediate'|'pending-reboot'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **EngineDefaults** *(dict) --* 

        Contains the result of a successful invocation of the  DescribeEngineDefaultParameters action.

        
        

        - **DBParameterGroupFamily** *(string) --* 

          Specifies the name of the DB parameter group family that the engine default parameters apply to.

          
        

        - **Marker** *(string) --* 

          An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords`` .

          
        

        - **Parameters** *(list) --* 

          Contains a list of engine default parameters.

          
          

          - *(dict) --* 

            Specifies a parameter.

            
            

            - **ParameterName** *(string) --* 

              Specifies the name of the parameter.

              
            

            - **ParameterValue** *(string) --* 

              Specifies the value of the parameter.

              
            

            - **Description** *(string) --* 

              Provides a description of the parameter.

              
            

            - **Source** *(string) --* 

              Indicates the source of the parameter value.

              
            

            - **ApplyType** *(string) --* 

              Specifies the engine specific parameters type.

              
            

            - **DataType** *(string) --* 

              Specifies the valid data type for the parameter.

              
            

            - **AllowedValues** *(string) --* 

              Specifies the valid range of values for the parameter.

              
            

            - **IsModifiable** *(boolean) --* 

              Indicates whether ( ``true``) or not ( ``false``) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

              
            

            - **MinimumEngineVersion** *(string) --* 

              The earliest engine version to which the parameter can apply.

              
            

            - **ApplyMethod** *(string) --* 

              Indicates when to apply parameter updates.

              
        
      
    
  