/AWS1/CL_IVR=>STARTCOMPOSITION()¶
About StartComposition¶
Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted:
-
When StopComposition is called.
-
After a 1-minute timeout, when all participants are disconnected from the stage.
-
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
-
When broadcasting to the IVS channel fails and all retries are exhausted.
-
When broadcasting is disconnected and all attempts to reconnect are exhausted.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_STAGEARN TYPE /AWS1/IVRSTAGEARN /AWS1/IVRSTAGEARN¶
ARN of the stage to be used for compositing.
IT_DESTINATIONS TYPE /AWS1/CL_IVRDESTINATIONCONF=>TT_DESTINATIONCONFLIST TT_DESTINATIONCONFLIST¶
Array of destination configuration.
Optional arguments:¶
IV_IDEMPOTENCYTOKEN TYPE /AWS1/IVRCOMPOSITIONCLITOKEN /AWS1/IVRCOMPOSITIONCLITOKEN¶
Idempotency token.
IO_LAYOUT TYPE REF TO /AWS1/CL_IVRLAYOUTCONF /AWS1/CL_IVRLAYOUTCONF¶
Layout object to configure composition parameters.
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 Tagging AWS Resources 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.