STARTDEPLOYMENT()`¶

About StartDeployment¶

Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository.

The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.

Method Signature¶

METHODS /AWS1/IF_AMF~STARTDEPLOYMENT
  IMPORTING
    !IV_APPID TYPE /AWS1/AMFAPPID OPTIONAL
    !IV_BRANCHNAME TYPE /AWS1/AMFBRANCHNAME OPTIONAL
    !IV_JOBID TYPE /AWS1/AMFJOBID OPTIONAL
    !IV_SOURCEURL TYPE /AWS1/AMFSOURCEURL OPTIONAL
    !IV_SOURCEURLTYPE TYPE /AWS1/AMFSOURCEURLTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_amfstrtdeploymentrslt
  RAISING
    /AWS1/CX_AMFBADREQUESTEX
    /AWS1/CX_AMFINTERNALFAILUREEX
    /AWS1/CX_AMFLIMITEXCEEDEDEX
    /AWS1/CX_AMFNOTFOUNDEXCEPTION
    /AWS1/CX_AMFUNAUTHORIZEDEX
    /AWS1/CX_AMFCLIENTEXC
    /AWS1/CX_AMFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_appid` `TYPE /AWS1/AMFAPPID` `/AWS1/AMFAPPID`¶

The unique ID for an Amplify app.

`iv_branchname` `TYPE /AWS1/AMFBRANCHNAME` `/AWS1/AMFBRANCHNAME`¶

The name of the branch to use for the deployment job.

Optional arguments:¶

`iv_jobid` `TYPE /AWS1/AMFJOBID` `/AWS1/AMFJOBID`¶

The job ID for this deployment that is generated by the CreateDeployment request.

`iv_sourceurl` `TYPE /AWS1/AMFSOURCEURL` `/AWS1/AMFSOURCEURL`¶

The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.

`iv_sourceurltype` `TYPE /AWS1/AMFSOURCEURLTYPE` `/AWS1/AMFSOURCEURLTYPE`¶

The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_amfstrtdeploymentrslt` `/AWS1/CL_AMFSTRTDEPLOYMENTRSLT`¶

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(
  iv_appid = |string|
  iv_branchname = |string|
  iv_jobid = |string|
  iv_sourceurl = |string|
  iv_sourceurltype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_jobsummary = lo_result->get_jobsummary( ).
  IF lo_jobsummary IS NOT INITIAL.
    lv_jobarn = lo_jobsummary->get_jobarn( ).
    lv_jobid = lo_jobsummary->get_jobid( ).
    lv_commitid = lo_jobsummary->get_commitid( ).
    lv_commitmessage = lo_jobsummary->get_commitmessage( ).
    lv_committime = lo_jobsummary->get_committime( ).
    lv_starttime = lo_jobsummary->get_starttime( ).
    lv_jobstatus = lo_jobsummary->get_status( ).
    lv_endtime = lo_jobsummary->get_endtime( ).
    lv_jobtype = lo_jobsummary->get_jobtype( ).
    lv_sourceurl = lo_jobsummary->get_sourceurl( ).
    lv_sourceurltype = lo_jobsummary->get_sourceurltype( ).
  ENDIF.
ENDIF.

/AWS1/IF_AMF=>STARTDEPLOYMENT()¶