/AWS1/IF_ECS=>LISTDAEMONS()¶
About ListDaemons¶
Returns a list of daemons. You can filter the results by cluster or capacity provider.
Method Signature¶
METHODS /AWS1/IF_ECS~LISTDAEMONS
IMPORTING
!IV_CLUSTERARN TYPE /AWS1/ECSSTRING OPTIONAL
!IT_CAPACITYPROVIDERARNS TYPE /AWS1/CL_ECSSTRINGLIST_W=>TT_STRINGLIST OPTIONAL
!IV_MAXRESULTS TYPE /AWS1/ECSBOXEDINTEGER OPTIONAL
!IV_NEXTTOKEN TYPE /AWS1/ECSSTRING OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecslistdaemonsrsp
RAISING
/AWS1/CX_ECSACCESSDENIEDEX
/AWS1/CX_ECSCLIENTEXCEPTION
/AWS1/CX_ECSCLUSTERNOTFOUNDEX
/AWS1/CX_ECSINVALIDPARAMETEREX
/AWS1/CX_ECSSERVEREXCEPTION
/AWS1/CX_ECSUNSUPPEDFEATUREEX
/AWS1/CX_ECSCLIENTEXC
/AWS1/CX_ECSSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Optional arguments:¶
iv_clusterarn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The Amazon Resource Name (ARN) of the cluster to filter daemons by. If not specified, daemons from all clusters are returned.
it_capacityproviderarns TYPE /AWS1/CL_ECSSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST¶
The Amazon Resource Names (ARNs) of the capacity providers to filter daemons by. Only daemons associated with the specified capacity providers are returned.
iv_maxresults TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER¶
The maximum number of daemon results that
ListDaemonsreturned in paginated output. When this parameter is used,ListDaemonsonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListDaemonsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter isn't used, thenListDaemonsreturns up to 100 results and anextTokenvalue if applicable.
iv_nexttoken TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The
nextTokenvalue returned from aListDaemonsrequest indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResultswas provided, it's possible for the number of results to be fewer thanmaxResults.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.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_ecslistdaemonsrsp /AWS1/CL_ECSLISTDAEMONSRSP¶
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->listdaemons(
it_capacityproviderarns = VALUE /aws1/cl_ecsstringlist_w=>tt_stringlist(
( new /aws1/cl_ecsstringlist_w( |string| ) )
)
iv_clusterarn = |string|
iv_maxresults = 123
iv_nexttoken = |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_daemonsummarieslist( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_string = lo_row_1->get_daemonarn( ).
lv_daemonstatus = lo_row_1->get_status( ).
lv_timestamp = lo_row_1->get_createdat( ).
lv_timestamp = lo_row_1->get_updatedat( ).
ENDIF.
ENDLOOP.
lv_string = lo_result->get_nexttoken( ).
ENDIF.
To list daemons in a cluster¶
This example lists all daemons in the specified cluster.
DATA(lo_result) = lo_client->listdaemons( iv_clusterarn = |arn:aws:ecs:us-east-1:123456789012:cluster/my-cluster| ) .