RDS / Paginator / DescribeEngineDefaultClusterParameters


class RDS.Paginator.DescribeEngineDefaultClusterParameters#
paginator = client.get_paginator('describe_engine_default_cluster_parameters')

Creates an iterator that will paginate through responses from RDS.Client.describe_engine_default_cluster_parameters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'Name': 'string',
            'Values': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • DBParameterGroupFamily (string) –


    The name of the DB cluster parameter group family to return engine parameter information for.

  • Filters (list) –

    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.


      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) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'EngineDefaults': {
        'DBParameterGroupFamily': 'string',
        'Marker': 'string',
        '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': [
    'NextToken': 'string'

Response Structure

  • (dict) –

    • EngineDefaults (dict) –

      Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

      • DBParameterGroupFamily (string) –

        Specifies the name of the DB parameter group family that the engine default parameters apply to.

      • Marker (string) –

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

      • Parameters (list) –

        Contains a list of engine default parameters.

        • (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) –

    • NextToken (string) –

      A token to resume pagination.