Module Values.StartCompositionRequestSource

Starts a Composition from a stage based on the configuration provided in the request. A Composition is an ephemeral resource that exists after this operation 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.

Sourcetype nonrec t = {
  1. stageArn : StageArn.t;
    (*

    ARN of the stage to be used for compositing.

    *)
  2. idempotencyToken : CompositionClientToken.t option;
    (*

    Idempotency token.

    *)
  3. layout : LayoutConfiguration.t option;
    (*

    Layout object to configure composition parameters.

    *)
  4. destinations : DestinationConfigurationList.t;
    (*

    Array of destination configuration.

    *)
  5. tags : Tags.t option;
    (*

    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.

    *)
}
Sourceval context_ : string
Sourceval make : ?idempotencyToken:??? -> ?layout:??? -> ?tags:??? -> stageArn:StageArn.t -> destinations:DestinationConfigurationList.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of DestinationConfigurationName.t | `Structure of (string * [> `List of [> `String of EncoderConfigurationArn.t | `Structure of (string * [> `Integer of ThumbnailIntervalSeconds.t | `List of [> `Enum of string ] list ]) list ] list | `String of ChannelArn.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Integer of CompositionRecordingTargetSegmentDurationSeconds.t ]) list ]) list ]) list ]) list ] list | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of StageArn.t | `Structure of (string * [> `Structure of (string * [> `Boolean of OmitStoppedVideo.t | `Enum of string | `Integer of GridGap.t | `String of AttributeKey.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t