DescribeContainerInstancesRequest Class

Container for the parameters to the DescribeContainerInstances operation. Describes one or more container instances. Returns metadata about each container instance requested.

Inheritance Hierarchy

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

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

Syntax

public class DescribeContainerInstancesRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The DescribeContainerInstancesRequest type exposes the following members

Constructors

	Name	Description
	DescribeContainerInstancesRequest()

Properties

Name Type Description

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 describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.
ContainerInstances	System.Collections.Generic.List<System.String>	Gets and sets the property ContainerInstances. A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
Include	System.Collections.Generic.List<System.String>	Gets and sets the property Include. Specifies whether you want to see the resource tags for the container instance. If `TAGS` is specified, the tags are included in the response. If `CONTAINER_INSTANCE_HEALTH` is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

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 describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

ContainerInstances

System.Collections.Generic.List<System.String>

Gets and sets the property ContainerInstances.

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

Include

System.Collections.Generic.List<System.String>

Gets and sets the property Include.

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

Examples

This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.

To describe container instance


var client = new AmazonECSClient();
var response = client.DescribeContainerInstances(new DescribeContainerInstancesRequest 
{
    Cluster = "default",
    ContainerInstances = new List<string> {
        "f2756532-8f13-4d53-87c9-aed50dc94cd7"
    }
});

List<ContainerInstance> containerInstances = response.ContainerInstances;
List<Failure> failures = response.Failures;

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