/AWS1/IF_APC=>STARTDEPLOYMENT()

About StartDeployment

Starts a deployment.

Method Signature

METHODS /AWS1/IF_APC~STARTDEPLOYMENT
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/APCID OPTIONAL
    !IV_ENVIRONMENTID TYPE /AWS1/APCID OPTIONAL
    !IV_DEPLOYMENTSTRATEGYID TYPE /AWS1/APCDEPLOYMENTSTRATEGYID OPTIONAL
    !IV_CONFIGURATIONPROFILEID TYPE /AWS1/APCID OPTIONAL
    !IV_CONFIGURATIONVERSION TYPE /AWS1/APCVERSION OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/APCDESCRIPTION OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_APCTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_KMSKEYIDENTIFIER TYPE /AWS1/APCKMSKEYIDENTIFIER OPTIONAL
    !IT_DYNAMICEXTENSIONPARAMS TYPE /AWS1/CL_APCDYNAMICPARAMMAP_W=>TT_DYNAMICPARAMETERMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_apcdeployment
  RAISING
    /AWS1/CX_APCBADREQUESTEX
    /AWS1/CX_APCCONFLICTEXCEPTION
    /AWS1/CX_APCINTERNALSERVEREX
    /AWS1/CX_APCRESOURCENOTFOUNDEX
    /AWS1/CX_APCCLIENTEXC
    /AWS1/CX_APCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/APCID /AWS1/APCID

The application ID.

iv_environmentid TYPE /AWS1/APCID /AWS1/APCID

The environment ID.

iv_deploymentstrategyid TYPE /AWS1/APCDEPLOYMENTSTRATEGYID /AWS1/APCDEPLOYMENTSTRATEGYID

The deployment strategy ID.

iv_configurationprofileid TYPE /AWS1/APCID /AWS1/APCID

The configuration profile ID.

iv_configurationversion TYPE /AWS1/APCVERSION /AWS1/APCVERSION

The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

Optional arguments:

iv_description TYPE /AWS1/APCDESCRIPTION /AWS1/APCDESCRIPTION

A description of the deployment.

it_tags TYPE /AWS1/CL_APCTAGMAP_W=>TT_TAGMAP TT_TAGMAP

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

iv_kmskeyidentifier TYPE /AWS1/APCKMSKEYIDENTIFIER /AWS1/APCKMSKEYIDENTIFIER

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

it_dynamicextensionparams TYPE /AWS1/CL_APCDYNAMICPARAMMAP_W=>TT_DYNAMICPARAMETERMAP TT_DYNAMICPARAMETERMAP

A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

RETURNING

oo_output TYPE REF TO /aws1/cl_apcdeployment /AWS1/CL_APCDEPLOYMENT

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->startdeployment(
  it_dynamicextensionparams = VALUE /aws1/cl_apcdynamicparammap_w=>tt_dynamicparametermap(
    (
      VALUE /aws1/cl_apcdynamicparammap_w=>ts_dynamicparametermap_maprow(
        key = |string|
        value = new /aws1/cl_apcdynamicparammap_w( |string| )
      )
    )
  )
  it_tags = VALUE /aws1/cl_apctagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_apctagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_apctagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_applicationid = |string|
  iv_configurationprofileid = |string|
  iv_configurationversion = |string|
  iv_deploymentstrategyid = |string|
  iv_description = |string|
  iv_environmentid = |string|
  iv_kmskeyidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_applicationid( ).
  lv_id = lo_result->get_environmentid( ).
  lv_id = lo_result->get_deploymentstrategyid( ).
  lv_id = lo_result->get_configurationprofileid( ).
  lv_integer = lo_result->get_deploymentnumber( ).
  lv_name = lo_result->get_configurationname( ).
  lv_uri = lo_result->get_configurationlocationuri( ).
  lv_version = lo_result->get_configurationversion( ).
  lv_description = lo_result->get_description( ).
  lv_minutesbetween0and24hou = lo_result->get_deploymentdurinminutes( ).
  lv_growthtype = lo_result->get_growthtype( ).
  lv_percentage = lo_result->get_growthfactor( ).
  lv_minutesbetween0and24hou = lo_result->get_finalbaketimeinminutes( ).
  lv_deploymentstate = lo_result->get_state( ).
  LOOP AT lo_result->get_eventlog( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_deploymenteventtype = lo_row_1->get_eventtype( ).
      lv_triggeredby = lo_row_1->get_triggeredby( ).
      lv_description = lo_row_1->get_description( ).
      LOOP AT lo_row_1->get_actioninvocations( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_identifier = lo_row_3->get_extensionidentifier( ).
          lv_name = lo_row_3->get_actionname( ).
          lv_uri = lo_row_3->get_uri( ).
          lv_arn = lo_row_3->get_rolearn( ).
          lv_string = lo_row_3->get_errormessage( ).
          lv_string = lo_row_3->get_errorcode( ).
          lv_id = lo_row_3->get_invocationid( ).
        ENDIF.
      ENDLOOP.
      lv_iso8601datetime = lo_row_1->get_occurredat( ).
    ENDIF.
  ENDLOOP.
  lv_percentage = lo_result->get_percentagecomplete( ).
  lv_iso8601datetime = lo_result->get_startedat( ).
  lv_iso8601datetime = lo_result->get_completedat( ).
  LOOP AT lo_result->get_appliedextensions( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_id = lo_row_5->get_extensionid( ).
      lv_id = lo_row_5->get_extensionassociationid( ).
      lv_integer = lo_row_5->get_versionnumber( ).
      LOOP AT lo_row_5->get_parameters( ) into ls_row_6.
        lv_key = ls_row_6-key.
        lo_value = ls_row_6-value.
        IF lo_value IS NOT INITIAL.
          lv_stringwithlengthbetween = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_arn = lo_result->get_kmskeyarn( ).
  lv_kmskeyidentifier = lo_result->get_kmskeyidentifier( ).
  lv_versionlabel = lo_result->get_versionlabel( ).
ENDIF.