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 PCL 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, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.
InvalidParameterException The specified parameter is invalid. 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 response = client.DescribeClusters(new DescribeClustersRequest 
{
    Clusters = new List {
        "default"
    }
});

List clusters = response.Clusters;
List failures = response.Failures;

            

Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also