RDS / Paginator / DescribeDBClusterParameters

DescribeDBClusterParameters#

class RDS.Paginator.DescribeDBClusterParameters#
paginator = client.get_paginator('describe_db_cluster_parameters')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DBClusterParameterGroupName='string',
    Source='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • DBClusterParameterGroupName (string) –

    [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.

  • Source (string) – A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

  • 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.

      Note

      Currently, wildcards are not supported in filters.

      The following actions can be filtered:

      • DescribeDBClusterBacktracks

      • DescribeDBClusterEndpoints

      • DescribeDBClusters

      • DescribeDBInstances

      • 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:

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',
            ]
        },
    ],
    'NextToken': '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) –

          Specifies the name of the parameter.

        • ParameterValue (string) –

          Specifies the value of the parameter.

        • Description (string) –

          Provides a description of the parameter.

        • Source (string) –

          Indicates 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.