ListContainerInstancesRequest Class

Container for the parameters to the ListContainerInstances operation. 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 Elastic Container Service Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.ListContainerInstancesRequest

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

Syntax

public class ListContainerInstancesRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The ListContainerInstancesRequest type exposes the following members

Constructors

	Name	Description
	ListContainerInstancesRequest()

Properties

Name	Type	Description
Cluster	System.String	Gets and sets the property Cluster. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
Filter	System.String	Gets and sets the property Filter. You can filter the results of a `ListContainerInstances` operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of container instance results that `ListContainerInstances` returned in paginated output. When this parameter is used, `ListContainerInstances` only returns `maxResults` results in a single page along with a `nextToken` response element. The remaining results of the initial request can be seen by sending another `ListContainerInstances` request with the returned `nextToken` value. This value can be between 1 and 100. If this parameter isn't used, then `ListContainerInstances` returns up to 100 results and a `nextToken` value if applicable.
NextToken	System.String	Gets and sets the property NextToken. The `nextToken` value returned from a `ListContainerInstances` request indicating that more results are available to fulfill the request and further calls are needed. If `maxResults` was provided, it's possible the number of results to be fewer than `maxResults`. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Status	Amazon.ECS.ContainerInstanceStatus	Gets and sets the property Status. Filters the container instances by status. For example, if you specify the `DRAINING` status, the results include only container instances that have been set to `DRAINING` using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than `INACTIVE`.

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 client = new AmazonECSClient();
var response = client.ListContainerInstances(new ListContainerInstancesRequest 
{
    Cluster = "default"
});

List<string> containerInstanceArns = response.ContainerInstanceArns;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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