@aws-sdk/client-kinesis-video-signaling 3.296.0 → 3.297.0

package/dist-types/KinesisVideoSignaling.d.ts

@@ -3,12 +3,14 @@ import { GetIceServerConfigCommandInput, GetIceServerConfigCommandOutput } from
 import { SendAlexaOfferToMasterCommandInput, SendAlexaOfferToMasterCommandOutput } from "./commands/SendAlexaOfferToMasterCommand";
 import { KinesisVideoSignalingClient } from "./KinesisVideoSignalingClient";
 /**
+ * @public
  * <p>Kinesis Video Streams Signaling Service is a intermediate service that establishes a
  *             communication channel for discovering peers, transmitting offers and answers in order to
  *             establish peer-to-peer connection in webRTC technology.</p>
  */
 export declare class KinesisVideoSignaling extends KinesisVideoSignalingClient {
     /**
+     * @public
      * <p>Gets the Interactive Connectivity Establishment (ICE) server configuration
      *             information, including URIs, username, and password which can be used to configure the
      *             WebRTC connection. The ICE component uses this configuration information to setup the
@@ -28,6 +30,7 @@ export declare class KinesisVideoSignaling extends KinesisVideoSignalingClient {
     getIceServerConfig(args: GetIceServerConfigCommandInput, cb: (err: any, data?: GetIceServerConfigCommandOutput) => void): void;
     getIceServerConfig(args: GetIceServerConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIceServerConfigCommandOutput) => void): void;
     /**
+     * @public
      * <p>This API allows you to connect WebRTC-enabled devices with Alexa display devices. When
      *             invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer.
      *             The offer is delivered as soon as the master is connected to the specified signaling

package/dist-types/KinesisVideoSignalingClient.d.ts

@@ -10,15 +10,24 @@ import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as
 import { GetIceServerConfigCommandInput, GetIceServerConfigCommandOutput } from "./commands/GetIceServerConfigCommand";
 import { SendAlexaOfferToMasterCommandInput, SendAlexaOfferToMasterCommandOutput } from "./commands/SendAlexaOfferToMasterCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = GetIceServerConfigCommandInput | SendAlexaOfferToMasterCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = GetIceServerConfigCommandOutput | SendAlexaOfferToMasterCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -108,23 +117,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type KinesisVideoSignalingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of KinesisVideoSignalingClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of KinesisVideoSignalingClient class constructor that set the region, credentials and other options.
  */
 export interface KinesisVideoSignalingClientConfig extends KinesisVideoSignalingClientConfigType {
 }
+/**
+ * @public
+ */
 type KinesisVideoSignalingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of KinesisVideoSignalingClient class. This is resolved and normalized from the {@link KinesisVideoSignalingClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of KinesisVideoSignalingClient class. This is resolved and normalized from the {@link KinesisVideoSignalingClientConfig | constructor configuration interface}.
  */
 export interface KinesisVideoSignalingClientResolvedConfig extends KinesisVideoSignalingClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>Kinesis Video Streams Signaling Service is a intermediate service that establishes a
  *             communication channel for discovering peers, transmitting offers and answers in order to
  *             establish peer-to-peer connection in webRTC technology.</p>

package/dist-types/commands/GetIceServerConfigCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KinesisVideoSignalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoSignalingClient";
 import { GetIceServerConfigRequest, GetIceServerConfigResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GetIceServerConfigCommand}.
  */
 export interface GetIceServerConfigCommandInput extends GetIceServerConfigRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetIceServerConfigCommand}.
  */
 export interface GetIceServerConfigCommandOutput extends GetIceServerConfigResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets the Interactive Connectivity Establishment (ICE) server configuration
  *             information, including URIs, username, and password which can be used to configure the
  *             WebRTC connection. The ICE component uses this configuration information to setup the
@@ -38,6 +43,8 @@ export interface GetIceServerConfigCommandOutput extends GetIceServerConfigRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param GetIceServerConfigCommandInput - {@link GetIceServerConfigCommandInput}
+ * @returns {@link GetIceServerConfigCommandOutput}
  * @see {@link GetIceServerConfigCommandInput} for command's `input` shape.
  * @see {@link GetIceServerConfigCommandOutput} for command's `response` shape.
  * @see {@link KinesisVideoSignalingClientResolvedConfig | config} for KinesisVideoSignalingClient's `config` shape.
@@ -68,11 +75,20 @@ export interface GetIceServerConfigCommandOutput extends GetIceServerConfigRespo
 export declare class GetIceServerConfigCommand extends $Command<GetIceServerConfigCommandInput, GetIceServerConfigCommandOutput, KinesisVideoSignalingClientResolvedConfig> {
     readonly input: GetIceServerConfigCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetIceServerConfigCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisVideoSignalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetIceServerConfigCommandInput, GetIceServerConfigCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/SendAlexaOfferToMasterCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KinesisVideoSignalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoSignalingClient";
 import { SendAlexaOfferToMasterRequest, SendAlexaOfferToMasterResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SendAlexaOfferToMasterCommand}.
  */
 export interface SendAlexaOfferToMasterCommandInput extends SendAlexaOfferToMasterRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SendAlexaOfferToMasterCommand}.
  */
 export interface SendAlexaOfferToMasterCommandOutput extends SendAlexaOfferToMasterResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>This API allows you to connect WebRTC-enabled devices with Alexa display devices. When
  *             invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer.
  *             The offer is delivered as soon as the master is connected to the specified signaling
@@ -30,6 +35,8 @@ export interface SendAlexaOfferToMasterCommandOutput extends SendAlexaOfferToMas
  * const response = await client.send(command);
  * ```
  *
+ * @param SendAlexaOfferToMasterCommandInput - {@link SendAlexaOfferToMasterCommandInput}
+ * @returns {@link SendAlexaOfferToMasterCommandOutput}
  * @see {@link SendAlexaOfferToMasterCommandInput} for command's `input` shape.
  * @see {@link SendAlexaOfferToMasterCommandOutput} for command's `response` shape.
  * @see {@link KinesisVideoSignalingClientResolvedConfig | config} for KinesisVideoSignalingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface SendAlexaOfferToMasterCommandOutput extends SendAlexaOfferToMas
 export declare class SendAlexaOfferToMasterCommand extends $Command<SendAlexaOfferToMasterCommandInput, SendAlexaOfferToMasterCommandOutput, KinesisVideoSignalingClientResolvedConfig> {
     readonly input: SendAlexaOfferToMasterCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SendAlexaOfferToMasterCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KinesisVideoSignalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendAlexaOfferToMasterCommandInput, SendAlexaOfferToMasterCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/KinesisVideoSignalingServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from KinesisVideoSignaling service.
  */
 export declare class KinesisVideoSignalingServiceException extends __ServiceException {

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { KinesisVideoSignalingServiceException as __BaseException } from "./KinesisVideoSignalingServiceException";
 /**
+ * @public
  * <p>Your request was throttled because you have exceeded the limit of allowed client
  *             calls. Try making the call later.</p>
  */
@@ -13,9 +14,15 @@ export declare class ClientLimitExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ClientLimitExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum Service {
     TURN = "TURN"
 }
+/**
+ * @public
+ */
 export interface GetIceServerConfigRequest {
     /**
      * <p>The ARN of the signaling channel to be used for the peer-to-peer connection between
@@ -37,6 +44,7 @@ export interface GetIceServerConfigRequest {
     Username?: string;
 }
 /**
+ * @public
  * <p>A structure for the ICE server connection data.</p>
  */
 export interface IceServer {
@@ -59,6 +67,9 @@ export interface IceServer {
      */
     Ttl?: number;
 }
+/**
+ * @public
+ */
 export interface GetIceServerConfigResponse {
     /**
      * <p>The list of ICE server information objects.</p>
@@ -66,6 +77,7 @@ export interface GetIceServerConfigResponse {
     IceServerList?: IceServer[];
 }
 /**
+ * @public
  * <p>The value for this input parameter is invalid.</p>
  */
 export declare class InvalidArgumentException extends __BaseException {
@@ -78,6 +90,7 @@ export declare class InvalidArgumentException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified client is invalid.</p>
  */
 export declare class InvalidClientException extends __BaseException {
@@ -89,6 +102,7 @@ export declare class InvalidClientException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidClientException, __BaseException>);
 }
 /**
+ * @public
  * <p>The caller is not authorized to perform this operation.</p>
  */
 export declare class NotAuthorizedException extends __BaseException {
@@ -101,6 +115,7 @@ export declare class NotAuthorizedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified resource is not found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -113,6 +128,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>If the client session is expired. Once the client is connected, the session is valid
  *             for 45 minutes. Client should reconnect to the channel to continue sending/receiving
  *             messages.</p>
@@ -125,6 +141,9 @@ export declare class SessionExpiredException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<SessionExpiredException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface SendAlexaOfferToMasterRequest {
     /**
      * <p>The ARN of the signaling channel by which Alexa and the master peer
@@ -140,6 +159,9 @@ export interface SendAlexaOfferToMasterRequest {
      */
     MessagePayload: string | undefined;
 }
+/**
+ * @public
+ */
 export interface SendAlexaOfferToMasterResponse {
     /**
      * <p>The base64-encoded SDP answer content.</p>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-kinesis-video-signaling",
   "description": "AWS SDK for JavaScript Kinesis Video Signaling Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",