neptune_describe_db_parameter_groups: Returns a list of DBParameterGroup descriptions

Description Usage Arguments Value Request syntax

View source: R/neptune_operations.R

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

1
2
neptune_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 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_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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
list(
  Marker = "string",
  DBParameterGroups = list(
    list(
      DBParameterGroupName = "string",
      DBParameterGroupFamily = "string",
      Description = "string",
      DBParameterGroupArn = "string"
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
svc$describe_db_parameter_groups(
  DBParameterGroupName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

paws.database documentation built on Aug. 23, 2021, 9:18 a.m.