LISTDEPLOYMENTS()`¶

About ListDeployments¶

Retrieves a paginated list of deployments.

Method Signature¶

METHODS /AWS1/IF_GG2~LISTDEPLOYMENTS
  IMPORTING
    !IV_TARGETARN TYPE /AWS1/GG2TARGETARN OPTIONAL
    !IV_HISTORYFILTER TYPE /AWS1/GG2DEPLOYMENTHISTORYFILT OPTIONAL
    !IV_PARENTTARGETARN TYPE /AWS1/GG2THINGGROUPARN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/GG2DEFAULTMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/GG2NEXTTOKENSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gg2listdeploymentsrsp
  RAISING
    /AWS1/CX_GG2ACCESSDENIEDEX
    /AWS1/CX_GG2INTERNALSERVEREX
    /AWS1/CX_GG2THROTTLINGEX
    /AWS1/CX_GG2VALIDATIONEX
    /AWS1/CX_GG2CLIENTEXC
    /AWS1/CX_GG2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_targetarn` `TYPE /AWS1/GG2TARGETARN` `/AWS1/GG2TARGETARN`¶

The ARN of the target IoT thing or thing group.

`iv_historyfilter` `TYPE /AWS1/GG2DEPLOYMENTHISTORYFILT` `/AWS1/GG2DEPLOYMENTHISTORYFILT`¶

The filter for the list of deployments. Choose one of the following options:

ALL – The list includes all deployments.

LATEST_ONLY – The list includes only the latest revision of each deployment.

Default: LATEST_ONLY

`iv_parenttargetarn` `TYPE /AWS1/GG2THINGGROUPARN` `/AWS1/GG2THINGGROUPARN`¶

The parent deployment's target ARN within a subdeployment.

`iv_maxresults` `TYPE /AWS1/GG2DEFAULTMAXRESULTS` `/AWS1/GG2DEFAULTMAXRESULTS`¶

The maximum number of results to be returned per paginated request.

Default: 50

`iv_nexttoken` `TYPE /AWS1/GG2NEXTTOKENSTRING` `/AWS1/GG2NEXTTOKENSTRING`¶

The token to be used for the next set of paginated results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gg2listdeploymentsrsp` `/AWS1/CL_GG2LISTDEPLOYMENTSRSP`¶

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(
  iv_historyfilter = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_parenttargetarn = |string|
  iv_targetarn = |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_targetarn = lo_row_1->get_targetarn( ).
      lv_nonemptystring = lo_row_1->get_revisionid( ).
      lv_nonemptystring = lo_row_1->get_deploymentid( ).
      lv_nonemptystring = lo_row_1->get_deploymentname( ).
      lv_timestamp = lo_row_1->get_creationtimestamp( ).
      lv_deploymentstatus = lo_row_1->get_deploymentstatus( ).
      lv_islatestfortarget = lo_row_1->get_islatestfortarget( ).
      lv_thinggrouparn = lo_row_1->get_parenttargetarn( ).
    ENDIF.
  ENDLOOP.
  lv_nexttokenstring = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_GG2=>LISTDEPLOYMENTS()¶