ecs_submit_container_state_change {aws.ecx}

Submit Container State Change

Description

Submit Container State Change

Usage

ecs_submit_container_state_change(
  cluster = NULL,
  task = NULL,
  containerName = NULL,
  runtimeId = NULL,
  status = NULL,
  exitCode = NULL,
  reason = NULL,
  networkBindings = 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 ARN of the cluster that hosts the container.

task

Character. The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

containerName

Character. The name of the container.

runtimeId

Character. The ID of the Docker container.

status

Character. The status of the state change request.

exitCode

Integer. The exit code returned for the state change request.

reason

Character. The reason for the state change request.

networkBindings

List. The network bindings of the container.

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 ARN of the cluster that hosts the container.

task

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

containerName

The name of the container.

runtimeId

The ID of the Docker container.

status

The status of the state change request.

exitCode

The exit code returned for the state change request.

reason

The reason for the state change request.

networkBindings

The network bindings of the container.