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 properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters 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 clusters that have any combination of those values are returned.

If both tag keys and values are omitted from the request, clusters 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 DescribeClustersAsync.

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

Syntax

C#
public abstract DescribeClustersResponse DescribeClusters(
         DescribeClustersRequest request
)

Parameters

request
Type: Amazon.Redshift.Model.DescribeClustersRequest

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

Return Value


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

Exceptions

ExceptionCondition
ClusterNotFoundException The ClusterIdentifier parameter does not refer to an existing cluster.
InvalidTagException The tag is invalid.

Examples

This example returns a description of all clusters for the account. By default, the output is in JSON format.

To get a description of all clusters


var client = new AmazonRedshiftClient();
var response = client.DescribeClusters(new DescribeClustersRequest 
{
});

List<Cluster> clusters = response.Clusters;

            

Version Information

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

See Also