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.

Describes one or more container instances. Returns metadata about each container instance requested.

Note:

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

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

Syntax

C#
public virtual DescribeContainerInstancesResponse DescribeContainerInstances(
         DescribeContainerInstancesRequest request
)

Parameters

request
Type: Amazon.ECS.Model.DescribeContainerInstancesRequest

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

Return Value


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

Exceptions

ExceptionCondition
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.
ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
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 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 Framework:
Supported in: 4.5, 4.0, 3.5

See Also