DescribeDBParameterGroups¶

class RDS.Paginator.DescribeDBParameterGroups¶

paginator = client.get_paginator('describe_db_parameter_groups')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DBParameterGroupName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

DBParameterGroupName (string) --
The name of a specific DB parameter group to return details for.

Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
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

{
    'DBParameterGroups': [
        {
            'DBParameterGroupName': 'string',
            'DBParameterGroupFamily': 'string',
            'Description': 'string',
            'DBParameterGroupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Contains the result of a successful invocation of the DescribeDBParameterGroups action.
- DBParameterGroups (list) --
  
  A list of DBParameterGroup instances.
  - (dict) --
    
    Contains the details of an Amazon RDS DB parameter group.
    
    This data type is used as a response element in the DescribeDBParameterGroups action.
    - DBParameterGroupName (string) --
      
      The name of the DB parameter group.
    - DBParameterGroupFamily (string) --
      
      The name of the DB parameter group family that this DB parameter group is compatible with.
    - Description (string) --
      
      Provides the customer-specified description for this DB parameter group.
    - DBParameterGroupArn (string) --
      
      The Amazon Resource Name (ARN) for the DB parameter group.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

DescribeDBParameterGroups¶