:doc:`RDS <../../rds>` / Client / describe_db_cluster_parameter_groups

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



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

  

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

   

  For more information on Amazon Aurora, see `What is Amazon Aurora? <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html>`__ in the *Amazon Aurora User Guide*.

   

  For more information on Multi-AZ DB clusters, see `Multi-AZ DB cluster deployments <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html>`__ in the *Amazon RDS User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-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 DB cluster parameter group to return details for.

     

    Constraints:

     

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

    

  
  :type Filters: list
  :param Filters: 

    This parameter isn't currently supported.

    

  
    - *(dict) --* 

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

       

      .. note::

        

        Currently, wildcards are not supported in filters.

        

       

      The following actions can be filtered:

       

      
      * ``DescribeDBClusterBacktracks``
       
      * ``DescribeDBClusterEndpoints``
       
      * ``DescribeDBClusters``
       
      * ``DescribeDBInstances``
       
      * ``DescribeDBRecommendations``
       
      * ``DescribeDBShardGroups``
       
      * ``DescribePendingMaintenanceActions``
      

      

    
      - **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 called a marker is included in the response so you can retrieve the remaining results.

     

    Default: 100

     

    Constraints: Minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous ``DescribeDBClusterParameterGroups`` 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) --* 
      

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

        An optional pagination token provided by a previous ``DescribeDBClusterParameterGroups`` 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 DB cluster parameter groups.

        
        

        - *(dict) --* 

          Contains the details of an Amazon RDS DB cluster parameter group.

           

          This data type is used as a response element in the ``DescribeDBClusterParameterGroups`` action.

          
          

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

            The name of the DB cluster parameter group.

            
          

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

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

            
          

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

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

            
          

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

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

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

  

  **Examples**

  This example lists settings for the specified DB cluster parameter group.
  ::

    response = client.describe_db_cluster_parameter_groups(
        DBClusterParameterGroupName='mydbclusterparametergroup',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'ResponseMetadata': {
            '...': '...',
        },
    }

  