Skip to content

/AWS1/IF_ECS=>LISTDAEMONDEPLOYMENTS()

About ListDaemonDeployments

Returns a list of daemon deployments for a specified daemon. You can filter the results by status or creation time.

Method Signature

METHODS /AWS1/IF_ECS~LISTDAEMONDEPLOYMENTS
  IMPORTING
    !IV_DAEMONARN TYPE /AWS1/ECSSTRING OPTIONAL
    !IT_STATUS TYPE /AWS1/CL_ECSDAEMDEPLSTATLIST_W=>TT_DAEMONDEPLOYMENTSTATUSLIST OPTIONAL
    !IO_CREATEDAT TYPE REF TO /AWS1/CL_ECSCREATEDAT OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ECSBOXEDINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ECSSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecslstdaemndeploysrsp
  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

Required arguments:

iv_daemonarn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The Amazon Resource Name (ARN) of the daemon to list deployments for.

Optional arguments:

it_status TYPE /AWS1/CL_ECSDAEMDEPLSTATLIST_W=>TT_DAEMONDEPLOYMENTSTATUSLIST TT_DAEMONDEPLOYMENTSTATUSLIST

An optional filter to narrow the ListDaemonDeployments results by deployment status. If you don't specify a status, all deployments are returned.

io_createdat TYPE REF TO /AWS1/CL_ECSCREATEDAT /AWS1/CL_ECSCREATEDAT

An optional filter to narrow the ListDaemonDeployments results by creation time. If you don't specify a time range, all deployments are returned.

iv_maxresults TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER

The maximum number of daemon deployment results that ListDaemonDeployments returned in paginated output. When this parameter is used, ListDaemonDeployments 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 ListDaemonDeployments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListDaemonDeployments returns up to 20 results and a nextToken value if applicable.

iv_nexttoken TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The nextToken value returned from a ListDaemonDeployments request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible for 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.

RETURNING

oo_output TYPE REF TO /aws1/cl_ecslstdaemndeploysrsp /AWS1/CL_ECSLSTDAEMNDEPLOYSRSP

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->listdaemondeployments(
  io_createdat = new /aws1/cl_ecscreatedat(
    iv_after = '20150101000000.0000000'
    iv_before = '20150101000000.0000000'
  )
  it_status = VALUE /aws1/cl_ecsdaemdeplstatlist_w=>tt_daemondeploymentstatuslist(
    ( new /aws1/cl_ecsdaemdeplstatlist_w( |string| ) )
  )
  iv_daemonarn = |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.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_daemondeployments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_daemondeploymentarn( ).
      lv_string = lo_row_1->get_daemonarn( ).
      lv_string = lo_row_1->get_clusterarn( ).
      lv_daemondeploymentstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_statusreason( ).
      lv_string = lo_row_1->get_targetdaemonrevisionarn( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_startedat( ).
      lv_timestamp = lo_row_1->get_stoppedat( ).
      lv_timestamp = lo_row_1->get_finishedat( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To list daemon deployments

This example lists all successful daemon deployments for the my-monitoring-daemon daemon.

DATA(lo_result) = lo_client->listdaemondeployments(
  it_status = VALUE /aws1/cl_ecsdaemdeplstatlist_w=>tt_daemondeploymentstatuslist(
    ( new /aws1/cl_ecsdaemdeplstatlist_w( |SUCCESSFUL| ) )
  )
  iv_daemonarn = |arn:aws:ecs:us-east-1:123456789012:daemon/my-cluster/my-monitoring-daemon|
).