Skip to content

Commit 5d52b43

Browse files
author
awstools
committed
feat(client-ivs-realtime): Adds new Stage Health EventErrorCodes applicable to RTMP(S) broadcasts. Bug Fix: Enforces that EncoderConfiguration Video height and width must be even-number values.
1 parent 525e37e commit 5d52b43

File tree

3 files changed

+122
-16
lines changed

3 files changed

+122
-16
lines changed

clients/client-ivs-realtime/src/commands/ListParticipantEventsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export interface ListParticipantEventsCommandOutput extends ListParticipantEvent
5252
* // participantId: "STRING_VALUE",
5353
* // eventTime: new Date("TIMESTAMP"),
5454
* // remoteParticipantId: "STRING_VALUE",
55-
* // errorCode: "INSUFFICIENT_CAPABILITIES" || "QUOTA_EXCEEDED" || "PUBLISHER_NOT_FOUND" || "BITRATE_EXCEEDED" || "RESOLUTION_EXCEEDED" || "STREAM_DURATION_EXCEEDED" || "INVALID_AUDIO_CODEC" || "INVALID_VIDEO_CODEC" || "INVALID_PROTOCOL" || "INVALID_STREAM_KEY" || "REUSE_OF_STREAM_KEY",
55+
* // errorCode: "INSUFFICIENT_CAPABILITIES" || "QUOTA_EXCEEDED" || "PUBLISHER_NOT_FOUND" || "BITRATE_EXCEEDED" || "RESOLUTION_EXCEEDED" || "STREAM_DURATION_EXCEEDED" || "INVALID_AUDIO_CODEC" || "INVALID_VIDEO_CODEC" || "INVALID_PROTOCOL" || "INVALID_STREAM_KEY" || "REUSE_OF_STREAM_KEY" || "B_FRAME_PRESENT" || "INVALID_INPUT" || "INTERNAL_SERVER_EXCEPTION",
5656
* // },
5757
* // ],
5858
* // nextToken: "STRING_VALUE",

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

Lines changed: 98 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,15 @@ export class ConflictException extends __BaseException {
6161
*/
6262
export interface Video {
6363
/**
64-
* <p>Video-resolution width. Note that the maximum value is determined by <code>width</code>
64+
* <p>Video-resolution width. This must be an even number. Note that the maximum value is determined by <code>width</code>
6565
* times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or
6666
* 1080x1920). Default: 1280.</p>
6767
* @public
6868
*/
6969
width?: number;
7070

7171
/**
72-
* <p>Video-resolution height. Note that the maximum value is determined by <code>width</code>
72+
* <p>Video-resolution height. This must be an even number. Note that the maximum value is determined by <code>width</code>
7373
* times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or
7474
* 1080x1920). Default: 720.</p>
7575
* @public
@@ -2239,8 +2239,11 @@ export interface ListParticipantEventsRequest {
22392239
*/
22402240
export const EventErrorCode = {
22412241
BITRATE_EXCEEDED: "BITRATE_EXCEEDED",
2242+
B_FRAME_PRESENT: "B_FRAME_PRESENT",
22422243
INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES",
2244+
INTERNAL_SERVER_EXCEPTION: "INTERNAL_SERVER_EXCEPTION",
22432245
INVALID_AUDIO_CODEC: "INVALID_AUDIO_CODEC",
2246+
INVALID_INPUT: "INVALID_INPUT",
22442247
INVALID_PROTOCOL: "INVALID_PROTOCOL",
22452248
INVALID_STREAM_KEY: "INVALID_STREAM_KEY",
22462249
INVALID_VIDEO_CODEC: "INVALID_VIDEO_CODEC",
@@ -2310,14 +2313,99 @@ export interface Event {
23102313

23112314
/**
23122315
* <p>If the event is an error event, the error code is provided to give insight into the
2313-
* specific error that occurred. If the event is not an error event, this field is null.
2314-
* <code>INSUFFICIENT_CAPABILITIES</code> indicates that the participant tried to take an
2315-
* action that the participant’s token is not allowed to do. For more information about
2316-
* participant capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>. <code>QUOTA_EXCEEDED</code> indicates that the
2317-
* number of participants who want to publish/subscribe to a stage exceeds the quota; for more
2318-
* information, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">Service Quotas</a>.
2319-
* <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a
2320-
* publisher that doesn’t exist. </p>
2316+
* specific error that occurred. If the event is not an error event, this field is null.</p>
2317+
* <ul>
2318+
* <li>
2319+
* <p>
2320+
* <code>B_FRAME_PRESENT</code> —
2321+
* The participant's stream includes B-frames.
2322+
* For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html">
2323+
* IVS RTMP Publishing</a>.</p>
2324+
* </li>
2325+
* <li>
2326+
* <p>
2327+
* <code>BITRATE_EXCEEDED</code> —
2328+
* The participant exceeded the maximum supported bitrate.
2329+
* For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2330+
* Service Quotas</a>.</p>
2331+
* </li>
2332+
* <li>
2333+
* <p>
2334+
* <code>INSUFFICIENT_CAPABILITIES</code> —
2335+
* The participant tried to take an action
2336+
* that the participant’s token is not allowed to do. For details on participant capabilities, see
2337+
* the <code>capabilities</code> field in <a>CreateParticipantToken</a>.</p>
2338+
* </li>
2339+
* <li>
2340+
* <p>
2341+
* <code>INTERNAL_SERVER_EXCEPTION</code> —
2342+
* The participant failed to publish to the stage due to an internal server error.</p>
2343+
* </li>
2344+
* <li>
2345+
* <p>
2346+
* <code>INVALID_AUDIO_CODEC</code> —
2347+
* The participant is using an invalid audio codec.
2348+
* For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html">
2349+
* Stream Ingest</a>.</p>
2350+
* </li>
2351+
* <li>
2352+
* <p>
2353+
* <code>INVALID_INPUT</code> —
2354+
* The participant is using an invalid input stream.</p>
2355+
* </li>
2356+
* <li>
2357+
* <p>
2358+
* <code>INVALID_PROTOCOL</code> —
2359+
* The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP.
2360+
* For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html">
2361+
* IVS RTMP Publishing</a>.</p>
2362+
* </li>
2363+
* <li>
2364+
* <p>
2365+
* <code>INVALID_STREAM_KEY</code> —
2366+
* The participant is using an invalid stream key.
2367+
* For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html">
2368+
* IVS RTMP Publishing</a>.</p>
2369+
* </li>
2370+
* <li>
2371+
* <p>
2372+
* <code>INVALID_VIDEO_CODEC</code> —
2373+
* The participant is using an invalid video codec.
2374+
* For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html">
2375+
* Stream Ingest</a>.</p>
2376+
* </li>
2377+
* <li>
2378+
* <p>
2379+
* <code>PUBLISHER_NOT_FOUND</code> —
2380+
* The participant tried to subscribe to a publisher that doesn’t exist.</p>
2381+
* </li>
2382+
* <li>
2383+
* <p>
2384+
* <code>QUOTA_EXCEEDED</code> —
2385+
* The number of participants who want to publish/subscribe to a stage exceeds the quota.
2386+
* For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2387+
* Service Quotas</a>.</p>
2388+
* </li>
2389+
* <li>
2390+
* <p>
2391+
* <code>RESOLUTION_EXCEEDED</code> —
2392+
* The participant exceeded the maximum supported resolution.
2393+
* For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2394+
* Service Quotas</a>.</p>
2395+
* </li>
2396+
* <li>
2397+
* <p>
2398+
* <code>REUSE_OF_STREAM_KEY</code> —
2399+
* The participant tried to use a stream key that is associated with another active stage session.</p>
2400+
* </li>
2401+
* <li>
2402+
* <p>
2403+
* <code>STREAM_DURATION_EXCEEDED</code> —
2404+
* The participant exceeded the maximum allowed stream duration.
2405+
* For details, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">
2406+
* Service Quotas</a>.</p>
2407+
* </li>
2408+
* </ul>
23212409
* @public
23222410
*/
23232411
errorCode?: EventErrorCode;

codegen/sdk-codegen/aws-models/ivs-realtime.json

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2190,7 +2190,7 @@
21902190
"errorCode": {
21912191
"target": "com.amazonaws.ivsrealtime#EventErrorCode",
21922192
"traits": {
2193-
"smithy.api#documentation": "<p>If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n <code>INSUFFICIENT_CAPABILITIES</code> indicates that the participant tried to take an\n action that the participant’s token is not allowed to do. For more information about\n participant capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>. <code>QUOTA_EXCEEDED</code> indicates that the\n number of participants who want to publish/subscribe to a stage exceeds the quota; for more\n information, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html\">Service Quotas</a>.\n <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a\n publisher that doesn’t exist. </p>"
2193+
"smithy.api#documentation": "<p>If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.</p>\n <ul>\n <li>\n <p>\n <code>B_FRAME_PRESENT</code> —\n\t\t The participant's stream includes B-frames.\n\t\t For details, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html\">\n\t\t IVS RTMP Publishing</a>.</p>\n </li>\n <li>\n <p>\n <code>BITRATE_EXCEEDED</code> —\n\t\t The participant exceeded the maximum supported bitrate.\n\t\t For details, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html\">\n\t\t Service Quotas</a>.</p>\n </li>\n <li>\n <p>\n <code>INSUFFICIENT_CAPABILITIES</code> —\n\t\t The participant tried to take an action\n\t\t that the participant’s token is not allowed to do. For details on participant capabilities, see\n\t\t the <code>capabilities</code> field in <a>CreateParticipantToken</a>.</p>\n </li>\n <li>\n <p>\n <code>INTERNAL_SERVER_EXCEPTION</code> —\n\t\t The participant failed to publish to the stage due to an internal server error.</p>\n </li>\n <li>\n <p>\n <code>INVALID_AUDIO_CODEC</code> —\n\t\t The participant is using an invalid audio codec.\n\t\t For details, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html\">\n\t\t Stream Ingest</a>.</p>\n </li>\n <li>\n <p>\n <code>INVALID_INPUT</code> —\n\t\t The participant is using an invalid input stream.</p>\n </li>\n <li>\n <p>\n <code>INVALID_PROTOCOL</code> —\n\t\t The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP.\n\t\t For details, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html\">\n\t\t IVS RTMP Publishing</a>.</p>\n </li>\n <li>\n <p>\n <code>INVALID_STREAM_KEY</code> —\n\t\t The participant is using an invalid stream key.\n\t\t For details, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html\">\n\t\t IVS RTMP Publishing</a>.</p>\n </li>\n <li>\n <p>\n <code>INVALID_VIDEO_CODEC</code> —\n\t\t The participant is using an invalid video codec.\n\t\t For details, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html\">\n\t\t Stream Ingest</a>.</p>\n </li>\n <li>\n <p>\n <code>PUBLISHER_NOT_FOUND</code> —\n\t\t The participant tried to subscribe to a publisher that doesn’t exist.</p>\n </li>\n <li>\n <p>\n <code>QUOTA_EXCEEDED</code> —\n\t\t The number of participants who want to publish/subscribe to a stage exceeds the quota.\n\t\t For details, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html\">\n\t\t Service Quotas</a>.</p>\n </li>\n <li>\n <p>\n <code>RESOLUTION_EXCEEDED</code> —\n\t\t The participant exceeded the maximum supported resolution.\n\t\t For details, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html\">\n\t\t Service Quotas</a>.</p>\n </li>\n <li>\n <p>\n <code>REUSE_OF_STREAM_KEY</code> —\n\t\t The participant tried to use a stream key that is associated with another active stage session.</p>\n </li>\n <li>\n <p>\n <code>STREAM_DURATION_EXCEEDED</code> —\n\t\t The participant exceeded the maximum allowed stream duration.\n\t\t For details, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html\">\n\t\t Service Quotas</a>.</p>\n </li>\n </ul>"
21942194
}
21952195
}
21962196
},
@@ -2266,6 +2266,24 @@
22662266
"traits": {
22672267
"smithy.api#enumValue": "REUSE_OF_STREAM_KEY"
22682268
}
2269+
},
2270+
"B_FRAME_PRESENT": {
2271+
"target": "smithy.api#Unit",
2272+
"traits": {
2273+
"smithy.api#enumValue": "B_FRAME_PRESENT"
2274+
}
2275+
},
2276+
"INVALID_INPUT": {
2277+
"target": "smithy.api#Unit",
2278+
"traits": {
2279+
"smithy.api#enumValue": "INVALID_INPUT"
2280+
}
2281+
},
2282+
"INTERNAL_SERVER_EXCEPTION": {
2283+
"target": "smithy.api#Unit",
2284+
"traits": {
2285+
"smithy.api#enumValue": "INTERNAL_SERVER_EXCEPTION"
2286+
}
22692287
}
22702288
}
22712289
},
@@ -2878,7 +2896,7 @@
28782896
"type": "integer",
28792897
"traits": {
28802898
"smithy.api#range": {
2881-
"min": 1,
2899+
"min": 2,
28822900
"max": 1920
28832901
}
28842902
}
@@ -5795,13 +5813,13 @@
57955813
"width": {
57965814
"target": "com.amazonaws.ivsrealtime#Width",
57975815
"traits": {
5798-
"smithy.api#documentation": "<p>Video-resolution width. Note that the maximum value is determined by <code>width</code>\n times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 1280.</p>"
5816+
"smithy.api#documentation": "<p>Video-resolution width. This must be an even number. Note that the maximum value is determined by <code>width</code>\n times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 1280.</p>"
57995817
}
58005818
},
58015819
"height": {
58025820
"target": "com.amazonaws.ivsrealtime#Height",
58035821
"traits": {
5804-
"smithy.api#documentation": "<p>Video-resolution height. Note that the maximum value is determined by <code>width</code>\n times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 720.</p>"
5822+
"smithy.api#documentation": "<p>Video-resolution height. This must be an even number. Note that the maximum value is determined by <code>width</code>\n times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 720.</p>"
58055823
}
58065824
},
58075825
"framerate": {
@@ -5877,7 +5895,7 @@
58775895
"type": "integer",
58785896
"traits": {
58795897
"smithy.api#range": {
5880-
"min": 1,
5898+
"min": 2,
58815899
"max": 1920
58825900
}
58835901
}

0 commit comments

Comments
 (0)