awscli 1.40.17__py3-none-any.whl → 1.44.26__py3-none-any.whl

awscli/examples/ivs-realtime/get-participant.rst

@@ -1,31 +1,99 @@
-**To get a stage participant**
-
-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). ::
-
-    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",
-            "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 Interactive Video Service User Guide*.
+**Example 1: To get a stage participant**
+
+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). ::
+
+    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",
+            "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 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*.

awscli/examples/ivs-realtime/get-stage.rst

@@ -21,12 +21,13 @@ Output::
                     "storage": [
                         "SEQUENTIAL"
                     ],
-                    "recordingMode": "DISABLED",
+                    "recordingMode": "DISABLED"
                 },
                 "recordingReconnectWindowSeconds": 0,
                 "hlsConfiguration": {
                     "targetSegmentDurationSeconds": 6
-                }
+                },
+                "recordParticipantReplicas": true
             },
             "endpoints": {
                 "events": "wss://global.events.live-video.net",

awscli/examples/ivs-realtime/list-participant-events.rst

@@ -1,4 +1,4 @@
-**To get a list of stage participant events**
+**Example 1: To get a list of stage participant events**
 
 The following ``list-participant-events`` example lists all participant events for a specified participant ID and session ID of a specified stage ARN (Amazon Resource Name). ::
 
@@ -34,4 +34,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*.

awscli/examples/ivs-realtime/list-participant-replicas.rst

@@ -0,0 +1,24 @@
+**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::
+
+    {
+        "replicas": [
+            {
+                "sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
+                "participantId": "abCDEf12GHIj",
+                "sourceSessionId": "st-a1b2c3d4e5f6g",
+                "destinationStageArn": "arn:aws:ivs:us-west-2:012345678901:stage/ABCDabcdefgh",
+                "destinationSessionId": "st-b1c2d3e4f5g6a",
+                "replicationState": "ACTIVE"
+            }
+        ]
+    }
+
+For more information, see `IVS Participant Replication <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.

awscli/examples/ivs-realtime/list-participants.rst

@@ -1,4 +1,4 @@
-**To get a list of stage participants**
+**Example 1: To get a list of stage participants**
 
 The following ``list-participants`` example lists all participants for a specified session ID of a specified stage ARN (Amazon Resource Name). ::
 
@@ -12,7 +12,7 @@ Output::
         "participants": [
             {
                 "firstJoinTime": "2023-04-26T20:30:34+00:00",
-                "participantId": "abCDEf12GHIj"
+                "participantId": "abCDEf12GHIj",
                 "published": true,
                 "recordingState": "STOPPED",
                 "state": "DISCONNECTED",
@@ -21,4 +21,62 @@ 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 list of stage participants, when a participant has been replicated to another stage**
+
+The following ``list-participants`` example lists all participants for a specified session ID of a specified stage ARN (Amazon Resource Name), when a participant has been replicated to another stage. ::
+
+    aws ivs-realtime list-participants \
+        --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
+        --session-id st-a1b2c3d4e5f6g
+
+Output::
+
+    {
+        "participants": [
+            {
+                "firstJoinTime": "2023-04-26T20:30:34+00:00",
+                "participantId": "abCDEf12GHIj",
+                "published": true,
+                "recordingState": "STOPPED",
+                "state": "DISCONNECTED",
+                "userId": "",
+                "replicationState": "ACTIVE",
+                "replicationType": "SOURCE",
+                "sourceStageArn": "",
+                "sourceSessionId": ""
+            }
+        ]
+    }
+
+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 list of stage participants, when a participant has been replicated from another stage**
+
+The following ``list-participants`` example lists all participants for a specified session ID of a specified stage ARN (Amazon Resource Name), when a participant has been replicated from another stage. ::
+
+    aws ivs-realtime list-participants \
+        --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
+        --session-id st-a1b2c3d4e5f6g
+
+Output::
+
+    {
+        "participants": [
+            {
+                "firstJoinTime": "2023-04-26T20:30:34+00:00",
+                "participantId": "abCDEf12GHIj",
+                "published": true,
+                "recordingState": "STOPPED",
+                "state": "DISCONNECTED",
+                "userId": "",
+                "replicationState": "ACTIVE",
+                "replicationType": "REPLICA",
+                "sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
+                "sourceSessionId": "st-a1b2c3d4e5f6g"
+            }
+        ]
+    }
+
+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*.

awscli/examples/ivs-realtime/start-composition.rst

@@ -57,6 +57,7 @@ Output::
                     "featuredParticipantAttribute": ""
                     "gridGap": 2,
                     "omitStoppedVideo": false,
+                    "participantOrderAttribute": "",
                     "videoAspectRatio": "VIDEO",
                     "videoFillMode": ""
                 }
@@ -68,7 +69,7 @@ Output::
         }
     }
 
-For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
+For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
 
 **Example 2: To start a composition with PiP layout**
 
@@ -129,6 +130,7 @@ Output::
                     "featuredParticipantAttribute": "abcdefg",
                     "gridGap": 0,
                     "omitStoppedVideo": false,
+                    "participantOrderAttribute": "",
                     "pipBehavior": "STATIC",
                     "pipOffset": 0,
                     "pipParticipantAttribute": "",
@@ -143,7 +145,7 @@ Output::
         }
     }
 
-For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
+For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
 
 **Example 3: To start a composition with thumbnail recording enabled**
 
@@ -212,6 +214,7 @@ Output::
                     "featuredParticipantAttribute": ""
                     "gridGap": 2,
                     "omitStoppedVideo": false,
+                    "participantOrderAttribute": "",
                     "videoAspectRatio": "VIDEO",
                     "videoFillMode": ""
                 }
@@ -223,4 +226,86 @@ Output::
         }
     }
 
-For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
+For more information, see `Composite Recording (Real-Time Streaming) <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
+
+**Example 4: To start a composition using grid layout with custom participant ordering**
+
+The following ``start-composition`` example starts a composition for the specified stage to be streamed to the specified locations using grid layout with custom participant ordering. ::
+
+    aws ivs-realtime start-composition \
+        --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
+        --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
+            "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
+            {"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \ 
+            "storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \
+            "thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]' \
+        --layout grid='{participantOrderAttribute="abcdefg"}'
+
+Output::
+
+    {
+        "composition": {
+            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
+            "destinations": [
+                {
+                    "configuration": {
+                        "channel": {
+                            "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
+                            "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
+                        },
+                        "name": ""
+                    },
+                    "id": "AabBCcdDEefF",
+                    "state": "STARTING"
+                },
+                {
+                    "configuration": {
+                        "name": "",
+                        "s3": {
+                            "encoderConfigurationArns": [
+                                "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
+                            ],
+                            "recordingConfiguration": {
+                                "format": "HLS",
+                                "hlsConfiguration": {
+                                    "targetSegmentDurationSeconds": 2
+                                }
+                            },
+                            "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
+                            "thumbnailConfigurations": [
+                               {
+                                  "targetIntervalSeconds": 60,
+                                  "storage": [
+                                      "SEQUENTIAL"
+                                  ]
+                               }
+                            ]
+                        }
+                    },
+                    "detail": {
+                        "s3": {
+                            "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
+                        }
+                    },
+                    "id": "GHFabcgefABC",
+                    "state": "STARTING"
+                }
+            ],
+            "layout": {
+                "grid": {
+                    "featuredParticipantAttribute": ""
+                    "gridGap": 2,
+                    "omitStoppedVideo": false,
+                    "participantOrderAttribute": "abcdefg",
+                    "videoAspectRatio": "VIDEO",
+                    "videoFillMode": ""
+                }
+            },
+            "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
+            "startTime": "2023-10-16T23:24:00+00:00",
+            "state": "STARTING",
+            "tags": {}
+        }
+    }
+
+For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.

awscli/examples/ivs-realtime/start-participant-replication.rst

@@ -0,0 +1,24 @@
+**To start replicating a participant from one stage to another stage**
+
+The following ``start-participant-replication`` example replicates a participant from a source stage to a destination stage, with each stage specified by its ARN (Amazon Resource Name). ::
+
+    aws ivs-realtime start-participant-replication \
+        --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
+        --destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \
+        --participant-id abCDEf12GHIj
+
+Output::
+
+    {
+        "accessControlAllowOrigin": "*",
+        "accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \
+        Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \
+        x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options",
+        "cacheControl": "no-store, no-cache",
+        "contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;",
+        "strictTransportSecurity": "max-age:47304000; includeSubDomains",
+        "xContentTypeOptions": "nosniff",
+        "xFrameOptions": "DENY"
+    }
+
+For more information, see `IVS Participant Replication <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.

awscli/examples/ivs-realtime/stop-participant-replication.rst

@@ -0,0 +1,24 @@
+**To stop replicating a participant from one stage to another stage**
+
+The following ``stop-participant-replication`` example stops replicating a participant from a source stage to a destination stage, with each stage specified by its ARN (Amazon Resource Name). ::
+
+    aws ivs-realtime stop-participant-replication \
+        --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
+        --destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \
+        --participant-id abCDEf12GHIj
+
+Output::
+
+    {
+        "accessControlAllowOrigin": "*",
+        "accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \
+        Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \
+        x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options",
+        "cacheControl": "no-store, no-cache",
+        "contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;",
+        "strictTransportSecurity": "max-age:47304000; includeSubDomains",
+        "xContentTypeOptions": "nosniff",
+        "xFrameOptions": "DENY"
+    }
+
+For more information, see `IVS Participant Replication <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.

awscli/examples/ivs-realtime/update-stage.rst

@@ -1,4 +1,4 @@
-**To update a stage's configuration**
+**Example 1: To update a stage's configuration**
 
 The following ``update-stage`` example updates a stage for a specified stage ARN to update the stage name and configure individual participant recording with thumbnail recording enabled. ::
 
@@ -19,7 +19,7 @@ Output::
                     "AUDIO_VIDEO"
                 ],
                 "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
-                "thumbnailConfiguration": { 
+                "thumbnailConfiguration": {
                     "targetIntervalSeconds": 60,
                     "storage": [
                         "SEQUENTIAL"
@@ -29,7 +29,55 @@ Output::
                 "recordingReconnectWindowSeconds": 100,
                 "hlsConfiguration": {
                     "targetSegmentDurationSeconds": 5
-                }
+                },
+                "recordParticipantReplicas": true
+            },
+            "endpoints": {
+                "events": "wss://global.events.live-video.net",
+                "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
+                "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
+                "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
+            },
+            "name": "stage1a",
+            "tags": {}
+        }
+    }
+
+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 update a stage's configuration, including disabling participant replica recording**
+
+The following ``update-stage`` example updates a stage for a specified stage ARN to update the stage name and configure individual participant recording with thumbnail recording enabled and participant replica recording disabled. ::
+
+    aws ivs-realtime update-stage \
+        --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
+        --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
+            "thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}, "recordParticipantReplicas":false} \
+            "hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \
+        --name stage1a
+
+Output::
+
+    {
+        "stage": {
+            "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
+            "autoParticipantRecordingConfiguration": {
+                "mediaTypes": [
+                    "AUDIO_VIDEO"
+                ],
+                "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
+                "thumbnailConfiguration": {
+                    "targetIntervalSeconds": 60,
+                    "storage": [
+                        "SEQUENTIAL"
+                    ],
+                    "recordingMode": "INTERVAL"
+                },
+                "recordingReconnectWindowSeconds": 100,
+                "hlsConfiguration": {
+                    "targetSegmentDurationSeconds": 5
+                },
+                "recordParticipantReplicas": false
             },
             "endpoints": {
                 "events": "wss://global.events.live-video.net",