LISTTASKDEFINITIONS()`¶

About ListTaskDefinitions¶

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

Method Signature¶

METHODS /AWS1/IF_ECS~LISTTASKDEFINITIONS
  IMPORTING
    !IV_FAMILYPREFIX TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_STATUS TYPE /AWS1/ECSTASKDEFINITIONSTATUS OPTIONAL
    !IV_SORT TYPE /AWS1/ECSSORTORDER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ECSBOXEDINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecslisttaskdefnsrsp
  RAISING
    /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_familyprefix` `TYPE /AWS1/ECSSTRING` `/AWS1/ECSSTRING`¶

The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

`iv_status` `TYPE /AWS1/ECSTASKDEFINITIONSTATUS` `/AWS1/ECSTASKDEFINITIONSTATUS`¶

The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

`iv_sort` `TYPE /AWS1/ECSSORTORDER` `/AWS1/ECSSORTORDER`¶

The order to sort the results in. Valid values are ASC and DESC. By default, (ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

`iv_nexttoken` `TYPE /AWS1/ECSSTRING` `/AWS1/ECSSTRING`¶

The nextToken value returned from a ListTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is 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 definition results that ListTaskDefinitions returned in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ecslisttaskdefnsrsp` `/AWS1/CL_ECSLISTTASKDEFNSRSP`¶

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->listtaskdefinitions(
  iv_familyprefix = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sort = |string|
  iv_status = |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_taskdefinitionarns( ) 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 registered task definitions in a family¶

This example lists the task definition revisions of a specified family.

DATA(lo_result) = lo_client->listtaskdefinitions( iv_familyprefix = |wordpress| ) .

To list your registered task definitions¶

This example lists all of your registered task definitions.

DATA(lo_result) = lo_client->listtaskdefinitions( ).

/AWS1/IF_ECS=>LISTTASKDEFINITIONS()¶