Skip to content

/AWS1/IF_IVR=>CREATEINGESTCONFIGURATION()

About CreateIngestConfiguration

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

Method Signature

METHODS /AWS1/IF_IVR~CREATEINGESTCONFIGURATION
  IMPORTING
    !IV_NAME TYPE /AWS1/IVRINGESTCONFNAME OPTIONAL
    !IV_STAGEARN TYPE /AWS1/IVRINGESTCONFSTAGEARN OPTIONAL
    !IV_USERID TYPE /AWS1/IVRUSERID OPTIONAL
    !IT_ATTRIBUTES TYPE /AWS1/CL_IVRPARTICIPANTATTRS_W=>TT_PARTICIPANTATTRIBUTES OPTIONAL
    !IV_INGESTPROTOCOL TYPE /AWS1/IVRINGESTPROTOCOL OPTIONAL
    !IV_INSECUREINGEST TYPE /AWS1/IVRINSECUREINGEST OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IVRTAGS_W=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ivrcreingestconfrsp
  RAISING
    /AWS1/CX_IVRACCESSDENIEDEX
    /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_ingestprotocol TYPE /AWS1/IVRINGESTPROTOCOL /AWS1/IVRINGESTPROTOCOL

Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

Optional arguments:

iv_name TYPE /AWS1/IVRINGESTCONFNAME /AWS1/IVRINGESTCONFNAME

Optional name that can be specified for the IngestConfiguration being created.

iv_stagearn TYPE /AWS1/IVRINGESTCONFSTAGEARN /AWS1/IVRINGESTCONFSTAGEARN

ARN of the stage with which the IngestConfiguration is associated.

iv_userid TYPE /AWS1/IVRUSERID /AWS1/IVRUSERID

Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

it_attributes TYPE /AWS1/CL_IVRPARTICIPANTATTRS_W=>TT_PARTICIPANTATTRIBUTES TT_PARTICIPANTATTRIBUTES

Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

iv_insecureingest TYPE /AWS1/IVRINSECUREINGEST /AWS1/IVRINSECUREINGEST

Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.

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_ivrcreingestconfrsp /AWS1/CL_IVRCREINGESTCONFRSP

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->createingestconfiguration(
  it_attributes = VALUE /aws1/cl_ivrparticipantattrs_w=>tt_participantattributes(
    (
      VALUE /aws1/cl_ivrparticipantattrs_w=>ts_participantattrs_maprow(
        value = new /aws1/cl_ivrparticipantattrs_w( |string| )
        key = |string|
      )
    )
  )
  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_ingestprotocol = |string|
  iv_insecureingest = ABAP_TRUE
  iv_name = |string|
  iv_stagearn = |string|
  iv_userid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_ingestconfiguration = lo_result->get_ingestconfiguration( ).
  IF lo_ingestconfiguration IS NOT INITIAL.
    lv_ingestconfigurationname = lo_ingestconfiguration->get_name( ).
    lv_ingestconfigurationarn = lo_ingestconfiguration->get_arn( ).
    lv_ingestprotocol = lo_ingestconfiguration->get_ingestprotocol( ).
    lv_streamkey = lo_ingestconfiguration->get_streamkey( ).
    lv_ingestconfigurationstag = lo_ingestconfiguration->get_stagearn( ).
    lv_participantid = lo_ingestconfiguration->get_participantid( ).
    lv_ingestconfigurationstat = lo_ingestconfiguration->get_state( ).
    lv_userid = lo_ingestconfiguration->get_userid( ).
    LOOP AT lo_ingestconfiguration->get_attributes( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_string = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_ingestconfiguration->get_tags( ) into ls_row_1.
      lv_key_1 = ls_row_1-key.
      lo_value_1 = ls_row_1-value.
      IF lo_value_1 IS NOT INITIAL.
        lv_tagvalue = lo_value_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.