Skip to content

CompositionSummary

Source code in docs_src/capo_ivs_realtime/types/composition_summary.py
class CompositionSummary(TypedDict, closed=True):
    arn: "capo_ivs_realtime.types.composition_arn.CompositionArn"
    """<p>ARN of the Composition resource.</p>"""
    stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn"
    """<p>ARN of the attached stage.</p>"""
    destinations: (
        "capo_ivs_realtime.types.destination_summary_list.DestinationSummaryList"
    )
    """<p>Array of Destination objects.</p>"""
    state: "capo_ivs_realtime.types.composition_state.CompositionState"
    """<p>State of the Composition resource.</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>"""
    start_time: NotRequired["capo_ivs_realtime.types.time.Time"]
    """<p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"""
    end_time: NotRequired["capo_ivs_realtime.types.time.Time"]
    """<p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"""

arn instance-attribute

ARN of the Composition resource.

destinations instance-attribute

destinations: DestinationSummaryList

Array of Destination objects.

end_time instance-attribute

end_time: NotRequired[Time]

UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

stage_arn instance-attribute

stage_arn: StageArn

ARN of the attached stage.

start_time instance-attribute

start_time: NotRequired[Time]

UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

state instance-attribute

State of the Composition resource.

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.