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

******************************
describe_db_cluster_parameters
******************************



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

  

  Returns the detailed parameter list for a particular 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/DescribeDBClusterParameters>`_  


  **Request Syntax**
  ::

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

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

     

    Constraints:

     

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

    

  
  :type Source: string
  :param Source: 

    A specific source to return parameters for.

     

    Valid Values:

     

    
    * ``engine-default``
     
    * ``system``
     
    * ``user``
    

    

  
  :type Filters: list
  :param Filters: 

    A filter that specifies one or more DB cluster parameters to describe.

     

    The only supported filter is ``parameter-name``. The results list only includes information about the DB cluster parameters with these names.

    

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

    
    ::

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

    

    - *(dict) --* 

      Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

      
      

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

        Provides a list of parameters for the DB cluster parameter group.

        
        

        - *(dict) --* 

          This data type is used as a request parameter in the ``ModifyDBParameterGroup`` and ``ResetDBParameterGroup`` actions.

           

          This data type is used as a response element in the ``DescribeEngineDefaultParameters`` and ``DescribeDBParameters`` actions.

          
          

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

            The name of the parameter.

            
          

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

            The value of the parameter.

            
          

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

            Provides a description of the parameter.

            
          

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

            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.

            
          

          - **SupportedEngineModes** *(list) --* 

            The valid DB engine modes.

            
            

            - *(string) --* 
        
      
    
      

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

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

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

  

  **Examples**

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

    response = client.describe_db_cluster_parameters(
        DBClusterParameterGroupName='mydbclusterparametergroup',
        Source='system',
    )
    
    print(response)

  
  Expected Output:
  ::

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

  