AmazonRedshiftClient.DescribeClusterParameterGroups Method (DescribeClusterParameterGroupsRequest)

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

Note:

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

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

Syntax

public virtual DescribeClusterParameterGroupsResponse DescribeClusterParameterGroups(
         DescribeClusterParameterGroupsRequest request
)

Parameters

request: Type: Amazon.Redshift.Model.DescribeClusterParameterGroupsRequest

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

Return Value

Type: DescribeClusterParameterGroupsResponse

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

Exceptions

Exception	Condition
ClusterParameterGroupNotFoundException	The parameter group name does not refer to an existing parameter group.
InvalidTagException	The tag is invalid.

Examples

This example returns a description of all cluster parameter groups for the account, with column headers.

To get a description of cluster parameter groups


var client = new AmazonRedshiftClient();
var response = client.DescribeClusterParameterGroups(new DescribeClusterParameterGroupsRequest 
{
    Marker = "",
    MaxRecords = 123,
    ParameterGroupName = "",
    TagKeys = new List<string> {
                    
    },
    TagValues = new List<string> {
                    
    }
});

List<ClusterParameterGroup> parameterGroups = response.ParameterGroups;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonRedshiftClient.DescribeClusterParameterGroups (DescribeClusterParameterGroupsRequest)

Method