Skip to content

Returns a list of DBParameterGroup descriptions

Description

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

Usage

rds_describe_db_parameter_groups(DBParameterGroupName, Filters,
  MaxRecords, Marker)

Arguments

  • DBParameterGroupName

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

    Constraints:

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

  • Filters

    This parameter isn't currently supported.

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • Marker

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

Value

A list with the following syntax:

list(
  Marker = "string",
  DBParameterGroups = list(
    list(
      DBParameterGroupName = "string",
      DBParameterGroupFamily = "string",
      Description = "string",
      DBParameterGroupArn = "string"
    )
  )
)

Request syntax

svc$describe_db_parameter_groups(
  DBParameterGroupName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

Examples

# This example lists information about the specified DB parameter group.
svc$describe_db_parameter_groups(
  DBParameterGroupName = "mymysqlparametergroup"
)