@aws-sdk/client-kinesis-video 3.80.0 → 3.83.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 (40) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist-cjs/KinesisVideo.js +60 -0
  3. package/dist-cjs/commands/DescribeImageGenerationConfigurationCommand.js +36 -0
  4. package/dist-cjs/commands/DescribeNotificationConfigurationCommand.js +36 -0
  5. package/dist-cjs/commands/UpdateImageGenerationConfigurationCommand.js +36 -0
  6. package/dist-cjs/commands/UpdateNotificationConfigurationCommand.js +36 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/models/models_0.js +109 -2
  9. package/dist-cjs/protocols/Aws_restJson1.js +393 -1
  10. package/dist-es/KinesisVideo.js +60 -0
  11. package/dist-es/commands/DescribeImageGenerationConfigurationCommand.js +39 -0
  12. package/dist-es/commands/DescribeNotificationConfigurationCommand.js +39 -0
  13. package/dist-es/commands/UpdateImageGenerationConfigurationCommand.js +39 -0
  14. package/dist-es/commands/UpdateNotificationConfigurationCommand.js +39 -0
  15. package/dist-es/commands/index.js +4 -0
  16. package/dist-es/models/models_0.js +82 -0
  17. package/dist-es/protocols/Aws_restJson1.js +468 -1
  18. package/dist-types/KinesisVideo.d.ts +37 -9
  19. package/dist-types/KinesisVideoClient.d.ts +6 -2
  20. package/dist-types/commands/DescribeImageGenerationConfigurationCommand.d.ts +35 -0
  21. package/dist-types/commands/DescribeNotificationConfigurationCommand.d.ts +35 -0
  22. package/dist-types/commands/GetSignalingChannelEndpointCommand.d.ts +2 -2
  23. package/dist-types/commands/ListSignalingChannelsCommand.d.ts +2 -2
  24. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  25. package/dist-types/commands/TagStreamCommand.d.ts +3 -3
  26. package/dist-types/commands/UpdateImageGenerationConfigurationCommand.d.ts +35 -0
  27. package/dist-types/commands/UpdateNotificationConfigurationCommand.d.ts +35 -0
  28. package/dist-types/commands/index.d.ts +4 -0
  29. package/dist-types/models/models_0.d.ts +264 -10
  30. package/dist-types/protocols/Aws_restJson1.d.ts +12 -0
  31. package/dist-types/ts3.4/KinesisVideo.d.ts +20 -0
  32. package/dist-types/ts3.4/KinesisVideoClient.d.ts +6 -2
  33. package/dist-types/ts3.4/commands/DescribeImageGenerationConfigurationCommand.d.ts +17 -0
  34. package/dist-types/ts3.4/commands/DescribeNotificationConfigurationCommand.d.ts +17 -0
  35. package/dist-types/ts3.4/commands/UpdateImageGenerationConfigurationCommand.d.ts +17 -0
  36. package/dist-types/ts3.4/commands/UpdateNotificationConfigurationCommand.d.ts +17 -0
  37. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  38. package/dist-types/ts3.4/models/models_0.d.ts +153 -0
  39. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  40. package/package.json +5 -5
@@ -10,6 +10,8 @@ import { CreateSignalingChannelCommandInput, CreateSignalingChannelCommandOutput
10
10
  import { CreateStreamCommandInput, CreateStreamCommandOutput } from "./commands/CreateStreamCommand";
11
11
  import { DeleteSignalingChannelCommandInput, DeleteSignalingChannelCommandOutput } from "./commands/DeleteSignalingChannelCommand";
12
12
  import { DeleteStreamCommandInput, DeleteStreamCommandOutput } from "./commands/DeleteStreamCommand";
13
+ import { DescribeImageGenerationConfigurationCommandInput, DescribeImageGenerationConfigurationCommandOutput } from "./commands/DescribeImageGenerationConfigurationCommand";
14
+ import { DescribeNotificationConfigurationCommandInput, DescribeNotificationConfigurationCommandOutput } from "./commands/DescribeNotificationConfigurationCommand";
13
15
  import { DescribeSignalingChannelCommandInput, DescribeSignalingChannelCommandOutput } from "./commands/DescribeSignalingChannelCommand";
14
16
  import { DescribeStreamCommandInput, DescribeStreamCommandOutput } from "./commands/DescribeStreamCommand";
15
17
  import { GetDataEndpointCommandInput, GetDataEndpointCommandOutput } from "./commands/GetDataEndpointCommand";
@@ -23,10 +25,12 @@ import { TagStreamCommandInput, TagStreamCommandOutput } from "./commands/TagStr
23
25
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
24
26
  import { UntagStreamCommandInput, UntagStreamCommandOutput } from "./commands/UntagStreamCommand";
25
27
  import { UpdateDataRetentionCommandInput, UpdateDataRetentionCommandOutput } from "./commands/UpdateDataRetentionCommand";
28
+ import { UpdateImageGenerationConfigurationCommandInput, UpdateImageGenerationConfigurationCommandOutput } from "./commands/UpdateImageGenerationConfigurationCommand";
29
+ import { UpdateNotificationConfigurationCommandInput, UpdateNotificationConfigurationCommandOutput } from "./commands/UpdateNotificationConfigurationCommand";
26
30
  import { UpdateSignalingChannelCommandInput, UpdateSignalingChannelCommandOutput } from "./commands/UpdateSignalingChannelCommand";
27
31
  import { UpdateStreamCommandInput, UpdateStreamCommandOutput } from "./commands/UpdateStreamCommand";
28
- export declare type ServiceInputTypes = CreateSignalingChannelCommandInput | CreateStreamCommandInput | DeleteSignalingChannelCommandInput | DeleteStreamCommandInput | DescribeSignalingChannelCommandInput | DescribeStreamCommandInput | GetDataEndpointCommandInput | GetSignalingChannelEndpointCommandInput | ListSignalingChannelsCommandInput | ListStreamsCommandInput | ListTagsForResourceCommandInput | ListTagsForStreamCommandInput | TagResourceCommandInput | TagStreamCommandInput | UntagResourceCommandInput | UntagStreamCommandInput | UpdateDataRetentionCommandInput | UpdateSignalingChannelCommandInput | UpdateStreamCommandInput;
29
- export declare type ServiceOutputTypes = CreateSignalingChannelCommandOutput | CreateStreamCommandOutput | DeleteSignalingChannelCommandOutput | DeleteStreamCommandOutput | DescribeSignalingChannelCommandOutput | DescribeStreamCommandOutput | GetDataEndpointCommandOutput | GetSignalingChannelEndpointCommandOutput | ListSignalingChannelsCommandOutput | ListStreamsCommandOutput | ListTagsForResourceCommandOutput | ListTagsForStreamCommandOutput | TagResourceCommandOutput | TagStreamCommandOutput | UntagResourceCommandOutput | UntagStreamCommandOutput | UpdateDataRetentionCommandOutput | UpdateSignalingChannelCommandOutput | UpdateStreamCommandOutput;
32
+ export declare type ServiceInputTypes = CreateSignalingChannelCommandInput | CreateStreamCommandInput | DeleteSignalingChannelCommandInput | DeleteStreamCommandInput | DescribeImageGenerationConfigurationCommandInput | DescribeNotificationConfigurationCommandInput | DescribeSignalingChannelCommandInput | DescribeStreamCommandInput | GetDataEndpointCommandInput | GetSignalingChannelEndpointCommandInput | ListSignalingChannelsCommandInput | ListStreamsCommandInput | ListTagsForResourceCommandInput | ListTagsForStreamCommandInput | TagResourceCommandInput | TagStreamCommandInput | UntagResourceCommandInput | UntagStreamCommandInput | UpdateDataRetentionCommandInput | UpdateImageGenerationConfigurationCommandInput | UpdateNotificationConfigurationCommandInput | UpdateSignalingChannelCommandInput | UpdateStreamCommandInput;
33
+ export declare type ServiceOutputTypes = CreateSignalingChannelCommandOutput | CreateStreamCommandOutput | DeleteSignalingChannelCommandOutput | DeleteStreamCommandOutput | DescribeImageGenerationConfigurationCommandOutput | DescribeNotificationConfigurationCommandOutput | DescribeSignalingChannelCommandOutput | DescribeStreamCommandOutput | GetDataEndpointCommandOutput | GetSignalingChannelEndpointCommandOutput | ListSignalingChannelsCommandOutput | ListStreamsCommandOutput | ListTagsForResourceCommandOutput | ListTagsForStreamCommandOutput | TagResourceCommandOutput | TagStreamCommandOutput | UntagResourceCommandOutput | UntagStreamCommandOutput | UpdateDataRetentionCommandOutput | UpdateImageGenerationConfigurationCommandOutput | UpdateNotificationConfigurationCommandOutput | UpdateSignalingChannelCommandOutput | UpdateStreamCommandOutput;
30
34
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
31
35
  /**
32
36
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -0,0 +1,35 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { KinesisVideoClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoClient";
4
+ import { DescribeImageGenerationConfigurationInput, DescribeImageGenerationConfigurationOutput } from "../models/models_0";
5
+ export interface DescribeImageGenerationConfigurationCommandInput extends DescribeImageGenerationConfigurationInput {
6
+ }
7
+ export interface DescribeImageGenerationConfigurationCommandOutput extends DescribeImageGenerationConfigurationOutput, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Gets the <code>ImageGenerationConfiguration</code> for a given Kinesis video stream.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { KinesisVideoClient, DescribeImageGenerationConfigurationCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import
15
+ * // const { KinesisVideoClient, DescribeImageGenerationConfigurationCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import
16
+ * const client = new KinesisVideoClient(config);
17
+ * const command = new DescribeImageGenerationConfigurationCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link DescribeImageGenerationConfigurationCommandInput} for command's `input` shape.
22
+ * @see {@link DescribeImageGenerationConfigurationCommandOutput} for command's `response` shape.
23
+ * @see {@link KinesisVideoClientResolvedConfig | config} for KinesisVideoClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class DescribeImageGenerationConfigurationCommand extends $Command<DescribeImageGenerationConfigurationCommandInput, DescribeImageGenerationConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
27
+ readonly input: DescribeImageGenerationConfigurationCommandInput;
28
+ constructor(input: DescribeImageGenerationConfigurationCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisVideoClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeImageGenerationConfigurationCommandInput, DescribeImageGenerationConfigurationCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -0,0 +1,35 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { KinesisVideoClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoClient";
4
+ import { DescribeNotificationConfigurationInput, DescribeNotificationConfigurationOutput } from "../models/models_0";
5
+ export interface DescribeNotificationConfigurationCommandInput extends DescribeNotificationConfigurationInput {
6
+ }
7
+ export interface DescribeNotificationConfigurationCommandOutput extends DescribeNotificationConfigurationOutput, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Gets the <code>NotificationConfiguration</code> for a given Kinesis video stream.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { KinesisVideoClient, DescribeNotificationConfigurationCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import
15
+ * // const { KinesisVideoClient, DescribeNotificationConfigurationCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import
16
+ * const client = new KinesisVideoClient(config);
17
+ * const command = new DescribeNotificationConfigurationCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link DescribeNotificationConfigurationCommandInput} for command's `input` shape.
22
+ * @see {@link DescribeNotificationConfigurationCommandOutput} for command's `response` shape.
23
+ * @see {@link KinesisVideoClientResolvedConfig | config} for KinesisVideoClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class DescribeNotificationConfigurationCommand extends $Command<DescribeNotificationConfigurationCommandInput, DescribeNotificationConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
27
+ readonly input: DescribeNotificationConfigurationCommandInput;
28
+ constructor(input: DescribeNotificationConfigurationCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisVideoClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeNotificationConfigurationCommandInput, DescribeNotificationConfigurationCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -19,8 +19,8 @@ export interface GetSignalingChannelEndpointCommandOutput extends GetSignalingCh
19
19
  * <code>Role</code> determines the messaging permissions. A <code>MASTER</code> role
20
20
  * results in this API generating an endpoint that a client can use to communicate with any
21
21
  * of the viewers on the channel. A <code>VIEWER</code> role results in this API generating
22
- * an endpoint that a client can use to communicate only with a
23
- * <code>MASTER</code>. </p>
22
+ * an endpoint that a client can use to communicate only with a <code>MASTER</code>.
23
+ * </p>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
26
26
  * ```javascript
@@ -8,8 +8,8 @@ export interface ListSignalingChannelsCommandOutput extends ListSignalingChannel
8
8
  }
9
9
  /**
10
10
  * <p>Returns an array of <code>ChannelInfo</code> objects. Each object describes a
11
- * signaling channel. To retrieve only those channels that satisfy a specific condition, you can
12
- * specify a <code>ChannelNameCondition</code>.</p>
11
+ * signaling channel. To retrieve only those channels that satisfy a specific condition,
12
+ * you can specify a <code>ChannelNameCondition</code>.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -8,10 +8,10 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
8
8
  }
9
9
  /**
10
10
  * <p>Adds one or more tags to a signaling channel. A <i>tag</i> is a
11
- * key-value pair (the value is optional) that you can define and assign to AWS resources.
11
+ * key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources.
12
12
  * If you specify a tag that already exists, the tag value is replaced with the value that
13
13
  * you specify in the request. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation
14
- * Tags</a> in the <i>AWS Billing and Cost Management User
14
+ * Tags</a> in the <i>Billing and Cost Management and Cost Management User
15
15
  * Guide</i>.</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
@@ -8,15 +8,15 @@ export interface TagStreamCommandOutput extends TagStreamOutput, __MetadataBeare
8
8
  }
9
9
  /**
10
10
  * <p>Adds one or more tags to a stream. A <i>tag</i> is a key-value pair
11
- * (the value is optional) that you can define and assign to AWS resources. If you specify
11
+ * (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify
12
12
  * a tag that already exists, the tag value is replaced with the value that you specify in
13
13
  * the request. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation
14
- * Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>. </p>
14
+ * Tags</a> in the <i>Billing and Cost Management and Cost Management User Guide</i>. </p>
15
15
  * <p>You must provide either the <code>StreamName</code> or the
16
16
  * <code>StreamARN</code>.</p>
17
17
  * <p>This operation requires permission for the <code>KinesisVideo:TagStream</code>
18
18
  * action.</p>
19
- * <p>Kinesis video streams support up to 50 tags.</p>
19
+ * <p>A Kinesis video stream can support up to 50 tags.</p>
20
20
  * @example
21
21
  * Use a bare-bones client and the command you need to make an API call.
22
22
  * ```javascript
@@ -0,0 +1,35 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { KinesisVideoClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoClient";
4
+ import { UpdateImageGenerationConfigurationInput, UpdateImageGenerationConfigurationOutput } from "../models/models_0";
5
+ export interface UpdateImageGenerationConfigurationCommandInput extends UpdateImageGenerationConfigurationInput {
6
+ }
7
+ export interface UpdateImageGenerationConfigurationCommandOutput extends UpdateImageGenerationConfigurationOutput, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Updates the <code>StreamInfo</code> and <code>ImageProcessingConfiguration</code> fields.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { KinesisVideoClient, UpdateImageGenerationConfigurationCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import
15
+ * // const { KinesisVideoClient, UpdateImageGenerationConfigurationCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import
16
+ * const client = new KinesisVideoClient(config);
17
+ * const command = new UpdateImageGenerationConfigurationCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link UpdateImageGenerationConfigurationCommandInput} for command's `input` shape.
22
+ * @see {@link UpdateImageGenerationConfigurationCommandOutput} for command's `response` shape.
23
+ * @see {@link KinesisVideoClientResolvedConfig | config} for KinesisVideoClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class UpdateImageGenerationConfigurationCommand extends $Command<UpdateImageGenerationConfigurationCommandInput, UpdateImageGenerationConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
27
+ readonly input: UpdateImageGenerationConfigurationCommandInput;
28
+ constructor(input: UpdateImageGenerationConfigurationCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisVideoClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateImageGenerationConfigurationCommandInput, UpdateImageGenerationConfigurationCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -0,0 +1,35 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { KinesisVideoClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoClient";
4
+ import { UpdateNotificationConfigurationInput, UpdateNotificationConfigurationOutput } from "../models/models_0";
5
+ export interface UpdateNotificationConfigurationCommandInput extends UpdateNotificationConfigurationInput {
6
+ }
7
+ export interface UpdateNotificationConfigurationCommandOutput extends UpdateNotificationConfigurationOutput, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Updates the notification information for a stream.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { KinesisVideoClient, UpdateNotificationConfigurationCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import
15
+ * // const { KinesisVideoClient, UpdateNotificationConfigurationCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import
16
+ * const client = new KinesisVideoClient(config);
17
+ * const command = new UpdateNotificationConfigurationCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link UpdateNotificationConfigurationCommandInput} for command's `input` shape.
22
+ * @see {@link UpdateNotificationConfigurationCommandOutput} for command's `response` shape.
23
+ * @see {@link KinesisVideoClientResolvedConfig | config} for KinesisVideoClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class UpdateNotificationConfigurationCommand extends $Command<UpdateNotificationConfigurationCommandInput, UpdateNotificationConfigurationCommandOutput, KinesisVideoClientResolvedConfig> {
27
+ readonly input: UpdateNotificationConfigurationCommandInput;
28
+ constructor(input: UpdateNotificationConfigurationCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisVideoClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateNotificationConfigurationCommandInput, UpdateNotificationConfigurationCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -2,6 +2,8 @@ export * from "./CreateSignalingChannelCommand";
2
2
  export * from "./CreateStreamCommand";
3
3
  export * from "./DeleteSignalingChannelCommand";
4
4
  export * from "./DeleteStreamCommand";
5
+ export * from "./DescribeImageGenerationConfigurationCommand";
6
+ export * from "./DescribeNotificationConfigurationCommand";
5
7
  export * from "./DescribeSignalingChannelCommand";
6
8
  export * from "./DescribeStreamCommand";
7
9
  export * from "./GetDataEndpointCommand";
@@ -15,5 +17,7 @@ export * from "./TagStreamCommand";
15
17
  export * from "./UntagResourceCommand";
16
18
  export * from "./UntagStreamCommand";
17
19
  export * from "./UpdateDataRetentionCommand";
20
+ export * from "./UpdateImageGenerationConfigurationCommand";
21
+ export * from "./UpdateNotificationConfigurationCommand";
18
22
  export * from "./UpdateSignalingChannelCommand";
19
23
  export * from "./UpdateStreamCommand";
@@ -13,7 +13,7 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * <p>You have reached the maximum limit of active signaling channels for this AWS account
16
+ * <p>You have reached the maximum limit of active signaling channels for this Amazon Web Services account
17
17
  * in this region.</p>
18
18
  */
19
19
  export declare class AccountChannelLimitExceededException extends __BaseException {
@@ -41,6 +41,7 @@ export declare enum APIName {
41
41
  GET_CLIP = "GET_CLIP",
42
42
  GET_DASH_STREAMING_SESSION_URL = "GET_DASH_STREAMING_SESSION_URL",
43
43
  GET_HLS_STREAMING_SESSION_URL = "GET_HLS_STREAMING_SESSION_URL",
44
+ GET_IMAGES = "GET_IMAGES",
44
45
  GET_MEDIA = "GET_MEDIA",
45
46
  GET_MEDIA_FOR_FRAGMENT_LIST = "GET_MEDIA_FOR_FRAGMENT_LIST",
46
47
  LIST_FRAGMENTS = "LIST_FRAGMENTS",
@@ -53,6 +54,7 @@ export declare enum Status {
53
54
  UPDATING = "UPDATING"
54
55
  }
55
56
  export declare enum ChannelType {
57
+ FULL_MESH = "FULL_MESH",
56
58
  SINGLE_MASTER = "SINGLE_MASTER"
57
59
  }
58
60
  /**
@@ -61,7 +63,7 @@ export declare enum ChannelType {
61
63
  */
62
64
  export interface SingleMasterConfiguration {
63
65
  /**
64
- * <p>The period of time a signaling channel retains underlivered messages before they are
66
+ * <p>The period of time a signaling channel retains undelivered messages before they are
65
67
  * discarded.</p>
66
68
  */
67
69
  MessageTtlSeconds?: number;
@@ -159,6 +161,10 @@ export declare class ClientLimitExceededException extends __BaseException {
159
161
  */
160
162
  constructor(opts: __ExceptionOptionType<ClientLimitExceededException, __BaseException>);
161
163
  }
164
+ export declare enum ConfigurationStatus {
165
+ DISABLED = "DISABLED",
166
+ ENABLED = "ENABLED"
167
+ }
162
168
  /**
163
169
  * <p>A key and value pair that is associated with the specified signaling channel.</p>
164
170
  */
@@ -180,8 +186,7 @@ export declare namespace Tag {
180
186
  }
181
187
  export interface CreateSignalingChannelInput {
182
188
  /**
183
- * <p>A name for the signaling channel that you are creating. It must be unique for each AWS
184
- * account and AWS Region.</p>
189
+ * <p>A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.</p>
185
190
  */
186
191
  ChannelName: string | undefined;
187
192
  /**
@@ -230,7 +235,12 @@ export declare class InvalidArgumentException extends __BaseException {
230
235
  constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
231
236
  }
232
237
  /**
233
- * <p>The signaling channel is currently not available for this operation.</p>
238
+ * <p>The resource is currently not available for this operation. New resources cannot be
239
+ * created with the same name as existing resources. Also, resources cannot be updated or
240
+ * deleted unless they are in an <code>ACTIVE</code> state.</p>
241
+ * <p>If this exception is returned, do not use it to determine whether the requested
242
+ * resource already exists. Instead, it is recommended you use the resource-specific
243
+ * describe API, for example, <code>DescribeStream</code> for video streams.</p>
234
244
  */
235
245
  export declare class ResourceInUseException extends __BaseException {
236
246
  readonly name: "ResourceInUseException";
@@ -243,7 +253,7 @@ export declare class ResourceInUseException extends __BaseException {
243
253
  }
244
254
  /**
245
255
  * <p>You have exceeded the limit of tags that you can associate with the resource.
246
- * Kinesis video streams support up to 50 tags. </p>
256
+ * A Kinesis video stream can support up to 50 tags. </p>
247
257
  */
248
258
  export declare class TagsPerResourceExceededLimitException extends __BaseException {
249
259
  readonly name: "TagsPerResourceExceededLimitException";
@@ -281,7 +291,7 @@ export interface CreateStreamInput {
281
291
  */
282
292
  MediaType?: string;
283
293
  /**
284
- * <p>The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video
294
+ * <p>The ID of the Key Management Service (KMS) key that you want Kinesis Video
285
295
  * Streams to use to encrypt stream data.</p>
286
296
  * <p>If no key ID is specified, the default, Kinesis Video-managed key
287
297
  * (<code>aws/kinesisvideo</code>) is used.</p>
@@ -289,8 +299,7 @@ export interface CreateStreamInput {
289
299
  */
290
300
  KmsKeyId?: string;
291
301
  /**
292
- * <p>The number of hours that you want to retain the data in the stream. Kinesis Video
293
- * Streams retains the data in a data store that is associated with the stream.</p>
302
+ * <p>The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.</p>
294
303
  * <p>The default value is 0, indicating that the stream does not persist data.</p>
295
304
  * <p>When the <code>DataRetentionInHours</code> value is 0, consumers can still consume
296
305
  * the fragments that remain in the service host buffer, which has a retention time limit
@@ -442,6 +451,182 @@ export declare class NotAuthorizedException extends __BaseException {
442
451
  */
443
452
  constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
444
453
  }
454
+ export interface DescribeImageGenerationConfigurationInput {
455
+ /**
456
+ * <p>The name of the stream from which to retrieve the image generation configuration. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>. </p>
457
+ */
458
+ StreamName?: string;
459
+ /**
460
+ * <p>The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
461
+ */
462
+ StreamARN?: string;
463
+ }
464
+ export declare namespace DescribeImageGenerationConfigurationInput {
465
+ /**
466
+ * @internal
467
+ */
468
+ const filterSensitiveLog: (obj: DescribeImageGenerationConfigurationInput) => any;
469
+ }
470
+ /**
471
+ * <p>The structure that contains the information required to deliver images to a customer.</p>
472
+ */
473
+ export interface ImageGenerationDestinationConfig {
474
+ /**
475
+ * <p>The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.</p>
476
+ */
477
+ Uri: string | undefined;
478
+ /**
479
+ * <p>The AWS Region of the S3 bucket where images will be delivered. This <code>DestinationRegion</code> must match the Region where the stream is located.</p>
480
+ */
481
+ DestinationRegion: string | undefined;
482
+ }
483
+ export declare namespace ImageGenerationDestinationConfig {
484
+ /**
485
+ * @internal
486
+ */
487
+ const filterSensitiveLog: (obj: ImageGenerationDestinationConfig) => any;
488
+ }
489
+ export declare enum Format {
490
+ JPEG = "JPEG",
491
+ PNG = "PNG"
492
+ }
493
+ export declare enum FormatConfigKey {
494
+ JPEGQuality = "JPEGQuality"
495
+ }
496
+ export declare enum ImageSelectorType {
497
+ PRODUCER_TIMESTAMP = "PRODUCER_TIMESTAMP",
498
+ SERVER_TIMESTAMP = "SERVER_TIMESTAMP"
499
+ }
500
+ /**
501
+ * <p>The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream.</p>
502
+ */
503
+ export interface ImageGenerationConfiguration {
504
+ /**
505
+ * <p>Indicates whether the <code>ContinuousImageGenerationConfigurations</code> API is enabled or disabled.</p>
506
+ */
507
+ Status: ConfigurationStatus | string | undefined;
508
+ /**
509
+ * <p>The origin of the Server or Producer timestamps to use to generate the images.</p>
510
+ */
511
+ ImageSelectorType: ImageSelectorType | string | undefined;
512
+ /**
513
+ * <p>The structure that contains the information required to deliver images to a customer.</p>
514
+ */
515
+ DestinationConfig: ImageGenerationDestinationConfig | undefined;
516
+ /**
517
+ * <p>The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms,
518
+ * because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the
519
+ * Image from the <code>StartTimestamp</code> will be returned if available. </p>
520
+ */
521
+ SamplingInterval: number | undefined;
522
+ /**
523
+ * <p>The accepted image format.</p>
524
+ */
525
+ Format: Format | string | undefined;
526
+ /**
527
+ * <p>The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.
528
+ * The <code>FormatConfig</code> key is the <code>JPEGQuality</code>, which indicates the JPEG quality key to be used to generate the image.
529
+ * The <code>FormatConfig</code> value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression.
530
+ * If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the <code>JPEGQuality</code>
531
+ * key will be set to 80.</p>
532
+ */
533
+ FormatConfig?: {
534
+ [key: string]: string;
535
+ };
536
+ /**
537
+ * <p>The width of the output image that is used in conjunction with the <code>HeightPixels</code> parameter. When both <code>WidthPixels</code> and
538
+ * <code>HeightPixels</code> parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the <code>WidthPixels</code> parameter is
539
+ * provided, its original aspect ratio will be used to calculate the <code>HeightPixels</code> ratio. If neither parameter is provided, the original image size will be returned.</p>
540
+ */
541
+ WidthPixels?: number;
542
+ /**
543
+ * <p>The height of the output image that is used in conjunction with the <code>WidthPixels</code> parameter. When both
544
+ * <code>HeightPixels</code> and <code>WidthPixels</code> parameters are provided, the image will be stretched to fit the specified aspect ratio.
545
+ * If only the <code>HeightPixels</code> parameter is provided, its original aspect ratio will be used to calculate the <code>WidthPixels</code> ratio.
546
+ * If neither parameter is provided, the original image size will be returned.</p>
547
+ */
548
+ HeightPixels?: number;
549
+ }
550
+ export declare namespace ImageGenerationConfiguration {
551
+ /**
552
+ * @internal
553
+ */
554
+ const filterSensitiveLog: (obj: ImageGenerationConfiguration) => any;
555
+ }
556
+ export interface DescribeImageGenerationConfigurationOutput {
557
+ /**
558
+ * <p>The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream.</p>
559
+ */
560
+ ImageGenerationConfiguration?: ImageGenerationConfiguration;
561
+ }
562
+ export declare namespace DescribeImageGenerationConfigurationOutput {
563
+ /**
564
+ * @internal
565
+ */
566
+ const filterSensitiveLog: (obj: DescribeImageGenerationConfigurationOutput) => any;
567
+ }
568
+ export interface DescribeNotificationConfigurationInput {
569
+ /**
570
+ * <p>The name of the stream from which to retrieve the notification configuration. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
571
+ */
572
+ StreamName?: string;
573
+ /**
574
+ * <p>The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to retrieve the notification configuration. You must specify either the <code>StreamName</code> or the StreamARN.</p>
575
+ */
576
+ StreamARN?: string;
577
+ }
578
+ export declare namespace DescribeNotificationConfigurationInput {
579
+ /**
580
+ * @internal
581
+ */
582
+ const filterSensitiveLog: (obj: DescribeNotificationConfigurationInput) => any;
583
+ }
584
+ /**
585
+ * <p>The structure that contains the information required to deliver a notification to a customer.</p>
586
+ */
587
+ export interface NotificationDestinationConfig {
588
+ /**
589
+ * <p>The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.</p>
590
+ */
591
+ Uri: string | undefined;
592
+ }
593
+ export declare namespace NotificationDestinationConfig {
594
+ /**
595
+ * @internal
596
+ */
597
+ const filterSensitiveLog: (obj: NotificationDestinationConfig) => any;
598
+ }
599
+ /**
600
+ * <p>The structure that contains the notification information for the KVS images delivery. If this parameter is null, the configuration will be deleted from the stream.</p>
601
+ */
602
+ export interface NotificationConfiguration {
603
+ /**
604
+ * <p>Indicates if a notification configuration is enabled or disabled.</p>
605
+ */
606
+ Status: ConfigurationStatus | string | undefined;
607
+ /**
608
+ * <p>The destination information required to deliver a notification to a customer.</p>
609
+ */
610
+ DestinationConfig: NotificationDestinationConfig | undefined;
611
+ }
612
+ export declare namespace NotificationConfiguration {
613
+ /**
614
+ * @internal
615
+ */
616
+ const filterSensitiveLog: (obj: NotificationConfiguration) => any;
617
+ }
618
+ export interface DescribeNotificationConfigurationOutput {
619
+ /**
620
+ * <p>The structure that contains the information required for notifications. If the structure is null, the configuration will be deleted from the stream.</p>
621
+ */
622
+ NotificationConfiguration?: NotificationConfiguration;
623
+ }
624
+ export declare namespace DescribeNotificationConfigurationOutput {
625
+ /**
626
+ * @internal
627
+ */
628
+ const filterSensitiveLog: (obj: DescribeNotificationConfigurationOutput) => any;
629
+ }
445
630
  export interface DescribeSignalingChannelInput {
446
631
  /**
447
632
  * <p>The name of the signaling channel that you want to describe.</p>
@@ -508,7 +693,7 @@ export interface StreamInfo {
508
693
  */
509
694
  MediaType?: string;
510
695
  /**
511
- * <p>The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams
696
+ * <p>The ID of the Key Management Service (KMS) key that Kinesis Video Streams
512
697
  * uses to encrypt data on the stream.</p>
513
698
  */
514
699
  KmsKeyId?: string;
@@ -1016,6 +1201,75 @@ export declare namespace UpdateDataRetentionOutput {
1016
1201
  */
1017
1202
  const filterSensitiveLog: (obj: UpdateDataRetentionOutput) => any;
1018
1203
  }
1204
+ /**
1205
+ * <p>The Stream data retention in hours is equal to zero.</p>
1206
+ */
1207
+ export declare class NoDataRetentionException extends __BaseException {
1208
+ readonly name: "NoDataRetentionException";
1209
+ readonly $fault: "client";
1210
+ Message?: string;
1211
+ /**
1212
+ * @internal
1213
+ */
1214
+ constructor(opts: __ExceptionOptionType<NoDataRetentionException, __BaseException>);
1215
+ }
1216
+ export interface UpdateImageGenerationConfigurationInput {
1217
+ /**
1218
+ * <p>The name of the stream from which to update the image generation configuration. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
1219
+ */
1220
+ StreamName?: string;
1221
+ /**
1222
+ * <p>The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the image generation configuration. You must specify either the <code>StreamName</code>
1223
+ * or the <code>StreamARN</code>.</p>
1224
+ */
1225
+ StreamARN?: string;
1226
+ /**
1227
+ * <p>The structure that contains the information required for the KVS images delivery. If the structure is null, the configuration will be deleted from the stream.</p>
1228
+ */
1229
+ ImageGenerationConfiguration?: ImageGenerationConfiguration;
1230
+ }
1231
+ export declare namespace UpdateImageGenerationConfigurationInput {
1232
+ /**
1233
+ * @internal
1234
+ */
1235
+ const filterSensitiveLog: (obj: UpdateImageGenerationConfigurationInput) => any;
1236
+ }
1237
+ export interface UpdateImageGenerationConfigurationOutput {
1238
+ }
1239
+ export declare namespace UpdateImageGenerationConfigurationOutput {
1240
+ /**
1241
+ * @internal
1242
+ */
1243
+ const filterSensitiveLog: (obj: UpdateImageGenerationConfigurationOutput) => any;
1244
+ }
1245
+ export interface UpdateNotificationConfigurationInput {
1246
+ /**
1247
+ * <p>The name of the stream from which to update the notification configuration. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
1248
+ */
1249
+ StreamName?: string;
1250
+ /**
1251
+ * <p>The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the notification configuration. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
1252
+ */
1253
+ StreamARN?: string;
1254
+ /**
1255
+ * <p>The structure containing the information required for notifications. If the structure is null, the configuration will be deleted from the stream.</p>
1256
+ */
1257
+ NotificationConfiguration?: NotificationConfiguration;
1258
+ }
1259
+ export declare namespace UpdateNotificationConfigurationInput {
1260
+ /**
1261
+ * @internal
1262
+ */
1263
+ const filterSensitiveLog: (obj: UpdateNotificationConfigurationInput) => any;
1264
+ }
1265
+ export interface UpdateNotificationConfigurationOutput {
1266
+ }
1267
+ export declare namespace UpdateNotificationConfigurationOutput {
1268
+ /**
1269
+ * @internal
1270
+ */
1271
+ const filterSensitiveLog: (obj: UpdateNotificationConfigurationOutput) => any;
1272
+ }
1019
1273
  export interface UpdateSignalingChannelInput {
1020
1274
  /**
1021
1275
  * <p>The Amazon Resource Name (ARN) of the signaling channel that you want to