Skip to content

StartCompositionRequest

Source code in docs_src/capo_ivs_realtime/types/start_composition_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class StartCompositionRequest(TypedDict, closed=True):
    stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn"
    """<p>ARN of the stage to be used for compositing.</p>"""
    idempotency_token: NotRequired[
        "capo_ivs_realtime.types.composition_client_token.CompositionClientToken"
    ]
    """<p>Idempotency token.</p>"""
    layout: NotRequired[
        "capo_ivs_realtime.types.layout_configuration.LayoutConfiguration"
    ]
    """<p>Layout object to configure composition parameters.</p>"""
    destinations: "capo_ivs_realtime.types.destination_configuration_list.DestinationConfigurationList"
    """<p>Array of destination configuration.</p>"""
    tags: NotRequired["capo_ivs_realtime.types.tags.Tags"]
    """<p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> 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.</p>"""

destinations instance-attribute 

destinations: DestinationConfigurationList

Array of destination configuration.

idempotency_token instance-attribute 

idempotency_token: NotRequired[CompositionClientToken]

Idempotency token.

layout instance-attribute 

layout: NotRequired[LayoutConfiguration]

Layout object to configure composition parameters.

stage_arn instance-attribute 

stage_arn: StageArn

ARN of the stage to be used for compositing.

tags instance-attribute 

tags: NotRequired[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.