ivsrealtime / Client / stop_participant_replication

stop_participant_replication

ivsrealtime.Client.stop_participant_replication(**kwargs)

Stops a replicated participant session.

See also: AWS API Documentation

Request Syntax

response = client.stop_participant_replication(
    sourceStageArn='string',
    destinationStageArn='string',
    participantId='string'
)
Parameters:

  • sourceStageArn (string) –

    [REQUIRED]

    ARN of the stage where the participant is publishing.

  • destinationStageArn (string) –

    [REQUIRED]

    ARN of the stage where the participant has been replicated.

  • participantId (string) –

    [REQUIRED]

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

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