Learn R Programming
aws.ecx (version 1.0.5)

ecs_delete_task_set: Delete Task Set

Description

Deletes a specified task set within a 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_delete_task_set(
  cluster = NULL,
  service = NULL,
  taskSet = NULL,
  force = 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 hosts the task set to delete.

taskSet

Character. The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

force

Logical. If true, this allows you to delete a task set even if it hasn\'t been scaled down to zero.

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 set exists in to delete.

service

The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.

taskSet

The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

force

If true, this allows you to delete a task set even if it hasn\'t been scaled down to zero.