DESCRIBEADDRESSES()`¶

About DescribeAddresses¶

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

Method Signature¶

METHODS /AWS1/IF_SNB~DESCRIBEADDRESSES
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/SNBLISTLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SNBSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_snbdescraddressesrslt
  RAISING
    /AWS1/CX_SNBINVALIDNEXTTOKENEX
    /AWS1/CX_SNBINVALIDRESOURCEEX
    /AWS1/CX_SNBCLIENTEXC
    /AWS1/CX_SNBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/SNBLISTLIMIT` `/AWS1/SNBLISTLIMIT`¶

The number of ADDRESS objects to return.

`iv_nexttoken` `TYPE /AWS1/SNBSTRING` `/AWS1/SNBSTRING`¶

HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_snbdescraddressesrslt` `/AWS1/CL_SNBDESCRADDRESSESRSLT`¶

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->describeaddresses(
  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_addresses( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_addressid = lo_row_1->get_addressid( ).
      lv_string = lo_row_1->get_name( ).
      lv_string = lo_row_1->get_company( ).
      lv_string = lo_row_1->get_street1( ).
      lv_string = lo_row_1->get_street2( ).
      lv_string = lo_row_1->get_street3( ).
      lv_string = lo_row_1->get_city( ).
      lv_string = lo_row_1->get_stateorprovince( ).
      lv_string = lo_row_1->get_prefectureordistrict( ).
      lv_string = lo_row_1->get_landmark( ).
      lv_string = lo_row_1->get_country( ).
      lv_string = lo_row_1->get_postalcode( ).
      lv_string = lo_row_1->get_phonenumber( ).
      lv_boolean = lo_row_1->get_isrestricted( ).
      lv_addresstype = lo_row_1->get_type( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To describe all the addresses you've created for AWS Snowball¶

This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

DATA(lo_result) = lo_client->describeaddresses( ).

/AWS1/IF_SNB=>DESCRIBEADDRESSES()¶