IMPORTPUBLICKEY()`¶

About ImportPublicKey¶

Import a public key to be used for signing stage participant tokens.

Method Signature¶

METHODS /AWS1/IF_IVR~IMPORTPUBLICKEY
  IMPORTING
    !IV_PUBLICKEYMATERIAL TYPE /AWS1/IVRPUBLICKEYMATERIAL OPTIONAL
    !IV_NAME TYPE /AWS1/IVRPUBLICKEYNAME OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IVRTAGS_W=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ivrimportpublickeyrsp
  RAISING
    /AWS1/CX_IVRACCESSDENIEDEX
    /AWS1/CX_IVRCONFLICTEXCEPTION
    /AWS1/CX_IVRPENDINGVERIFICAT00
    /AWS1/CX_IVRSERVICEQUOTAEXCDEX
    /AWS1/CX_IVRVALIDATIONEX
    /AWS1/CX_IVRCLIENTEXC
    /AWS1/CX_IVRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_publickeymaterial` `TYPE /AWS1/IVRPUBLICKEYMATERIAL` `/AWS1/IVRPUBLICKEYMATERIAL`¶

The content of the public key to be imported.

Optional arguments:¶

`iv_name` `TYPE /AWS1/IVRPUBLICKEYNAME` `/AWS1/IVRPUBLICKEYNAME`¶

Name of the public key to be imported.

`it_tags` `TYPE /AWS1/CL_IVRTAGS_W=>TT_TAGS` `TT_TAGS`¶

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ivrimportpublickeyrsp` `/AWS1/CL_IVRIMPORTPUBLICKEYRSP`¶

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->importpublickey(
  it_tags = VALUE /aws1/cl_ivrtags_w=>tt_tags(
    (
      VALUE /aws1/cl_ivrtags_w=>ts_tags_maprow(
        key = |string|
        value = new /aws1/cl_ivrtags_w( |string| )
      )
    )
  )
  iv_name = |string|
  iv_publickeymaterial = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_publickey = lo_result->get_publickey( ).
  IF lo_publickey IS NOT INITIAL.
    lv_publickeyarn = lo_publickey->get_arn( ).
    lv_publickeyname = lo_publickey->get_name( ).
    lv_publickeymaterial = lo_publickey->get_publickeymaterial( ).
    lv_publickeyfingerprint = lo_publickey->get_fingerprint( ).
    LOOP AT lo_publickey->get_tags( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_IVR=>IMPORTPUBLICKEY()¶