:doc:`MemoryDB <../../memorydb>` / Client / describe_parameter_groups

*************************
describe_parameter_groups
*************************



.. py:method:: MemoryDB.Client.describe_parameter_groups(**kwargs)

  

  Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeParameterGroups>`_  


  **Request Syntax**
  ::

    response = client.describe_parameter_groups(
        ParameterGroupName='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type ParameterGroupName: string
  :param ParameterGroupName: 

    The name of a specific parameter group to return details for.

    

  
  :type MaxResults: integer
  :param MaxResults: 

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

    

  
  :type NextToken: string
  :param NextToken: 

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    

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

    
    ::

      {
          'NextToken': 'string',
          'ParameterGroups': [
              {
                  'Name': 'string',
                  'Family': 'string',
                  'Description': 'string',
                  'ARN': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NextToken** *(string) --* 

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

        
      

      - **ParameterGroups** *(list) --* 

        A list of parameter groups. Each element in the list contains detailed information about one parameter group.

        
        

        - *(dict) --* 

          Represents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.

          
          

          - **Name** *(string) --* 

            The name of the parameter group

            
          

          - **Family** *(string) --* 

            The name of the parameter group family that this parameter group is compatible with.

            
          

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

            A description of the parameter group

            
          

          - **ARN** *(string) --* 

            The Amazon Resource Name (ARN) of the parameter group

            
      
    
  
  **Exceptions**
  
  *   :py:class:`MemoryDB.Client.exceptions.ParameterGroupNotFoundFault`

  
  *   :py:class:`MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault`

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

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

  