@aws-sdk/client-kinesis-video 3.325.0 → 3.326.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/CreateSignalingChannelCommand.d.ts +6 -0
  2. package/dist-types/commands/CreateStreamCommand.d.ts +6 -0
  3. package/dist-types/commands/DeleteSignalingChannelCommand.d.ts +4 -0
  4. package/dist-types/commands/DeleteStreamCommand.d.ts +4 -0
  5. package/dist-types/commands/DescribeEdgeConfigurationCommand.d.ts +38 -0
  6. package/dist-types/commands/DescribeImageGenerationConfigurationCommand.d.ts +20 -0
  7. package/dist-types/commands/DescribeMappedResourceConfigurationCommand.d.ts +12 -0
  8. package/dist-types/commands/DescribeMediaStorageConfigurationCommand.d.ts +9 -0
  9. package/dist-types/commands/DescribeNotificationConfigurationCommand.d.ts +11 -0
  10. package/dist-types/commands/DescribeSignalingChannelCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeStreamCommand.d.ts +16 -0
  12. package/dist-types/commands/GetDataEndpointCommand.d.ts +6 -0
  13. package/dist-types/commands/GetSignalingChannelEndpointCommand.d.ts +11 -0
  14. package/dist-types/commands/ListSignalingChannelsCommand.d.ts +19 -0
  15. package/dist-types/commands/ListStreamsCommand.d.ts +19 -0
  16. package/dist-types/commands/ListTagsForResourceCommand.d.ts +9 -0
  17. package/dist-types/commands/ListTagsForStreamCommand.d.ts +9 -0
  18. package/dist-types/commands/StartEdgeConfigurationUpdateCommand.d.ts +38 -0
  19. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  20. package/dist-types/commands/TagStreamCommand.d.ts +4 -0
  21. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  22. package/dist-types/commands/UntagStreamCommand.d.ts +4 -0
  23. package/dist-types/commands/UpdateDataRetentionCommand.d.ts +4 -0
  24. package/dist-types/commands/UpdateImageGenerationConfigurationCommand.d.ts +4 -0
  25. package/dist-types/commands/UpdateMediaStorageConfigurationCommand.d.ts +4 -0
  26. package/dist-types/commands/UpdateNotificationConfigurationCommand.d.ts +4 -0
  27. package/dist-types/commands/UpdateSignalingChannelCommand.d.ts +4 -0
  28. package/dist-types/commands/UpdateStreamCommand.d.ts +4 -0
  29. package/package.json +3 -3
@@ -43,6 +43,10 @@ export interface CreateSignalingChannelCommandOutput extends CreateSignalingChan
43
43
  * };
44
44
  * const command = new CreateSignalingChannelCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // CreateSignalingChannelOutput
47
+ * // ChannelARN: "STRING_VALUE",
48
+ * // };
49
+ *
46
50
  * ```
47
51
  *
48
52
  * @param CreateSignalingChannelCommandInput - {@link CreateSignalingChannelCommandInput}
@@ -89,6 +93,8 @@ export interface CreateSignalingChannelCommandOutput extends CreateSignalingChan
89
93
  * <p>You have exceeded the limit of tags that you can associate with the resource.
90
94
  * A Kinesis video stream can support up to 50 tags. </p>
91
95
  *
96
+ * @throws {@link KinesisVideoServiceException}
97
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
92
98
  *
93
99
  */
94
100
  export declare class CreateSignalingChannelCommand extends $Command<CreateSignalingChannelCommandInput, CreateSignalingChannelCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -45,6 +45,10 @@ export interface CreateStreamCommandOutput extends CreateStreamOutput, __Metadat
45
45
  * };
46
46
  * const command = new CreateStreamCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // CreateStreamOutput
49
+ * // StreamARN: "STRING_VALUE",
50
+ * // };
51
+ *
48
52
  * ```
49
53
  *
50
54
  * @param CreateStreamCommandInput - {@link CreateStreamCommandInput}
@@ -94,6 +98,8 @@ export interface CreateStreamCommandOutput extends CreateStreamOutput, __Metadat
94
98
  * <p>You have exceeded the limit of tags that you can associate with the resource.
95
99
  * A Kinesis video stream can support up to 50 tags. </p>
96
100
  *
101
+ * @throws {@link KinesisVideoServiceException}
102
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
97
103
  *
98
104
  */
99
105
  export declare class CreateStreamCommand extends $Command<CreateStreamCommandInput, CreateStreamCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteSignalingChannelCommandOutput extends DeleteSignalingChan
34
34
  * };
35
35
  * const command = new DeleteSignalingChannelCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteSignalingChannelCommandInput - {@link DeleteSignalingChannelCommandInput}
@@ -80,6 +82,8 @@ export interface DeleteSignalingChannelCommandOutput extends DeleteSignalingChan
80
82
  * version, use the <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html">DescribeStream</a>
81
83
  * API.</p>
82
84
  *
85
+ * @throws {@link KinesisVideoServiceException}
86
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
83
87
  *
84
88
  */
85
89
  export declare class DeleteSignalingChannelCommand extends $Command<DeleteSignalingChannelCommandInput, DeleteSignalingChannelCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -41,6 +41,8 @@ export interface DeleteStreamCommandOutput extends DeleteStreamOutput, __Metadat
41
41
  * };
42
42
  * const command = new DeleteStreamCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param DeleteStreamCommandInput - {@link DeleteStreamCommandInput}
@@ -87,6 +89,8 @@ export interface DeleteStreamCommandOutput extends DeleteStreamOutput, __Metadat
87
89
  * version, use the <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html">DescribeStream</a>
88
90
  * API.</p>
89
91
  *
92
+ * @throws {@link KinesisVideoServiceException}
93
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
90
94
  *
91
95
  */
92
96
  export declare class DeleteStreamCommand extends $Command<DeleteStreamCommandInput, DeleteStreamCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -34,6 +34,42 @@ export interface DescribeEdgeConfigurationCommandOutput extends DescribeEdgeConf
34
34
  * };
35
35
  * const command = new DescribeEdgeConfigurationCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DescribeEdgeConfigurationOutput
38
+ * // StreamName: "STRING_VALUE",
39
+ * // StreamARN: "STRING_VALUE",
40
+ * // CreationTime: new Date("TIMESTAMP"),
41
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
42
+ * // SyncStatus: "SYNCING" || "ACKNOWLEDGED" || "IN_SYNC" || "SYNC_FAILED" || "DELETING" || "DELETE_FAILED",
43
+ * // FailedStatusDetails: "STRING_VALUE",
44
+ * // EdgeConfig: { // EdgeConfig
45
+ * // HubDeviceArn: "STRING_VALUE", // required
46
+ * // RecorderConfig: { // RecorderConfig
47
+ * // MediaSourceConfig: { // MediaSourceConfig
48
+ * // MediaUriSecretArn: "STRING_VALUE", // required
49
+ * // MediaUriType: "RTSP_URI" || "FILE_URI", // required
50
+ * // },
51
+ * // ScheduleConfig: { // ScheduleConfig
52
+ * // ScheduleExpression: "STRING_VALUE", // required
53
+ * // DurationInSeconds: Number("int"), // required
54
+ * // },
55
+ * // },
56
+ * // UploaderConfig: { // UploaderConfig
57
+ * // ScheduleConfig: {
58
+ * // ScheduleExpression: "STRING_VALUE", // required
59
+ * // DurationInSeconds: Number("int"), // required
60
+ * // },
61
+ * // },
62
+ * // DeletionConfig: { // DeletionConfig
63
+ * // EdgeRetentionInHours: Number("int"),
64
+ * // LocalSizeConfig: { // LocalSizeConfig
65
+ * // MaxLocalMediaSizeInMB: Number("int"),
66
+ * // StrategyOnFullSize: "DELETE_OLDEST_MEDIA" || "DENY_NEW_MEDIA",
67
+ * // },
68
+ * // DeleteAfterUpload: true || false,
69
+ * // },
70
+ * // },
71
+ * // };
72
+ *
37
73
  * ```
38
74
  *
39
75
  * @param DescribeEdgeConfigurationCommandInput - {@link DescribeEdgeConfigurationCommandInput}
@@ -59,6 +95,8 @@ export interface DescribeEdgeConfigurationCommandOutput extends DescribeEdgeConf
59
95
  * <p>The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration
60
96
  * that you specified. </p>
61
97
  *
98
+ * @throws {@link KinesisVideoServiceException}
99
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
62
100
  *
63
101
  */
64
102
  export declare class DescribeEdgeConfigurationCommand extends $Command<DescribeEdgeConfigurationCommandInput, DescribeEdgeConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -32,6 +32,24 @@ export interface DescribeImageGenerationConfigurationCommandOutput extends Descr
32
32
  * };
33
33
  * const command = new DescribeImageGenerationConfigurationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeImageGenerationConfigurationOutput
36
+ * // ImageGenerationConfiguration: { // ImageGenerationConfiguration
37
+ * // Status: "ENABLED" || "DISABLED", // required
38
+ * // ImageSelectorType: "SERVER_TIMESTAMP" || "PRODUCER_TIMESTAMP", // required
39
+ * // DestinationConfig: { // ImageGenerationDestinationConfig
40
+ * // Uri: "STRING_VALUE", // required
41
+ * // DestinationRegion: "STRING_VALUE", // required
42
+ * // },
43
+ * // SamplingInterval: Number("int"), // required
44
+ * // Format: "JPEG" || "PNG", // required
45
+ * // FormatConfig: { // FormatConfig
46
+ * // "<keys>": "STRING_VALUE",
47
+ * // },
48
+ * // WidthPixels: Number("int"),
49
+ * // HeightPixels: Number("int"),
50
+ * // },
51
+ * // };
52
+ *
35
53
  * ```
36
54
  *
37
55
  * @param DescribeImageGenerationConfigurationCommandInput - {@link DescribeImageGenerationConfigurationCommandInput}
@@ -53,6 +71,8 @@ export interface DescribeImageGenerationConfigurationCommandOutput extends Descr
53
71
  * @throws {@link ResourceNotFoundException} (client fault)
54
72
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
55
73
  *
74
+ * @throws {@link KinesisVideoServiceException}
75
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
56
76
  *
57
77
  */
58
78
  export declare class DescribeImageGenerationConfigurationCommand extends $Command<DescribeImageGenerationConfigurationCommandInput, DescribeImageGenerationConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -36,6 +36,16 @@ export interface DescribeMappedResourceConfigurationCommandOutput extends Descri
36
36
  * };
37
37
  * const command = new DescribeMappedResourceConfigurationCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeMappedResourceConfigurationOutput
40
+ * // MappedResourceConfigurationList: [ // MappedResourceConfigurationList
41
+ * // { // MappedResourceConfigurationListItem
42
+ * // Type: "STRING_VALUE",
43
+ * // ARN: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
39
49
  * ```
40
50
  *
41
51
  * @param DescribeMappedResourceConfigurationCommandInput - {@link DescribeMappedResourceConfigurationCommandInput}
@@ -57,6 +67,8 @@ export interface DescribeMappedResourceConfigurationCommandOutput extends Descri
57
67
  * @throws {@link ResourceNotFoundException} (client fault)
58
68
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
59
69
  *
70
+ * @throws {@link KinesisVideoServiceException}
71
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
60
72
  *
61
73
  */
62
74
  export declare class DescribeMappedResourceConfigurationCommand extends $Command<DescribeMappedResourceConfigurationCommandInput, DescribeMappedResourceConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -33,6 +33,13 @@ export interface DescribeMediaStorageConfigurationCommandOutput extends Describe
33
33
  * };
34
34
  * const command = new DescribeMediaStorageConfigurationCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeMediaStorageConfigurationOutput
37
+ * // MediaStorageConfiguration: { // MediaStorageConfiguration
38
+ * // StreamARN: "STRING_VALUE",
39
+ * // Status: "ENABLED" || "DISABLED", // required
40
+ * // },
41
+ * // };
42
+ *
36
43
  * ```
37
44
  *
38
45
  * @param DescribeMediaStorageConfigurationCommandInput - {@link DescribeMediaStorageConfigurationCommandInput}
@@ -54,6 +61,8 @@ export interface DescribeMediaStorageConfigurationCommandOutput extends Describe
54
61
  * @throws {@link ResourceNotFoundException} (client fault)
55
62
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
56
63
  *
64
+ * @throws {@link KinesisVideoServiceException}
65
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
57
66
  *
58
67
  */
59
68
  export declare class DescribeMediaStorageConfigurationCommand extends $Command<DescribeMediaStorageConfigurationCommandInput, DescribeMediaStorageConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -32,6 +32,15 @@ export interface DescribeNotificationConfigurationCommandOutput extends Describe
32
32
  * };
33
33
  * const command = new DescribeNotificationConfigurationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeNotificationConfigurationOutput
36
+ * // NotificationConfiguration: { // NotificationConfiguration
37
+ * // Status: "ENABLED" || "DISABLED", // required
38
+ * // DestinationConfig: { // NotificationDestinationConfig
39
+ * // Uri: "STRING_VALUE", // required
40
+ * // },
41
+ * // },
42
+ * // };
43
+ *
35
44
  * ```
36
45
  *
37
46
  * @param DescribeNotificationConfigurationCommandInput - {@link DescribeNotificationConfigurationCommandInput}
@@ -53,6 +62,8 @@ export interface DescribeNotificationConfigurationCommandOutput extends Describe
53
62
  * @throws {@link ResourceNotFoundException} (client fault)
54
63
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
55
64
  *
65
+ * @throws {@link KinesisVideoServiceException}
66
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
56
67
  *
57
68
  */
58
69
  export declare class DescribeNotificationConfigurationCommand extends $Command<DescribeNotificationConfigurationCommandInput, DescribeNotificationConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -34,6 +34,20 @@ export interface DescribeSignalingChannelCommandOutput extends DescribeSignaling
34
34
  * };
35
35
  * const command = new DescribeSignalingChannelCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DescribeSignalingChannelOutput
38
+ * // ChannelInfo: { // ChannelInfo
39
+ * // ChannelName: "STRING_VALUE",
40
+ * // ChannelARN: "STRING_VALUE",
41
+ * // ChannelType: "SINGLE_MASTER" || "FULL_MESH",
42
+ * // ChannelStatus: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING",
43
+ * // CreationTime: new Date("TIMESTAMP"),
44
+ * // SingleMasterConfiguration: { // SingleMasterConfiguration
45
+ * // MessageTtlSeconds: Number("int"),
46
+ * // },
47
+ * // Version: "STRING_VALUE",
48
+ * // },
49
+ * // };
50
+ *
37
51
  * ```
38
52
  *
39
53
  * @param DescribeSignalingChannelCommandInput - {@link DescribeSignalingChannelCommandInput}
@@ -55,6 +69,8 @@ export interface DescribeSignalingChannelCommandOutput extends DescribeSignaling
55
69
  * @throws {@link ResourceNotFoundException} (client fault)
56
70
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
57
71
  *
72
+ * @throws {@link KinesisVideoServiceException}
73
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
58
74
  *
59
75
  */
60
76
  export declare class DescribeSignalingChannelCommand extends $Command<DescribeSignalingChannelCommandInput, DescribeSignalingChannelCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -33,6 +33,20 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
33
33
  * };
34
34
  * const command = new DescribeStreamCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeStreamOutput
37
+ * // StreamInfo: { // StreamInfo
38
+ * // DeviceName: "STRING_VALUE",
39
+ * // StreamName: "STRING_VALUE",
40
+ * // StreamARN: "STRING_VALUE",
41
+ * // MediaType: "STRING_VALUE",
42
+ * // KmsKeyId: "STRING_VALUE",
43
+ * // Version: "STRING_VALUE",
44
+ * // Status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING",
45
+ * // CreationTime: new Date("TIMESTAMP"),
46
+ * // DataRetentionInHours: Number("int"),
47
+ * // },
48
+ * // };
49
+ *
36
50
  * ```
37
51
  *
38
52
  * @param DescribeStreamCommandInput - {@link DescribeStreamCommandInput}
@@ -54,6 +68,8 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
54
68
  * @throws {@link ResourceNotFoundException} (client fault)
55
69
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
56
70
  *
71
+ * @throws {@link KinesisVideoServiceException}
72
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
57
73
  *
58
74
  */
59
75
  export declare class DescribeStreamCommand extends $Command<DescribeStreamCommandInput, DescribeStreamCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -43,6 +43,10 @@ export interface GetDataEndpointCommandOutput extends GetDataEndpointOutput, __M
43
43
  * };
44
44
  * const command = new GetDataEndpointCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // GetDataEndpointOutput
47
+ * // DataEndpoint: "STRING_VALUE",
48
+ * // };
49
+ *
46
50
  * ```
47
51
  *
48
52
  * @param GetDataEndpointCommandInput - {@link GetDataEndpointCommandInput}
@@ -64,6 +68,8 @@ export interface GetDataEndpointCommandOutput extends GetDataEndpointOutput, __M
64
68
  * @throws {@link ResourceNotFoundException} (client fault)
65
69
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
66
70
  *
71
+ * @throws {@link KinesisVideoServiceException}
72
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
67
73
  *
68
74
  */
69
75
  export declare class GetDataEndpointCommand extends $Command<GetDataEndpointCommandInput, GetDataEndpointCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -50,6 +50,15 @@ export interface GetSignalingChannelEndpointCommandOutput extends GetSignalingCh
50
50
  * };
51
51
  * const command = new GetSignalingChannelEndpointCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // GetSignalingChannelEndpointOutput
54
+ * // ResourceEndpointList: [ // ResourceEndpointList
55
+ * // { // ResourceEndpointListItem
56
+ * // Protocol: "WSS" || "HTTPS" || "WEBRTC",
57
+ * // ResourceEndpoint: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // };
61
+ *
53
62
  * ```
54
63
  *
55
64
  * @param GetSignalingChannelEndpointCommandInput - {@link GetSignalingChannelEndpointCommandInput}
@@ -91,6 +100,8 @@ export interface GetSignalingChannelEndpointCommandOutput extends GetSignalingCh
91
100
  * @throws {@link ResourceNotFoundException} (client fault)
92
101
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
93
102
  *
103
+ * @throws {@link KinesisVideoServiceException}
104
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
94
105
  *
95
106
  */
96
107
  export declare class GetSignalingChannelEndpointCommand extends $Command<GetSignalingChannelEndpointCommandInput, GetSignalingChannelEndpointCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -38,6 +38,23 @@ export interface ListSignalingChannelsCommandOutput extends ListSignalingChannel
38
38
  * };
39
39
  * const command = new ListSignalingChannelsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListSignalingChannelsOutput
42
+ * // ChannelInfoList: [ // ChannelInfoList
43
+ * // { // ChannelInfo
44
+ * // ChannelName: "STRING_VALUE",
45
+ * // ChannelARN: "STRING_VALUE",
46
+ * // ChannelType: "SINGLE_MASTER" || "FULL_MESH",
47
+ * // ChannelStatus: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING",
48
+ * // CreationTime: new Date("TIMESTAMP"),
49
+ * // SingleMasterConfiguration: { // SingleMasterConfiguration
50
+ * // MessageTtlSeconds: Number("int"),
51
+ * // },
52
+ * // Version: "STRING_VALUE",
53
+ * // },
54
+ * // ],
55
+ * // NextToken: "STRING_VALUE",
56
+ * // };
57
+ *
41
58
  * ```
42
59
  *
43
60
  * @param ListSignalingChannelsCommandInput - {@link ListSignalingChannelsCommandInput}
@@ -56,6 +73,8 @@ export interface ListSignalingChannelsCommandOutput extends ListSignalingChannel
56
73
  * @throws {@link InvalidArgumentException} (client fault)
57
74
  * <p>The value for this input parameter is invalid.</p>
58
75
  *
76
+ * @throws {@link KinesisVideoServiceException}
77
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
59
78
  *
60
79
  */
61
80
  export declare class ListSignalingChannelsCommand extends $Command<ListSignalingChannelsCommandInput, ListSignalingChannelsCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -38,6 +38,23 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
38
38
  * };
39
39
  * const command = new ListStreamsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListStreamsOutput
42
+ * // StreamInfoList: [ // StreamInfoList
43
+ * // { // StreamInfo
44
+ * // DeviceName: "STRING_VALUE",
45
+ * // StreamName: "STRING_VALUE",
46
+ * // StreamARN: "STRING_VALUE",
47
+ * // MediaType: "STRING_VALUE",
48
+ * // KmsKeyId: "STRING_VALUE",
49
+ * // Version: "STRING_VALUE",
50
+ * // Status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING",
51
+ * // CreationTime: new Date("TIMESTAMP"),
52
+ * // DataRetentionInHours: Number("int"),
53
+ * // },
54
+ * // ],
55
+ * // NextToken: "STRING_VALUE",
56
+ * // };
57
+ *
41
58
  * ```
42
59
  *
43
60
  * @param ListStreamsCommandInput - {@link ListStreamsCommandInput}
@@ -53,6 +70,8 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
53
70
  * @throws {@link InvalidArgumentException} (client fault)
54
71
  * <p>The value for this input parameter is invalid.</p>
55
72
  *
73
+ * @throws {@link KinesisVideoServiceException}
74
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
56
75
  *
57
76
  */
58
77
  export declare class ListStreamsCommand extends $Command<ListStreamsCommandInput, ListStreamsCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -32,6 +32,13 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
32
32
  * };
33
33
  * const command = new ListTagsForResourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListTagsForResourceOutput
36
+ * // NextToken: "STRING_VALUE",
37
+ * // Tags: { // ResourceTags
38
+ * // "<keys>": "STRING_VALUE",
39
+ * // },
40
+ * // };
41
+ *
35
42
  * ```
36
43
  *
37
44
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -53,6 +60,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
53
60
  * @throws {@link ResourceNotFoundException} (client fault)
54
61
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
55
62
  *
63
+ * @throws {@link KinesisVideoServiceException}
64
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
56
65
  *
57
66
  */
58
67
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -35,6 +35,13 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput,
35
35
  * };
36
36
  * const command = new ListTagsForStreamCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListTagsForStreamOutput
39
+ * // NextToken: "STRING_VALUE",
40
+ * // Tags: { // ResourceTags
41
+ * // "<keys>": "STRING_VALUE",
42
+ * // },
43
+ * // };
44
+ *
38
45
  * ```
39
46
  *
40
47
  * @param ListTagsForStreamCommandInput - {@link ListTagsForStreamCommandInput}
@@ -59,6 +66,8 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput,
59
66
  * @throws {@link ResourceNotFoundException} (client fault)
60
67
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
61
68
  *
69
+ * @throws {@link KinesisVideoServiceException}
70
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
62
71
  *
63
72
  */
64
73
  export declare class ListTagsForStreamCommand extends $Command<ListTagsForStreamCommandInput, ListTagsForStreamCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -70,6 +70,42 @@ export interface StartEdgeConfigurationUpdateCommandOutput extends StartEdgeConf
70
70
  * };
71
71
  * const command = new StartEdgeConfigurationUpdateCommand(input);
72
72
  * const response = await client.send(command);
73
+ * // { // StartEdgeConfigurationUpdateOutput
74
+ * // StreamName: "STRING_VALUE",
75
+ * // StreamARN: "STRING_VALUE",
76
+ * // CreationTime: new Date("TIMESTAMP"),
77
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
78
+ * // SyncStatus: "SYNCING" || "ACKNOWLEDGED" || "IN_SYNC" || "SYNC_FAILED" || "DELETING" || "DELETE_FAILED",
79
+ * // FailedStatusDetails: "STRING_VALUE",
80
+ * // EdgeConfig: { // EdgeConfig
81
+ * // HubDeviceArn: "STRING_VALUE", // required
82
+ * // RecorderConfig: { // RecorderConfig
83
+ * // MediaSourceConfig: { // MediaSourceConfig
84
+ * // MediaUriSecretArn: "STRING_VALUE", // required
85
+ * // MediaUriType: "RTSP_URI" || "FILE_URI", // required
86
+ * // },
87
+ * // ScheduleConfig: { // ScheduleConfig
88
+ * // ScheduleExpression: "STRING_VALUE", // required
89
+ * // DurationInSeconds: Number("int"), // required
90
+ * // },
91
+ * // },
92
+ * // UploaderConfig: { // UploaderConfig
93
+ * // ScheduleConfig: {
94
+ * // ScheduleExpression: "STRING_VALUE", // required
95
+ * // DurationInSeconds: Number("int"), // required
96
+ * // },
97
+ * // },
98
+ * // DeletionConfig: { // DeletionConfig
99
+ * // EdgeRetentionInHours: Number("int"),
100
+ * // LocalSizeConfig: { // LocalSizeConfig
101
+ * // MaxLocalMediaSizeInMB: Number("int"),
102
+ * // StrategyOnFullSize: "DELETE_OLDEST_MEDIA" || "DENY_NEW_MEDIA",
103
+ * // },
104
+ * // DeleteAfterUpload: true || false,
105
+ * // },
106
+ * // },
107
+ * // };
108
+ *
73
109
  * ```
74
110
  *
75
111
  * @param StartEdgeConfigurationUpdateCommandInput - {@link StartEdgeConfigurationUpdateCommandInput}
@@ -114,6 +150,8 @@ export interface StartEdgeConfigurationUpdateCommandOutput extends StartEdgeConf
114
150
  * @throws {@link ResourceNotFoundException} (client fault)
115
151
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
116
152
  *
153
+ * @throws {@link KinesisVideoServiceException}
154
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
117
155
  *
118
156
  */
119
157
  export declare class StartEdgeConfigurationUpdateCommand extends $Command<StartEdgeConfigurationUpdateCommandInput, StartEdgeConfigurationUpdateCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -42,6 +42,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
42
42
  * };
43
43
  * const command = new TagResourceCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // {};
46
+ *
45
47
  * ```
46
48
  *
47
49
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -67,6 +69,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
67
69
  * <p>You have exceeded the limit of tags that you can associate with the resource.
68
70
  * A Kinesis video stream can support up to 50 tags. </p>
69
71
  *
72
+ * @throws {@link KinesisVideoServiceException}
73
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
70
74
  *
71
75
  */
72
76
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -44,6 +44,8 @@ export interface TagStreamCommandOutput extends TagStreamOutput, __MetadataBeare
44
44
  * };
45
45
  * const command = new TagStreamCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // {};
48
+ *
47
49
  * ```
48
50
  *
49
51
  * @param TagStreamCommandInput - {@link TagStreamCommandInput}
@@ -72,6 +74,8 @@ export interface TagStreamCommandOutput extends TagStreamOutput, __MetadataBeare
72
74
  * <p>You have exceeded the limit of tags that you can associate with the resource.
73
75
  * A Kinesis video stream can support up to 50 tags. </p>
74
76
  *
77
+ * @throws {@link KinesisVideoServiceException}
78
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
75
79
  *
76
80
  */
77
81
  export declare class TagStreamCommand extends $Command<TagStreamCommandInput, TagStreamCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
36
36
  * };
37
37
  * const command = new UntagResourceCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -57,6 +59,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
57
59
  * @throws {@link ResourceNotFoundException} (client fault)
58
60
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
59
61
  *
62
+ * @throws {@link KinesisVideoServiceException}
63
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
60
64
  *
61
65
  */
62
66
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -39,6 +39,8 @@ export interface UntagStreamCommandOutput extends UntagStreamOutput, __MetadataB
39
39
  * };
40
40
  * const command = new UntagStreamCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param UntagStreamCommandInput - {@link UntagStreamCommandInput}
@@ -63,6 +65,8 @@ export interface UntagStreamCommandOutput extends UntagStreamOutput, __MetadataB
63
65
  * @throws {@link ResourceNotFoundException} (client fault)
64
66
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
65
67
  *
68
+ * @throws {@link KinesisVideoServiceException}
69
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
66
70
  *
67
71
  */
68
72
  export declare class UntagStreamCommand extends $Command<UntagStreamCommandInput, UntagStreamCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -59,6 +59,8 @@ export interface UpdateDataRetentionCommandOutput extends UpdateDataRetentionOut
59
59
  * };
60
60
  * const command = new UpdateDataRetentionCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // {};
63
+ *
62
64
  * ```
63
65
  *
64
66
  * @param UpdateDataRetentionCommandInput - {@link UpdateDataRetentionCommandInput}
@@ -105,6 +107,8 @@ export interface UpdateDataRetentionCommandOutput extends UpdateDataRetentionOut
105
107
  * version, use the <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html">DescribeStream</a>
106
108
  * API.</p>
107
109
  *
110
+ * @throws {@link KinesisVideoServiceException}
111
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
108
112
  *
109
113
  */
110
114
  export declare class UpdateDataRetentionCommand extends $Command<UpdateDataRetentionCommandInput, UpdateDataRetentionCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -47,6 +47,8 @@ export interface UpdateImageGenerationConfigurationCommandOutput extends UpdateI
47
47
  * };
48
48
  * const command = new UpdateImageGenerationConfigurationCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // {};
51
+ *
50
52
  * ```
51
53
  *
52
54
  * @param UpdateImageGenerationConfigurationCommandInput - {@link UpdateImageGenerationConfigurationCommandInput}
@@ -91,6 +93,8 @@ export interface UpdateImageGenerationConfigurationCommandOutput extends UpdateI
91
93
  * @throws {@link ResourceNotFoundException} (client fault)
92
94
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
93
95
  *
96
+ * @throws {@link KinesisVideoServiceException}
97
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
94
98
  *
95
99
  */
96
100
  export declare class UpdateImageGenerationConfigurationCommand extends $Command<UpdateImageGenerationConfigurationCommandInput, UpdateImageGenerationConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -46,6 +46,8 @@ export interface UpdateMediaStorageConfigurationCommandOutput extends UpdateMedi
46
46
  * };
47
47
  * const command = new UpdateMediaStorageConfigurationCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // {};
50
+ *
49
51
  * ```
50
52
  *
51
53
  * @param UpdateMediaStorageConfigurationCommandInput - {@link UpdateMediaStorageConfigurationCommandInput}
@@ -90,6 +92,8 @@ export interface UpdateMediaStorageConfigurationCommandOutput extends UpdateMedi
90
92
  * @throws {@link ResourceNotFoundException} (client fault)
91
93
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
92
94
  *
95
+ * @throws {@link KinesisVideoServiceException}
96
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
93
97
  *
94
98
  */
95
99
  export declare class UpdateMediaStorageConfigurationCommand extends $Command<UpdateMediaStorageConfigurationCommandInput, UpdateMediaStorageConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -38,6 +38,8 @@ export interface UpdateNotificationConfigurationCommandOutput extends UpdateNoti
38
38
  * };
39
39
  * const command = new UpdateNotificationConfigurationCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param UpdateNotificationConfigurationCommandInput - {@link UpdateNotificationConfigurationCommandInput}
@@ -82,6 +84,8 @@ export interface UpdateNotificationConfigurationCommandOutput extends UpdateNoti
82
84
  * @throws {@link ResourceNotFoundException} (client fault)
83
85
  * <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
84
86
  *
87
+ * @throws {@link KinesisVideoServiceException}
88
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
85
89
  *
86
90
  */
87
91
  export declare class UpdateNotificationConfigurationCommand extends $Command<UpdateNotificationConfigurationCommandInput, UpdateNotificationConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -40,6 +40,8 @@ export interface UpdateSignalingChannelCommandOutput extends UpdateSignalingChan
40
40
  * };
41
41
  * const command = new UpdateSignalingChannelCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // {};
44
+ *
43
45
  * ```
44
46
  *
45
47
  * @param UpdateSignalingChannelCommandInput - {@link UpdateSignalingChannelCommandInput}
@@ -86,6 +88,8 @@ export interface UpdateSignalingChannelCommandOutput extends UpdateSignalingChan
86
88
  * version, use the <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html">DescribeStream</a>
87
89
  * API.</p>
88
90
  *
91
+ * @throws {@link KinesisVideoServiceException}
92
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
89
93
  *
90
94
  */
91
95
  export declare class UpdateSignalingChannelCommand extends $Command<UpdateSignalingChannelCommandInput, UpdateSignalingChannelCommandOutput, KinesisVideoClientResolvedConfig> {
@@ -44,6 +44,8 @@ export interface UpdateStreamCommandOutput extends UpdateStreamOutput, __Metadat
44
44
  * };
45
45
  * const command = new UpdateStreamCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // {};
48
+ *
47
49
  * ```
48
50
  *
49
51
  * @param UpdateStreamCommandInput - {@link UpdateStreamCommandInput}
@@ -90,6 +92,8 @@ export interface UpdateStreamCommandOutput extends UpdateStreamOutput, __Metadat
90
92
  * version, use the <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html">DescribeStream</a>
91
93
  * API.</p>
92
94
  *
95
+ * @throws {@link KinesisVideoServiceException}
96
+ * <p>Base exception class for all service exceptions from KinesisVideo service.</p>
93
97
  *
94
98
  */
95
99
  export declare class UpdateStreamCommand extends $Command<UpdateStreamCommandInput, UpdateStreamCommandOutput, KinesisVideoClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kinesis-video",
3
3
  "description": "AWS SDK for JavaScript Kinesis Video Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.326.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.326.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.326.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",