RDS / Client / describe_db_parameter_groups

describe_db_parameter_groups

RDS.Client.describe_db_parameter_groups(**kwargs)

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

See also: AWS API Documentation

Request Syntax

response = client.describe_db_parameter_groups(
    DBParameterGroupName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='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) –

• MaxRecords (integer) –

  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 that you can retrieve the remaining results.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• Marker (string) – An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

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

  • Marker (string) –

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

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

Exceptions

• RDS.Client.exceptions.DBParameterGroupNotFoundFault

Examples

This example lists information about the specified DB parameter group.

response = client.describe_db_parameter_groups(
    DBParameterGroupName='mymysqlparametergroup',
)

print(response)

Expected Output:

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