Skip to content

Commit 51a4ff5

Browse files
author
awstools
committed
docs(client-ivs): Documentation Change for IVS API Reference - Doc-only update to type field description for CreateChannel and UpdateChannel actions and for Channel data type. Also added Amazon Resource Names (ARNs) paragraph to Welcome section.
1 parent df8ddff commit 51a4ff5

File tree

5 files changed

+58
-28
lines changed

5 files changed

+58
-28
lines changed

clients/client-ivs/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,13 @@ the Security page of the <i>Amazon IVS User Guide</i>.</p>
141141
</li>
142142
</ul>
143143
<p>
144+
<b>Amazon Resource Names (ARNs)</b>
145+
</p>
146+
<p>ARNs uniquely identify AWS resources. An ARN is required when you need to specify a
147+
resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
148+
information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
149+
Reference</i>.</p>
150+
<p>
144151
<b>Channel Endpoints</b>
145152
</p>
146153
<ul>
@@ -152,7 +159,7 @@ key to start streaming.</p>
152159
<li>
153160
<p>
154161
<a>GetChannel</a> — Gets the channel configuration for the specified
155-
channel ARN (Amazon Resource Name).</p>
162+
channel ARN.</p>
156163
</li>
157164
<li>
158165
<p>

clients/client-ivs/src/Ivs.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,13 @@ import { IvsClient } from "./IvsClient";
252252
* </li>
253253
* </ul>
254254
* <p>
255+
* <b>Amazon Resource Names (ARNs)</b>
256+
* </p>
257+
* <p>ARNs uniquely identify AWS resources. An ARN is required when you need to specify a
258+
* resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
259+
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
260+
* Reference</i>.</p>
261+
* <p>
255262
* <b>Channel Endpoints</b>
256263
* </p>
257264
* <ul>
@@ -263,7 +270,7 @@ import { IvsClient } from "./IvsClient";
263270
* <li>
264271
* <p>
265272
* <a>GetChannel</a> — Gets the channel configuration for the specified
266-
* channel ARN (Amazon Resource Name).</p>
273+
* channel ARN.</p>
267274
* </li>
268275
* <li>
269276
* <p>

clients/client-ivs/src/IvsClient.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,13 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {}
453453
* </li>
454454
* </ul>
455455
* <p>
456+
* <b>Amazon Resource Names (ARNs)</b>
457+
* </p>
458+
* <p>ARNs uniquely identify AWS resources. An ARN is required when you need to specify a
459+
* resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
460+
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
461+
* Reference</i>.</p>
462+
* <p>
456463
* <b>Channel Endpoints</b>
457464
* </p>
458465
* <ul>
@@ -464,7 +471,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {}
464471
* <li>
465472
* <p>
466473
* <a>GetChannel</a> — Gets the channel configuration for the specified
467-
* channel ARN (Amazon Resource Name).</p>
474+
* channel ARN.</p>
468475
* </li>
469476
* <li>
470477
* <p>

clients/client-ivs/src/models/models_0.ts

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -73,16 +73,19 @@ export interface Channel {
7373
* <ul>
7474
* <li>
7575
* <p>
76-
* <code>STANDARD</code>: Multiple qualities are generated from the original input, to
77-
* automatically give viewers the best experience for their devices and network conditions.
78-
* Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only
79-
* for renditions 360p and below; above that, audio is passed through.</p>
76+
* <code>STANDARD</code>: Video is transcoded: multiple qualities are generated from the
77+
* original input, to automatically give viewers the best experience for their devices and
78+
* network conditions. Transcoding allows higher playback quality across a range of download
79+
* speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is
80+
* transcoded only for renditions 360p and below; above that, audio is passed through. This
81+
* is the default.</p>
8082
* </li>
8183
* <li>
8284
* <p>
83-
* <code>BASIC</code>: Amazon IVS delivers the original input to viewers. The viewer’s
84-
* video-quality choice is limited to the original input. Resolution can be up to 480p and
85-
* bitrate can be up to 1.5 Mbps.</p>
85+
* <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input to
86+
* viewers. The viewer’s video-quality choice is limited to the original input. Resolution
87+
* can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for
88+
* resolutions between 480p and 1080p.</p>
8689
* </li>
8790
* </ul>
8891
*/
@@ -220,16 +223,19 @@ export interface CreateChannelRequest {
220223
* <ul>
221224
* <li>
222225
* <p>
223-
* <code>STANDARD</code>: Multiple qualities are generated from the original input, to
224-
* automatically give viewers the best experience for their devices and network conditions.
225-
* Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only
226-
* for renditions 360p and below; above that, audio is passed through.</p>
226+
* <code>STANDARD</code>: Video is transcoded: multiple qualities are generated from the
227+
* original input, to automatically give viewers the best experience for their devices and
228+
* network conditions. Transcoding allows higher playback quality across a range of download
229+
* speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is
230+
* transcoded only for renditions 360p and below; above that, audio is passed through. This
231+
* is the default.</p>
227232
* </li>
228233
* <li>
229234
* <p>
230-
* <code>BASIC</code>: Amazon IVS delivers the original input to viewers. The viewer’s
231-
* video-quality choice is limited to the original input. Resolution can be up to 480p and
232-
* bitrate can be up to 1.5 Mbps.</p>
235+
* <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input to
236+
* viewers. The viewer’s video-quality choice is limited to the original input. Resolution
237+
* can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for
238+
* resolutions between 480p and 1080p.</p>
233239
* </li>
234240
* </ul>
235241
*/
@@ -1504,16 +1510,19 @@ export interface UpdateChannelRequest {
15041510
* <ul>
15051511
* <li>
15061512
* <p>
1507-
* <code>STANDARD</code>: Multiple qualities are generated from the original input, to
1508-
* automatically give viewers the best experience for their devices and network conditions.
1509-
* Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only
1510-
* for renditions 360p and below; above that, audio is passed through.</p>
1513+
* <code>STANDARD</code>: Video is transcoded: multiple qualities are generated from the
1514+
* original input, to automatically give viewers the best experience for their devices and
1515+
* network conditions. Transcoding allows higher playback quality across a range of download
1516+
* speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is
1517+
* transcoded only for renditions 360p and below; above that, audio is passed through. This
1518+
* is the default.</p>
15111519
* </li>
15121520
* <li>
15131521
* <p>
1514-
* <code>BASIC</code>: Amazon IVS delivers the original input to viewers. The viewer’s
1515-
* video-quality choice is limited to the original input. Resolution can be up to 480p and
1516-
* bitrate can be up to 1.5 Mbps.</p>
1522+
* <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input to
1523+
* viewers. The viewer’s video-quality choice is limited to the original input. Resolution
1524+
* can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for
1525+
* resolutions between 480p and 1080p.</p>
15171526
* </li>
15181527
* </ul>
15191528
*/

0 commit comments

Comments
 (0)