AmazonECSClient.DescribeClusters Method (DescribeClustersRequest)

Describes one or more of your clusters.

For CLI examples, see describe-clusters.rst on GitHub.

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

public virtual DescribeClustersResponse DescribeClusters(
         DescribeClustersRequest request
)

Parameters

request: Type: Amazon.ECS.Model.DescribeClustersRequest

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

Return Value

Type: DescribeClustersResponse

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

Exceptions

Exception	Condition
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. For more information about service event errors, see Amazon ECS service event messages.
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 and newer, 3.5

AmazonECSClient.DescribeClusters (DescribeClustersRequest)

Method