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 information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use.

If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.

Note:

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

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

Syntax

C#
public virtual DescribeClustersResponse DescribeClusters(
         DescribeClustersRequest request
)

Parameters

request
Type: Amazon.DAX.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 DAX.

Exceptions

ExceptionCondition
ClusterNotFoundException The requested cluster ID does not refer to an existing DAX cluster.
InvalidParameterCombinationException Two or more incompatible parameters were specified.
InvalidParameterValueException The value for a parameter is invalid.
ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.

Version Information

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

See Also