Skip to content

/AWS1/IF_DZN=>LISTENVIRONMENTS()

About ListEnvironments

Lists Amazon DataZone environments.

Method Signature

METHODS /AWS1/IF_DZN~LISTENVIRONMENTS
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_AWSACCOUNTID TYPE /AWS1/DZNAWSACCOUNTID OPTIONAL
    !IV_STATUS TYPE /AWS1/DZNENVIRONMENTSTATUS OPTIONAL
    !IV_AWSACCOUNTREGION TYPE /AWS1/DZNAWSREGION OPTIONAL
    !IV_PROJECTIDENTIFIER TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IV_ENVIRONMENTPROFILEID00 TYPE /AWS1/DZNENVIRONMENTPROFILEID OPTIONAL
    !IV_ENVIRONMENTBLUEPRINTID00 TYPE /AWS1/DZNENVIRONMENTBLUEPRIN00 OPTIONAL
    !IV_PROVIDER TYPE /AWS1/DZNSTRING OPTIONAL
    !IV_NAME TYPE /AWS1/DZNSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DZNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznlstenvironmentsout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

The identifier of the Amazon DataZone domain.

iv_projectidentifier TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

The identifier of the Amazon DataZone project.

Optional arguments:

iv_awsaccountid TYPE /AWS1/DZNAWSACCOUNTID /AWS1/DZNAWSACCOUNTID

The identifier of the Amazon Web Services account where you want to list environments.

iv_status TYPE /AWS1/DZNENVIRONMENTSTATUS /AWS1/DZNENVIRONMENTSTATUS

The status of the environments that you want to list.

iv_awsaccountregion TYPE /AWS1/DZNAWSREGION /AWS1/DZNAWSREGION

The Amazon Web Services region where you want to list environments.

iv_environmentprofileid00 TYPE /AWS1/DZNENVIRONMENTPROFILEID /AWS1/DZNENVIRONMENTPROFILEID

The identifier of the environment profile.

iv_environmentblueprintid00 TYPE /AWS1/DZNENVIRONMENTBLUEPRIN00 /AWS1/DZNENVIRONMENTBLUEPRIN00

The identifier of the Amazon DataZone blueprint.

iv_provider TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The provider of the environment.

iv_name TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The name of the environment.

iv_maxresults TYPE /AWS1/DZNMAXRESULTS /AWS1/DZNMAXRESULTS

The maximum number of environments to return in a single call to ListEnvironments. When the number of environments 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 ListEnvironments to list the next set of environments.

iv_nexttoken TYPE /AWS1/DZNPAGINATIONTOKEN /AWS1/DZNPAGINATIONTOKEN

When the number of environments 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 environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

RETURNING

oo_output TYPE REF TO /aws1/cl_dznlstenvironmentsout /AWS1/CL_DZNLSTENVIRONMENTSOUT

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->listenvironments(
  iv_awsaccountid = |string|
  iv_awsaccountregion = |string|
  iv_domainidentifier = |string|
  iv_environmentblueprintid00 = |string|
  iv_environmentprofileid00 = |string|
  iv_maxresults = 123
  iv_name = |string|
  iv_nexttoken = |string|
  iv_projectidentifier = |string|
  iv_provider = |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_projectid = lo_row_1->get_projectid( ).
      lv_environmentid = lo_row_1->get_id( ).
      lv_domainid = lo_row_1->get_domainid( ).
      lv_string = lo_row_1->get_createdby( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
      lv_environmentname = lo_row_1->get_name( ).
      lv_description = lo_row_1->get_description( ).
      lv_environmentprofileid = lo_row_1->get_environmentprofileid( ).
      lv_awsaccountid = lo_row_1->get_awsaccountid( ).
      lv_awsregion = lo_row_1->get_awsaccountregion( ).
      lv_string = lo_row_1->get_provider( ).
      lv_environmentstatus = lo_row_1->get_status( ).
      lv_environmentconfiguratio = lo_row_1->get_environmentconfid( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.