Skip to content

Commit 9d14837

Browse files
author
awstools
committed
feat(client-ivs): API update to include an SRT ingest endpoint and passphrase for all channels.
1 parent 30e75ea commit 9d14837

File tree

12 files changed

+228
-130
lines changed

12 files changed

+228
-130
lines changed

‎clients/client-ivs/README.md‎

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -47,49 +47,34 @@ History</a>.</p>
4747
</li>
4848
</ul>
4949
<p>
50-
<b>Resources</b>
50+
<b>Key Concepts</b>
5151
</p>
52-
<p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with
53-
Amazon IVS</a>):</p>
5452
<ul>
5553
<li>
5654
<p>
57-
<b>Channel</b> — Stores configuration data related to your
58-
live stream. You first create a channel and then use the channel’s stream key to start
59-
your live stream. See the Channel endpoints for more information. </p>
55+
<b>Channel</b> — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.</p>
6056
</li>
6157
<li>
6258
<p>
63-
<b>Stream key</b> — An identifier assigned by Amazon IVS
64-
when you create a channel, which is then used to authorize streaming. See the StreamKey
65-
endpoints for more information. <i>
66-
<b>Treat the stream key like
67-
a secret, since it allows anyone to stream to the
68-
channel.</b>
59+
<b>Stream key</b> — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. <i>
60+
<b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b>
6961
</i>
7062
</p>
7163
</li>
7264
<li>
7365
<p>
74-
<b>Playback key pair</b> — Video playback may be restricted
75-
using playback-authorization tokens, which use public-key encryption. A playback key pair
76-
is the public-private pair of keys used to sign and validate the playback-authorization
77-
token. See the PlaybackKeyPair endpoints for more information.</p>
66+
<b>Playback key pair</b> — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.</p>
7867
</li>
7968
<li>
8069
<p>
81-
<b>Recording configuration</b> — Stores configuration
82-
related to recording a live stream and where to store the recorded content. Multiple
83-
channels can reference the same recording configuration. See the Recording Configuration
84-
endpoints for more information.</p>
70+
<b>Recording configuration</b> — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.</p>
8571
</li>
8672
<li>
8773
<p>
88-
<b>Playback restriction policy</b> — Restricts playback by
89-
countries and/or origin sites. See the Playback Restriction Policy endpoints for more
90-
information.</p>
74+
<b>Playback restriction policy</b> — Restricts playback by countries and/or origin sites.</p>
9175
</li>
9276
</ul>
77+
<p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html">Getting Started with IVS Low-Latency Streaming</a>.</p>
9378
<p>
9479
<b>Tagging</b>
9580
</p>
@@ -268,7 +253,7 @@ simultaneously.</p>
268253
</li>
269254
</ul>
270255
<p>
271-
<b>RecordingConfiguration Endpoints</b>
256+
<b>Recording Configuration Endpoints</b>
272257
</p>
273258
<ul>
274259
<li>
@@ -333,7 +318,7 @@ allowed.</p>
333318
</li>
334319
</ul>
335320
<p>
336-
<b>StreamKey Endpoints</b>
321+
<b>Stream Key Endpoints</b>
337322
</p>
338323
<ul>
339324
<li>

‎clients/client-ivs/src/Ivs.ts‎

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -755,49 +755,34 @@ export interface Ivs {
755755
* </li>
756756
* </ul>
757757
* <p>
758-
* <b>Resources</b>
758+
* <b>Key Concepts</b>
759759
* </p>
760-
* <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with
761-
* Amazon IVS</a>):</p>
762760
* <ul>
763761
* <li>
764762
* <p>
765-
* <b>Channel</b> — Stores configuration data related to your
766-
* live stream. You first create a channel and then use the channel’s stream key to start
767-
* your live stream. See the Channel endpoints for more information. </p>
763+
* <b>Channel</b> — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.</p>
768764
* </li>
769765
* <li>
770766
* <p>
771-
* <b>Stream key</b> — An identifier assigned by Amazon IVS
772-
* when you create a channel, which is then used to authorize streaming. See the StreamKey
773-
* endpoints for more information. <i>
774-
* <b>Treat the stream key like
775-
* a secret, since it allows anyone to stream to the
776-
* channel.</b>
767+
* <b>Stream key</b> — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. <i>
768+
* <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b>
777769
* </i>
778770
* </p>
779771
* </li>
780772
* <li>
781773
* <p>
782-
* <b>Playback key pair</b> — Video playback may be restricted
783-
* using playback-authorization tokens, which use public-key encryption. A playback key pair
784-
* is the public-private pair of keys used to sign and validate the playback-authorization
785-
* token. See the PlaybackKeyPair endpoints for more information.</p>
774+
* <b>Playback key pair</b> — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.</p>
786775
* </li>
787776
* <li>
788777
* <p>
789-
* <b>Recording configuration</b> — Stores configuration
790-
* related to recording a live stream and where to store the recorded content. Multiple
791-
* channels can reference the same recording configuration. See the Recording Configuration
792-
* endpoints for more information.</p>
778+
* <b>Recording configuration</b> — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.</p>
793779
* </li>
794780
* <li>
795781
* <p>
796-
* <b>Playback restriction policy</b> — Restricts playback by
797-
* countries and/or origin sites. See the Playback Restriction Policy endpoints for more
798-
* information.</p>
782+
* <b>Playback restriction policy</b> — Restricts playback by countries and/or origin sites.</p>
799783
* </li>
800784
* </ul>
785+
* <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html">Getting Started with IVS Low-Latency Streaming</a>.</p>
801786
* <p>
802787
* <b>Tagging</b>
803788
* </p>
@@ -976,7 +961,7 @@ export interface Ivs {
976961
* </li>
977962
* </ul>
978963
* <p>
979-
* <b>RecordingConfiguration Endpoints</b>
964+
* <b>Recording Configuration Endpoints</b>
980965
* </p>
981966
* <ul>
982967
* <li>
@@ -1041,7 +1026,7 @@ export interface Ivs {
10411026
* </li>
10421027
* </ul>
10431028
* <p>
1044-
* <b>StreamKey Endpoints</b>
1029+
* <b>Stream Key Endpoints</b>
10451030
* </p>
10461031
* <ul>
10471032
* <li>

‎clients/client-ivs/src/IvsClient.ts‎

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -437,49 +437,34 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {}
437437
* </li>
438438
* </ul>
439439
* <p>
440-
* <b>Resources</b>
440+
* <b>Key Concepts</b>
441441
* </p>
442-
* <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with
443-
* Amazon IVS</a>):</p>
444442
* <ul>
445443
* <li>
446444
* <p>
447-
* <b>Channel</b> — Stores configuration data related to your
448-
* live stream. You first create a channel and then use the channel’s stream key to start
449-
* your live stream. See the Channel endpoints for more information. </p>
445+
* <b>Channel</b> — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.</p>
450446
* </li>
451447
* <li>
452448
* <p>
453-
* <b>Stream key</b> — An identifier assigned by Amazon IVS
454-
* when you create a channel, which is then used to authorize streaming. See the StreamKey
455-
* endpoints for more information. <i>
456-
* <b>Treat the stream key like
457-
* a secret, since it allows anyone to stream to the
458-
* channel.</b>
449+
* <b>Stream key</b> — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. <i>
450+
* <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b>
459451
* </i>
460452
* </p>
461453
* </li>
462454
* <li>
463455
* <p>
464-
* <b>Playback key pair</b> — Video playback may be restricted
465-
* using playback-authorization tokens, which use public-key encryption. A playback key pair
466-
* is the public-private pair of keys used to sign and validate the playback-authorization
467-
* token. See the PlaybackKeyPair endpoints for more information.</p>
456+
* <b>Playback key pair</b> — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.</p>
468457
* </li>
469458
* <li>
470459
* <p>
471-
* <b>Recording configuration</b> — Stores configuration
472-
* related to recording a live stream and where to store the recorded content. Multiple
473-
* channels can reference the same recording configuration. See the Recording Configuration
474-
* endpoints for more information.</p>
460+
* <b>Recording configuration</b> — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.</p>
475461
* </li>
476462
* <li>
477463
* <p>
478-
* <b>Playback restriction policy</b> — Restricts playback by
479-
* countries and/or origin sites. See the Playback Restriction Policy endpoints for more
480-
* information.</p>
464+
* <b>Playback restriction policy</b> — Restricts playback by countries and/or origin sites.</p>
481465
* </li>
482466
* </ul>
467+
* <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html">Getting Started with IVS Low-Latency Streaming</a>.</p>
483468
* <p>
484469
* <b>Tagging</b>
485470
* </p>
@@ -658,7 +643,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {}
658643
* </li>
659644
* </ul>
660645
* <p>
661-
* <b>RecordingConfiguration Endpoints</b>
646+
* <b>Recording Configuration Endpoints</b>
662647
* </p>
663648
* <ul>
664649
* <li>
@@ -723,7 +708,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {}
723708
* </li>
724709
* </ul>
725710
* <p>
726-
* <b>StreamKey Endpoints</b>
711+
* <b>Stream Key Endpoints</b>
727712
* </p>
728713
* <ul>
729714
* <li>

‎clients/client-ivs/src/commands/BatchGetChannelCommand.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
88
import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
9-
import { BatchGetChannelRequest, BatchGetChannelResponse } from "../models/models_0";
9+
import {
10+
BatchGetChannelRequest,
11+
BatchGetChannelResponse,
12+
BatchGetChannelResponseFilterSensitiveLog,
13+
} from "../models/models_0";
1014
import { de_BatchGetChannelCommand, se_BatchGetChannelCommand } from "../protocols/Aws_restJson1";
1115

1216
/**
@@ -57,6 +61,10 @@ export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, _
5761
* // },
5862
* // insecureIngest: true || false,
5963
* // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
64+
* // srt: { // Srt
65+
* // endpoint: "STRING_VALUE",
66+
* // passphrase: "STRING_VALUE",
67+
* // },
6068
* // playbackRestrictionPolicyArn: "STRING_VALUE",
6169
* // },
6270
* // ],
@@ -101,7 +109,7 @@ export class BatchGetChannelCommand extends $Command
101109
})
102110
.s("AmazonInteractiveVideoService", "BatchGetChannel", {})
103111
.n("IvsClient", "BatchGetChannelCommand")
104-
.f(void 0, void 0)
112+
.f(void 0, BatchGetChannelResponseFilterSensitiveLog)
105113
.ser(se_BatchGetChannelCommand)
106114
.de(de_BatchGetChannelCommand)
107115
.build() {}

‎clients/client-ivs/src/commands/CreateChannelCommand.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
6868
* // },
6969
* // insecureIngest: true || false,
7070
* // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
71+
* // srt: { // Srt
72+
* // endpoint: "STRING_VALUE",
73+
* // passphrase: "STRING_VALUE",
74+
* // },
7175
* // playbackRestrictionPolicyArn: "STRING_VALUE",
7276
* // },
7377
* // streamKey: { // StreamKey

‎clients/client-ivs/src/commands/GetChannelCommand.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
88
import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
9-
import { GetChannelRequest, GetChannelResponse } from "../models/models_0";
9+
import { GetChannelRequest, GetChannelResponse, GetChannelResponseFilterSensitiveLog } from "../models/models_0";
1010
import { de_GetChannelCommand, se_GetChannelCommand } from "../protocols/Aws_restJson1";
1111

1212
/**
@@ -54,6 +54,10 @@ export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataB
5454
* // },
5555
* // insecureIngest: true || false,
5656
* // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
57+
* // srt: { // Srt
58+
* // endpoint: "STRING_VALUE",
59+
* // passphrase: "STRING_VALUE",
60+
* // },
5761
* // playbackRestrictionPolicyArn: "STRING_VALUE",
5862
* // },
5963
* // };
@@ -99,7 +103,7 @@ export class GetChannelCommand extends $Command
99103
})
100104
.s("AmazonInteractiveVideoService", "GetChannel", {})
101105
.n("IvsClient", "GetChannelCommand")
102-
.f(void 0, void 0)
106+
.f(void 0, GetChannelResponseFilterSensitiveLog)
103107
.ser(se_GetChannelCommand)
104108
.de(de_GetChannelCommand)
105109
.build() {}

‎clients/client-ivs/src/commands/GetStreamSessionCommand.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
88
import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
9-
import { GetStreamSessionRequest, GetStreamSessionResponse } from "../models/models_0";
9+
import {
10+
GetStreamSessionRequest,
11+
GetStreamSessionResponse,
12+
GetStreamSessionResponseFilterSensitiveLog,
13+
} from "../models/models_0";
1014
import { de_GetStreamSessionCommand, se_GetStreamSessionCommand } from "../protocols/Aws_restJson1";
1115

1216
/**
@@ -59,6 +63,10 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
5963
* // },
6064
* // insecureIngest: true || false,
6165
* // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
66+
* // srt: { // Srt
67+
* // endpoint: "STRING_VALUE",
68+
* // passphrase: "STRING_VALUE",
69+
* // },
6270
* // playbackRestrictionPolicyArn: "STRING_VALUE",
6371
* // },
6472
* // ingestConfiguration: { // IngestConfiguration
@@ -158,7 +166,7 @@ export class GetStreamSessionCommand extends $Command
158166
})
159167
.s("AmazonInteractiveVideoService", "GetStreamSession", {})
160168
.n("IvsClient", "GetStreamSessionCommand")
161-
.f(void 0, void 0)
169+
.f(void 0, GetStreamSessionResponseFilterSensitiveLog)
162170
.ser(se_GetStreamSessionCommand)
163171
.de(de_GetStreamSessionCommand)
164172
.build() {}

‎clients/client-ivs/src/commands/UpdateChannelCommand.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
88
import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
9-
import { UpdateChannelRequest, UpdateChannelResponse } from "../models/models_0";
9+
import {
10+
UpdateChannelRequest,
11+
UpdateChannelResponse,
12+
UpdateChannelResponseFilterSensitiveLog,
13+
} from "../models/models_0";
1014
import { de_UpdateChannelCommand, se_UpdateChannelCommand } from "../protocols/Aws_restJson1";
1115

1216
/**
@@ -64,6 +68,10 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
6468
* // },
6569
* // insecureIngest: true || false,
6670
* // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
71+
* // srt: { // Srt
72+
* // endpoint: "STRING_VALUE",
73+
* // passphrase: "STRING_VALUE",
74+
* // },
6775
* // playbackRestrictionPolicyArn: "STRING_VALUE",
6876
* // },
6977
* // };
@@ -115,7 +123,7 @@ export class UpdateChannelCommand extends $Command
115123
})
116124
.s("AmazonInteractiveVideoService", "UpdateChannel", {})
117125
.n("IvsClient", "UpdateChannelCommand")
118-
.f(void 0, void 0)
126+
.f(void 0, UpdateChannelResponseFilterSensitiveLog)
119127
.ser(se_UpdateChannelCommand)
120128
.de(de_UpdateChannelCommand)
121129
.build() {}

0 commit comments

Comments
 (0)