Skip to content

/AWS1/IF_DZN=>CREATEENVIRONMENT()

About CreateEnvironment

Create an Amazon DataZone environment.

Method Signature

METHODS /AWS1/IF_DZN~CREATEENVIRONMENT
  IMPORTING
    !IV_PROJECTIDENTIFIER TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/DZNSTRING OPTIONAL
    !IV_NAME TYPE /AWS1/DZNSTRING OPTIONAL
    !IV_ENVIRONMENTPROFILEID00 TYPE /AWS1/DZNENVIRONMENTPROFILEID OPTIONAL
    !IT_USERPARAMETERS TYPE /AWS1/CL_DZNENVIRONMENTPARAM=>TT_ENVIRONMENTPARAMETERSLIST OPTIONAL
    !IT_GLOSSARYTERMS TYPE /AWS1/CL_DZNGLOSSARYTERMS_W=>TT_GLOSSARYTERMS OPTIONAL
    !IV_ENVIRONMENTACCOUNTID TYPE /AWS1/DZNSTRING OPTIONAL
    !IV_ENVIRONMENTACCOUNTREGION TYPE /AWS1/DZNSTRING OPTIONAL
    !IV_ENVIRONMENTBLUEPRINTID00 TYPE /AWS1/DZNSTRING OPTIONAL
    !IV_DEPLOYMENTORDER TYPE /AWS1/DZNINTEGER OPTIONAL
    !IV_ENVIRONMENTCONFID TYPE /AWS1/DZNSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dzncreenvironmentout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNCONFLICTEXCEPTION
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_projectidentifier TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

The identifier of the Amazon DataZone project in which this environment is created.

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

The identifier of the Amazon DataZone domain in which the environment is created.

iv_name TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The name of the Amazon DataZone environment.

Optional arguments:

iv_description TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The description of the Amazon DataZone environment.

iv_environmentprofileid00 TYPE /AWS1/DZNENVIRONMENTPROFILEID /AWS1/DZNENVIRONMENTPROFILEID

The identifier of the environment profile that is used to create this Amazon DataZone environment.

it_userparameters TYPE /AWS1/CL_DZNENVIRONMENTPARAM=>TT_ENVIRONMENTPARAMETERSLIST TT_ENVIRONMENTPARAMETERSLIST

The user parameters of this Amazon DataZone environment.

it_glossaryterms TYPE /AWS1/CL_DZNGLOSSARYTERMS_W=>TT_GLOSSARYTERMS TT_GLOSSARYTERMS

The glossary terms that can be used in this Amazon DataZone environment.

iv_environmentaccountid TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The ID of the account in which the environment is being created.

iv_environmentaccountregion TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The region of the account in which the environment is being created.

iv_environmentblueprintid00 TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The ID of the blueprint with which the environment is being created.

iv_deploymentorder TYPE /AWS1/DZNINTEGER /AWS1/DZNINTEGER

The deployment order of the environment.

iv_environmentconfid TYPE /AWS1/DZNSTRING /AWS1/DZNSTRING

The configuration ID of the environment.

RETURNING

oo_output TYPE REF TO /aws1/cl_dzncreenvironmentout /AWS1/CL_DZNCREENVIRONMENTOUT

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->createenvironment(
  it_glossaryterms = VALUE /aws1/cl_dznglossaryterms_w=>tt_glossaryterms(
    ( new /aws1/cl_dznglossaryterms_w( |string| ) )
  )
  it_userparameters = VALUE /aws1/cl_dznenvironmentparam=>tt_environmentparameterslist(
    (
      new /aws1/cl_dznenvironmentparam(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  iv_deploymentorder = 123
  iv_description = |string|
  iv_domainidentifier = |string|
  iv_environmentaccountid = |string|
  iv_environmentaccountregion = |string|
  iv_environmentblueprintid00 = |string|
  iv_environmentconfid = |string|
  iv_environmentprofileid00 = |string|
  iv_name = |string|
  iv_projectidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_projectid = lo_result->get_projectid( ).
  lv_environmentid = lo_result->get_id( ).
  lv_domainid = lo_result->get_domainid( ).
  lv_string = lo_result->get_createdby( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_updatedat( ).
  lv_environmentname = lo_result->get_name( ).
  lv_description = lo_result->get_description( ).
  lv_environmentprofileid = lo_result->get_environmentprofileid( ).
  lv_awsaccountid = lo_result->get_awsaccountid( ).
  lv_awsregion = lo_result->get_awsaccountregion( ).
  lv_string = lo_result->get_provider( ).
  LOOP AT lo_result->get_provisionedresources( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_provider( ).
      lv_string = lo_row_1->get_name( ).
      lv_string = lo_row_1->get_value( ).
      lv_string = lo_row_1->get_type( ).
    ENDIF.
  ENDLOOP.
  lv_environmentstatus = lo_result->get_status( ).
  LOOP AT lo_result->get_environmentactions( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_string = lo_row_3->get_type( ).
      lv_configurableactiontypea = lo_row_3->get_auth( ).
      LOOP AT lo_row_3->get_parameters( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_key( ).
          lv_string = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_glossaryterms( ) into lo_row_6.
    lo_row_7 = lo_row_6.
    IF lo_row_7 IS NOT INITIAL.
      lv_glossarytermid = lo_row_7->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_userparameters( ) into lo_row_8.
    lo_row_9 = lo_row_8.
    IF lo_row_9 IS NOT INITIAL.
      lv_string = lo_row_9->get_keyname( ).
      lv_description = lo_row_9->get_description( ).
      lv_string = lo_row_9->get_fieldtype( ).
      lv_string = lo_row_9->get_defaultvalue( ).
      lv_boolean = lo_row_9->get_iseditable( ).
      lv_boolean = lo_row_9->get_isoptional( ).
      lv_boolean = lo_row_9->get_isupdatesupported( ).
    ENDIF.
  ENDLOOP.
  lo_deployment = lo_result->get_lastdeployment( ).
  IF lo_deployment IS NOT INITIAL.
    lv_string = lo_deployment->get_deploymentid( ).
    lv_deploymenttype = lo_deployment->get_deploymenttype( ).
    lv_deploymentstatus = lo_deployment->get_deploymentstatus( ).
    lo_environmenterror = lo_deployment->get_failurereason( ).
    IF lo_environmenterror IS NOT INITIAL.
      lv_string = lo_environmenterror->get_code( ).
      lv_string = lo_environmenterror->get_message( ).
    ENDIF.
    LOOP AT lo_deployment->get_messages( ) into lo_row_10.
      lo_row_11 = lo_row_10.
      IF lo_row_11 IS NOT INITIAL.
        lv_deploymentmessage = lo_row_11->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_boolean = lo_deployment->get_isdeploymentcomplete( ).
  ENDIF.
  lo_provisioningproperties = lo_result->get_provisioningproperties( ).
  IF lo_provisioningproperties IS NOT INITIAL.
    lo_cloudformationpropertie = lo_provisioningproperties->get_cloudformation( ).
    IF lo_cloudformationpropertie IS NOT INITIAL.
      lv_string = lo_cloudformationpropertie->get_templateurl( ).
    ENDIF.
  ENDIF.
  lo_deploymentproperties = lo_result->get_deploymentproperties( ).
  IF lo_deploymentproperties IS NOT INITIAL.
    lv_integer = lo_deploymentproperties->get_starttimeoutminutes( ).
    lv_integer = lo_deploymentproperties->get_endtimeoutminutes( ).
  ENDIF.
  lv_environmentblueprintid = lo_result->get_environmentblueprintid( ).
  lv_environmentconfiguratio = lo_result->get_environmentconfid( ).
ENDIF.