PUTLCEVENTHOOKEXECSTATUS()`¶

About PutLifecycleEventHookExecutionStatus¶

Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are BeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the available lifecycle hooks are BeforeInstall, AfterInstall, AfterAllowTestTraffic, BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.

Method Signature¶

METHODS /AWS1/IF_DPL~PUTLCEVENTHOOKEXECSTATUS
  IMPORTING
    !IV_DEPLOYMENTID TYPE /AWS1/DPLDEPLOYMENTID OPTIONAL
    !IV_LCEVENTHOOKEXECUTIONID TYPE /AWS1/DPLLCEVENTHOOKEXECID OPTIONAL
    !IV_STATUS TYPE /AWS1/DPLLIFECYCLEEVENTSTATUS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dplputlcevthookexst01
  RAISING
    /AWS1/CX_DPLDEPLOYMENTDOESNO00
    /AWS1/CX_DPLDEPLOYMENTIDREQU00
    /AWS1/CX_DPLINVDEPLOYMENTIDEX
    /AWS1/CX_DPLINVLCEVTHOOKEXIDEX
    /AWS1/CX_DPLINVLCEVTHOOKEXST00
    /AWS1/CX_DPLLCEVTALRDYCOMPLDEX
    /AWS1/CX_DPLUNSUPPEDACTFORDE00
    /AWS1/CX_DPLCLIENTEXC
    /AWS1/CX_DPLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_deploymentid` `TYPE /AWS1/DPLDEPLOYMENTID` `/AWS1/DPLDEPLOYMENTID`¶

The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.

`iv_lceventhookexecutionid` `TYPE /AWS1/DPLLCEVENTHOOKEXECID` `/AWS1/DPLLCEVENTHOOKEXECID`¶

The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.

`iv_status` `TYPE /AWS1/DPLLIFECYCLEEVENTSTATUS` `/AWS1/DPLLIFECYCLEEVENTSTATUS`¶

The result of a Lambda function that validates a deployment lifecycle event. The values listed in Valid Values are valid for lifecycle statuses in general; however, only Succeeded and Failed can be passed successfully in your API call.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dplputlcevthookexst01` `/AWS1/CL_DPLPUTLCEVTHOOKEXST01`¶

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->putlceventhookexecstatus(
  iv_deploymentid = |string|
  iv_lceventhookexecutionid = |string|
  iv_status = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_lifecycleeventhookexecu = lo_result->get_lceventhookexecutionid( ).
ENDIF.

/AWS1/IF_DPL=>PUTLCEVENTHOOKEXECSTATUS()¶