Describe Parameters

dax_describe_parameters

R Documentation

Returns the detailed parameter list for a particular parameter group

Description

Returns the detailed parameter list for a particular parameter group.

Usage

dax_describe_parameters(ParameterGroupName, Source, MaxResults,
  NextToken)

Arguments

ParameterGroupName

[required] The name of the parameter group.

Source

How the parameter is defined. For example, system denotes a system-defined parameter.

MaxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Parameters = list(
    list(
      ParameterName = "string",
      ParameterType = "DEFAULT"|"NODE_TYPE_SPECIFIC",
      ParameterValue = "string",
      NodeTypeSpecificValues = list(
        list(
          NodeType = "string",
          Value = "string"
        )
      ),
      Description = "string",
      Source = "string",
      DataType = "string",
      AllowedValues = "string",
      IsModifiable = "TRUE"|"FALSE"|"CONDITIONAL",
      ChangeType = "IMMEDIATE"|"REQUIRES_REBOOT"
    )
  )
)

Request syntax

svc$describe_parameters(
  ParameterGroupName = "string",
  Source = "string",
  MaxResults = 123,
  NextToken = "string"
)