:doc:`ElastiCache <../../elasticache>` / Client / reset_cache_parameter_group

***************************
reset_cache_parameter_group
***************************



.. py:method:: ElastiCache.Client.reset_cache_parameter_group(**kwargs)

  

  Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ``ResetAllParameters`` and ``CacheParameterGroupName`` parameters.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ResetCacheParameterGroup>`_  


  **Request Syntax**
  ::

    response = client.reset_cache_parameter_group(
        CacheParameterGroupName='string',
        ResetAllParameters=True|False,
        ParameterNameValues=[
            {
                'ParameterName': 'string',
                'ParameterValue': 'string'
            },
        ]
    )
    
  :type CacheParameterGroupName: string
  :param CacheParameterGroupName: **[REQUIRED]** 

    The name of the cache parameter group to reset.

    

  
  :type ResetAllParameters: boolean
  :param ResetAllParameters: 

    If ``true``, all parameters in the cache parameter group are reset to their default values. If ``false``, only the parameters listed by ``ParameterNameValues`` are reset to their default values.

     

    Valid values: ``true`` | ``false``

    

  
  :type ParameterNameValues: list
  :param ParameterNameValues: 

    An array of parameter names to reset to their default values. If ``ResetAllParameters`` is ``true``, do not use ``ParameterNameValues``. If ``ResetAllParameters`` is ``false``, you must specify the name of at least one parameter to reset.

    

  
    - *(dict) --* 

      Describes a name-value pair that is used to update the value of a parameter.

      

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

        The name of the parameter.

        

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

        The value of the parameter.

        

      
    

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

    
    ::

      {
          'CacheParameterGroupName': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of one of the following operations:

       

      
      * ``ModifyCacheParameterGroup``
       
      * ``ResetCacheParameterGroup``
      

      
      

      - **CacheParameterGroupName** *(string) --* 

        The name of the cache parameter group.

        
  
  **Exceptions**
  
  *   :py:class:`ElastiCache.Client.exceptions.InvalidCacheParameterGroupStateFault`

  
  *   :py:class:`ElastiCache.Client.exceptions.CacheParameterGroupNotFoundFault`

  
  *   :py:class:`ElastiCache.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`ElastiCache.Client.exceptions.InvalidParameterCombinationException`

  
  *   :py:class:`ElastiCache.Client.exceptions.InvalidGlobalReplicationGroupStateFault`

  

  **Examples**

  Modifies the parameters of a cache parameter group to the engine or system default value.
  ::

    response = client.reset_cache_parameter_group(
        CacheParameterGroupName='custom-mem1-4',
        ResetAllParameters=True,
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'CacheParameterGroupName': 'custom-mem1-4',
        'ResponseMetadata': {
            '...': '...',
        },
    }

  