AWS ivs documentation change
Summary
Added replication event fields (destinationSessionId, destinationStageArn) and replica flag to Event documentation
Security assessment
Adds new API fields for event tracking but contains no security-related context or vulnerability fixes
Diff
diff --git a/ivs/latest/RealTimeAPIReference/API_Event.md b/ivs/latest/RealTimeAPIReference/API_Event.md index 41969ca0b..1d34ace48 100644 --- a//ivs/latest/RealTimeAPIReference/API_Event.md +++ b//ivs/latest/RealTimeAPIReference/API_Event.md @@ -12,0 +13,26 @@ An occurrence during a stage session. +**destinationSessionId** + + +ID of the session within the destination stage. Applicable only if the event name is `REPLICATION_STARTED` or `REPLICATION_STOPPED`. + +Type: String + +Length Constraints: Fixed length of 16. + +Pattern: `st-[a-zA-Z0-9]+` + +Required: No + +**destinationStageArn** + + +ARN of the stage where the participant is replicated. Applicable only if the event name is `REPLICATION_STARTED` or `REPLICATION_STOPPED`. + +Type: String + +Length Constraints: Minimum length of 1. Maximum length of 128. + +Pattern: `arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+` + +Required: No + @@ -71 +97 @@ Type: String -Valid Values: `JOINED | LEFT | PUBLISH_STARTED | PUBLISH_STOPPED | SUBSCRIBE_STARTED | SUBSCRIBE_STOPPED | PUBLISH_ERROR | SUBSCRIBE_ERROR | JOIN_ERROR` +Valid Values: `JOINED | LEFT | PUBLISH_STARTED | PUBLISH_STOPPED | SUBSCRIBE_STARTED | SUBSCRIBE_STOPPED | PUBLISH_ERROR | SUBSCRIBE_ERROR | JOIN_ERROR | REPLICATION_STARTED | REPLICATION_STOPPED` @@ -100,0 +127,9 @@ Required: No +**replica** + + +If true, this indicates the `participantId` is a replicated participant. If this is a subscribe event, then this flag refers to `remoteParticipantId`. Default: `false`. + +Type: Boolean + +Required: No +