ecs_submit_task_state_change {aws.ecx}R Documentation

Submit Task State Change

Description

Submit Task State Change

Usage

ecs_submit_task_state_change(
  cluster = NULL,
  task = NULL,
  status = NULL,
  reason = NULL,
  containers = NULL,
  attachments = NULL,
  pullStartedAt = NULL,
  pullStoppedAt = NULL,
  executionStoppedAt = 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 task.

task

Character. The task ID or full ARN of the task in the state change request.

status

Character. The status of the state change request.

reason

Character. The reason for the state change request.

containers

List. Any containers associated with the state change request.

attachments

List. Any attachments associated with the state change request.

pullStartedAt

Character. The Unix timestamp for when the container image pull began.

pullStoppedAt

Character. The Unix timestamp for when the container image pull completed.

executionStoppedAt

Character. The Unix timestamp for when the task execution stopped.

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 task.

task

The task ID or full ARN of the task in the state change request.

status

The status of the state change request.

reason

The reason for the state change request.

containers

Any containers associated with the state change request.

attachments

Any attachments associated with the state change request.

pullStartedAt

The Unix timestamp for when the container image pull began.

pullStoppedAt

The Unix timestamp for when the container image pull completed.

executionStoppedAt

The Unix timestamp for when the task execution stopped.


[Package aws.ecx version 1.0.5 Index]