Skip to content

/AWS1/IF_ECS=>LISTTASKS()

About ListTasks

Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.

Recently stopped tasks might appear in the returned results.

Method Signature

METHODS /AWS1/IF_ECS~LISTTASKS
  IMPORTING
    !IV_CLUSTER TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_CONTAINERINSTANCE TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_FAMILY TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ECSBOXEDINTEGER OPTIONAL
    !IV_STARTEDBY TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_SERVICENAME TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_DESIREDSTATUS TYPE /AWS1/ECSDESIREDSTATUS OPTIONAL
    !IV_LAUNCHTYPE TYPE /AWS1/ECSLAUNCHTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecslisttasksresponse
  RAISING
    /AWS1/CX_ECSCLIENTEXCEPTION
    /AWS1/CX_ECSCLUSTERNOTFOUNDEX
    /AWS1/CX_ECSINVALIDPARAMETEREX
    /AWS1/CX_ECSSERVEREXCEPTION
    /AWS1/CX_ECSSERVICENOTFOUNDEX
    /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 to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

iv_containerinstance TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

iv_family TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

iv_nexttoken TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

iv_maxresults TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER

The maximum number of task results that ListTasks returned in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTasks returns up to 100 results and a nextToken value if applicable.

iv_startedby TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The startedBy value to filter the task results with. Specifying a startedBy value limits the results to tasks that were started with that value.

When you specify startedBy as the filter, it must be the only filter that you use.

iv_servicename TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

iv_desiredstatus TYPE /AWS1/ECSDESIREDSTATUS /AWS1/ECSDESIREDSTATUS

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren't starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this doesn't return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

iv_launchtype TYPE /AWS1/ECSLAUNCHTYPE /AWS1/ECSLAUNCHTYPE

The launch type to use when filtering the ListTasks results.

RETURNING

oo_output TYPE REF TO /aws1/cl_ecslisttasksresponse /AWS1/CL_ECSLISTTASKSRESPONSE

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->listtasks(
  iv_cluster = |string|
  iv_containerinstance = |string|
  iv_desiredstatus = |string|
  iv_family = |string|
  iv_launchtype = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_servicename = |string|
  iv_startedby = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_taskarns( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To list the tasks on a particular container instance

This example lists the tasks of a specified container instance. Specifying a containerInstance value limits the results to tasks that belong to that container instance.

DATA(lo_result) = lo_client->listtasks(
  iv_cluster = |default|
  iv_containerinstance = |f6bbb147-5370-4ace-8c73-c7181ded911f|
).

To list the tasks in a cluster

This example lists all of the tasks in a cluster.

DATA(lo_result) = lo_client->listtasks( iv_cluster = |default| ) .