AmazonECSClient.ListClusters Method (ListClustersRequest)

Returns a list of existing clusters.

Note:

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

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

Syntax

public virtual ListClustersResponse ListClusters(
         ListClustersRequest request
)

Parameters

request: Type: Amazon.ECS.Model.ListClustersRequest

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

Return Value

Type: ListClustersResponse

The response from the ListClusters 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.
ServerException	These errors are usually caused by a server issue.

Examples

This example lists all of your available clusters in your default region.

To list your available clusters


var client = new AmazonECSClient();
var response = client.ListClusters(new ListClustersRequest 
{
});

List<string> clusterArns = response.ClusterArns;

Version Information

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

AmazonECSClient.ListClusters (ListClustersRequest)

Method