submit-task-state-change¶

Description¶

Note

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

Synopsis¶

  submit-task-state-change
[--cluster <value>]
[--task <value>]
[--status <value>]
[--reason <value>]
[--containers <value>]
[--attachments <value>]
[--managed-agents <value>]
[--pull-started-at <value>]
[--pull-stopped-at <value>]
[--execution-stopped-at <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--cluster (string)

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

--task (string)

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

--status (string)

The status of the state change request.

--reason (string)

The reason for the state change request.

--containers (list)

Any containers that’s associated with the state change request.

(structure)

An object that represents a change in state for a container.

containerName -> (string)

The name of the container.

imageDigest -> (string)

The container image SHA 256 digest.

runtimeId -> (string)

The ID of the Docker container.

exitCode -> (integer)

The exit code for the container, if the state change is a result of the container exiting.

networkBindings -> (list)

Any network bindings that are associated with the container.

(structure)

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

bindIP -> (string)

The IP address that the container is bound to on the container instance.

containerPort -> (integer)

The port number on the container that’s used with the network binding.

hostPort -> (integer)

The port number on the host that’s used with the network binding.

protocol -> (string)

The protocol used for the network binding.

reason -> (string)

The reason for the state change.

status -> (string)

The status of the container.

Shorthand Syntax:

containerName=string,imageDigest=string,runtimeId=string,exitCode=integer,networkBindings=[{bindIP=string,containerPort=integer,hostPort=integer,protocol=string},{bindIP=string,containerPort=integer,hostPort=integer,protocol=string}],reason=string,status=string ...

JSON Syntax:

[
  {
    "containerName": "string",
    "imageDigest": "string",
    "runtimeId": "string",
    "exitCode": integer,
    "networkBindings": [
      {
        "bindIP": "string",
        "containerPort": integer,
        "hostPort": integer,
        "protocol": "tcp"|"udp"
      }
      ...
    ],
    "reason": "string",
    "status": "string"
  }
  ...
]

--attachments (list)

Any attachments associated with the state change request.

(structure)

An object representing a change in state for a task attachment.

attachmentArn -> (string)

The Amazon Resource Name (ARN) of the attachment.

status -> (string)

The status of the attachment.

Shorthand Syntax:

attachmentArn=string,status=string ...

JSON Syntax:

[
  {
    "attachmentArn": "string",
    "status": "string"
  }
  ...
]

--managed-agents (list)

The details for the managed agent that’s associated with the task.

(structure)

An object representing a change in state for a managed agent.

containerName -> (string)

The name of the container that’s associated with the managed agent.

managedAgentName -> (string)

The name of the managed agent.

status -> (string)

The status of the managed agent.

reason -> (string)

The reason for the status of the managed agent.

Shorthand Syntax:

containerName=string,managedAgentName=string,status=string,reason=string ...

JSON Syntax:

[
  {
    "containerName": "string",
    "managedAgentName": "ExecuteCommandAgent",
    "status": "string",
    "reason": "string"
  }
  ...
]

--pull-started-at (timestamp)

The Unix timestamp for the time when the container image pull started.

--pull-stopped-at (timestamp)

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

--execution-stopped-at (timestamp)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

acknowledgment -> (string)

Acknowledgement of the state change.

Table of Contents

Feedback

User Guide

submit-task-state-change¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶