Skip to content

Commit d2a2156

Browse files
kdailykdaily
authored
Merge pull request #9521 from daniil-millwood/awsdocs-05-29-25
Updated CLI examples for IVS and Verified Permissions
2 parents 7d3a8bb + 68039fa commit d2a2156

File tree

10 files changed

+356
-122
lines changed

10 files changed

+356
-122
lines changed

‎awscli/examples/ivs-realtime/create-stage.rst‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ Output::
3434
"recordingReconnectWindowSeconds": 0,
3535
"hlsConfiguration": {
3636
"targetSegmentDurationSeconds": 6
37-
}
37+
},
38+
"recordParticipantReplicas": true
3839
},
3940
"endpoints": {
4041
"events": "wss://global.events.live-video.net",
@@ -79,7 +80,8 @@ Output::
7980
"recordingReconnectWindowSeconds": 100,
8081
"hlsConfiguration": {
8182
"targetSegmentDurationSeconds": 5
82-
}
83+
},
84+
"recordParticipantReplicas": true
8385
},
8486
"endpoints": {
8587
"events": "wss://global.events.live-video.net",
@@ -124,7 +126,8 @@ Output::
124126
"recordingReconnectWindowSeconds": 0,
125127
"hlsConfiguration": {
126128
"targetSegmentDurationSeconds": 6
127-
}
129+
},
130+
"recordParticipantReplicas": true
128131
},
129132
"endpoints": {
130133
"events": "wss://global.events.live-video.net",

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

Lines changed: 99 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,99 @@
1-
**To get a stage participant**
2-
3-
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). ::
4-
5-
aws ivs-realtime get-participant \
6-
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
7-
--session-id st-a1b2c3d4e5f6g \
8-
--participant-id abCDEf12GHIj
9-
10-
Output::
11-
12-
{
13-
"participant": {
14-
"browserName", "Google Chrome",
15-
"browserVersion", "116",
16-
"firstJoinTime": "2023-04-26T20:30:34+00:00",
17-
"ispName", "Comcast",
18-
"osName", "Microsoft Windows 10 Pro",
19-
"osVersion", "10.0.19044"
20-
"participantId": "abCDEf12GHIj",
21-
"published": true,
22-
"recordingS3BucketName": "bucket-name",
23-
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
24-
"recordingState": "ACTIVE",
25-
"sdkVersion", "",
26-
"state": "CONNECTED",
27-
"userId": "",
28-
}
29-
}
30-
31-
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*.
1+
**Example 1: To get a stage participant**
2+
3+
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). ::
4+
5+
aws ivs-realtime get-participant \
6+
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
7+
--session-id st-a1b2c3d4e5f6g \
8+
--participant-id abCDEf12GHIj
9+
10+
Output::
11+
12+
{
13+
"participant": {
14+
"browserName": "Google Chrome",
15+
"browserVersion": "116",
16+
"firstJoinTime": "2023-04-26T20:30:34+00:00",
17+
"ispName": "Comcast",
18+
"osName": "Microsoft Windows 10 Pro",
19+
"osVersion": "10.0.19044",
20+
"participantId": "abCDEf12GHIj",
21+
"published": true,
22+
"recordingS3BucketName": "bucket-name",
23+
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
24+
"recordingState": "ACTIVE",
25+
"sdkVersion": "",
26+
"state": "CONNECTED",
27+
"userId": ""
28+
}
29+
}
30+
31+
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*.
32+
33+
**Example 2: To get a stage participant that has been replicated to another stage**
34+
35+
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. ::
36+
37+
aws ivs-realtime get-participant \
38+
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
39+
--session-id st-a1b2c3d4e5f6g \
40+
--participant-id abCDEf12GHIj
41+
42+
Output::
43+
44+
{
45+
"participant": {
46+
"browserName": "Google Chrome",
47+
"browserVersion": "116",
48+
"firstJoinTime": "2023-04-26T20:30:34+00:00",
49+
"ispName": "Comcast",
50+
"osName": "Microsoft Windows 10 Pro",
51+
"osVersion": "10.0.19044",
52+
"participantId": "abCDEf12GHIj",
53+
"published": true,
54+
"recordingS3BucketName": "bucket-name",
55+
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
56+
"recordingState": "ACTIVE",
57+
"replicationState": "ACTIVE",
58+
"replicationType": "SOURCE",
59+
"sdkVersion": "",
60+
"state": "CONNECTED",
61+
"userId": ""
62+
}
63+
}
64+
65+
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*.
66+
67+
**Example 3: To get a stage participant that has been replicated from another stage**
68+
69+
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. ::
70+
71+
aws ivs-realtime get-participant \
72+
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
73+
--session-id st-a1b2c3d4e5f6g \
74+
--participant-id abCDEf12GHIj
75+
76+
Output::
77+
78+
{
79+
"participant": {
80+
"browserName": "Google Chrome",
81+
"browserVersion": "116",
82+
"firstJoinTime": "2023-04-26T20:30:34+00:00",
83+
"ispName": "Comcast",
84+
"osName": "Microsoft Windows 10 Pro",
85+
"osVersion": "10.0.19044",
86+
"participantId": "abCDEf12GHIj",
87+
"published": true,
88+
"recordingS3BucketName": "bucket-name",
89+
"recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
90+
"recordingState": "ACTIVE",
91+
"replicationState": "ACTIVE",
92+
"replicationType": "REPLICA",
93+
"sdkVersion": "",
94+
"state": "CONNECTED",
95+
"userId": ""
96+
}
97+
}
98+
99+
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‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,13 @@ Output::
2121
"storage": [
2222
"SEQUENTIAL"
2323
],
24-
"recordingMode": "DISABLED",
24+
"recordingMode": "DISABLED"
2525
},
2626
"recordingReconnectWindowSeconds": 0,
2727
"hlsConfiguration": {
2828
"targetSegmentDurationSeconds": 6
29-
}
29+
},
30+
"recordParticipantReplicas": true
3031
},
3132
"endpoints": {
3233
"events": "wss://global.events.live-video.net",

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

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**To get a list of stage participant events**
1+
**Example 1: To get a list of stage participant events**
22

33
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). ::
44

@@ -34,4 +34,56 @@ Output::
3434
]
3535
}
3636

37-
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*.
37+
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*.
38+
39+
**Example 2: To get a list of stage participant events, including participant replication stop and start**
40+
41+
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. ::
42+
43+
aws ivs-realtime list-participant-events \
44+
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
45+
--session-id st-a1b2c3d4e5f6g \
46+
--participant-id abCDEf12GHIj
47+
48+
Output::
49+
50+
{
51+
"events": [
52+
{
53+
"eventTime": "2025-04-26T20:36:28+00:00",
54+
"name": "LEFT",
55+
"participantId": "abCDEf12GHIj"
56+
},
57+
{
58+
"eventTime": "2025-04-26T20:36:28+00:00",
59+
"name": "PUBLISH_STOPPED",
60+
"participantId": "abCDEf12GHIj"
61+
},
62+
{
63+
"eventTime": "2025-04-26T20:30:34+00:00",
64+
"name": "JOINED",
65+
"participantId": "abCDEf12GHIj"
66+
},
67+
{
68+
"eventTime": "2025-04-26T20:30:34+00:00",
69+
"name": "PUBLISH_STARTED",
70+
"participantId": "abCDEf12GHIj"
71+
},
72+
{
73+
"name": "REPLICATION_STARTED",
74+
"participantId": "abCDEf12GHIj",
75+
"eventTime": "2025-04-26T20:30:34+00:00",
76+
"destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh",
77+
"destinationSessionId": "st-b1c2d3e4f5g6a"
78+
},
79+
{
80+
"name": "REPLICATION_STOPPED",
81+
"participantId": "abCDEf12GHIj",
82+
"eventTime": "2025-04-26T20:32:34+00:00",
83+
"destinationStageArn": "arn:aws:ivs:us-west-2:12345678901:stage/ABCDabcdefgh",
84+
"destinationSessionId": "st-b1c2d3e4f5g6a"
85+
}
86+
]
87+
}
88+
89+
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‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
**To get a list of stage participant replicas**
2+
3+
The following ``list-participant-replicas`` example lists all stage participants replicated from the specified source stage ARN (Amazon Resource Name) to another stage. ::
4+
5+
aws ivs-realtime list-participant-replicas \
6+
--source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
7+
--participant-id abCDEf12GHIj
8+
9+
Output::
10+
11+
{
12+
"replicas": [
13+
{
14+
"sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
15+
"participantId": "abCDEf12GHIj",
16+
"sourceSessionId": "st-a1b2c3d4e5f6g",
17+
"destinationStageArn": "arn:aws:ivs:us-west-2:012345678901:stage/ABCDabcdefgh",
18+
"destinationSessionId": "st-b1c2d3e4f5g6a",
19+
"replicationState": "ACTIVE"
20+
}
21+
]
22+
}
23+
24+
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‎

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**To get a list of stage participants**
1+
**Example 1: To get a list of stage participants**
22

33
The following ``list-participants`` example lists all participants for a specified session ID of a specified stage ARN (Amazon Resource Name). ::
44

@@ -12,7 +12,7 @@ Output::
1212
"participants": [
1313
{
1414
"firstJoinTime": "2023-04-26T20:30:34+00:00",
15-
"participantId": "abCDEf12GHIj"
15+
"participantId": "abCDEf12GHIj",
1616
"published": true,
1717
"recordingState": "STOPPED",
1818
"state": "DISCONNECTED",
@@ -21,4 +21,62 @@ Output::
2121
]
2222
}
2323

24-
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*.
24+
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*.
25+
26+
**Example 2: To get a list of stage participants, when a participant has been replicated to another stage**
27+
28+
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. ::
29+
30+
aws ivs-realtime list-participants \
31+
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
32+
--session-id st-a1b2c3d4e5f6g
33+
34+
Output::
35+
36+
{
37+
"participants": [
38+
{
39+
"firstJoinTime": "2023-04-26T20:30:34+00:00",
40+
"participantId": "abCDEf12GHIj",
41+
"published": true,
42+
"recordingState": "STOPPED",
43+
"state": "DISCONNECTED",
44+
"userId": "",
45+
"replicationState": "ACTIVE",
46+
"replicationType": "SOURCE",
47+
"sourceStageArn": "",
48+
"sourceSessionId": ""
49+
}
50+
]
51+
}
52+
53+
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*.
54+
55+
**Example 3: To get a list of stage participants, when a participant has been replicated from another stage**
56+
57+
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. ::
58+
59+
aws ivs-realtime list-participants \
60+
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
61+
--session-id st-a1b2c3d4e5f6g
62+
63+
Output::
64+
65+
{
66+
"participants": [
67+
{
68+
"firstJoinTime": "2023-04-26T20:30:34+00:00",
69+
"participantId": "abCDEf12GHIj",
70+
"published": true,
71+
"recordingState": "STOPPED",
72+
"state": "DISCONNECTED",
73+
"userId": "",
74+
"replicationState": "ACTIVE",
75+
"replicationType": "REPLICA",
76+
"sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
77+
"sourceSessionId": "st-a1b2c3d4e5f6g"
78+
}
79+
]
80+
}
81+
82+
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-participant-replication.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
**To start replicating a participant from one stage to another stage**
2+
3+
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). ::
4+
5+
aws ivs-realtime start-participant-replication \
6+
--source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
7+
--destination-stage-arn arn:aws:ivs:us-west-2:234567890123:stage/bcdABCDefghi \
8+
--participant-id abCDEf12GHIj
9+
10+
Output::
11+
12+
{
13+
"accessControlAllowOrigin": "*",
14+
"accessControlExposeHeaders": "Access-Control-Allow-Origin,Access-Control-Expose-Headers,Cache-Control,Content-Length, \
15+
Content-Security-Policy,Content-Type,date,Strict-Transport-Security,x-amz-apigw-id,x-amzn-errormessage,x-amzn-errortype, \
16+
x-amzn-requestid,x-amzn-trace-id,X-Content-Type-Options,X-Frame-Options",
17+
"cacheControl": "no-store, no-cache",
18+
"contentSecurityPolicy": "default-src 'self'; upgrade-insecure-requests;",
19+
"strictTransportSecurity": "max-age:47304000; includeSubDomains",
20+
"xContentTypeOptions": "nosniff",
21+
"xFrameOptions": "DENY"
22+
}
23+
24+
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*.

0 commit comments

Comments
 (0)