@aws-sdk/client-kinesis-video-media 3.295.0 → 3.297.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 (6) hide show
  1. package/dist-types/KinesisVideoMedia.d.ts +2 -0
  2. package/dist-types/KinesisVideoMediaClient.d.ts +24 -4
  3. package/dist-types/commands/GetMediaCommand.d.ts +16 -0
  4. package/dist-types/models/KinesisVideoMediaServiceException.d.ts +2 -0
  5. package/dist-types/models/models_0.d.ts +16 -0
  6. package/package.json +31 -31
package/dist-types/KinesisVideoMedia.d.ts CHANGED
@@ -2,10 +2,12 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
2
2
  import { GetMediaCommandInput, GetMediaCommandOutput } from "./commands/GetMediaCommand";
3
3
  import { KinesisVideoMediaClient } from "./KinesisVideoMediaClient";
4
4
  /**
5
+ * @public
5
6
  * <p></p>
6
7
  */
7
8
  export declare class KinesisVideoMedia extends KinesisVideoMediaClient {
8
9
  /**
10
+ * @public
9
11
  * <p> Use this API to retrieve media content from a Kinesis video stream. In the request,
10
12
  * you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk.
11
13
  * Kinesis Video Streams then returns a stream of chunks in order by fragment number.</p>
package/dist-types/KinesisVideoMediaClient.d.ts CHANGED
@@ -9,15 +9,24 @@ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration
9
9
  import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, SdkStreamMixinInjector as __SdkStreamMixinInjector, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
10
10
  import { GetMediaCommandInput, GetMediaCommandOutput } from "./commands/GetMediaCommand";
11
11
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
12
+ /**
13
+ * @public
14
+ */
12
15
  export type ServiceInputTypes = GetMediaCommandInput;
16
+ /**
17
+ * @public
18
+ */
13
19
  export type ServiceOutputTypes = GetMediaCommandOutput;
20
+ /**
21
+ * @public
22
+ */
14
23
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
15
24
  /**
16
25
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
17
26
  */
18
27
  requestHandler?: __HttpHandler;
19
28
  /**
20
- * A constructor for a class implementing the {@link __Checksum} interface
29
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
21
30
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
22
31
  * @internal
23
32
  */
@@ -107,7 +116,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
107
116
  */
108
117
  logger?: __Logger;
109
118
  /**
110
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
119
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
111
120
  */
112
121
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
113
122
  /**
@@ -116,19 +125,30 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
116
125
  */
117
126
  sdkStreamMixin?: __SdkStreamMixinInjector;
118
127
  }
128
+ /**
129
+ * @public
130
+ */
119
131
  type KinesisVideoMediaClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
120
132
  /**
121
- * The configuration interface of KinesisVideoMediaClient class constructor that set the region, credentials and other options.
133
+ * @public
134
+ *
135
+ * The configuration interface of KinesisVideoMediaClient class constructor that set the region, credentials and other options.
122
136
  */
123
137
  export interface KinesisVideoMediaClientConfig extends KinesisVideoMediaClientConfigType {
124
138
  }
139
+ /**
140
+ * @public
141
+ */
125
142
  type KinesisVideoMediaClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
126
143
  /**
127
- * The resolved configuration interface of KinesisVideoMediaClient class. This is resolved and normalized from the {@link KinesisVideoMediaClientConfig | constructor configuration interface}.
144
+ * @public
145
+ *
146
+ * The resolved configuration interface of KinesisVideoMediaClient class. This is resolved and normalized from the {@link KinesisVideoMediaClientConfig | constructor configuration interface}.
128
147
  */
129
148
  export interface KinesisVideoMediaClientResolvedConfig extends KinesisVideoMediaClientResolvedConfigType {
130
149
  }
131
150
  /**
151
+ * @public
132
152
  * <p></p>
133
153
  */
134
154
  export declare class KinesisVideoMediaClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, KinesisVideoMediaClientResolvedConfig> {
package/dist-types/commands/GetMediaCommand.d.ts CHANGED
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KinesisVideoMediaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoMediaClient";
5
5
  import { GetMediaInput, GetMediaOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetMediaCommand}.
8
10
  */
9
11
  export interface GetMediaCommandInput extends GetMediaInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetMediaCommand}.
13
17
  */
14
18
  export interface GetMediaCommandOutput extends __WithSdkStreamMixin<GetMediaOutput, "Payload">, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Use this API to retrieve media content from a Kinesis video stream. In the request,
18
23
  * you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk.
19
24
  * Kinesis Video Streams then returns a stream of chunks in order by fragment number.</p>
@@ -70,6 +75,8 @@ export interface GetMediaCommandOutput extends __WithSdkStreamMixin<GetMediaOutp
70
75
  * const response = await client.send(command);
71
76
  * ```
72
77
  *
78
+ * @param GetMediaCommandInput - {@link GetMediaCommandInput}
79
+ * @returns {@link GetMediaCommandOutput}
73
80
  * @see {@link GetMediaCommandInput} for command's `input` shape.
74
81
  * @see {@link GetMediaCommandOutput} for command's `response` shape.
75
82
  * @see {@link KinesisVideoMediaClientResolvedConfig | config} for KinesisVideoMediaClient's `config` shape.
@@ -103,11 +110,20 @@ export interface GetMediaCommandOutput extends __WithSdkStreamMixin<GetMediaOutp
103
110
  export declare class GetMediaCommand extends $Command<GetMediaCommandInput, GetMediaCommandOutput, KinesisVideoMediaClientResolvedConfig> {
104
111
  readonly input: GetMediaCommandInput;
105
112
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
113
+ /**
114
+ * @public
115
+ */
106
116
  constructor(input: GetMediaCommandInput);
107
117
  /**
108
118
  * @internal
109
119
  */
110
120
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisVideoMediaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMediaCommandInput, GetMediaCommandOutput>;
121
+ /**
122
+ * @internal
123
+ */
111
124
  private serialize;
125
+ /**
126
+ * @internal
127
+ */
112
128
  private deserialize;
113
129
  }
package/dist-types/models/KinesisVideoMediaServiceException.d.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from KinesisVideoMedia service.
4
6
  */
5
7
  export declare class KinesisVideoMediaServiceException extends __ServiceException {
package/dist-types/models/models_0.d.ts CHANGED
@@ -3,6 +3,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
3
3
  import { Readable } from "stream";
4
4
  import { KinesisVideoMediaServiceException as __BaseException } from "./KinesisVideoMediaServiceException";
5
5
  /**
6
+ * @public
6
7
  * <p>Kinesis Video Streams has throttled the request because you have exceeded the limit of
7
8
  * allowed client calls. Try making the call later.</p>
8
9
  */
@@ -16,6 +17,7 @@ export declare class ClientLimitExceededException extends __BaseException {
16
17
  constructor(opts: __ExceptionOptionType<ClientLimitExceededException, __BaseException>);
17
18
  }
18
19
  /**
20
+ * @public
19
21
  * <p>Kinesis Video Streams has throttled the request because you have exceeded the limit of
20
22
  * allowed client connections.</p>
21
23
  */
@@ -28,6 +30,9 @@ export declare class ConnectionLimitExceededException extends __BaseException {
28
30
  */
29
31
  constructor(opts: __ExceptionOptionType<ConnectionLimitExceededException, __BaseException>);
30
32
  }
33
+ /**
34
+ * @public
35
+ */
31
36
  export declare enum StartSelectorType {
32
37
  CONTINUATION_TOKEN = "CONTINUATION_TOKEN",
33
38
  EARLIEST = "EARLIEST",
@@ -37,6 +42,7 @@ export declare enum StartSelectorType {
37
42
  SERVER_TIMESTAMP = "SERVER_TIMESTAMP"
38
43
  }
39
44
  /**
45
+ * @public
40
46
  * <p>Identifies the chunk on the Kinesis video stream where you want the
41
47
  * <code>GetMedia</code> API to start returning media data. You have the following options to
42
48
  * identify the starting chunk: </p>
@@ -106,6 +112,9 @@ export interface StartSelector {
106
112
  */
107
113
  ContinuationToken?: string;
108
114
  }
115
+ /**
116
+ * @public
117
+ */
109
118
  export interface GetMediaInput {
110
119
  /**
111
120
  * <p>The Kinesis video stream name from where you want to get the media content. If you
@@ -123,6 +132,9 @@ export interface GetMediaInput {
123
132
  */
124
133
  StartSelector: StartSelector | undefined;
125
134
  }
135
+ /**
136
+ * @public
137
+ */
126
138
  export interface GetMediaOutput {
127
139
  /**
128
140
  * <p>The content type of the requested media.</p>
@@ -201,6 +213,7 @@ export interface GetMediaOutput {
201
213
  Payload?: Readable | ReadableStream | Blob;
202
214
  }
203
215
  /**
216
+ * @public
204
217
  * <p>The value for this input parameter is invalid.</p>
205
218
  */
206
219
  export declare class InvalidArgumentException extends __BaseException {
@@ -213,6 +226,7 @@ export declare class InvalidArgumentException extends __BaseException {
213
226
  constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
214
227
  }
215
228
  /**
229
+ * @public
216
230
  * <p> Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving
217
231
  * such an exception, the user must call <code>GetDataEndpoint</code> with
218
232
  * <code>AccessMode</code> set to "READ" and use the endpoint Kinesis Video returns in the next
@@ -228,6 +242,7 @@ export declare class InvalidEndpointException extends __BaseException {
228
242
  constructor(opts: __ExceptionOptionType<InvalidEndpointException, __BaseException>);
229
243
  }
230
244
  /**
245
+ * @public
231
246
  * <p>Status Code: 403, The caller is not authorized to perform an operation on the given
232
247
  * stream, or the token has expired.</p>
233
248
  */
@@ -241,6 +256,7 @@ export declare class NotAuthorizedException extends __BaseException {
241
256
  constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
242
257
  }
243
258
  /**
259
+ * @public
244
260
  * <p>Status Code: 404, The stream with the given name does not exist.</p>
245
261
  */
246
262
  export declare class ResourceNotFoundException extends __BaseException {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kinesis-video-media",
3
3
  "description": "AWS SDK for JavaScript Kinesis Video Media Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
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.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-stream-browser": "3.295.0",
53
- "@aws-sdk/util-stream-node": "3.295.0",
54
- "@aws-sdk/util-user-agent-browser": "3.295.0",
55
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-stream-browser": "3.296.0",
53
+ "@aws-sdk/util-stream-node": "3.296.0",
54
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
55
+ "@aws-sdk/util-user-agent-node": "3.296.0",
56
56
  "@aws-sdk/util-utf8": "3.295.0",
57
57
  "tslib": "^2.5.0"
58
58
  },