Skip to content

/AWS1/IF_DPL=>LISTDEPLOYMENTS()

About ListDeployments

Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.

Method Signature

METHODS /AWS1/IF_DPL~LISTDEPLOYMENTS
  IMPORTING
    !IV_APPLICATIONNAME TYPE /AWS1/DPLAPPLICATIONNAME OPTIONAL
    !IV_DEPLOYMENTGROUPNAME TYPE /AWS1/DPLDEPLOYMENTGROUPNAME OPTIONAL
    !IV_EXTERNALID TYPE /AWS1/DPLEXTERNALID OPTIONAL
    !IT_INCLUDEONLYSTATUSES TYPE /AWS1/CL_DPLDEPLOYMENTSTATLS00=>TT_DEPLOYMENTSTATUSLIST OPTIONAL
    !IO_CREATETIMERANGE TYPE REF TO /AWS1/CL_DPLTIMERANGE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DPLNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dpllistdeploymentsout
  RAISING
    /AWS1/CX_DPLAPPLICATIONDOESN00
    /AWS1/CX_DPLAPPLICATIONNAMER00
    /AWS1/CX_DPLDEPLOYMENTGRDOES00
    /AWS1/CX_DPLDEPLOYMENTGRNAME00
    /AWS1/CX_DPLINVAPPLICATIONNA00
    /AWS1/CX_DPLINVDEPLOYMENTGRN00
    /AWS1/CX_DPLINVDEPLOYMENTSTA00
    /AWS1/CX_DPLINVEXTERNALIDEX
    /AWS1/CX_DPLINVALIDINPUTEX
    /AWS1/CX_DPLINVALIDNEXTTOKENEX
    /AWS1/CX_DPLINVALIDTIMERANGEEX
    /AWS1/CX_DPLCLIENTEXC
    /AWS1/CX_DPLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_applicationname TYPE /AWS1/DPLAPPLICATIONNAME /AWS1/DPLAPPLICATIONNAME

The name of an CodeDeploy application associated with the user or Amazon Web Services account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

iv_deploymentgroupname TYPE /AWS1/DPLDEPLOYMENTGROUPNAME /AWS1/DPLDEPLOYMENTGROUPNAME

The name of a deployment group for the specified application.

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

iv_externalid TYPE /AWS1/DPLEXTERNALID /AWS1/DPLEXTERNALID

The unique ID of an external resource for returning deployments linked to the external resource.

it_includeonlystatuses TYPE /AWS1/CL_DPLDEPLOYMENTSTATLS00=>TT_DEPLOYMENTSTATUSLIST TT_DEPLOYMENTSTATUSLIST

A subset of deployments to list by status:

  • Created: Include created deployments in the resulting list.

  • Queued: Include queued deployments in the resulting list.

  • In Progress: Include in-progress deployments in the resulting list.

  • Succeeded: Include successful deployments in the resulting list.

  • Failed: Include failed deployments in the resulting list.

  • Stopped: Include stopped deployments in the resulting list.

io_createtimerange TYPE REF TO /AWS1/CL_DPLTIMERANGE /AWS1/CL_DPLTIMERANGE

A time range (start and end) for returning a subset of the list of deployments.

iv_nexttoken TYPE /AWS1/DPLNEXTTOKEN /AWS1/DPLNEXTTOKEN

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

RETURNING

oo_output TYPE REF TO /aws1/cl_dpllistdeploymentsout /AWS1/CL_DPLLISTDEPLOYMENTSOUT

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->listdeployments(
  io_createtimerange = new /aws1/cl_dpltimerange(
    iv_end = '20150101000000.0000000'
    iv_start = '20150101000000.0000000'
  )
  it_includeonlystatuses = VALUE /aws1/cl_dpldeploymentstatls00=>tt_deploymentstatuslist(
    ( new /aws1/cl_dpldeploymentstatls00( |string| ) )
  )
  iv_applicationname = |string|
  iv_deploymentgroupname = |string|
  iv_externalid = |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_deployments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_deploymentid = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.