@aws-sdk/client-kinesis-video-archived-media 3.533.0 → 3.535.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.
@@ -16,12 +16,14 @@ export interface KinesisVideoArchivedMedia {
16
16
  /**
17
17
  * @see {@link GetDASHStreamingSessionURLCommand}
18
18
  */
19
+ getDASHStreamingSessionURL(): Promise<GetDASHStreamingSessionURLCommandOutput>;
19
20
  getDASHStreamingSessionURL(args: GetDASHStreamingSessionURLCommandInput, options?: __HttpHandlerOptions): Promise<GetDASHStreamingSessionURLCommandOutput>;
20
21
  getDASHStreamingSessionURL(args: GetDASHStreamingSessionURLCommandInput, cb: (err: any, data?: GetDASHStreamingSessionURLCommandOutput) => void): void;
21
22
  getDASHStreamingSessionURL(args: GetDASHStreamingSessionURLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDASHStreamingSessionURLCommandOutput) => void): void;
22
23
  /**
23
24
  * @see {@link GetHLSStreamingSessionURLCommand}
24
25
  */
26
+ getHLSStreamingSessionURL(): Promise<GetHLSStreamingSessionURLCommandOutput>;
25
27
  getHLSStreamingSessionURL(args: GetHLSStreamingSessionURLCommandInput, options?: __HttpHandlerOptions): Promise<GetHLSStreamingSessionURLCommandOutput>;
26
28
  getHLSStreamingSessionURL(args: GetHLSStreamingSessionURLCommandInput, cb: (err: any, data?: GetHLSStreamingSessionURLCommandOutput) => void): void;
27
29
  getHLSStreamingSessionURL(args: GetHLSStreamingSessionURLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHLSStreamingSessionURLCommandOutput) => void): void;
@@ -40,13 +42,14 @@ export interface KinesisVideoArchivedMedia {
40
42
  /**
41
43
  * @see {@link ListFragmentsCommand}
42
44
  */
45
+ listFragments(): Promise<ListFragmentsCommandOutput>;
43
46
  listFragments(args: ListFragmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListFragmentsCommandOutput>;
44
47
  listFragments(args: ListFragmentsCommandInput, cb: (err: any, data?: ListFragmentsCommandOutput) => void): void;
45
48
  listFragments(args: ListFragmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFragmentsCommandOutput) => void): void;
46
49
  }
47
50
  /**
48
- * @public
49
51
  * <p></p>
52
+ * @public
50
53
  */
51
54
  export declare class KinesisVideoArchivedMedia extends KinesisVideoArchivedMediaClient implements KinesisVideoArchivedMedia {
52
55
  }
@@ -162,8 +162,8 @@ export type KinesisVideoArchivedMediaClientResolvedConfigType = __SmithyResolved
162
162
  export interface KinesisVideoArchivedMediaClientResolvedConfig extends KinesisVideoArchivedMediaClientResolvedConfigType {
163
163
  }
164
164
  /**
165
- * @public
166
165
  * <p></p>
166
+ * @public
167
167
  */
168
168
  export declare class KinesisVideoArchivedMediaClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, KinesisVideoArchivedMediaClientResolvedConfig> {
169
169
  /**
@@ -23,10 +23,10 @@ export interface GetClipCommandOutput extends Omit<GetClipOutput, "Payload">, __
23
23
  }
24
24
  declare const GetClipCommand_base: {
25
25
  new (input: GetClipCommandInput): import("@smithy/smithy-client").CommandImpl<GetClipCommandInput, GetClipCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetClipCommandInput): import("@smithy/smithy-client").CommandImpl<GetClipCommandInput, GetClipCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
28
  };
28
29
  /**
29
- * @public
30
30
  * <p>Downloads an MP4 file (clip) containing the archived, on-demand media from the
31
31
  * specified video stream over the specified time range. </p>
32
32
  * <p>Both the StreamName and the StreamARN parameters are optional, but you must specify
@@ -146,6 +146,7 @@ declare const GetClipCommand_base: {
146
146
  * @throws {@link KinesisVideoArchivedMediaServiceException}
147
147
  * <p>Base exception class for all service exceptions from KinesisVideoArchivedMedia service.</p>
148
148
  *
149
+ * @public
149
150
  */
150
151
  export declare class GetClipCommand extends GetClipCommand_base {
151
152
  }
@@ -22,10 +22,10 @@ export interface GetDASHStreamingSessionURLCommandOutput extends GetDASHStreamin
22
22
  }
23
23
  declare const GetDASHStreamingSessionURLCommand_base: {
24
24
  new (input: GetDASHStreamingSessionURLCommandInput): import("@smithy/smithy-client").CommandImpl<GetDASHStreamingSessionURLCommandInput, GetDASHStreamingSessionURLCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [GetDASHStreamingSessionURLCommandInput]): import("@smithy/smithy-client").CommandImpl<GetDASHStreamingSessionURLCommandInput, GetDASHStreamingSessionURLCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You
30
30
  * can then open the URL in a media player to view the stream contents.</p>
31
31
  * <p>Both the <code>StreamName</code> and the <code>StreamARN</code> parameters are
@@ -250,6 +250,7 @@ declare const GetDASHStreamingSessionURLCommand_base: {
250
250
  * @throws {@link KinesisVideoArchivedMediaServiceException}
251
251
  * <p>Base exception class for all service exceptions from KinesisVideoArchivedMedia service.</p>
252
252
  *
253
+ * @public
253
254
  */
254
255
  export declare class GetDASHStreamingSessionURLCommand extends GetDASHStreamingSessionURLCommand_base {
255
256
  }
@@ -22,10 +22,10 @@ export interface GetHLSStreamingSessionURLCommandOutput extends GetHLSStreamingS
22
22
  }
23
23
  declare const GetHLSStreamingSessionURLCommand_base: {
24
24
  new (input: GetHLSStreamingSessionURLCommandInput): import("@smithy/smithy-client").CommandImpl<GetHLSStreamingSessionURLCommandInput, GetHLSStreamingSessionURLCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [GetHLSStreamingSessionURLCommandInput]): import("@smithy/smithy-client").CommandImpl<GetHLSStreamingSessionURLCommandInput, GetHLSStreamingSessionURLCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL
30
30
  * in a browser or media player to view the stream contents.</p>
31
31
  * <p>Both the <code>StreamName</code> and the <code>StreamARN</code> parameters are
@@ -293,6 +293,7 @@ declare const GetHLSStreamingSessionURLCommand_base: {
293
293
  * @throws {@link KinesisVideoArchivedMediaServiceException}
294
294
  * <p>Base exception class for all service exceptions from KinesisVideoArchivedMedia service.</p>
295
295
  *
296
+ * @public
296
297
  */
297
298
  export declare class GetHLSStreamingSessionURLCommand extends GetHLSStreamingSessionURLCommand_base {
298
299
  }
@@ -22,10 +22,10 @@ export interface GetImagesCommandOutput extends GetImagesOutput, __MetadataBeare
22
22
  }
23
23
  declare const GetImagesCommand_base: {
24
24
  new (input: GetImagesCommandInput): import("@smithy/smithy-client").CommandImpl<GetImagesCommandInput, GetImagesCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: GetImagesCommandInput): import("@smithy/smithy-client").CommandImpl<GetImagesCommandInput, GetImagesCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Retrieves a list of images corresponding to each timestamp for a given time range,
30
30
  * sampling interval, and image format configuration.</p>
31
31
  * @example
@@ -102,6 +102,7 @@ declare const GetImagesCommand_base: {
102
102
  * @throws {@link KinesisVideoArchivedMediaServiceException}
103
103
  * <p>Base exception class for all service exceptions from KinesisVideoArchivedMedia service.</p>
104
104
  *
105
+ * @public
105
106
  */
106
107
  export declare class GetImagesCommand extends GetImagesCommand_base {
107
108
  }
@@ -23,10 +23,10 @@ export interface GetMediaForFragmentListCommandOutput extends Omit<GetMediaForFr
23
23
  }
24
24
  declare const GetMediaForFragmentListCommand_base: {
25
25
  new (input: GetMediaForFragmentListCommandInput): import("@smithy/smithy-client").CommandImpl<GetMediaForFragmentListCommandInput, GetMediaForFragmentListCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetMediaForFragmentListCommandInput): import("@smithy/smithy-client").CommandImpl<GetMediaForFragmentListCommandInput, GetMediaForFragmentListCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
28
  };
28
29
  /**
29
- * @public
30
30
  * <p>Gets media for a list of fragments (specified by fragment number) from the archived
31
31
  * data in an Amazon Kinesis video stream.</p>
32
32
  * <note>
@@ -115,6 +115,7 @@ declare const GetMediaForFragmentListCommand_base: {
115
115
  * @throws {@link KinesisVideoArchivedMediaServiceException}
116
116
  * <p>Base exception class for all service exceptions from KinesisVideoArchivedMedia service.</p>
117
117
  *
118
+ * @public
118
119
  */
119
120
  export declare class GetMediaForFragmentListCommand extends GetMediaForFragmentListCommand_base {
120
121
  }
@@ -22,10 +22,10 @@ export interface ListFragmentsCommandOutput extends ListFragmentsOutput, __Metad
22
22
  }
23
23
  declare const ListFragmentsCommand_base: {
24
24
  new (input: ListFragmentsCommandInput): import("@smithy/smithy-client").CommandImpl<ListFragmentsCommandInput, ListFragmentsCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [ListFragmentsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListFragmentsCommandInput, ListFragmentsCommandOutput, KinesisVideoArchivedMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Returns a list of <a>Fragment</a> objects from the specified stream and
30
30
  * timestamp range within the archived data.</p>
31
31
  * <p>Listing fragments is eventually consistent. This means that even if the producer
@@ -130,6 +130,7 @@ declare const ListFragmentsCommand_base: {
130
130
  * @throws {@link KinesisVideoArchivedMediaServiceException}
131
131
  * <p>Base exception class for all service exceptions from KinesisVideoArchivedMedia service.</p>
132
132
  *
133
+ * @public
133
134
  */
134
135
  export declare class ListFragmentsCommand extends ListFragmentsCommand_base {
135
136
  }
@@ -2,8 +2,8 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
2
2
  import { StreamingBlobTypes } from "@smithy/types";
3
3
  import { KinesisVideoArchivedMediaServiceException as __BaseException } from "./KinesisVideoArchivedMediaServiceException";
4
4
  /**
5
- * @public
6
5
  * <p>Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see <a href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis Video Streams Limits</a>.</p>
6
+ * @public
7
7
  */
8
8
  export declare class ClientLimitExceededException extends __BaseException {
9
9
  readonly name: "ClientLimitExceededException";
@@ -27,22 +27,21 @@ export declare const ClipFragmentSelectorType: {
27
27
  */
28
28
  export type ClipFragmentSelectorType = (typeof ClipFragmentSelectorType)[keyof typeof ClipFragmentSelectorType];
29
29
  /**
30
- * @public
31
30
  * <p>The range of timestamps for which to return fragments.</p>
31
+ * @public
32
32
  */
33
33
  export interface ClipTimestampRange {
34
34
  /**
35
- * @public
36
35
  * <p>The starting timestamp in the range of timestamps for which to return fragments. </p>
37
36
  * <p>Only fragments that start exactly at or after <code>StartTimestamp</code> are included
38
37
  * in the session. Fragments that start before <code>StartTimestamp</code> and continue
39
38
  * past it aren't included in the session. If <code>FragmentSelectorType</code> is
40
39
  * <code>SERVER_TIMESTAMP</code>, the <code>StartTimestamp</code> must be later than
41
40
  * the stream head. </p>
41
+ * @public
42
42
  */
43
43
  StartTimestamp: Date | undefined;
44
44
  /**
45
- * @public
46
45
  * <p>The end of the timestamp range for the requested media.</p>
47
46
  * <p>This value must be within 24 hours of the specified <code>StartTimestamp</code>, and
48
47
  * it must be later than the <code>StartTimestamp</code> value. If
@@ -51,11 +50,11 @@ export interface ClipTimestampRange {
51
50
  * <p>This value is inclusive. The <code>EndTimestamp</code> is compared to the (starting)
52
51
  * timestamp of the fragment. Fragments that start before the <code>EndTimestamp</code>
53
52
  * value and continue past it are included in the session. </p>
53
+ * @public
54
54
  */
55
55
  EndTimestamp: Date | undefined;
56
56
  }
57
57
  /**
58
- * @public
59
58
  * <p>Describes the timestamp range and timestamp origin of a range of fragments.</p>
60
59
  * <p>Fragments that have duplicate producer timestamps are deduplicated. This means that if
61
60
  * producers are producing a stream of fragments with producer timestamps that are
@@ -63,16 +62,17 @@ export interface ClipTimestampRange {
63
62
  * within the requested timestamp range. If some fragments are ingested within the same
64
63
  * time range and very different points in time, only the oldest ingested collection of
65
64
  * fragments are returned.</p>
65
+ * @public
66
66
  */
67
67
  export interface ClipFragmentSelector {
68
68
  /**
69
- * @public
70
69
  * <p>The origin of the timestamps to use (Server or Producer).</p>
70
+ * @public
71
71
  */
72
72
  FragmentSelectorType: ClipFragmentSelectorType | undefined;
73
73
  /**
74
- * @public
75
74
  * <p>The range of timestamps to return.</p>
75
+ * @public
76
76
  */
77
77
  TimestampRange: ClipTimestampRange | undefined;
78
78
  }
@@ -81,20 +81,20 @@ export interface ClipFragmentSelector {
81
81
  */
82
82
  export interface GetClipInput {
83
83
  /**
84
- * @public
85
84
  * <p>The name of the stream for which to retrieve the media clip. </p>
86
85
  * <p>You must specify either the StreamName or the StreamARN. </p>
86
+ * @public
87
87
  */
88
88
  StreamName?: string;
89
89
  /**
90
- * @public
91
90
  * <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip. </p>
92
91
  * <p>You must specify either the StreamName or the StreamARN. </p>
92
+ * @public
93
93
  */
94
94
  StreamARN?: string;
95
95
  /**
96
- * @public
97
96
  * <p>The time range of the requested clip and the source of the timestamps.</p>
97
+ * @public
98
98
  */
99
99
  ClipFragmentSelector: ClipFragmentSelector | undefined;
100
100
  }
@@ -103,23 +103,23 @@ export interface GetClipInput {
103
103
  */
104
104
  export interface GetClipOutput {
105
105
  /**
106
- * @public
107
106
  * <p>The content type of the media in the requested clip.</p>
107
+ * @public
108
108
  */
109
109
  ContentType?: string;
110
110
  /**
111
- * @public
112
111
  * <p>Traditional MP4 file that contains the media clip from the specified video stream. The
113
112
  * output will contain the first 100 MB or the first 200 fragments from the specified start
114
113
  * timestamp. For more information, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis
115
114
  * Video Streams Limits</a>. </p>
115
+ * @public
116
116
  */
117
117
  Payload?: StreamingBlobTypes;
118
118
  }
119
119
  /**
120
- * @public
121
120
  * <p>A specified parameter exceeds its restrictions, is not supported, or can't be
122
121
  * used.</p>
122
+ * @public
123
123
  */
124
124
  export declare class InvalidArgumentException extends __BaseException {
125
125
  readonly name: "InvalidArgumentException";
@@ -131,9 +131,9 @@ export declare class InvalidArgumentException extends __BaseException {
131
131
  constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
132
132
  }
133
133
  /**
134
- * @public
135
134
  * <p>The codec private data in at least one of the tracks of the video stream is not valid
136
135
  * for this operation.</p>
136
+ * @public
137
137
  */
138
138
  export declare class InvalidCodecPrivateDataException extends __BaseException {
139
139
  readonly name: "InvalidCodecPrivateDataException";
@@ -145,9 +145,9 @@ export declare class InvalidCodecPrivateDataException extends __BaseException {
145
145
  constructor(opts: __ExceptionOptionType<InvalidCodecPrivateDataException, __BaseException>);
146
146
  }
147
147
  /**
148
- * @public
149
148
  * <p>One or more frames in the requested clip could not be parsed based on the specified
150
149
  * codec.</p>
150
+ * @public
151
151
  */
152
152
  export declare class InvalidMediaFrameException extends __BaseException {
153
153
  readonly name: "InvalidMediaFrameException";
@@ -159,8 +159,8 @@ export declare class InvalidMediaFrameException extends __BaseException {
159
159
  constructor(opts: __ExceptionOptionType<InvalidMediaFrameException, __BaseException>);
160
160
  }
161
161
  /**
162
- * @public
163
162
  * <p>No codec private data was found in at least one of tracks of the video stream.</p>
163
+ * @public
164
164
  */
165
165
  export declare class MissingCodecPrivateDataException extends __BaseException {
166
166
  readonly name: "MissingCodecPrivateDataException";
@@ -172,10 +172,10 @@ export declare class MissingCodecPrivateDataException extends __BaseException {
172
172
  constructor(opts: __ExceptionOptionType<MissingCodecPrivateDataException, __BaseException>);
173
173
  }
174
174
  /**
175
- * @public
176
175
  * <p>
177
176
  * <code>GetImages</code> was requested for a stream that does not retain data (that is, has
178
177
  * a <code>DataRetentionInHours</code> of 0). </p>
178
+ * @public
179
179
  */
180
180
  export declare class NoDataRetentionException extends __BaseException {
181
181
  readonly name: "NoDataRetentionException";
@@ -187,9 +187,9 @@ export declare class NoDataRetentionException extends __BaseException {
187
187
  constructor(opts: __ExceptionOptionType<NoDataRetentionException, __BaseException>);
188
188
  }
189
189
  /**
190
- * @public
191
190
  * <p>Status Code: 403, The caller is not authorized to perform an operation on the given
192
191
  * stream, or the token has expired.</p>
192
+ * @public
193
193
  */
194
194
  export declare class NotAuthorizedException extends __BaseException {
195
195
  readonly name: "NotAuthorizedException";
@@ -201,7 +201,6 @@ export declare class NotAuthorizedException extends __BaseException {
201
201
  constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
202
202
  }
203
203
  /**
204
- * @public
205
204
  * <p>
206
205
  * <code>GetImages</code> will throw this error when Kinesis Video Streams can't find the stream
207
206
  * that you specified.</p>
@@ -212,6 +211,7 @@ export declare class NotAuthorizedException extends __BaseException {
212
211
  * requested time range, or if a session with a <code>PlaybackMode</code> of
213
212
  * <code>LIVE</code> is requested for a stream that has no fragments within the last 30
214
213
  * seconds.</p>
214
+ * @public
215
215
  */
216
216
  export declare class ResourceNotFoundException extends __BaseException {
217
217
  readonly name: "ResourceNotFoundException";
@@ -223,11 +223,11 @@ export declare class ResourceNotFoundException extends __BaseException {
223
223
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
224
224
  }
225
225
  /**
226
- * @public
227
226
  * <p>The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could
228
227
  * not be determined from the codec IDs of the tracks in the first fragment for a playback
229
228
  * session. The codec ID for track 1 should be <code>V_MPEG/ISO/AVC</code> and, optionally,
230
229
  * the codec ID for track 2 should be <code>A_AAC</code>.</p>
230
+ * @public
231
231
  */
232
232
  export declare class UnsupportedStreamMediaTypeException extends __BaseException {
233
233
  readonly name: "UnsupportedStreamMediaTypeException";
@@ -251,17 +251,16 @@ export declare const DASHFragmentSelectorType: {
251
251
  */
252
252
  export type DASHFragmentSelectorType = (typeof DASHFragmentSelectorType)[keyof typeof DASHFragmentSelectorType];
253
253
  /**
254
- * @public
255
254
  * <p>The start and end of the timestamp range for the requested media.</p>
256
255
  * <p>This value should not be present if <code>PlaybackType</code> is
257
256
  * <code>LIVE</code>.</p>
258
257
  * <p>The values in <code>DASHimestampRange</code> are inclusive. Fragments that start
259
258
  * exactly at or after the start time are included in the session. Fragments that start
260
259
  * before the start time and continue past it are not included in the session.</p>
260
+ * @public
261
261
  */
262
262
  export interface DASHTimestampRange {
263
263
  /**
264
- * @public
265
264
  * <p>The start of the timestamp range for the requested media.</p>
266
265
  * <p>If the <code>DASHTimestampRange</code> value is specified, the
267
266
  * <code>StartTimestamp</code> value is required.</p>
@@ -270,10 +269,10 @@ export interface DASHTimestampRange {
270
269
  * past it aren't included in the session. If <code>FragmentSelectorType</code> is
271
270
  * <code>SERVER_TIMESTAMP</code>, the <code>StartTimestamp</code> must be later than
272
271
  * the stream head. </p>
272
+ * @public
273
273
  */
274
274
  StartTimestamp?: Date;
275
275
  /**
276
- * @public
277
276
  * <p>The end of the timestamp range for the requested media. This value must be within 24
278
277
  * hours of the specified <code>StartTimestamp</code>, and it must be later than the
279
278
  * <code>StartTimestamp</code> value.</p>
@@ -289,17 +288,17 @@ export interface DASHTimestampRange {
289
288
  * <code>EndTimestamp</code> value and continue past it are included in the
290
289
  * session.</p>
291
290
  * </note>
291
+ * @public
292
292
  */
293
293
  EndTimestamp?: Date;
294
294
  }
295
295
  /**
296
- * @public
297
296
  * <p>Contains the range of timestamps for the requested media, and the source of the
298
297
  * timestamps. </p>
298
+ * @public
299
299
  */
300
300
  export interface DASHFragmentSelector {
301
301
  /**
302
- * @public
303
302
  * <p>The source of the timestamps for the requested media.</p>
304
303
  * <p>When <code>FragmentSelectorType</code> is set to <code>PRODUCER_TIMESTAMP</code> and
305
304
  * <a>GetDASHStreamingSessionURLInput$PlaybackMode</a> is
@@ -321,13 +320,14 @@ export interface DASHFragmentSelector {
321
320
  * MPEG-DASH manifest. This means that even if fragments ingested in the past have producer
322
321
  * timestamps with values now, they are not included in the HLS media playlist.</p>
323
322
  * <p>The default is <code>SERVER_TIMESTAMP</code>.</p>
323
+ * @public
324
324
  */
325
325
  FragmentSelectorType?: DASHFragmentSelectorType;
326
326
  /**
327
- * @public
328
327
  * <p>The start and end of the timestamp range for the requested media.</p>
329
328
  * <p>This value should not be present if <code>PlaybackType</code> is
330
329
  * <code>LIVE</code>.</p>
330
+ * @public
331
331
  */
332
332
  TimestampRange?: DASHTimestampRange;
333
333
  }
@@ -373,22 +373,21 @@ export type DASHPlaybackMode = (typeof DASHPlaybackMode)[keyof typeof DASHPlayba
373
373
  */
374
374
  export interface GetDASHStreamingSessionURLInput {
375
375
  /**
376
- * @public
377
376
  * <p>The name of the stream for which to retrieve the MPEG-DASH manifest URL.</p>
378
377
  * <p>You must specify either the <code>StreamName</code> or the
379
378
  * <code>StreamARN</code>.</p>
379
+ * @public
380
380
  */
381
381
  StreamName?: string;
382
382
  /**
383
- * @public
384
383
  * <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH
385
384
  * manifest URL.</p>
386
385
  * <p>You must specify either the <code>StreamName</code> or the
387
386
  * <code>StreamARN</code>.</p>
387
+ * @public
388
388
  */
389
389
  StreamARN?: string;
390
390
  /**
391
- * @public
392
391
  * <p>Whether to retrieve live, live replay, or archived, on-demand data.</p>
393
392
  * <p>Features of the three types of sessions include the following:</p>
394
393
  * <ul>
@@ -449,10 +448,10 @@ export interface GetDASHStreamingSessionURLInput {
449
448
  * included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media
450
449
  * player.</p>
451
450
  * <p>The default is <code>LIVE</code>.</p>
451
+ * @public
452
452
  */
453
453
  PlaybackMode?: DASHPlaybackMode;
454
454
  /**
455
- * @public
456
455
  * <p>Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file
457
456
  * can be derived using attributes in the manifest itself. However, typically, MPEG-DASH
458
457
  * compatible media players do not properly handle gaps in the media timeline. Kinesis
@@ -467,10 +466,10 @@ export interface GetDASHStreamingSessionURLInput {
467
466
  * Similarly, when <a>DASHFragmentSelector</a> is
468
467
  * <code>PRODUCER_TIMESTAMP</code>, the timestamps will be the producer start
469
468
  * timestamps. </p>
469
+ * @public
470
470
  */
471
471
  DisplayFragmentTimestamp?: DASHDisplayFragmentTimestamp;
472
472
  /**
473
- * @public
474
473
  * <p>Fragments are identified in the manifest file based on their sequence number in the
475
474
  * session. If DisplayFragmentNumber is set to <code>ALWAYS</code>, the Kinesis Video
476
475
  * Streams fragment number is added to each S element in the manifest file with the
@@ -479,10 +478,10 @@ export interface GetDASHStreamingSessionURLInput {
479
478
  * custom MPEG-DASH media player is necessary to leverage these this custom
480
479
  * attribute.</p>
481
480
  * <p>The default value is <code>NEVER</code>.</p>
481
+ * @public
482
482
  */
483
483
  DisplayFragmentNumber?: DASHDisplayFragmentNumber;
484
484
  /**
485
- * @public
486
485
  * <p>The time range of the requested fragment and the source of the timestamps.</p>
487
486
  * <p>This parameter is required if <code>PlaybackMode</code> is <code>ON_DEMAND</code> or
488
487
  * <code>LIVE_REPLAY</code>. This parameter is optional if PlaybackMode is<code></code>
@@ -491,20 +490,20 @@ export interface GetDASHStreamingSessionURLInput {
491
490
  * should not be set. If <code>PlaybackMode</code> is <code>ON_DEMAND</code> or
492
491
  * <code>LIVE_REPLAY</code>, both <code>FragmentSelectorType</code> and
493
492
  * <code>TimestampRange</code> must be set.</p>
493
+ * @public
494
494
  */
495
495
  DASHFragmentSelector?: DASHFragmentSelector;
496
496
  /**
497
- * @public
498
497
  * <p>The time in seconds until the requested session expires. This value can be between 300
499
498
  * (5 minutes) and 43200 (12 hours).</p>
500
499
  * <p>When a session expires, no new calls to <code>GetDashManifest</code>,
501
500
  * <code>GetMP4InitFragment</code>, or <code>GetMP4MediaFragment</code> can be made for
502
501
  * that session.</p>
503
502
  * <p>The default is 300 (5 minutes).</p>
503
+ * @public
504
504
  */
505
505
  Expires?: number;
506
506
  /**
507
- * @public
508
507
  * <p>The maximum number of fragments that are returned in the MPEG-DASH manifest.</p>
509
508
  * <p>When the <code>PlaybackMode</code> is <code>LIVE</code>, the most recent fragments are
510
509
  * returned up to this value. When the <code>PlaybackMode</code> is <code>ON_DEMAND</code>,
@@ -520,6 +519,7 @@ export interface GetDASHStreamingSessionURLInput {
520
519
  * <p>The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on
521
520
  * streams with 1-second fragments, and more than 2 1/2 hours of video on streams with
522
521
  * 10-second fragments.</p>
522
+ * @public
523
523
  */
524
524
  MaxManifestFragmentResults?: number;
525
525
  }
@@ -528,9 +528,9 @@ export interface GetDASHStreamingSessionURLInput {
528
528
  */
529
529
  export interface GetDASHStreamingSessionURLOutput {
530
530
  /**
531
- * @public
532
531
  * <p>The URL (containing the session token) that a media player can use to retrieve the
533
532
  * MPEG-DASH manifest.</p>
533
+ * @public
534
534
  */
535
535
  DASHStreamingSessionURL?: string;
536
536
  }
@@ -584,14 +584,13 @@ export declare const HLSFragmentSelectorType: {
584
584
  */
585
585
  export type HLSFragmentSelectorType = (typeof HLSFragmentSelectorType)[keyof typeof HLSFragmentSelectorType];
586
586
  /**
587
- * @public
588
587
  * <p>The start and end of the timestamp range for the requested media.</p>
589
588
  * <p>This value should not be present if <code>PlaybackType</code> is
590
589
  * <code>LIVE</code>.</p>
590
+ * @public
591
591
  */
592
592
  export interface HLSTimestampRange {
593
593
  /**
594
- * @public
595
594
  * <p>The start of the timestamp range for the requested media.</p>
596
595
  * <p>If the <code>HLSTimestampRange</code> value is specified, the
597
596
  * <code>StartTimestamp</code> value is required. </p>
@@ -600,10 +599,10 @@ export interface HLSTimestampRange {
600
599
  * past it aren't included in the session. If <code>FragmentSelectorType</code> is
601
600
  * <code>SERVER_TIMESTAMP</code>, the <code>StartTimestamp</code> must be later than
602
601
  * the stream head. </p>
602
+ * @public
603
603
  */
604
604
  StartTimestamp?: Date;
605
605
  /**
606
- * @public
607
606
  * <p>The end of the timestamp range for the requested media. This value must be within 24
608
607
  * hours of the specified <code>StartTimestamp</code>, and it must be later than the
609
608
  * <code>StartTimestamp</code> value.</p>
@@ -619,17 +618,17 @@ export interface HLSTimestampRange {
619
618
  * <code>EndTimestamp</code> value and continue past it are included in the
620
619
  * session.</p>
621
620
  * </note>
621
+ * @public
622
622
  */
623
623
  EndTimestamp?: Date;
624
624
  }
625
625
  /**
626
- * @public
627
626
  * <p>Contains the range of timestamps for the requested media, and the source of the
628
627
  * timestamps.</p>
628
+ * @public
629
629
  */
630
630
  export interface HLSFragmentSelector {
631
631
  /**
632
- * @public
633
632
  * <p>The source of the timestamps for the requested media.</p>
634
633
  * <p>When <code>FragmentSelectorType</code> is set to <code>PRODUCER_TIMESTAMP</code> and
635
634
  * <a>GetHLSStreamingSessionURLInput$PlaybackMode</a> is
@@ -651,13 +650,14 @@ export interface HLSFragmentSelector {
651
650
  * media playlist. This means that even if fragments ingested in the past have producer
652
651
  * timestamps with values now, they are not included in the HLS media playlist.</p>
653
652
  * <p>The default is <code>SERVER_TIMESTAMP</code>.</p>
653
+ * @public
654
654
  */
655
655
  FragmentSelectorType?: HLSFragmentSelectorType;
656
656
  /**
657
- * @public
658
657
  * <p>The start and end of the timestamp range for the requested media.</p>
659
658
  * <p>This value should not be present if <code>PlaybackType</code> is
660
659
  * <code>LIVE</code>.</p>
660
+ * @public
661
661
  */
662
662
  TimestampRange?: HLSTimestampRange;
663
663
  }
@@ -679,22 +679,21 @@ export type HLSPlaybackMode = (typeof HLSPlaybackMode)[keyof typeof HLSPlaybackM
679
679
  */
680
680
  export interface GetHLSStreamingSessionURLInput {
681
681
  /**
682
- * @public
683
682
  * <p>The name of the stream for which to retrieve the HLS master playlist URL.</p>
684
683
  * <p>You must specify either the <code>StreamName</code> or the
685
684
  * <code>StreamARN</code>.</p>
685
+ * @public
686
686
  */
687
687
  StreamName?: string;
688
688
  /**
689
- * @public
690
689
  * <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master
691
690
  * playlist URL.</p>
692
691
  * <p>You must specify either the <code>StreamName</code> or the
693
692
  * <code>StreamARN</code>.</p>
693
+ * @public
694
694
  */
695
695
  StreamARN?: string;
696
696
  /**
697
- * @public
698
697
  * <p>Whether to retrieve live, live replay, or archived, on-demand data.</p>
699
698
  * <p>Features of the three types of sessions include the following:</p>
700
699
  * <ul>
@@ -755,10 +754,10 @@ export interface GetHLSStreamingSessionURLInput {
755
754
  * included in the HLS media playlist. This can lead to unexpected behavior in the media
756
755
  * player.</p>
757
756
  * <p>The default is <code>LIVE</code>.</p>
757
+ * @public
758
758
  */
759
759
  PlaybackMode?: HLSPlaybackMode;
760
760
  /**
761
- * @public
762
761
  * <p>The time range of the requested fragment and the source of the timestamps.</p>
763
762
  * <p>This parameter is required if <code>PlaybackMode</code> is <code>ON_DEMAND</code> or
764
763
  * <code>LIVE_REPLAY</code>. This parameter is optional if PlaybackMode is<code></code>
@@ -767,10 +766,10 @@ export interface GetHLSStreamingSessionURLInput {
767
766
  * should not be set. If <code>PlaybackMode</code> is <code>ON_DEMAND</code> or
768
767
  * <code>LIVE_REPLAY</code>, both <code>FragmentSelectorType</code> and
769
768
  * <code>TimestampRange</code> must be set.</p>
769
+ * @public
770
770
  */
771
771
  HLSFragmentSelector?: HLSFragmentSelector;
772
772
  /**
773
- * @public
774
773
  * <p>Specifies which format should be used for packaging the media. Specifying the
775
774
  * <code>FRAGMENTED_MP4</code> container format packages the media into MP4 fragments
776
775
  * (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging
@@ -779,10 +778,10 @@ export interface GetHLSStreamingSessionURLInput {
779
778
  * older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means
780
779
  * MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.</p>
781
780
  * <p>The default is <code>FRAGMENTED_MP4</code>.</p>
781
+ * @public
782
782
  */
783
783
  ContainerFormat?: ContainerFormat;
784
784
  /**
785
- * @public
786
785
  * <p>Specifies when flags marking discontinuities between fragments are added to the media
787
786
  * playlists.</p>
788
787
  * <p>Media players typically build a timeline of media content to play, based on the
@@ -821,10 +820,10 @@ export interface GetHLSStreamingSessionURLInput {
821
820
  * <p>The default is <code>ALWAYS</code> when <a>HLSFragmentSelector</a> is set
822
821
  * to <code>SERVER_TIMESTAMP</code>, and <code>NEVER</code> when it is set to
823
822
  * <code>PRODUCER_TIMESTAMP</code>.</p>
823
+ * @public
824
824
  */
825
825
  DiscontinuityMode?: HLSDiscontinuityMode;
826
826
  /**
827
- * @public
828
827
  * <p>Specifies when the fragment start timestamps should be included in the HLS media
829
828
  * playlist. Typically, media players report the playhead position as a time relative to
830
829
  * the start of the first fragment in the playback session. However, when the start
@@ -837,10 +836,10 @@ export interface GetHLSStreamingSessionURLInput {
837
836
  * Similarly, when <a>HLSFragmentSelector</a> is
838
837
  * <code>PRODUCER_TIMESTAMP</code>, the timestamps will be the producer start timestamps.
839
838
  * </p>
839
+ * @public
840
840
  */
841
841
  DisplayFragmentTimestamp?: HLSDisplayFragmentTimestamp;
842
842
  /**
843
- * @public
844
843
  * <p>The time in seconds until the requested session expires. This value can be between 300
845
844
  * (5 minutes) and 43200 (12 hours).</p>
846
845
  * <p>When a session expires, no new calls to <code>GetHLSMasterPlaylist</code>,
@@ -848,10 +847,10 @@ export interface GetHLSStreamingSessionURLInput {
848
847
  * <code>GetMP4MediaFragment</code>, or <code>GetTSFragment</code> can be made for that
849
848
  * session.</p>
850
849
  * <p>The default is 300 (5 minutes).</p>
850
+ * @public
851
851
  */
852
852
  Expires?: number;
853
853
  /**
854
- * @public
855
854
  * <p>The maximum number of fragments that are returned in the HLS media playlists.</p>
856
855
  * <p>When the <code>PlaybackMode</code> is <code>LIVE</code>, the most recent fragments are
857
856
  * returned up to this value. When the <code>PlaybackMode</code> is <code>ON_DEMAND</code>,
@@ -867,6 +866,7 @@ export interface GetHLSStreamingSessionURLInput {
867
866
  * <p>The maximum value of 5,000 fragments corresponds to more than 80 minutes of video on
868
867
  * streams with 1-second fragments, and more than 13 hours of video on streams with
869
868
  * 10-second fragments.</p>
869
+ * @public
870
870
  */
871
871
  MaxMediaPlaylistFragmentResults?: number;
872
872
  }
@@ -875,9 +875,9 @@ export interface GetHLSStreamingSessionURLInput {
875
875
  */
876
876
  export interface GetHLSStreamingSessionURLOutput {
877
877
  /**
878
- * @public
879
878
  * <p>The URL (containing the session token) that a media player can use to retrieve the HLS
880
879
  * master playlist.</p>
880
+ * @public
881
881
  */
882
882
  HLSStreamingSessionURL?: string;
883
883
  }
@@ -921,73 +921,73 @@ export type ImageSelectorType = (typeof ImageSelectorType)[keyof typeof ImageSel
921
921
  */
922
922
  export interface GetImagesInput {
923
923
  /**
924
- * @public
925
924
  * <p>The name of the stream from which to retrieve the images. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
925
+ * @public
926
926
  */
927
927
  StreamName?: string;
928
928
  /**
929
- * @public
930
929
  * <p>The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
930
+ * @public
931
931
  */
932
932
  StreamARN?: string;
933
933
  /**
934
- * @public
935
934
  * <p>The origin of the Server or Producer timestamps to use to generate the images.</p>
935
+ * @public
936
936
  */
937
937
  ImageSelectorType: ImageSelectorType | undefined;
938
938
  /**
939
- * @public
940
939
  * <p>The starting point from which the images should be generated. This <code>StartTimestamp</code> must be within an inclusive range of timestamps for an image to be returned.</p>
940
+ * @public
941
941
  */
942
942
  StartTimestamp: Date | undefined;
943
943
  /**
944
- * @public
945
944
  * <p>The end timestamp for the range of images to be generated. If the time range between <code>StartTimestamp</code> and <code>EndTimestamp</code> is more than 300 seconds above <code>StartTimestamp</code>, you will receive an <code>IllegalArgumentException</code>.</p>
945
+ * @public
946
946
  */
947
947
  EndTimestamp: Date | undefined;
948
948
  /**
949
- * @public
950
949
  * <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 200 ms (5 images per second). If the timestamp range is less than the sampling interval, the image from the <code>startTimestamp</code> will be returned if available.
951
950
  * </p>
951
+ * @public
952
952
  */
953
953
  SamplingInterval?: number;
954
954
  /**
955
- * @public
956
955
  * <p>The format that will be used to encode the image.</p>
956
+ * @public
957
957
  */
958
958
  Format: Format | undefined;
959
959
  /**
960
- * @public
961
960
  * <p>The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The <code>FormatConfig</code> key is the <code>JPEGQuality</code>, which indicates the JPEG quality key to be used to generate the image.
962
961
  * 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.
963
962
  * 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> key will be set to 80.</p>
963
+ * @public
964
964
  */
965
965
  FormatConfig?: Partial<Record<FormatConfigKey, string>>;
966
966
  /**
967
- * @public
968
967
  * <p>The width of the output image that is used in conjunction with the <code>HeightPixels</code> parameter. When both <code>WidthPixels</code> and <code>HeightPixels</code> parameters are provided,
969
968
  * the image will be stretched to fit the specified aspect ratio. If only the <code>WidthPixels</code> parameter is provided or if only the <code>HeightPixels</code> is provided, a <code>ValidationException</code> will be thrown.
970
969
  * If neither parameter is provided, the original image size from the stream will be returned.</p>
970
+ * @public
971
971
  */
972
972
  WidthPixels?: number;
973
973
  /**
974
- * @public
975
974
  * <p>The height of the output image that is used in conjunction with the <code>WidthPixels</code> parameter. When both <code>HeightPixels</code> and <code>WidthPixels</code> parameters are provided, the image will be stretched to fit the
976
975
  * specified aspect ratio. If only the <code>HeightPixels</code> parameter is provided, its original aspect ratio will be used to calculate the <code>WidthPixels</code> ratio. If neither parameter is provided,
977
976
  * the original image size will be returned.</p>
977
+ * @public
978
978
  */
979
979
  HeightPixels?: number;
980
980
  /**
981
- * @public
982
981
  * <p>The maximum number of images to be returned by the API. </p>
983
982
  * <note>
984
983
  * <p>The default limit is 25 images per API response. Providing a <code>MaxResults</code> greater than this value will result in a page size of 25. Any additional results will be paginated. </p>
985
984
  * </note>
985
+ * @public
986
986
  */
987
987
  MaxResults?: number;
988
988
  /**
989
- * @public
990
989
  * <p>A token that specifies where to start paginating the next set of Images. This is the <code>GetImages:NextToken</code> from a previously truncated response.</p>
990
+ * @public
991
991
  */
992
992
  NextToken?: string;
993
993
  }
@@ -1004,18 +1004,17 @@ export declare const ImageError: {
1004
1004
  */
1005
1005
  export type ImageError = (typeof ImageError)[keyof typeof ImageError];
1006
1006
  /**
1007
- * @public
1008
1007
  * <p>A structure that contains the <code>Timestamp</code>, <code>Error</code>, and <code>ImageContent</code>.</p>
1008
+ * @public
1009
1009
  */
1010
1010
  export interface Image {
1011
1011
  /**
1012
- * @public
1013
1012
  * <p>An attribute of the <code>Image</code> object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination
1014
1013
  * window.</p>
1014
+ * @public
1015
1015
  */
1016
1016
  TimeStamp?: Date;
1017
1017
  /**
1018
- * @public
1019
1018
  * <p>The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if: </p>
1020
1019
  * <ul>
1021
1020
  * <li>
@@ -1028,11 +1027,12 @@ export interface Image {
1028
1027
  * media has been ingested.</p>
1029
1028
  * </li>
1030
1029
  * </ul>
1030
+ * @public
1031
1031
  */
1032
1032
  Error?: ImageError;
1033
1033
  /**
1034
- * @public
1035
1034
  * <p>An attribute of the <code>Image</code> object that is Base64 encoded.</p>
1035
+ * @public
1036
1036
  */
1037
1037
  ImageContent?: string;
1038
1038
  }
@@ -1041,14 +1041,14 @@ export interface Image {
1041
1041
  */
1042
1042
  export interface GetImagesOutput {
1043
1043
  /**
1044
- * @public
1045
1044
  * <p>The list of images generated from the video stream. If there is no media available for the given timestamp, the <code>NO_MEDIA</code> error will be listed in the output.
1046
1045
  * If an error occurs while the image is being generated, the <code>MEDIA_ERROR</code> will be listed in the output as the cause of the missing image. </p>
1046
+ * @public
1047
1047
  */
1048
1048
  Images?: Image[];
1049
1049
  /**
1050
- * @public
1051
1050
  * <p>The encrypted token that was used in the request to get more images.</p>
1051
+ * @public
1052
1052
  */
1053
1053
  NextToken?: string;
1054
1054
  }
@@ -1057,19 +1057,19 @@ export interface GetImagesOutput {
1057
1057
  */
1058
1058
  export interface GetMediaForFragmentListInput {
1059
1059
  /**
1060
- * @public
1061
1060
  * <p>The name of the stream from which to retrieve fragment media. Specify either this parameter or the <code>StreamARN</code> parameter.</p>
1061
+ * @public
1062
1062
  */
1063
1063
  StreamName?: string;
1064
1064
  /**
1065
- * @public
1066
1065
  * <p>The Amazon Resource Name (ARN) of the stream from which to retrieve fragment media. Specify either this parameter or the <code>StreamName</code> parameter.</p>
1066
+ * @public
1067
1067
  */
1068
1068
  StreamARN?: string;
1069
1069
  /**
1070
- * @public
1071
1070
  * <p>A list of the numbers of fragments for which to retrieve media. You retrieve these
1072
1071
  * values with <a>ListFragments</a>.</p>
1072
+ * @public
1073
1073
  */
1074
1074
  Fragments: string[] | undefined;
1075
1075
  }
@@ -1078,12 +1078,11 @@ export interface GetMediaForFragmentListInput {
1078
1078
  */
1079
1079
  export interface GetMediaForFragmentListOutput {
1080
1080
  /**
1081
- * @public
1082
1081
  * <p>The content type of the requested media.</p>
1082
+ * @public
1083
1083
  */
1084
1084
  ContentType?: string;
1085
1085
  /**
1086
- * @public
1087
1086
  * <p>The payload that Kinesis Video Streams returns is a sequence of chunks from the
1088
1087
  * specified stream. For information about the chunks, see <a href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html">PutMedia</a>. The chunks that Kinesis Video Streams returns in the
1089
1088
  * <code>GetMediaForFragmentList</code> call also include the following additional
@@ -1117,6 +1116,7 @@ export interface GetMediaForFragmentListOutput {
1117
1116
  * </p>
1118
1117
  * </li>
1119
1118
  * </ul>
1119
+ * @public
1120
1120
  */
1121
1121
  Payload?: StreamingBlobTypes;
1122
1122
  }
@@ -1133,24 +1133,23 @@ export declare const FragmentSelectorType: {
1133
1133
  */
1134
1134
  export type FragmentSelectorType = (typeof FragmentSelectorType)[keyof typeof FragmentSelectorType];
1135
1135
  /**
1136
- * @public
1137
1136
  * <p>The range of timestamps for which to return fragments.</p>
1137
+ * @public
1138
1138
  */
1139
1139
  export interface TimestampRange {
1140
1140
  /**
1141
- * @public
1142
1141
  * <p>The starting timestamp in the range of timestamps for which to return
1143
1142
  * fragments.</p>
1143
+ * @public
1144
1144
  */
1145
1145
  StartTimestamp: Date | undefined;
1146
1146
  /**
1147
- * @public
1148
1147
  * <p>The ending timestamp in the range of timestamps for which to return fragments.</p>
1148
+ * @public
1149
1149
  */
1150
1150
  EndTimestamp: Date | undefined;
1151
1151
  }
1152
1152
  /**
1153
- * @public
1154
1153
  * <p>Describes the timestamp range and timestamp origin of a range of fragments.</p>
1155
1154
  * <p>Only fragments with a start timestamp greater than or equal to the given start time
1156
1155
  * and less than or equal to the end time are returned. For example, if a stream contains
@@ -1171,16 +1170,17 @@ export interface TimestampRange {
1171
1170
  * </ul>
1172
1171
  * <p> A fragment selector range with a start time of 00:00:01 and end time of 00:00:04
1173
1172
  * would return the fragments with start times of 00:00:02 and 00:00:04. </p>
1173
+ * @public
1174
1174
  */
1175
1175
  export interface FragmentSelector {
1176
1176
  /**
1177
- * @public
1178
1177
  * <p>The origin of the timestamps to use (Server or Producer).</p>
1178
+ * @public
1179
1179
  */
1180
1180
  FragmentSelectorType: FragmentSelectorType | undefined;
1181
1181
  /**
1182
- * @public
1183
1182
  * <p>The range of timestamps to return.</p>
1183
+ * @public
1184
1184
  */
1185
1185
  TimestampRange: TimestampRange | undefined;
1186
1186
  }
@@ -1189,68 +1189,68 @@ export interface FragmentSelector {
1189
1189
  */
1190
1190
  export interface ListFragmentsInput {
1191
1191
  /**
1192
- * @public
1193
1192
  * <p>The name of the stream from which to retrieve a fragment list. Specify either this parameter or the <code>StreamARN</code> parameter.</p>
1193
+ * @public
1194
1194
  */
1195
1195
  StreamName?: string;
1196
1196
  /**
1197
- * @public
1198
1197
  * <p>The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the <code>StreamName</code> parameter.</p>
1198
+ * @public
1199
1199
  */
1200
1200
  StreamARN?: string;
1201
1201
  /**
1202
- * @public
1203
1202
  * <p>The total number of fragments to return. If the total number of fragments available is
1204
1203
  * more than the value specified in <code>max-results</code>, then a <a>ListFragmentsOutput$NextToken</a> is provided in the output that you can use
1205
1204
  * to resume pagination.</p>
1205
+ * @public
1206
1206
  */
1207
1207
  MaxResults?: number;
1208
1208
  /**
1209
- * @public
1210
1209
  * <p>A token to specify where to start paginating. This is the <a>ListFragmentsOutput$NextToken</a> from a previously truncated
1211
1210
  * response.</p>
1211
+ * @public
1212
1212
  */
1213
1213
  NextToken?: string;
1214
1214
  /**
1215
- * @public
1216
1215
  * <p>Describes the timestamp range and timestamp origin for the range of fragments to
1217
1216
  * return.</p>
1218
1217
  * <note>
1219
1218
  * <p>This is only required when the <code>NextToken</code> isn't passed in the API.</p>
1220
1219
  * </note>
1220
+ * @public
1221
1221
  */
1222
1222
  FragmentSelector?: FragmentSelector;
1223
1223
  }
1224
1224
  /**
1225
- * @public
1226
1225
  * <p>Represents a segment of video or other time-delimited data.</p>
1226
+ * @public
1227
1227
  */
1228
1228
  export interface Fragment {
1229
1229
  /**
1230
- * @public
1231
1230
  * <p>The unique identifier of the fragment. This value monotonically increases based on the
1232
1231
  * ingestion order.</p>
1232
+ * @public
1233
1233
  */
1234
1234
  FragmentNumber?: string;
1235
1235
  /**
1236
- * @public
1237
1236
  * <p>The total fragment size, including information about the fragment and contained media
1238
1237
  * data.</p>
1238
+ * @public
1239
1239
  */
1240
1240
  FragmentSizeInBytes?: number;
1241
1241
  /**
1242
- * @public
1243
1242
  * <p>The timestamp from the producer corresponding to the fragment.</p>
1243
+ * @public
1244
1244
  */
1245
1245
  ProducerTimestamp?: Date;
1246
1246
  /**
1247
- * @public
1248
1247
  * <p>The timestamp from the Amazon Web Services server corresponding to the fragment.</p>
1248
+ * @public
1249
1249
  */
1250
1250
  ServerTimestamp?: Date;
1251
1251
  /**
1252
- * @public
1253
1252
  * <p>The playback duration or other time value associated with the fragment.</p>
1253
+ * @public
1254
1254
  */
1255
1255
  FragmentLengthInMilliseconds?: number;
1256
1256
  }
@@ -1259,16 +1259,16 @@ export interface Fragment {
1259
1259
  */
1260
1260
  export interface ListFragmentsOutput {
1261
1261
  /**
1262
- * @public
1263
1262
  * <p>A list of archived <a>Fragment</a> objects from the stream that meet the
1264
1263
  * selector criteria. Results are in no specific order, even across pages.</p>
1264
+ * @public
1265
1265
  */
1266
1266
  Fragments?: Fragment[];
1267
1267
  /**
1268
- * @public
1269
1268
  * <p>If the returned list is truncated, the operation returns this token to use to retrieve
1270
1269
  * the next page of results. This value is <code>null</code> when there are no more results
1271
1270
  * to return.</p>
1271
+ * @public
1272
1272
  */
1273
1273
  NextToken?: string;
1274
1274
  }
@@ -38,6 +38,7 @@ export interface KinesisVideoArchivedMedia {
38
38
  options: __HttpHandlerOptions,
39
39
  cb: (err: any, data?: GetClipCommandOutput) => void
40
40
  ): void;
41
+ getDASHStreamingSessionURL(): Promise<GetDASHStreamingSessionURLCommandOutput>;
41
42
  getDASHStreamingSessionURL(
42
43
  args: GetDASHStreamingSessionURLCommandInput,
43
44
  options?: __HttpHandlerOptions
@@ -51,6 +52,7 @@ export interface KinesisVideoArchivedMedia {
51
52
  options: __HttpHandlerOptions,
52
53
  cb: (err: any, data?: GetDASHStreamingSessionURLCommandOutput) => void
53
54
  ): void;
55
+ getHLSStreamingSessionURL(): Promise<GetHLSStreamingSessionURLCommandOutput>;
54
56
  getHLSStreamingSessionURL(
55
57
  args: GetHLSStreamingSessionURLCommandInput,
56
58
  options?: __HttpHandlerOptions
@@ -90,6 +92,7 @@ export interface KinesisVideoArchivedMedia {
90
92
  options: __HttpHandlerOptions,
91
93
  cb: (err: any, data?: GetMediaForFragmentListCommandOutput) => void
92
94
  ): void;
95
+ listFragments(): Promise<ListFragmentsCommandOutput>;
93
96
  listFragments(
94
97
  args: ListFragmentsCommandInput,
95
98
  options?: __HttpHandlerOptions
@@ -24,6 +24,13 @@ declare const GetClipCommand_base: {
24
24
  ServiceInputTypes,
25
25
  ServiceOutputTypes
26
26
  >;
27
+ new (__0_0: GetClipCommandInput): import("@smithy/smithy-client").CommandImpl<
28
+ GetClipCommandInput,
29
+ GetClipCommandOutput,
30
+ KinesisVideoArchivedMediaClientResolvedConfig,
31
+ ServiceInputTypes,
32
+ ServiceOutputTypes
33
+ >;
27
34
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
35
  };
29
36
  export declare class GetClipCommand extends GetClipCommand_base {}
@@ -25,6 +25,15 @@ declare const GetDASHStreamingSessionURLCommand_base: {
25
25
  ServiceInputTypes,
26
26
  ServiceOutputTypes
27
27
  >;
28
+ new (
29
+ ...[input]: [] | [GetDASHStreamingSessionURLCommandInput]
30
+ ): import("@smithy/smithy-client").CommandImpl<
31
+ GetDASHStreamingSessionURLCommandInput,
32
+ GetDASHStreamingSessionURLCommandOutput,
33
+ KinesisVideoArchivedMediaClientResolvedConfig,
34
+ ServiceInputTypes,
35
+ ServiceOutputTypes
36
+ >;
28
37
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
29
38
  };
30
39
  export declare class GetDASHStreamingSessionURLCommand extends GetDASHStreamingSessionURLCommand_base {}
@@ -25,6 +25,15 @@ declare const GetHLSStreamingSessionURLCommand_base: {
25
25
  ServiceInputTypes,
26
26
  ServiceOutputTypes
27
27
  >;
28
+ new (
29
+ ...[input]: [] | [GetHLSStreamingSessionURLCommandInput]
30
+ ): import("@smithy/smithy-client").CommandImpl<
31
+ GetHLSStreamingSessionURLCommandInput,
32
+ GetHLSStreamingSessionURLCommandOutput,
33
+ KinesisVideoArchivedMediaClientResolvedConfig,
34
+ ServiceInputTypes,
35
+ ServiceOutputTypes
36
+ >;
28
37
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
29
38
  };
30
39
  export declare class GetHLSStreamingSessionURLCommand extends GetHLSStreamingSessionURLCommand_base {}
@@ -21,6 +21,15 @@ declare const GetImagesCommand_base: {
21
21
  ServiceInputTypes,
22
22
  ServiceOutputTypes
23
23
  >;
24
+ new (
25
+ __0_0: GetImagesCommandInput
26
+ ): import("@smithy/smithy-client").CommandImpl<
27
+ GetImagesCommandInput,
28
+ GetImagesCommandOutput,
29
+ KinesisVideoArchivedMediaClientResolvedConfig,
30
+ ServiceInputTypes,
31
+ ServiceOutputTypes
32
+ >;
24
33
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
25
34
  };
26
35
  export declare class GetImagesCommand extends GetImagesCommand_base {}
@@ -33,6 +33,15 @@ declare const GetMediaForFragmentListCommand_base: {
33
33
  ServiceInputTypes,
34
34
  ServiceOutputTypes
35
35
  >;
36
+ new (
37
+ __0_0: GetMediaForFragmentListCommandInput
38
+ ): import("@smithy/smithy-client").CommandImpl<
39
+ GetMediaForFragmentListCommandInput,
40
+ GetMediaForFragmentListCommandOutput,
41
+ KinesisVideoArchivedMediaClientResolvedConfig,
42
+ ServiceInputTypes,
43
+ ServiceOutputTypes
44
+ >;
36
45
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
37
46
  };
38
47
  export declare class GetMediaForFragmentListCommand extends GetMediaForFragmentListCommand_base {}
@@ -21,6 +21,15 @@ declare const ListFragmentsCommand_base: {
21
21
  ServiceInputTypes,
22
22
  ServiceOutputTypes
23
23
  >;
24
+ new (
25
+ ...[input]: [] | [ListFragmentsCommandInput]
26
+ ): import("@smithy/smithy-client").CommandImpl<
27
+ ListFragmentsCommandInput,
28
+ ListFragmentsCommandOutput,
29
+ KinesisVideoArchivedMediaClientResolvedConfig,
30
+ ServiceInputTypes,
31
+ ServiceOutputTypes
32
+ >;
24
33
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
25
34
  };
26
35
  export declare class ListFragmentsCommand extends ListFragmentsCommand_base {}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kinesis-video-archived-media",
3
3
  "description": "AWS SDK for JavaScript Kinesis Video Archived Media Client for Node.js, Browser and React Native",
4
- "version": "3.533.0",
4
+ "version": "3.535.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-kinesis-video-archived-media",
@@ -20,48 +20,48 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.533.0",
24
- "@aws-sdk/core": "3.533.0",
25
- "@aws-sdk/credential-provider-node": "3.533.0",
26
- "@aws-sdk/middleware-host-header": "3.533.0",
27
- "@aws-sdk/middleware-logger": "3.533.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.533.0",
29
- "@aws-sdk/middleware-user-agent": "3.533.0",
30
- "@aws-sdk/region-config-resolver": "3.533.0",
31
- "@aws-sdk/types": "3.533.0",
32
- "@aws-sdk/util-endpoints": "3.533.0",
33
- "@aws-sdk/util-user-agent-browser": "3.533.0",
34
- "@aws-sdk/util-user-agent-node": "3.533.0",
35
- "@smithy/config-resolver": "^2.1.5",
36
- "@smithy/core": "^1.3.8",
37
- "@smithy/fetch-http-handler": "^2.4.5",
38
- "@smithy/hash-node": "^2.1.4",
39
- "@smithy/invalid-dependency": "^2.1.4",
40
- "@smithy/middleware-content-length": "^2.1.4",
41
- "@smithy/middleware-endpoint": "^2.4.6",
42
- "@smithy/middleware-retry": "^2.1.7",
43
- "@smithy/middleware-serde": "^2.2.1",
44
- "@smithy/middleware-stack": "^2.1.4",
45
- "@smithy/node-config-provider": "^2.2.5",
46
- "@smithy/node-http-handler": "^2.4.3",
47
- "@smithy/protocol-http": "^3.2.2",
48
- "@smithy/smithy-client": "^2.4.5",
49
- "@smithy/types": "^2.11.0",
50
- "@smithy/url-parser": "^2.1.4",
51
- "@smithy/util-base64": "^2.2.1",
52
- "@smithy/util-body-length-browser": "^2.1.1",
53
- "@smithy/util-body-length-node": "^2.2.2",
54
- "@smithy/util-defaults-mode-browser": "^2.1.7",
55
- "@smithy/util-defaults-mode-node": "^2.2.7",
56
- "@smithy/util-endpoints": "^1.1.5",
57
- "@smithy/util-middleware": "^2.1.4",
58
- "@smithy/util-retry": "^2.1.4",
59
- "@smithy/util-stream": "^2.1.5",
60
- "@smithy/util-utf8": "^2.2.0",
61
- "tslib": "^2.5.0"
23
+ "@aws-sdk/client-sts": "3.535.0",
24
+ "@aws-sdk/core": "3.535.0",
25
+ "@aws-sdk/credential-provider-node": "3.535.0",
26
+ "@aws-sdk/middleware-host-header": "3.535.0",
27
+ "@aws-sdk/middleware-logger": "3.535.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.535.0",
29
+ "@aws-sdk/middleware-user-agent": "3.535.0",
30
+ "@aws-sdk/region-config-resolver": "3.535.0",
31
+ "@aws-sdk/types": "3.535.0",
32
+ "@aws-sdk/util-endpoints": "3.535.0",
33
+ "@aws-sdk/util-user-agent-browser": "3.535.0",
34
+ "@aws-sdk/util-user-agent-node": "3.535.0",
35
+ "@smithy/config-resolver": "^2.2.0",
36
+ "@smithy/core": "^1.4.0",
37
+ "@smithy/fetch-http-handler": "^2.5.0",
38
+ "@smithy/hash-node": "^2.2.0",
39
+ "@smithy/invalid-dependency": "^2.2.0",
40
+ "@smithy/middleware-content-length": "^2.2.0",
41
+ "@smithy/middleware-endpoint": "^2.5.0",
42
+ "@smithy/middleware-retry": "^2.2.0",
43
+ "@smithy/middleware-serde": "^2.3.0",
44
+ "@smithy/middleware-stack": "^2.2.0",
45
+ "@smithy/node-config-provider": "^2.3.0",
46
+ "@smithy/node-http-handler": "^2.5.0",
47
+ "@smithy/protocol-http": "^3.3.0",
48
+ "@smithy/smithy-client": "^2.5.0",
49
+ "@smithy/types": "^2.12.0",
50
+ "@smithy/url-parser": "^2.2.0",
51
+ "@smithy/util-base64": "^2.3.0",
52
+ "@smithy/util-body-length-browser": "^2.2.0",
53
+ "@smithy/util-body-length-node": "^2.3.0",
54
+ "@smithy/util-defaults-mode-browser": "^2.2.0",
55
+ "@smithy/util-defaults-mode-node": "^2.3.0",
56
+ "@smithy/util-endpoints": "^1.2.0",
57
+ "@smithy/util-middleware": "^2.2.0",
58
+ "@smithy/util-retry": "^2.2.0",
59
+ "@smithy/util-stream": "^2.2.0",
60
+ "@smithy/util-utf8": "^2.3.0",
61
+ "tslib": "^2.6.2"
62
62
  },
63
63
  "devDependencies": {
64
- "@smithy/service-client-documentation-generator": "^2.1.1",
64
+ "@smithy/service-client-documentation-generator": "^2.2.0",
65
65
  "@tsconfig/node14": "1.0.3",
66
66
  "@types/node": "^14.14.31",
67
67
  "concurrently": "7.0.0",