Skip to content

/AWS1/IF_ECS=>SUBMITTASKSTATECHANGE()

About SubmitTaskStateChange

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.

Method Signature

METHODS /AWS1/IF_ECS~SUBMITTASKSTATECHANGE
  IMPORTING
    !IV_CLUSTER TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_TASK TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_STATUS TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_REASON TYPE /AWS1/ECSSTRING OPTIONAL
    !IT_CONTAINERS TYPE /AWS1/CL_ECSCONTAINERSTATECH00=>TT_CONTAINERSTATECHANGES OPTIONAL
    !IT_ATTACHMENTS TYPE /AWS1/CL_ECSATTACHMENTSTATEC00=>TT_ATTACHMENTSTATECHANGES OPTIONAL
    !IT_MANAGEDAGENTS TYPE /AWS1/CL_ECSMANAGEDAGENTSTAT00=>TT_MANAGEDAGENTSTATECHANGES OPTIONAL
    !IV_PULLSTARTEDAT TYPE /AWS1/ECSTIMESTAMP OPTIONAL
    !IV_PULLSTOPPEDAT TYPE /AWS1/ECSTIMESTAMP OPTIONAL
    !IV_EXECUTIONSTOPPEDAT TYPE /AWS1/ECSTIMESTAMP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecssubmittskstatech01
  RAISING
    /AWS1/CX_ECSACCESSDENIEDEX
    /AWS1/CX_ECSCLIENTEXCEPTION
    /AWS1/CX_ECSINVALIDPARAMETEREX
    /AWS1/CX_ECSSERVEREXCEPTION
    /AWS1/CX_ECSCLIENTEXC
    /AWS1/CX_ECSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_cluster TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

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

iv_task TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

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

iv_status TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The status of the state change request.

iv_reason TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The reason for the state change request.

it_containers TYPE /AWS1/CL_ECSCONTAINERSTATECH00=>TT_CONTAINERSTATECHANGES TT_CONTAINERSTATECHANGES

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

it_attachments TYPE /AWS1/CL_ECSATTACHMENTSTATEC00=>TT_ATTACHMENTSTATECHANGES TT_ATTACHMENTSTATECHANGES

Any attachments associated with the state change request.

it_managedagents TYPE /AWS1/CL_ECSMANAGEDAGENTSTAT00=>TT_MANAGEDAGENTSTATECHANGES TT_MANAGEDAGENTSTATECHANGES

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

iv_pullstartedat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP

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

iv_pullstoppedat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP

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

iv_executionstoppedat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP

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

RETURNING

oo_output TYPE REF TO /aws1/cl_ecssubmittskstatech01 /AWS1/CL_ECSSUBMITTSKSTATECH01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->submittaskstatechange(
  it_attachments = VALUE /aws1/cl_ecsattachmentstatec00=>tt_attachmentstatechanges(
    (
      new /aws1/cl_ecsattachmentstatec00(
        iv_attachmentarn = |string|
        iv_status = |string|
      )
    )
  )
  it_containers = VALUE /aws1/cl_ecscontainerstatech00=>tt_containerstatechanges(
    (
      new /aws1/cl_ecscontainerstatech00(
        it_networkbindings = VALUE /aws1/cl_ecsnetworkbinding=>tt_networkbindings(
          (
            new /aws1/cl_ecsnetworkbinding(
              iv_bindip = |string|
              iv_containerport = 123
              iv_containerportrange = |string|
              iv_hostport = 123
              iv_hostportrange = |string|
              iv_protocol = |string|
            )
          )
        )
        iv_containername = |string|
        iv_exitcode = 123
        iv_imagedigest = |string|
        iv_reason = |string|
        iv_runtimeid = |string|
        iv_status = |string|
      )
    )
  )
  it_managedagents = VALUE /aws1/cl_ecsmanagedagentstat00=>tt_managedagentstatechanges(
    (
      new /aws1/cl_ecsmanagedagentstat00(
        iv_containername = |string|
        iv_managedagentname = |string|
        iv_reason = |string|
        iv_status = |string|
      )
    )
  )
  iv_cluster = |string|
  iv_executionstoppedat = '20150101000000.0000000'
  iv_pullstartedat = '20150101000000.0000000'
  iv_pullstoppedat = '20150101000000.0000000'
  iv_reason = |string|
  iv_status = |string|
  iv_task = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_acknowledgment( ).
ENDIF.