LISTDOMAINS()`¶

About ListDomains¶

Lists Amazon DataZone domains.

Method Signature¶

METHODS /AWS1/IF_DZN~LISTDOMAINS
  IMPORTING
    !IV_STATUS TYPE /AWS1/DZNDOMAINSTATUS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DZNMAXRESULTSFORLISTDOMS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznlistdomainsoutput
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNCONFLICTEXCEPTION
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /AWS1/CX_DZNSERVICEQUOTAEXCDEX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_status` `TYPE /AWS1/DZNDOMAINSTATUS` `/AWS1/DZNDOMAINSTATUS`¶

The status of the data source.

`iv_maxresults` `TYPE /AWS1/DZNMAXRESULTSFORLISTDOMS` `/AWS1/DZNMAXRESULTSFORLISTDOMS`¶

The maximum number of domains to return in a single call to ListDomains. When the number of domains to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomains to list the next set of domains.

`iv_nexttoken` `TYPE /AWS1/DZNPAGINATIONTOKEN` `/AWS1/DZNPAGINATIONTOKEN`¶

When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dznlistdomainsoutput` `/AWS1/CL_DZNLISTDOMAINSOUTPUT`¶

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->listdomains(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_status = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_domainid = lo_row_1->get_id( ).
      lv_domainname = lo_row_1->get_name( ).
      lv_domaindescription = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_arn( ).
      lv_string = lo_row_1->get_managedaccountid( ).
      lv_domainstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_portalurl( ).
      lv_createdat = lo_row_1->get_createdat( ).
      lv_updatedat = lo_row_1->get_lastupdatedat( ).
      lv_domainversion = lo_row_1->get_domainversion( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_DZN=>LISTDOMAINS()¶