AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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 ModifyClusterParameterGroup, 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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeClusterParametersAsync.

Namespace: Amazon.Redshift
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C#
public virtual DescribeClusterParametersResponse DescribeClusterParameters(
         DescribeClusterParametersRequest request
)

Parameters

request
Type: Amazon.Redshift.Model.DescribeClusterParametersRequest

Container for the necessary parameters to execute the DescribeClusterParameters service method.

Return Value


The response from the DescribeClusterParameters service method, as returned by Redshift.

Exceptions

ExceptionCondition
ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.

Examples

This example retrieves the parameters for the named parameter group.

To get the parameters for a parameter group


var client = new AmazonRedshiftClient();
var response = client.DescribeClusterParameters(new DescribeClusterParametersRequest 
{
    ParameterGroupName = "myclusterparametergroup"
});

List<Parameter> parameters = response.Parameters;

            

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also