paws.compute (version 0.1.12)

ecs_describe_clusters: Describes one or more of your clusters

Description

Describes one or more of your clusters.

Usage

ecs_describe_clusters(clusters, include)

Value

A list with the following syntax:

list(
  clusters = list(
    list(
      clusterArn = "string",
      clusterName = "string",
      status = "string",
      registeredContainerInstancesCount = 123,
      runningTasksCount = 123,
      pendingTasksCount = 123,
      activeServicesCount = 123,
      statistics = list(
        list(
          name = "string",
          value = "string"
        )
      ),
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      settings = list(
        list(
          name = "containerInsights",
          value = "string"
        )
      ),
      capacityProviders = list(
        "string"
      ),
      defaultCapacityProviderStrategy = list(
        list(
          capacityProvider = "string",
          weight = 123,
          base = 123
        )
      ),
      attachments = list(
        list(
          id = "string",
          type = "string",
          status = "string",
          details = list(
            list(
              name = "string",
              value = "string"
            )
          )
        )
      ),
      attachmentsStatus = "string"
    )
  ),
  failures = list(
    list(
      arn = "string",
      reason = "string",
      detail = "string"
    )
  )
)

Arguments

clusters

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

include

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Request syntax

svc$describe_clusters(
  clusters = list(
    "string"
  ),
  include = list(
    "ATTACHMENTS"|"SETTINGS"|"STATISTICS"|"TAGS"
  )
)

Examples

if (FALSE) {
# This example provides a description of the specified cluster in your
# default region.
svc$describe_clusters(
  clusters = list(
    "default"
  )
)
}