Describe Container Instances

ecs_describe_container_instances

R Documentation

Describes one or more container instances

Description

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

Usage

ecs_describe_container_instances(cluster, containerInstances, include)

Arguments

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

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

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.

Value

A list with the following syntax:

list(
  containerInstances = list(
    list(
      containerInstanceArn = "string",
      ec2InstanceId = "string",
      capacityProviderName = "string",
      version = 123,
      versionInfo = list(
        agentVersion = "string",
        agentHash = "string",
        dockerVersion = "string"
      ),
      remainingResources = list(
        list(
          name = "string",
          type = "string",
          doubleValue = 123.0,
          longValue = 123,
          integerValue = 123,
          stringSetValue = list(
            "string"
          )
        )
      ),
      registeredResources = list(
        list(
          name = "string",
          type = "string",
          doubleValue = 123.0,
          longValue = 123,
          integerValue = 123,
          stringSetValue = list(
            "string"
          )
        )
      ),
      status = "string",
      statusReason = "string",
      agentConnected = TRUE|FALSE,
      runningTasksCount = 123,
      pendingTasksCount = 123,
      agentUpdateStatus = "PENDING"|"STAGING"|"STAGED"|"UPDATING"|"UPDATED"|"FAILED",
      attributes = list(
        list(
          name = "string",
          value = "string",
          targetType = "container-instance",
          targetId = "string"
        )
      ),
      registeredAt = as.POSIXct(
        "2015-01-01"
      ),
      attachments = list(
        list(
          id = "string",
          type = "string",
          status = "string",
          details = list(
            list(
              name = "string",
              value = "string"
            )
          )
        )
      ),
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      healthStatus = list(
        overallStatus = "OK"|"IMPAIRED"|"INSUFFICIENT_DATA"|"INITIALIZING",
        details = list(
          list(
            type = "CONTAINER_RUNTIME",
            status = "OK"|"IMPAIRED"|"INSUFFICIENT_DATA"|"INITIALIZING",
            lastUpdated = as.POSIXct(
              "2015-01-01"
            ),
            lastStatusChange = as.POSIXct(
              "2015-01-01"
            )
          )
        )
      )
    )
  ),
  failures = list(
    list(
      arn = "string",
      reason = "string",
      detail = "string"
    )
  )
)

Request syntax

svc$describe_container_instances(
  cluster = "string",
  containerInstances = list(
    "string"
  ),
  include = list(
    "TAGS"|"CONTAINER_INSTANCE_HEALTH"
  )
)

Examples

## Not run: 
# This example provides a description of the specified container instance
# in your default region, using the container instance UUID as an
# identifier.
svc$describe_container_instances(
  cluster = "default",
  containerInstances = list(
    "f2756532-8f13-4d53-87c9-aed50dc94cd7"
  )
)

## End(Not run)