Skip to content

Describe Db Parameters

neptune_describe_db_parameters R Documentation

Returns the detailed parameter list for a particular DB parameter group

Description

Returns the detailed parameter list for a particular DB parameter group.

Usage

neptune_describe_db_parameters(DBParameterGroupName, Source, Filters,
  MaxRecords, Marker)

Arguments

DBParameterGroupName

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

Constraints:

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

Source

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

Filters

This parameter is not 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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

An optional pagination token provided by a previous describe_db_parameters 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(
  Parameters = list(
    list(
      ParameterName = "string",
      ParameterValue = "string",
      Description = "string",
      Source = "string",
      ApplyType = "string",
      DataType = "string",
      AllowedValues = "string",
      IsModifiable = TRUE|FALSE,
      MinimumEngineVersion = "string",
      ApplyMethod = "immediate"|"pending-reboot"
    )
  ),
  Marker = "string"
)

Request syntax

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