Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific
type. For example, to retrieve parameters that were modified by a user
action such as from
modify_cluster_parameter_group
,
you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
redshift_describe_cluster_parameters(ParameterGroupName, Source,
MaxRecords, Marker)
A list with the following syntax:
list(
Parameters = list(
list(
ParameterName = "string",
ParameterValue = "string",
Description = "string",
Source = "string",
DataType = "string",
AllowedValues = "string",
ApplyType = "static"|"dynamic",
IsModifiable = TRUE|FALSE,
MinimumEngineVersion = "string"
)
),
Marker = "string"
)
[required] The name of a cluster parameter group for which to return details.
The parameter types to return. Specify user
to show parameters that
are different form the default. Similarly, specify engine-default
to
show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user
| engine-default
The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords
value, a value is returned in a marker
field of the response. You can
retrieve the next set of records by retrying the command with the
returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
An optional parameter that specifies the starting point to return a set
of response records. When the results of a
describe_cluster_parameters
request exceed the value specified in MaxRecords
, AWS returns a value
in the Marker
field of the response. You can retrieve the next set of
response records by providing the returned marker value in the Marker
parameter and retrying the request.
svc$describe_cluster_parameters(
ParameterGroupName = "string",
Source = "string",
MaxRecords = 123,
Marker = "string"
)