DESCRIBEPACKAGES()`¶

About DescribePackages¶

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

Method Signature¶

METHODS /AWS1/IF_ESS~DESCRIBEPACKAGES
  IMPORTING
    !IT_FILTERS TYPE /AWS1/CL_ESSDESCRPACKAGESFILT=>TT_DESCRIBEPACKAGESFILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ESSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ESSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_essdescrpackagesrsp
  RAISING
    /AWS1/CX_ESSACCESSDENIEDEX
    /AWS1/CX_ESSBASEEXCEPTION
    /AWS1/CX_ESSINTERNALEXCEPTION
    /AWS1/CX_ESSRESOURCENOTFOUNDEX
    /AWS1/CX_ESSVALIDATIONEX
    /AWS1/CX_ESSCLIENTEXC
    /AWS1/CX_ESSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_ESSDESCRPACKAGESFILT=>TT_DESCRIBEPACKAGESFILTERLIST` `TT_DESCRIBEPACKAGESFILTERLIST`¶

Only returns packages that match the DescribePackagesFilterList values.

`iv_maxresults` `TYPE /AWS1/ESSMAXRESULTS` `/AWS1/ESSMAXRESULTS`¶

Limits results to a maximum number of packages.

`iv_nexttoken` `TYPE /AWS1/ESSNEXTTOKEN` `/AWS1/ESSNEXTTOKEN`¶

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_essdescrpackagesrsp` `/AWS1/CL_ESSDESCRPACKAGESRSP`¶

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->describepackages(
  it_filters = VALUE /aws1/cl_essdescrpackagesfilt=>tt_describepackagesfilterlist(
    (
      new /aws1/cl_essdescrpackagesfilt(
        it_value = VALUE /aws1/cl_essdscpackagesfiltv00=>tt_descrpackagesfiltervalues(
          ( new /aws1/cl_essdscpackagesfiltv00( |string| ) )
        )
        iv_name = |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_packagedetailslist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_packageid = lo_row_1->get_packageid( ).
      lv_packagename = lo_row_1->get_packagename( ).
      lv_packagetype = lo_row_1->get_packagetype( ).
      lv_packagedescription = lo_row_1->get_packagedescription( ).
      lv_packagestatus = lo_row_1->get_packagestatus( ).
      lv_createdat = lo_row_1->get_createdat( ).
      lv_lastupdated = lo_row_1->get_lastupdatedat( ).
      lv_packageversion = lo_row_1->get_availablepackageversion( ).
      lo_errordetails = lo_row_1->get_errordetails( ).
      IF lo_errordetails IS NOT INITIAL.
        lv_errortype = lo_errordetails->get_errortype( ).
        lv_errormessage = lo_errordetails->get_errormessage( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_ESS=>DESCRIBEPACKAGES()¶