Describe Capacity Providers

ecs_describe_capacity_providers

R Documentation

Describes one or more of your capacity providers

Description

Describes one or more of your capacity providers.

Usage

ecs_describe_capacity_providers(capacityProviders, include, maxResults,
  nextToken)

Arguments

capacityProviders

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

include

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

maxResults

The maximum number of account setting results returned by describe_capacity_providers in paginated output. When this parameter is used, describe_capacity_providers 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 describe_capacity_providers request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then describe_capacity_providers returns up to 10 results and a nextToken value if applicable.

nextToken

The nextToken value returned from a previous paginated describe_capacity_providers request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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.

Value

A list with the following syntax:

list(
  capacityProviders = list(
    list(
      capacityProviderArn = "string",
      name = "string",
      status = "ACTIVE"|"INACTIVE",
      autoScalingGroupProvider = list(
        autoScalingGroupArn = "string",
        managedScaling = list(
          status = "ENABLED"|"DISABLED",
          targetCapacity = 123,
          minimumScalingStepSize = 123,
          maximumScalingStepSize = 123,
          instanceWarmupPeriod = 123
        ),
        managedTerminationProtection = "ENABLED"|"DISABLED",
        managedDraining = "ENABLED"|"DISABLED"
      ),
      updateStatus = "DELETE_IN_PROGRESS"|"DELETE_COMPLETE"|"DELETE_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_COMPLETE"|"UPDATE_FAILED",
      updateStatusReason = "string",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  ),
  failures = list(
    list(
      arn = "string",
      reason = "string",
      detail = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_capacity_providers(
  capacityProviders = list(
    "string"
  ),
  include = list(
    "TAGS"
  ),
  maxResults = 123,
  nextToken = "string"
)