ecs_describe_task_sets {aws.ecx}

Describe Task Sets

Description

Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

Usage

ecs_describe_task_sets(
  cluster = NULL,
  service = NULL,
  taskSets = NULL,
  include = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

cluster

Character. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the...

service

Character. The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

taskSets

List. The ID or full Amazon Resource Name (ARN) of task sets to describe.

include

List. Specifies whether to see the resource tags for the task set.

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

cluster

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

service

The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

taskSets

The ID or full Amazon Resource Name (ARN) of task sets to describe.

include

Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.