LISTDEPLOYMENTINSTANCES()`¶

About ListDeploymentInstances¶

The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda.

Lists the instance for a deployment associated with the user or Amazon Web Services account.

Method Signature¶

METHODS /AWS1/IF_DPL~LISTDEPLOYMENTINSTANCES
  IMPORTING
    !IV_DEPLOYMENTID TYPE /AWS1/DPLDEPLOYMENTID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DPLNEXTTOKEN OPTIONAL
    !IT_INSTANCESTATUSFILTER TYPE /AWS1/CL_DPLINSTSTATUSLIST_W=>TT_INSTANCESTATUSLIST OPTIONAL
    !IT_INSTANCETYPEFILTER TYPE /AWS1/CL_DPLINSTANCETYPELIST_W=>TT_INSTANCETYPELIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dpllstdeploymentins01
  RAISING
    /AWS1/CX_DPLDEPLOYMENTDOESNO00
    /AWS1/CX_DPLDEPLOYMENTIDREQU00
    /AWS1/CX_DPLDEPLOYMENTNOTSTR00
    /AWS1/CX_DPLINVCOMPUTEPLATFO00
    /AWS1/CX_DPLINVDEPLOYMENTIDEX
    /AWS1/CX_DPLINVDEPLOYMENTINS00
    /AWS1/CX_DPLINVINSTSTATUSEX
    /AWS1/CX_DPLINVALIDINSTTYPEEX
    /AWS1/CX_DPLINVALIDNEXTTOKENEX
    /AWS1/CX_DPLINVTGTFILTERNAMEEX
    /AWS1/CX_DPLCLIENTEXC
    /AWS1/CX_DPLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_deploymentid` `TYPE /AWS1/DPLDEPLOYMENTID` `/AWS1/DPLDEPLOYMENTID`¶

The unique ID of a deployment.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/DPLNEXTTOKEN` `/AWS1/DPLNEXTTOKEN`¶

An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.

`it_instancestatusfilter` `TYPE /AWS1/CL_DPLINSTSTATUSLIST_W=>TT_INSTANCESTATUSLIST` `TT_INSTANCESTATUSLIST`¶

A subset of instances to list by status:

Pending: Include those instances with pending deployments.

InProgress: Include those instances where deployments are still in progress.

Succeeded: Include those instances with successful deployments.

Failed: Include those instances with failed deployments.

Skipped: Include those instances with skipped deployments.

Unknown: Include those instances with deployments in an unknown state.

`it_instancetypefilter` `TYPE /AWS1/CL_DPLINSTANCETYPELIST_W=>TT_INSTANCETYPELIST` `TT_INSTANCETYPELIST`¶

The set of instances in a blue/green deployment, either those in the original environment ("BLUE") or those in the replacement environment ("GREEN"), for which you want to view instance information.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dpllstdeploymentins01` `/AWS1/CL_DPLLSTDEPLOYMENTINS01`¶

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->listdeploymentinstances(
  it_instancestatusfilter = VALUE /aws1/cl_dplinststatuslist_w=>tt_instancestatuslist(
    ( new /aws1/cl_dplinststatuslist_w( |string| ) )
  )
  it_instancetypefilter = VALUE /aws1/cl_dplinstancetypelist_w=>tt_instancetypelist(
    ( new /aws1/cl_dplinstancetypelist_w( |string| ) )
  )
  iv_deploymentid = |string|
  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_instanceslist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_instanceid = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_DPL=>LISTDEPLOYMENTINSTANCES()¶