AWS cli documentation change
Summary
Added documentation for participant replication features including new commands (list-participant-replicas, start/stop-participant-replication), updated examples with replication states, and added 'recordParticipantReplicas' configuration parameter
Security assessment
Changes introduce participant replication capabilities and recording configurations but do not explicitly address security vulnerabilities or describe security controls. The 'recordParticipantReplicas' parameter relates to data recording features rather than security mechanisms.
Diff
diff --git a/cli/v1/userguide/cli_ivs-realtime_code_examples.md b/cli/v1/userguide/cli_ivs-realtime_code_examples.md index 01c5212e9..5866dff00 100644 --- a//cli/v1/userguide/cli_ivs-realtime_code_examples.md +++ b//cli/v1/userguide/cli_ivs-realtime_code_examples.md @@ -180 +180,2 @@ Output: - } + }, + "recordParticipantReplicas": true @@ -228 +229,2 @@ Output: - } + }, + "recordParticipantReplicas": true @@ -276 +278,2 @@ Output: - } + }, + "recordParticipantReplicas": true @@ -801 +804 @@ The following code example shows how to use `get-participant`. -**To get a stage participant** +**Example 1: To get a stage participant** @@ -817,2 +820,2 @@ Output: - "browserName", "Google Chrome", - "browserVersion", "116", + "browserName": "Google Chrome", + "browserVersion": "116", @@ -820,3 +823,3 @@ Output: - "ispName", "Comcast", - "osName", "Microsoft Windows 10 Pro", - "osVersion", "10.0.19044" + "ispName": "Comcast", + "osName": "Microsoft Windows 10 Pro", + "osVersion": "10.0.19044", @@ -828 +831 @@ Output: - "sdkVersion", "", + "sdkVersion": "", @@ -830 +833 @@ Output: - "userId": "", + "userId": "" @@ -834 +837,75 @@ Output: -For more information, see [Enabling Multiple Hosts on an Amazon IVS Stream](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) in the _Amazon Interactive Video Service User Guide_. +For more information, see [Enabling Multiple Hosts on an Amazon IVS Stream](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) in the _Amazon IVS Low-Latency Streaming User Guide_. + +**Example 2: To get a stage participant that has been replicated to another stage** + +The following `get-participant` example gets the stage participant for a specified participant ID and session ID in the specified stage ARN (Amazon Resource Name), when the participant has also been replicated to another stage. + + + aws ivs-realtime get-participant \ + --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ + --session-id st-a1b2c3d4e5f6g \ + --participant-id abCDEf12GHIj + + +Output: + + + { + "participant": { + "browserName": "Google Chrome", + "browserVersion": "116", + "firstJoinTime": "2023-04-26T20:30:34+00:00", + "ispName": "Comcast", + "osName": "Microsoft Windows 10 Pro", + "osVersion": "10.0.19044", + "participantId": "abCDEf12GHIj", + "published": true, + "recordingS3BucketName": "bucket-name", + "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890", + "recordingState": "ACTIVE", + "replicationState": "ACTIVE", + "replicationType": "SOURCE", + "sdkVersion": "", + "state": "CONNECTED", + "userId": "" + } + } + +For more information, see [Enabling Multiple Hosts on an Amazon IVS Stream](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) in the _Amazon IVS Low-Latency Streaming User Guide_. + +**Example 3: To get a stage participant that has been replicated from another stage** + +The following `get-participant` example gets the stage participant for a specified participant ID and session ID in the specified stage ARN (Amazon Resource Name), when the participant has been replicated from another stage. + + + aws ivs-realtime get-participant \ + --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ + --session-id st-a1b2c3d4e5f6g \ + --participant-id abCDEf12GHIj + + +Output: + + + { + "participant": { + "browserName": "Google Chrome", + "browserVersion": "116", + "firstJoinTime": "2023-04-26T20:30:34+00:00", + "ispName": "Comcast", + "osName": "Microsoft Windows 10 Pro", + "osVersion": "10.0.19044", + "participantId": "abCDEf12GHIj", + "published": true, + "recordingS3BucketName": "bucket-name", + "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890", + "recordingState": "ACTIVE", + "replicationState": "ACTIVE", + "replicationType": "REPLICA", + "sdkVersion": "", + "state": "CONNECTED", + "userId": "" + } + } + +For more information, see [Enabling Multiple Hosts on an Amazon IVS Stream](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) in the _Amazon IVS Low-Latency Streaming User Guide_. @@ -939 +1016 @@ Output: - "recordingMode": "DISABLED", + "recordingMode": "DISABLED" @@ -944 +1021,2 @@ Output: - } + }, + "recordParticipantReplicas": true @@ -1177 +1255 @@ The following code example shows how to use `list-participant-events`. -**To get a list of stage participant events** +**Example 1: To get a list of stage participant events** @@ -1216 +1294,56 @@ Output: -For more information, see [Enabling Multiple Hosts on an Amazon IVS Stream](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html) in the _Amazon Interactive Video Service User Guide_. +For more information, see [Enabling Multiple Hosts on an Amazon IVS Stream](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) in the _Amazon IVS Low-Latency Streaming User Guide_. + +**Example 2: To get a list of stage participant events, including participant replication stop and start** + +The following `list-participant-events` example lists all participant events for a specified session ID of a specified stage ARN (Amazon Resource Name), where a participant is replicated to another stage. + + + aws ivs-realtime list-participant-events \ + --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ + --session-id st-a1b2c3d4e5f6g \ + --participant-id abCDEf12GHIj + + +Output: + + + { + "events": [ + { + "eventTime": "2025-04-26T20:36:28+00:00", + "name": "LEFT", + "participantId": "abCDEf12GHIj" + }, + { + "eventTime": "2025-04-26T20:36:28+00:00", + "name": "PUBLISH_STOPPED", + "participantId": "abCDEf12GHIj" + }, + { + "eventTime": "2025-04-26T20:30:34+00:00", + "name": "JOINED", + "participantId": "abCDEf12GHIj" + }, + { + "eventTime": "2025-04-26T20:30:34+00:00", + "name": "PUBLISH_STARTED", + "participantId": "abCDEf12GHIj" + }, + { + "name": "REPLICATION_STARTED", + "participantId": "abCDEf12GHIj", + "eventTime": "2025-04-26T20:30:34+00:00", + "destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh", + "destinationSessionId": "st-b1c2d3e4f5g6a" + }, + { + "name": "REPLICATION_STOPPED", + "participantId": "abCDEf12GHIj", + "eventTime": "2025-04-26T20:32:34+00:00", + "destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh", + "destinationSessionId": "st-b1c2d3e4f5g6a" + } + ] + } + +For more information, see [Enabling Multiple Hosts on an Amazon IVS Stream](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html) in the _Amazon IVS Low-Latency Streaming User Guide_. @@ -1222,0 +1356,38 @@ For more information, see [Enabling Multiple Hosts on an Amazon IVS Stream](http +The following code example shows how to use `list-participant-replicas`. + +**AWS CLI** + + +**To get a list of stage participant replicas** + +The following `list-participant-replicas` example lists all stage participants replicated from the specified source stage ARN (Amazon Resource Name) to another stage. + + + aws ivs-realtime list-participant-replicas \ + --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ + --participant-id abCDEf12GHIj + + +Output: +