Skip to content

Commit cf45fd9

Browse files
author
AWS
committed
Amazon Interactive Video Service Update: Updated text description in DeleteChannel, Stream, and StreamSummary.
1 parent 7255048 commit cf45fd9

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Interactive Video Service",
4+
"contributor": "",
5+
"description": "Updated text description in DeleteChannel, Stream, and StreamSummary."
6+
}

services/ivs/src/main/resources/codegen-resources/service-2.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
{"shape":"PendingVerification"},
106106
{"shape":"ConflictException"}
107107
],
108-
"documentation":"<p>Deletes the specified channel and its associated stream keys.</p> <p>If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call <a>StopStream</a>, wait for the Amazon EventBridge \"Stream End\" event (to verify that the stream's state was changed from Live to Offline), then call DeleteChannel. (See <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html\"> Using EventBridge with Amazon IVS</a>.) </p>"
108+
"documentation":"<p>Deletes the specified channel and its associated stream keys.</p> <p>If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call <a>StopStream</a>, wait for the Amazon EventBridge \"Stream End\" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html\"> Using EventBridge with Amazon IVS</a>.) </p>"
109109
},
110110
"DeletePlaybackKeyPair":{
111111
"name":"DeletePlaybackKeyPair",
@@ -1578,7 +1578,7 @@
15781578
},
15791579
"state":{
15801580
"shape":"StreamState",
1581-
"documentation":"<p>The stream’s state.</p>"
1581+
"documentation":"<p>The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not return it; instead, a \"NotBroadcasting\" error will indicate that the stream is not live.</p>"
15821582
},
15831583
"streamId":{
15841584
"shape":"StreamId",
@@ -1800,7 +1800,7 @@
18001800
},
18011801
"state":{
18021802
"shape":"StreamState",
1803-
"documentation":"<p>The stream’s state.</p>"
1803+
"documentation":"<p>The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not return it; instead, a \"NotBroadcasting\" error will indicate that the stream is not live.</p>"
18041804
},
18051805
"streamId":{
18061806
"shape":"StreamId",

0 commit comments

Comments
 (0)