Skip to content

StartParticipantReplicationRequest

Source code in docs_src/capo_ivs_realtime/types/start_participant_replication_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class StartParticipantReplicationRequest(TypedDict, closed=True):
    source_stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn"
    """<p>ARN of the stage where the participant is publishing.</p>"""
    destination_stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn"
    """<p>ARN of the stage to which the participant will be replicated.</p>"""
    participant_id: "capo_ivs_realtime.types.participant_id.ParticipantId"
    """<p>Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by <a>CreateParticipantToken</a> or the <code>jti</code> (JWT ID) used to <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed">create a self signed token</a>. </p>"""
    reconnect_window_seconds: NotRequired[
        "capo_ivs_realtime.types.reconnect_window_seconds.ReconnectWindowSeconds"
    ]
    """<p>If the participant disconnects and then reconnects within the specified interval, replication will continue to be <code>ACTIVE</code>. Default: 0.</p>"""
    attributes: NotRequired[
        "capo_ivs_realtime.types.participant_attributes.ParticipantAttributes"
    ]
    """<p>Application-provided attributes to set on the replicated participant in the destination stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p> <p>These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.</p>"""

attributes instance-attribute 

attributes: NotRequired[ParticipantAttributes]

Application-provided attributes to set on the replicated participant in the destination 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.

These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.

destination_stage_arn instance-attribute 

destination_stage_arn: StageArn

ARN of the stage to which the participant will be replicated.

participant_id instance-attribute 

participant_id: ParticipantId

Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.

reconnect_window_seconds instance-attribute 

reconnect_window_seconds: NotRequired[ReconnectWindowSeconds]

If the participant disconnects and then reconnects within the specified interval, replication will continue to be ACTIVE. Default: 0.

source_stage_arn instance-attribute 

source_stage_arn: StageArn

ARN of the stage where the participant is publishing.