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.

Describes one or more of your clusters.

Note:

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

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

Syntax

C#
public abstract DescribeClustersResponse DescribeClusters(
         DescribeClustersRequest request
)

Parameters

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

Exceptions

ExceptionCondition
ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
ServerException These errors are usually caused by a server issue.

Examples

This example provides a description of the specified cluster in your default region.

To describe a cluster


var client = new AmazonECSClient();
var response = client.DescribeClusters(new DescribeClustersRequest 
{
    Clusters = new List<string> {
        "default"
    }
});

List<Cluster> clusters = response.Clusters;
List<Failure> failures = response.Failures;

            

Version Information

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

See Also