ivsrealtime / Client / start_participant_replication

start_participant_replication

ivsrealtime.Client.start_participant_replication(**kwargs)

Starts replicating a publishing participant from a source stage to a destination stage.

See also: AWS API Documentation

Request Syntax

response = client.start_participant_replication(
    sourceStageArn='string',
    destinationStageArn='string',
    participantId='string',
    reconnectWindowSeconds=123,
    attributes={
        'string': 'string'
    }
)
Parameters:

  • sourceStageArn (string) –

    [REQUIRED]

    ARN of the stage where the participant is publishing.

  • destinationStageArn (string) –

    [REQUIRED]

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

  • participantId (string) –

    [REQUIRED]

    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.

  • reconnectWindowSeconds (integer) – If the participant disconnects and then reconnects within the specified interval, replication will continue to be ACTIVE. Default: 0.

  • attributes (dict) –

    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.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'accessControlAllowOrigin': 'string',
    'accessControlExposeHeaders': 'string',
    'cacheControl': 'string',
    'contentSecurityPolicy': 'string',
    'strictTransportSecurity': 'string',
    'xContentTypeOptions': 'string',
    'xFrameOptions': 'string'
}

Response Structure

  • (dict) –

    • accessControlAllowOrigin (string) –

    • accessControlExposeHeaders (string) –

    • cacheControl (string) –

    • contentSecurityPolicy (string) –

    • strictTransportSecurity (string) –

    • xContentTypeOptions (string) –

    • xFrameOptions (string) –

Exceptions