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 a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

Note:

For PCL this operation is only available in asynchronous form. Please refer to ListContainerInstancesAsync.

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

Syntax

C#
public virtual ListContainerInstancesResponse ListContainerInstances(
         ListContainerInstancesRequest request
)
Parameters
request
Type: Amazon.ECS.Model.ListContainerInstancesRequest

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

Return Value
The response from the ListContainerInstances 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.
ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.
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 lists all of your available container instances in the specified cluster in your default region.

To list your available container instances in a cluster


var response = client.ListContainerInstances(new ListContainerInstancesRequest 
{
    Cluster = "default"
});

List containerInstanceArns = response.ContainerInstanceArns;

            

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