:doc:`DocDB <../../docdb>` / Client / describe_db_cluster_parameter_groups

************************************
describe_db_cluster_parameter_groups
************************************



.. py:method:: DocDB.Client.describe_db_cluster_parameter_groups(**kwargs)

  

  Returns a list of ``DBClusterParameterGroup`` descriptions. If a ``DBClusterParameterGroupName`` parameter is specified, the list contains only the description of the specified cluster parameter group.

  

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


  **Request Syntax**
  ::

    response = client.describe_db_cluster_parameter_groups(
        DBClusterParameterGroupName='string',
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        Marker='string'
    )
    
  :type DBClusterParameterGroupName: string
  :param DBClusterParameterGroupName: 

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

     

    Constraints:

     

    
    * If provided, must match the name of an existing ``DBClusterParameterGroup``.
    

    

  
  :type Filters: list
  :param Filters: 

    This parameter is not currently supported.

    

  
    - *(dict) --* 

      A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

       

      Wildcards are not supported in filters.

      

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

        The name of the filter. Filter names are case sensitive.

        

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

        One or more filter values. Filter values are case sensitive.

        

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

    
    ::

      {
          'Marker': 'string',
          'DBClusterParameterGroups': [
              {
                  'DBClusterParameterGroupName': 'string',
                  'DBParameterGroupFamily': 'string',
                  'Description': 'string',
                  'DBClusterParameterGroupArn': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of  DBClusterParameterGroups.

      
      

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

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

        
      

      - **DBClusterParameterGroups** *(list) --* 

        A list of cluster parameter groups.

        
        

        - *(dict) --* 

          Detailed information about a cluster parameter group.

          
          

          - **DBClusterParameterGroupName** *(string) --* 

            Provides the name of the cluster parameter group.

            
          

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

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

            
          

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

            Provides the customer-specified description for this cluster parameter group.

            
          

          - **DBClusterParameterGroupArn** *(string) --* 

            The Amazon Resource Name (ARN) for the cluster parameter group.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`DocDB.Client.exceptions.DBParameterGroupNotFoundFault`

  