LISTTASKDEFINITIONFAMILIES()`¶

About ListTaskDefinitionFamilies¶

Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

You can filter out task definition families that don't contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

Method Signature¶

METHODS /AWS1/IF_ECS~LISTTASKDEFINITIONFAMILIES
  IMPORTING
    !IV_FAMILYPREFIX TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_STATUS TYPE /AWS1/ECSTASKDEFNFAMILYSTATUS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ECSBOXEDINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecslsttskdeffamilie01
  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 familyPrefix is a string that's used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

`iv_status` `TYPE /AWS1/ECSTASKDEFNFAMILYSTATUS` `/AWS1/ECSTASKDEFNFAMILYSTATUS`¶

The task definition family status to filter the ListTaskDefinitionFamilies results with. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

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

The nextToken value returned from a ListTaskDefinitionFamilies 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 family results that ListTaskDefinitionFamilies 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 ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ecslsttskdeffamilie01` `/AWS1/CL_ECSLSTTSKDEFFAMILIE01`¶

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->listtaskdefinitionfamilies(
  iv_familyprefix = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_families( ) 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 filter your registered task definition families¶

This example lists the task definition revisions that start with "hpcc".

DATA(lo_result) = lo_client->listtaskdefinitionfamilies( iv_familyprefix = |hpcc| ) .

To list your registered task definition families¶

This example lists all of your registered task definition families.

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

/AWS1/IF_ECS=>LISTTASKDEFINITIONFAMILIES()¶