GETDEPOTURL()`¶

About GetDepotUrl¶

Returns a URL and authentication token for accessing the Amazon EVS Custom Addon depot. Configure the depot URL as a download source in vSphere Lifecycle Manager (vLCM) to sync and install the Amazon EVS Custom Addon.

The depot URL remains active until you rotate the authentication token by calling this action with rotate set to true.

Method Signature¶

METHODS /AWS1/IF_EVS~GETDEPOTURL
  IMPORTING
    !IV_ENVIRONMENTID TYPE /AWS1/EVSENVIRONMENTID OPTIONAL
    !IV_ROTATE TYPE /AWS1/EVSBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_evsgetdepoturlrsp
  RAISING
    /AWS1/CX_EVSRESOURCENOTFOUNDEX
    /AWS1/CX_EVSTHROTTLINGEX
    /AWS1/CX_EVSVALIDATIONEX
    /AWS1/CX_EVSCLIENTEXC
    /AWS1/CX_EVSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_environmentid` `TYPE /AWS1/EVSENVIRONMENTID` `/AWS1/EVSENVIRONMENTID`¶

The unique ID of the Amazon EVS environment to get the depot URL for.

Optional arguments:¶

`iv_rotate` `TYPE /AWS1/EVSBOOLEAN` `/AWS1/EVSBOOLEAN`¶

Revokes the current authentication token and returns a new depot URL with a new token. Previously issued depot URLs will stop working within 5 minutes of rotation.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_evsgetdepoturlrsp` `/AWS1/CL_EVSGETDEPOTURLRSP`¶

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->getdepoturl(
  iv_environmentid = |string|
  iv_rotate = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_depoturl( ).
  lv_string = lo_result->get_token( ).
ENDIF.

/AWS1/IF_EVS=>GETDEPOTURL()¶