@aws-sdk/client-ivs 3.325.0 → 3.327.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/dist-types/commands/BatchGetChannelCommand.d.ts +28 -0
  2. package/dist-types/commands/BatchGetStreamKeyCommand.d.ts +22 -0
  3. package/dist-types/commands/CreateChannelCommand.d.ts +27 -0
  4. package/dist-types/commands/CreateRecordingConfigurationCommand.d.ts +23 -0
  5. package/dist-types/commands/CreateStreamKeyCommand.d.ts +13 -0
  6. package/dist-types/commands/DeleteChannelCommand.d.ts +4 -0
  7. package/dist-types/commands/DeletePlaybackKeyPairCommand.d.ts +4 -0
  8. package/dist-types/commands/DeleteRecordingConfigurationCommand.d.ts +4 -0
  9. package/dist-types/commands/DeleteStreamKeyCommand.d.ts +4 -0
  10. package/dist-types/commands/GetChannelCommand.d.ts +19 -0
  11. package/dist-types/commands/GetPlaybackKeyPairCommand.d.ts +13 -0
  12. package/dist-types/commands/GetRecordingConfigurationCommand.d.ts +23 -0
  13. package/dist-types/commands/GetStreamCommand.d.ts +14 -0
  14. package/dist-types/commands/GetStreamKeyCommand.d.ts +13 -0
  15. package/dist-types/commands/GetStreamSessionCommand.d.ts +67 -0
  16. package/dist-types/commands/ImportPlaybackKeyPairCommand.d.ts +13 -0
  17. package/dist-types/commands/ListChannelsCommand.d.ts +19 -0
  18. package/dist-types/commands/ListPlaybackKeyPairsCommand.d.ts +15 -0
  19. package/dist-types/commands/ListRecordingConfigurationsCommand.d.ts +21 -0
  20. package/dist-types/commands/ListStreamKeysCommand.d.ts +15 -0
  21. package/dist-types/commands/ListStreamSessionsCommand.d.ts +14 -0
  22. package/dist-types/commands/ListStreamsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  24. package/dist-types/commands/PutMetadataCommand.d.ts +4 -0
  25. package/dist-types/commands/StopStreamCommand.d.ts +4 -0
  26. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  27. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  28. package/dist-types/commands/UpdateChannelCommand.d.ts +19 -0
  29. package/package.json +7 -7
@@ -33,6 +33,32 @@ export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, _
33
33
  * };
34
34
  * const command = new BatchGetChannelCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // BatchGetChannelResponse
37
+ * // channels: [ // Channels
38
+ * // { // Channel
39
+ * // arn: "STRING_VALUE",
40
+ * // name: "STRING_VALUE",
41
+ * // latencyMode: "STRING_VALUE",
42
+ * // type: "BASIC" || "STANDARD",
43
+ * // recordingConfigurationArn: "STRING_VALUE",
44
+ * // ingestEndpoint: "STRING_VALUE",
45
+ * // playbackUrl: "STRING_VALUE",
46
+ * // authorized: true || false,
47
+ * // tags: { // Tags
48
+ * // "<keys>": "STRING_VALUE",
49
+ * // },
50
+ * // insecureIngest: true || false,
51
+ * // },
52
+ * // ],
53
+ * // errors: [ // BatchErrors
54
+ * // { // BatchError
55
+ * // arn: "STRING_VALUE",
56
+ * // code: "STRING_VALUE",
57
+ * // message: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // };
61
+ *
36
62
  * ```
37
63
  *
38
64
  * @param BatchGetChannelCommandInput - {@link BatchGetChannelCommandInput}
@@ -41,6 +67,8 @@ export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, _
41
67
  * @see {@link BatchGetChannelCommandOutput} for command's `response` shape.
42
68
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
43
69
  *
70
+ * @throws {@link IvsServiceException}
71
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
44
72
  *
45
73
  */
46
74
  export declare class BatchGetChannelCommand extends $Command<BatchGetChannelCommandInput, BatchGetChannelCommandOutput, IvsClientResolvedConfig> {
@@ -33,6 +33,26 @@ export interface BatchGetStreamKeyCommandOutput extends BatchGetStreamKeyRespons
33
33
  * };
34
34
  * const command = new BatchGetStreamKeyCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // BatchGetStreamKeyResponse
37
+ * // streamKeys: [ // StreamKeys
38
+ * // { // StreamKey
39
+ * // arn: "STRING_VALUE",
40
+ * // value: "STRING_VALUE",
41
+ * // channelArn: "STRING_VALUE",
42
+ * // tags: { // Tags
43
+ * // "<keys>": "STRING_VALUE",
44
+ * // },
45
+ * // },
46
+ * // ],
47
+ * // errors: [ // BatchErrors
48
+ * // { // BatchError
49
+ * // arn: "STRING_VALUE",
50
+ * // code: "STRING_VALUE",
51
+ * // message: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // };
55
+ *
36
56
  * ```
37
57
  *
38
58
  * @param BatchGetStreamKeyCommandInput - {@link BatchGetStreamKeyCommandInput}
@@ -41,6 +61,8 @@ export interface BatchGetStreamKeyCommandOutput extends BatchGetStreamKeyRespons
41
61
  * @see {@link BatchGetStreamKeyCommandOutput} for command's `response` shape.
42
62
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
43
63
  *
64
+ * @throws {@link IvsServiceException}
65
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
44
66
  *
45
67
  */
46
68
  export declare class BatchGetStreamKeyCommand extends $Command<BatchGetStreamKeyCommandInput, BatchGetStreamKeyCommandOutput, IvsClientResolvedConfig> {
@@ -39,6 +39,31 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
39
39
  * };
40
40
  * const command = new CreateChannelCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // CreateChannelResponse
43
+ * // channel: { // Channel
44
+ * // arn: "STRING_VALUE",
45
+ * // name: "STRING_VALUE",
46
+ * // latencyMode: "STRING_VALUE",
47
+ * // type: "BASIC" || "STANDARD",
48
+ * // recordingConfigurationArn: "STRING_VALUE",
49
+ * // ingestEndpoint: "STRING_VALUE",
50
+ * // playbackUrl: "STRING_VALUE",
51
+ * // authorized: true || false,
52
+ * // tags: { // Tags
53
+ * // "<keys>": "STRING_VALUE",
54
+ * // },
55
+ * // insecureIngest: true || false,
56
+ * // },
57
+ * // streamKey: { // StreamKey
58
+ * // arn: "STRING_VALUE",
59
+ * // value: "STRING_VALUE",
60
+ * // channelArn: "STRING_VALUE",
61
+ * // tags: {
62
+ * // "<keys>": "STRING_VALUE",
63
+ * // },
64
+ * // },
65
+ * // };
66
+ *
42
67
  * ```
43
68
  *
44
69
  * @param CreateChannelCommandInput - {@link CreateChannelCommandInput}
@@ -62,6 +87,8 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
62
87
  * @throws {@link ValidationException} (client fault)
63
88
  * <p/>
64
89
  *
90
+ * @throws {@link IvsServiceException}
91
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
65
92
  *
66
93
  */
67
94
  export declare class CreateChannelCommand extends $Command<CreateChannelCommandInput, CreateChannelCommandOutput, IvsClientResolvedConfig> {
@@ -55,6 +55,27 @@ export interface CreateRecordingConfigurationCommandOutput extends CreateRecordi
55
55
  * };
56
56
  * const command = new CreateRecordingConfigurationCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // CreateRecordingConfigurationResponse
59
+ * // recordingConfiguration: { // RecordingConfiguration
60
+ * // arn: "STRING_VALUE", // required
61
+ * // name: "STRING_VALUE",
62
+ * // destinationConfiguration: { // DestinationConfiguration
63
+ * // s3: { // S3DestinationConfiguration
64
+ * // bucketName: "STRING_VALUE", // required
65
+ * // },
66
+ * // },
67
+ * // state: "STRING_VALUE", // required
68
+ * // tags: { // Tags
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // thumbnailConfiguration: { // ThumbnailConfiguration
72
+ * // recordingMode: "STRING_VALUE",
73
+ * // targetIntervalSeconds: Number("long"),
74
+ * // },
75
+ * // recordingReconnectWindowSeconds: Number("int"),
76
+ * // },
77
+ * // };
78
+ *
58
79
  * ```
59
80
  *
60
81
  * @param CreateRecordingConfigurationCommandInput - {@link CreateRecordingConfigurationCommandInput}
@@ -81,6 +102,8 @@ export interface CreateRecordingConfigurationCommandOutput extends CreateRecordi
81
102
  * @throws {@link ValidationException} (client fault)
82
103
  * <p/>
83
104
  *
105
+ * @throws {@link IvsServiceException}
106
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
84
107
  *
85
108
  */
86
109
  export declare class CreateRecordingConfigurationCommand extends $Command<CreateRecordingConfigurationCommandInput, CreateRecordingConfigurationCommandOutput, IvsClientResolvedConfig> {
@@ -37,6 +37,17 @@ export interface CreateStreamKeyCommandOutput extends CreateStreamKeyResponse, _
37
37
  * };
38
38
  * const command = new CreateStreamKeyCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // CreateStreamKeyResponse
41
+ * // streamKey: { // StreamKey
42
+ * // arn: "STRING_VALUE",
43
+ * // value: "STRING_VALUE",
44
+ * // channelArn: "STRING_VALUE",
45
+ * // tags: { // Tags
46
+ * // "<keys>": "STRING_VALUE",
47
+ * // },
48
+ * // },
49
+ * // };
50
+ *
40
51
  * ```
41
52
  *
42
53
  * @param CreateStreamKeyCommandInput - {@link CreateStreamKeyCommandInput}
@@ -60,6 +71,8 @@ export interface CreateStreamKeyCommandOutput extends CreateStreamKeyResponse, _
60
71
  * @throws {@link ValidationException} (client fault)
61
72
  * <p/>
62
73
  *
74
+ * @throws {@link IvsServiceException}
75
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
63
76
  *
64
77
  */
65
78
  export declare class CreateStreamKeyCommand extends $Command<CreateStreamKeyCommandInput, CreateStreamKeyCommandOutput, IvsClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
35
35
  * };
36
36
  * const command = new DeleteChannelCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DeleteChannelCommandInput - {@link DeleteChannelCommandInput}
@@ -58,6 +60,8 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
58
60
  * @throws {@link ValidationException} (client fault)
59
61
  * <p/>
60
62
  *
63
+ * @throws {@link IvsServiceException}
64
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
61
65
  *
62
66
  */
63
67
  export declare class DeleteChannelCommand extends $Command<DeleteChannelCommandInput, DeleteChannelCommandOutput, IvsClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeletePlaybackKeyPairCommandOutput extends DeletePlaybackKeyPai
33
33
  * };
34
34
  * const command = new DeletePlaybackKeyPairCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeletePlaybackKeyPairCommandInput - {@link DeletePlaybackKeyPairCommandInput}
@@ -53,6 +55,8 @@ export interface DeletePlaybackKeyPairCommandOutput extends DeletePlaybackKeyPai
53
55
  * @throws {@link ValidationException} (client fault)
54
56
  * <p/>
55
57
  *
58
+ * @throws {@link IvsServiceException}
59
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
56
60
  *
57
61
  */
58
62
  export declare class DeletePlaybackKeyPairCommand extends $Command<DeletePlaybackKeyPairCommandInput, DeletePlaybackKeyPairCommandOutput, IvsClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface DeleteRecordingConfigurationCommandOutput extends __MetadataBea
36
36
  * };
37
37
  * const command = new DeleteRecordingConfigurationCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param DeleteRecordingConfigurationCommandInput - {@link DeleteRecordingConfigurationCommandInput}
@@ -59,6 +61,8 @@ export interface DeleteRecordingConfigurationCommandOutput extends __MetadataBea
59
61
  * @throws {@link ValidationException} (client fault)
60
62
  * <p/>
61
63
  *
64
+ * @throws {@link IvsServiceException}
65
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
62
66
  *
63
67
  */
64
68
  export declare class DeleteRecordingConfigurationCommand extends $Command<DeleteRecordingConfigurationCommandInput, DeleteRecordingConfigurationCommandOutput, IvsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteStreamKeyCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteStreamKeyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteStreamKeyCommandInput - {@link DeleteStreamKeyCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteStreamKeyCommandOutput extends __MetadataBearer {
52
54
  * @throws {@link ValidationException} (client fault)
53
55
  * <p/>
54
56
  *
57
+ * @throws {@link IvsServiceException}
58
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeleteStreamKeyCommand extends $Command<DeleteStreamKeyCommandInput, DeleteStreamKeyCommandOutput, IvsClientResolvedConfig> {
@@ -31,6 +31,23 @@ export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataB
31
31
  * };
32
32
  * const command = new GetChannelCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetChannelResponse
35
+ * // channel: { // Channel
36
+ * // arn: "STRING_VALUE",
37
+ * // name: "STRING_VALUE",
38
+ * // latencyMode: "STRING_VALUE",
39
+ * // type: "BASIC" || "STANDARD",
40
+ * // recordingConfigurationArn: "STRING_VALUE",
41
+ * // ingestEndpoint: "STRING_VALUE",
42
+ * // playbackUrl: "STRING_VALUE",
43
+ * // authorized: true || false,
44
+ * // tags: { // Tags
45
+ * // "<keys>": "STRING_VALUE",
46
+ * // },
47
+ * // insecureIngest: true || false,
48
+ * // },
49
+ * // };
50
+ *
34
51
  * ```
35
52
  *
36
53
  * @param GetChannelCommandInput - {@link GetChannelCommandInput}
@@ -48,6 +65,8 @@ export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataB
48
65
  * @throws {@link ValidationException} (client fault)
49
66
  * <p/>
50
67
  *
68
+ * @throws {@link IvsServiceException}
69
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
51
70
  *
52
71
  */
53
72
  export declare class GetChannelCommand extends $Command<GetChannelCommandInput, GetChannelCommandOutput, IvsClientResolvedConfig> {
@@ -35,6 +35,17 @@ export interface GetPlaybackKeyPairCommandOutput extends GetPlaybackKeyPairRespo
35
35
  * };
36
36
  * const command = new GetPlaybackKeyPairCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // GetPlaybackKeyPairResponse
39
+ * // keyPair: { // PlaybackKeyPair
40
+ * // arn: "STRING_VALUE",
41
+ * // name: "STRING_VALUE",
42
+ * // fingerprint: "STRING_VALUE",
43
+ * // tags: { // Tags
44
+ * // "<keys>": "STRING_VALUE",
45
+ * // },
46
+ * // },
47
+ * // };
48
+ *
38
49
  * ```
39
50
  *
40
51
  * @param GetPlaybackKeyPairCommandInput - {@link GetPlaybackKeyPairCommandInput}
@@ -52,6 +63,8 @@ export interface GetPlaybackKeyPairCommandOutput extends GetPlaybackKeyPairRespo
52
63
  * @throws {@link ValidationException} (client fault)
53
64
  * <p/>
54
65
  *
66
+ * @throws {@link IvsServiceException}
67
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
55
68
  *
56
69
  */
57
70
  export declare class GetPlaybackKeyPairCommand extends $Command<GetPlaybackKeyPairCommandInput, GetPlaybackKeyPairCommandOutput, IvsClientResolvedConfig> {
@@ -31,6 +31,27 @@ export interface GetRecordingConfigurationCommandOutput extends GetRecordingConf
31
31
  * };
32
32
  * const command = new GetRecordingConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetRecordingConfigurationResponse
35
+ * // recordingConfiguration: { // RecordingConfiguration
36
+ * // arn: "STRING_VALUE", // required
37
+ * // name: "STRING_VALUE",
38
+ * // destinationConfiguration: { // DestinationConfiguration
39
+ * // s3: { // S3DestinationConfiguration
40
+ * // bucketName: "STRING_VALUE", // required
41
+ * // },
42
+ * // },
43
+ * // state: "STRING_VALUE", // required
44
+ * // tags: { // Tags
45
+ * // "<keys>": "STRING_VALUE",
46
+ * // },
47
+ * // thumbnailConfiguration: { // ThumbnailConfiguration
48
+ * // recordingMode: "STRING_VALUE",
49
+ * // targetIntervalSeconds: Number("long"),
50
+ * // },
51
+ * // recordingReconnectWindowSeconds: Number("int"),
52
+ * // },
53
+ * // };
54
+ *
34
55
  * ```
35
56
  *
36
57
  * @param GetRecordingConfigurationCommandInput - {@link GetRecordingConfigurationCommandInput}
@@ -51,6 +72,8 @@ export interface GetRecordingConfigurationCommandOutput extends GetRecordingConf
51
72
  * @throws {@link ValidationException} (client fault)
52
73
  * <p/>
53
74
  *
75
+ * @throws {@link IvsServiceException}
76
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
54
77
  *
55
78
  */
56
79
  export declare class GetRecordingConfigurationCommand extends $Command<GetRecordingConfigurationCommandInput, GetRecordingConfigurationCommandOutput, IvsClientResolvedConfig> {
@@ -31,6 +31,18 @@ export interface GetStreamCommandOutput extends GetStreamResponse, __MetadataBea
31
31
  * };
32
32
  * const command = new GetStreamCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetStreamResponse
35
+ * // stream: { // Stream
36
+ * // channelArn: "STRING_VALUE",
37
+ * // streamId: "STRING_VALUE",
38
+ * // playbackUrl: "STRING_VALUE",
39
+ * // startTime: new Date("TIMESTAMP"),
40
+ * // state: "STRING_VALUE",
41
+ * // health: "STRING_VALUE",
42
+ * // viewerCount: Number("long"),
43
+ * // },
44
+ * // };
45
+ *
34
46
  * ```
35
47
  *
36
48
  * @param GetStreamCommandInput - {@link GetStreamCommandInput}
@@ -51,6 +63,8 @@ export interface GetStreamCommandOutput extends GetStreamResponse, __MetadataBea
51
63
  * @throws {@link ValidationException} (client fault)
52
64
  * <p/>
53
65
  *
66
+ * @throws {@link IvsServiceException}
67
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
54
68
  *
55
69
  */
56
70
  export declare class GetStreamCommand extends $Command<GetStreamCommandInput, GetStreamCommandOutput, IvsClientResolvedConfig> {
@@ -31,6 +31,17 @@ export interface GetStreamKeyCommandOutput extends GetStreamKeyResponse, __Metad
31
31
  * };
32
32
  * const command = new GetStreamKeyCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetStreamKeyResponse
35
+ * // streamKey: { // StreamKey
36
+ * // arn: "STRING_VALUE",
37
+ * // value: "STRING_VALUE",
38
+ * // channelArn: "STRING_VALUE",
39
+ * // tags: { // Tags
40
+ * // "<keys>": "STRING_VALUE",
41
+ * // },
42
+ * // },
43
+ * // };
44
+ *
34
45
  * ```
35
46
  *
36
47
  * @param GetStreamKeyCommandInput - {@link GetStreamKeyCommandInput}
@@ -48,6 +59,8 @@ export interface GetStreamKeyCommandOutput extends GetStreamKeyResponse, __Metad
48
59
  * @throws {@link ValidationException} (client fault)
49
60
  * <p/>
50
61
  *
62
+ * @throws {@link IvsServiceException}
63
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
51
64
  *
52
65
  */
53
66
  export declare class GetStreamKeyCommand extends $Command<GetStreamKeyCommandInput, GetStreamKeyCommandOutput, IvsClientResolvedConfig> {
@@ -32,6 +32,71 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
32
32
  * };
33
33
  * const command = new GetStreamSessionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetStreamSessionResponse
36
+ * // streamSession: { // StreamSession
37
+ * // streamId: "STRING_VALUE",
38
+ * // startTime: new Date("TIMESTAMP"),
39
+ * // endTime: new Date("TIMESTAMP"),
40
+ * // channel: { // Channel
41
+ * // arn: "STRING_VALUE",
42
+ * // name: "STRING_VALUE",
43
+ * // latencyMode: "STRING_VALUE",
44
+ * // type: "BASIC" || "STANDARD",
45
+ * // recordingConfigurationArn: "STRING_VALUE",
46
+ * // ingestEndpoint: "STRING_VALUE",
47
+ * // playbackUrl: "STRING_VALUE",
48
+ * // authorized: true || false,
49
+ * // tags: { // Tags
50
+ * // "<keys>": "STRING_VALUE",
51
+ * // },
52
+ * // insecureIngest: true || false,
53
+ * // },
54
+ * // ingestConfiguration: { // IngestConfiguration
55
+ * // video: { // VideoConfiguration
56
+ * // avcProfile: "STRING_VALUE",
57
+ * // avcLevel: "STRING_VALUE",
58
+ * // codec: "STRING_VALUE",
59
+ * // encoder: "STRING_VALUE",
60
+ * // targetBitrate: Number("long"),
61
+ * // targetFramerate: Number("long"),
62
+ * // videoHeight: Number("long"),
63
+ * // videoWidth: Number("long"),
64
+ * // },
65
+ * // audio: { // AudioConfiguration
66
+ * // codec: "STRING_VALUE",
67
+ * // targetBitrate: Number("long"),
68
+ * // sampleRate: Number("long"),
69
+ * // channels: Number("long"),
70
+ * // },
71
+ * // },
72
+ * // recordingConfiguration: { // RecordingConfiguration
73
+ * // arn: "STRING_VALUE", // required
74
+ * // name: "STRING_VALUE",
75
+ * // destinationConfiguration: { // DestinationConfiguration
76
+ * // s3: { // S3DestinationConfiguration
77
+ * // bucketName: "STRING_VALUE", // required
78
+ * // },
79
+ * // },
80
+ * // state: "STRING_VALUE", // required
81
+ * // tags: {
82
+ * // "<keys>": "STRING_VALUE",
83
+ * // },
84
+ * // thumbnailConfiguration: { // ThumbnailConfiguration
85
+ * // recordingMode: "STRING_VALUE",
86
+ * // targetIntervalSeconds: Number("long"),
87
+ * // },
88
+ * // recordingReconnectWindowSeconds: Number("int"),
89
+ * // },
90
+ * // truncatedEvents: [ // StreamEvents
91
+ * // { // StreamEvent
92
+ * // name: "STRING_VALUE",
93
+ * // type: "STRING_VALUE",
94
+ * // eventTime: new Date("TIMESTAMP"),
95
+ * // },
96
+ * // ],
97
+ * // },
98
+ * // };
99
+ *
35
100
  * ```
36
101
  *
37
102
  * @param GetStreamSessionCommandInput - {@link GetStreamSessionCommandInput}
@@ -49,6 +114,8 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
49
114
  * @throws {@link ValidationException} (client fault)
50
115
  * <p/>
51
116
  *
117
+ * @throws {@link IvsServiceException}
118
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
52
119
  *
53
120
  */
54
121
  export declare class GetStreamSessionCommand extends $Command<GetStreamSessionCommandInput, GetStreamSessionCommandOutput, IvsClientResolvedConfig> {
@@ -39,6 +39,17 @@ export interface ImportPlaybackKeyPairCommandOutput extends ImportPlaybackKeyPai
39
39
  * };
40
40
  * const command = new ImportPlaybackKeyPairCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ImportPlaybackKeyPairResponse
43
+ * // keyPair: { // PlaybackKeyPair
44
+ * // arn: "STRING_VALUE",
45
+ * // name: "STRING_VALUE",
46
+ * // fingerprint: "STRING_VALUE",
47
+ * // tags: { // Tags
48
+ * // "<keys>": "STRING_VALUE",
49
+ * // },
50
+ * // },
51
+ * // };
52
+ *
42
53
  * ```
43
54
  *
44
55
  * @param ImportPlaybackKeyPairCommandInput - {@link ImportPlaybackKeyPairCommandInput}
@@ -62,6 +73,8 @@ export interface ImportPlaybackKeyPairCommandOutput extends ImportPlaybackKeyPai
62
73
  * @throws {@link ValidationException} (client fault)
63
74
  * <p/>
64
75
  *
76
+ * @throws {@link IvsServiceException}
77
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
65
78
  *
66
79
  */
67
80
  export declare class ImportPlaybackKeyPairCommand extends $Command<ImportPlaybackKeyPairCommandInput, ImportPlaybackKeyPairCommandOutput, IvsClientResolvedConfig> {
@@ -37,6 +37,23 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
37
37
  * };
38
38
  * const command = new ListChannelsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListChannelsResponse
41
+ * // channels: [ // ChannelList // required
42
+ * // { // ChannelSummary
43
+ * // arn: "STRING_VALUE",
44
+ * // name: "STRING_VALUE",
45
+ * // latencyMode: "STRING_VALUE",
46
+ * // authorized: true || false,
47
+ * // recordingConfigurationArn: "STRING_VALUE",
48
+ * // tags: { // Tags
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // insecureIngest: true || false,
52
+ * // },
53
+ * // ],
54
+ * // nextToken: "STRING_VALUE",
55
+ * // };
56
+ *
40
57
  * ```
41
58
  *
42
59
  * @param ListChannelsCommandInput - {@link ListChannelsCommandInput}
@@ -54,6 +71,8 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
54
71
  * @throws {@link ValidationException} (client fault)
55
72
  * <p/>
56
73
  *
74
+ * @throws {@link IvsServiceException}
75
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
57
76
  *
58
77
  */
59
78
  export declare class ListChannelsCommand extends $Command<ListChannelsCommandInput, ListChannelsCommandOutput, IvsClientResolvedConfig> {
@@ -33,6 +33,19 @@ export interface ListPlaybackKeyPairsCommandOutput extends ListPlaybackKeyPairsR
33
33
  * };
34
34
  * const command = new ListPlaybackKeyPairsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListPlaybackKeyPairsResponse
37
+ * // keyPairs: [ // PlaybackKeyPairList // required
38
+ * // { // PlaybackKeyPairSummary
39
+ * // arn: "STRING_VALUE",
40
+ * // name: "STRING_VALUE",
41
+ * // tags: { // Tags
42
+ * // "<keys>": "STRING_VALUE",
43
+ * // },
44
+ * // },
45
+ * // ],
46
+ * // nextToken: "STRING_VALUE",
47
+ * // };
48
+ *
36
49
  * ```
37
50
  *
38
51
  * @param ListPlaybackKeyPairsCommandInput - {@link ListPlaybackKeyPairsCommandInput}
@@ -47,6 +60,8 @@ export interface ListPlaybackKeyPairsCommandOutput extends ListPlaybackKeyPairsR
47
60
  * @throws {@link ValidationException} (client fault)
48
61
  * <p/>
49
62
  *
63
+ * @throws {@link IvsServiceException}
64
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
50
65
  *
51
66
  */
52
67
  export declare class ListPlaybackKeyPairsCommand extends $Command<ListPlaybackKeyPairsCommandInput, ListPlaybackKeyPairsCommandOutput, IvsClientResolvedConfig> {
@@ -33,6 +33,25 @@ export interface ListRecordingConfigurationsCommandOutput extends ListRecordingC
33
33
  * };
34
34
  * const command = new ListRecordingConfigurationsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListRecordingConfigurationsResponse
37
+ * // recordingConfigurations: [ // RecordingConfigurationList // required
38
+ * // { // RecordingConfigurationSummary
39
+ * // arn: "STRING_VALUE", // required
40
+ * // name: "STRING_VALUE",
41
+ * // destinationConfiguration: { // DestinationConfiguration
42
+ * // s3: { // S3DestinationConfiguration
43
+ * // bucketName: "STRING_VALUE", // required
44
+ * // },
45
+ * // },
46
+ * // state: "STRING_VALUE", // required
47
+ * // tags: { // Tags
48
+ * // "<keys>": "STRING_VALUE",
49
+ * // },
50
+ * // },
51
+ * // ],
52
+ * // nextToken: "STRING_VALUE",
53
+ * // };
54
+ *
36
55
  * ```
37
56
  *
38
57
  * @param ListRecordingConfigurationsCommandInput - {@link ListRecordingConfigurationsCommandInput}
@@ -50,6 +69,8 @@ export interface ListRecordingConfigurationsCommandOutput extends ListRecordingC
50
69
  * @throws {@link ValidationException} (client fault)
51
70
  * <p/>
52
71
  *
72
+ * @throws {@link IvsServiceException}
73
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
53
74
  *
54
75
  */
55
76
  export declare class ListRecordingConfigurationsCommand extends $Command<ListRecordingConfigurationsCommandInput, ListRecordingConfigurationsCommandOutput, IvsClientResolvedConfig> {
@@ -33,6 +33,19 @@ export interface ListStreamKeysCommandOutput extends ListStreamKeysResponse, __M
33
33
  * };
34
34
  * const command = new ListStreamKeysCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListStreamKeysResponse
37
+ * // streamKeys: [ // StreamKeyList // required
38
+ * // { // StreamKeySummary
39
+ * // arn: "STRING_VALUE",
40
+ * // channelArn: "STRING_VALUE",
41
+ * // tags: { // Tags
42
+ * // "<keys>": "STRING_VALUE",
43
+ * // },
44
+ * // },
45
+ * // ],
46
+ * // nextToken: "STRING_VALUE",
47
+ * // };
48
+ *
36
49
  * ```
37
50
  *
38
51
  * @param ListStreamKeysCommandInput - {@link ListStreamKeysCommandInput}
@@ -50,6 +63,8 @@ export interface ListStreamKeysCommandOutput extends ListStreamKeysResponse, __M
50
63
  * @throws {@link ValidationException} (client fault)
51
64
  * <p/>
52
65
  *
66
+ * @throws {@link IvsServiceException}
67
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
53
68
  *
54
69
  */
55
70
  export declare class ListStreamKeysCommand extends $Command<ListStreamKeysCommandInput, ListStreamKeysCommandOutput, IvsClientResolvedConfig> {
@@ -34,6 +34,18 @@ export interface ListStreamSessionsCommandOutput extends ListStreamSessionsRespo
34
34
  * };
35
35
  * const command = new ListStreamSessionsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListStreamSessionsResponse
38
+ * // streamSessions: [ // StreamSessionList // required
39
+ * // { // StreamSessionSummary
40
+ * // streamId: "STRING_VALUE",
41
+ * // startTime: new Date("TIMESTAMP"),
42
+ * // endTime: new Date("TIMESTAMP"),
43
+ * // hasErrorEvent: true || false,
44
+ * // },
45
+ * // ],
46
+ * // nextToken: "STRING_VALUE",
47
+ * // };
48
+ *
37
49
  * ```
38
50
  *
39
51
  * @param ListStreamSessionsCommandInput - {@link ListStreamSessionsCommandInput}
@@ -51,6 +63,8 @@ export interface ListStreamSessionsCommandOutput extends ListStreamSessionsRespo
51
63
  * @throws {@link ValidationException} (client fault)
52
64
  * <p/>
53
65
  *
66
+ * @throws {@link IvsServiceException}
67
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
54
68
  *
55
69
  */
56
70
  export declare class ListStreamSessionsCommand extends $Command<ListStreamSessionsCommandInput, ListStreamSessionsCommandOutput, IvsClientResolvedConfig> {
@@ -36,6 +36,20 @@ export interface ListStreamsCommandOutput extends ListStreamsResponse, __Metadat
36
36
  * };
37
37
  * const command = new ListStreamsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListStreamsResponse
40
+ * // streams: [ // StreamList // required
41
+ * // { // StreamSummary
42
+ * // channelArn: "STRING_VALUE",
43
+ * // streamId: "STRING_VALUE",
44
+ * // state: "STRING_VALUE",
45
+ * // health: "STRING_VALUE",
46
+ * // viewerCount: Number("long"),
47
+ * // startTime: new Date("TIMESTAMP"),
48
+ * // },
49
+ * // ],
50
+ * // nextToken: "STRING_VALUE",
51
+ * // };
52
+ *
39
53
  * ```
40
54
  *
41
55
  * @param ListStreamsCommandInput - {@link ListStreamsCommandInput}
@@ -50,6 +64,8 @@ export interface ListStreamsCommandOutput extends ListStreamsResponse, __Metadat
50
64
  * @throws {@link ValidationException} (client fault)
51
65
  * <p/>
52
66
  *
67
+ * @throws {@link IvsServiceException}
68
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
53
69
  *
54
70
  */
55
71
  export declare class ListStreamsCommand extends $Command<ListStreamsCommandInput, ListStreamsCommandOutput, IvsClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // tags: { // Tags // required
36
+ * // "<keys>": "STRING_VALUE",
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -48,6 +54,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
48
54
  * @throws {@link ValidationException} (client fault)
49
55
  * <p/>
50
56
  *
57
+ * @throws {@link IvsServiceException}
58
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
51
59
  *
52
60
  */
53
61
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, IvsClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface PutMetadataCommandOutput extends __MetadataBearer {
36
36
  * };
37
37
  * const command = new PutMetadataCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param PutMetadataCommandInput - {@link PutMetadataCommandInput}
@@ -59,6 +61,8 @@ export interface PutMetadataCommandOutput extends __MetadataBearer {
59
61
  * @throws {@link ValidationException} (client fault)
60
62
  * <p/>
61
63
  *
64
+ * @throws {@link IvsServiceException}
65
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
62
66
  *
63
67
  */
64
68
  export declare class PutMetadataCommand extends $Command<PutMetadataCommandInput, PutMetadataCommandOutput, IvsClientResolvedConfig> {
@@ -38,6 +38,8 @@ export interface StopStreamCommandOutput extends StopStreamResponse, __MetadataB
38
38
  * };
39
39
  * const command = new StopStreamCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param StopStreamCommandInput - {@link StopStreamCommandInput}
@@ -61,6 +63,8 @@ export interface StopStreamCommandOutput extends StopStreamResponse, __MetadataB
61
63
  * @throws {@link ValidationException} (client fault)
62
64
  * <p/>
63
65
  *
66
+ * @throws {@link IvsServiceException}
67
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
64
68
  *
65
69
  */
66
70
  export declare class StopStreamCommand extends $Command<StopStreamCommandInput, StopStreamCommandOutput, IvsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
34
34
  * };
35
35
  * const command = new TagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -51,6 +53,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
51
53
  * @throws {@link ValidationException} (client fault)
52
54
  * <p/>
53
55
  *
56
+ * @throws {@link IvsServiceException}
57
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
54
58
  *
55
59
  */
56
60
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IvsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -51,6 +53,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
51
53
  * @throws {@link ValidationException} (client fault)
52
54
  * <p/>
53
55
  *
56
+ * @throws {@link IvsServiceException}
57
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
54
58
  *
55
59
  */
56
60
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IvsClientResolvedConfig> {
@@ -38,6 +38,23 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
38
38
  * };
39
39
  * const command = new UpdateChannelCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // UpdateChannelResponse
42
+ * // channel: { // Channel
43
+ * // arn: "STRING_VALUE",
44
+ * // name: "STRING_VALUE",
45
+ * // latencyMode: "STRING_VALUE",
46
+ * // type: "BASIC" || "STANDARD",
47
+ * // recordingConfigurationArn: "STRING_VALUE",
48
+ * // ingestEndpoint: "STRING_VALUE",
49
+ * // playbackUrl: "STRING_VALUE",
50
+ * // authorized: true || false,
51
+ * // tags: { // Tags
52
+ * // "<keys>": "STRING_VALUE",
53
+ * // },
54
+ * // insecureIngest: true || false,
55
+ * // },
56
+ * // };
57
+ *
41
58
  * ```
42
59
  *
43
60
  * @param UpdateChannelCommandInput - {@link UpdateChannelCommandInput}
@@ -61,6 +78,8 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
61
78
  * @throws {@link ValidationException} (client fault)
62
79
  * <p/>
63
80
  *
81
+ * @throws {@link IvsServiceException}
82
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
64
83
  *
65
84
  */
66
85
  export declare class UpdateChannelCommand extends $Command<UpdateChannelCommandInput, UpdateChannelCommandOutput, IvsClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ivs",
3
3
  "description": "AWS SDK for JavaScript Ivs Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.327.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.327.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.327.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
32
32
  "@aws-sdk/middleware-host-header": "3.325.0",
33
33
  "@aws-sdk/middleware-logger": "3.325.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
- "@aws-sdk/middleware-retry": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.327.0",
36
36
  "@aws-sdk/middleware-serde": "3.325.0",
37
37
  "@aws-sdk/middleware-signing": "3.325.0",
38
38
  "@aws-sdk/middleware-stack": "3.325.0",
39
- "@aws-sdk/middleware-user-agent": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.327.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
50
  "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
- "@aws-sdk/util-endpoints": "3.319.0",
52
- "@aws-sdk/util-retry": "3.310.0",
51
+ "@aws-sdk/util-endpoints": "3.327.0",
52
+ "@aws-sdk/util-retry": "3.327.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",
55
55
  "@aws-sdk/util-utf8": "3.310.0",