@aws-sdk/client-apigatewaymanagementapi 3.295.0 → 3.297.0

package/dist-types/ApiGatewayManagementApi.d.ts

@@ -4,22 +4,26 @@ import { DeleteConnectionCommandInput, DeleteConnectionCommandOutput } from "./c
 import { GetConnectionCommandInput, GetConnectionCommandOutput } from "./commands/GetConnectionCommand";
 import { PostToConnectionCommandInput, PostToConnectionCommandOutput } from "./commands/PostToConnectionCommand";
 /**
- * <p>The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.</p>
+ * @public
+ * <p>The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://\{api-id\}.execute-api.\{region\}.amazonaws.com/\{stage\}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.</p>
  */
 export declare class ApiGatewayManagementApi extends ApiGatewayManagementApiClient {
     /**
+     * @public
      * <p>Delete the connection with the provided id.</p>
      */
     deleteConnection(args: DeleteConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConnectionCommandOutput>;
     deleteConnection(args: DeleteConnectionCommandInput, cb: (err: any, data?: DeleteConnectionCommandOutput) => void): void;
     deleteConnection(args: DeleteConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Get information about the connection with the provided id.</p>
      */
     getConnection(args: GetConnectionCommandInput, options?: __HttpHandlerOptions): Promise<GetConnectionCommandOutput>;
     getConnection(args: GetConnectionCommandInput, cb: (err: any, data?: GetConnectionCommandOutput) => void): void;
     getConnection(args: GetConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Sends the provided data to the specified connection.</p>
      */
     postToConnection(args: PostToConnectionCommandInput, options?: __HttpHandlerOptions): Promise<PostToConnectionCommandOutput>;

package/dist-types/ApiGatewayManagementApiClient.d.ts

@@ -11,15 +11,24 @@ import { DeleteConnectionCommandInput, DeleteConnectionCommandOutput } from "./c
 import { GetConnectionCommandInput, GetConnectionCommandOutput } from "./commands/GetConnectionCommand";
 import { PostToConnectionCommandInput, PostToConnectionCommandOutput } from "./commands/PostToConnectionCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = DeleteConnectionCommandInput | GetConnectionCommandInput | PostToConnectionCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = DeleteConnectionCommandOutput | GetConnectionCommandOutput | PostToConnectionCommandOutput;
+/**
+ * @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
      */
@@ -109,24 +118,35 @@ 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 ApiGatewayManagementApiClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of ApiGatewayManagementApiClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of ApiGatewayManagementApiClient class constructor that set the region, credentials and other options.
  */
 export interface ApiGatewayManagementApiClientConfig extends ApiGatewayManagementApiClientConfigType {
 }
+/**
+ * @public
+ */
 type ApiGatewayManagementApiClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of ApiGatewayManagementApiClient class. This is resolved and normalized from the {@link ApiGatewayManagementApiClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of ApiGatewayManagementApiClient class. This is resolved and normalized from the {@link ApiGatewayManagementApiClientConfig | constructor configuration interface}.
  */
 export interface ApiGatewayManagementApiClientResolvedConfig extends ApiGatewayManagementApiClientResolvedConfigType {
 }
 /**
- * <p>The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.</p>
+ * @public
+ * <p>The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://\{api-id\}.execute-api.\{region\}.amazonaws.com/\{stage\}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.</p>
  */
 export declare class ApiGatewayManagementApiClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ApiGatewayManagementApiClientResolvedConfig> {
     /**

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ApiGatewayManagementApiClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayManagementApiClient";
 import { DeleteConnectionRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteConnectionCommand}.
  */
 export interface DeleteConnectionCommandInput extends DeleteConnectionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteConnectionCommand}.
  */
 export interface DeleteConnectionCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Delete the connection with the provided id.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteConnectionCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteConnectionCommandInput - {@link DeleteConnectionCommandInput}
+ * @returns {@link DeleteConnectionCommandOutput}
  * @see {@link DeleteConnectionCommandInput} for command's `input` shape.
  * @see {@link DeleteConnectionCommandOutput} for command's `response` shape.
  * @see {@link ApiGatewayManagementApiClientResolvedConfig | config} for ApiGatewayManagementApiClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DeleteConnectionCommandOutput extends __MetadataBearer {
 export declare class DeleteConnectionCommand extends $Command<DeleteConnectionCommandInput, DeleteConnectionCommandOutput, ApiGatewayManagementApiClientResolvedConfig> {
     readonly input: DeleteConnectionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteConnectionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApiGatewayManagementApiClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConnectionCommandInput, DeleteConnectionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ApiGatewayManagementApiClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayManagementApiClient";
 import { GetConnectionRequest, GetConnectionResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GetConnectionCommand}.
  */
 export interface GetConnectionCommandInput extends GetConnectionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetConnectionCommand}.
  */
 export interface GetConnectionCommandOutput extends GetConnectionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Get information about the connection with the provided id.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetConnectionCommandOutput extends GetConnectionResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param GetConnectionCommandInput - {@link GetConnectionCommandInput}
+ * @returns {@link GetConnectionCommandOutput}
  * @see {@link GetConnectionCommandInput} for command's `input` shape.
  * @see {@link GetConnectionCommandOutput} for command's `response` shape.
  * @see {@link ApiGatewayManagementApiClientResolvedConfig | config} for ApiGatewayManagementApiClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetConnectionCommandOutput extends GetConnectionResponse, __Met
 export declare class GetConnectionCommand extends $Command<GetConnectionCommandInput, GetConnectionCommandOutput, ApiGatewayManagementApiClientResolvedConfig> {
     readonly input: GetConnectionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetConnectionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApiGatewayManagementApiClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConnectionCommandInput, GetConnectionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ApiGatewayManagementApiClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayManagementApiClient";
 import { PostToConnectionRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PostToConnectionCommand}.
  */
 export interface PostToConnectionCommandInput extends PostToConnectionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PostToConnectionCommand}.
  */
 export interface PostToConnectionCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Sends the provided data to the specified connection.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface PostToConnectionCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param PostToConnectionCommandInput - {@link PostToConnectionCommandInput}
+ * @returns {@link PostToConnectionCommandOutput}
  * @see {@link PostToConnectionCommandInput} for command's `input` shape.
  * @see {@link PostToConnectionCommandOutput} for command's `response` shape.
  * @see {@link ApiGatewayManagementApiClientResolvedConfig | config} for ApiGatewayManagementApiClient's `config` shape.
@@ -46,11 +53,20 @@ export interface PostToConnectionCommandOutput extends __MetadataBearer {
 export declare class PostToConnectionCommand extends $Command<PostToConnectionCommandInput, PostToConnectionCommandOutput, ApiGatewayManagementApiClientResolvedConfig> {
     readonly input: PostToConnectionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PostToConnectionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApiGatewayManagementApiClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PostToConnectionCommandInput, PostToConnectionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/ApiGatewayManagementApiServiceException.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 ApiGatewayManagementApi service.
  */
 export declare class ApiGatewayManagementApiServiceException extends __ServiceException {

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

@@ -1,9 +1,13 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { ApiGatewayManagementApiServiceException as __BaseException } from "./ApiGatewayManagementApiServiceException";
+/**
+ * @public
+ */
 export interface DeleteConnectionRequest {
     ConnectionId: string | undefined;
 }
 /**
+ * @public
  * <p>The caller is not authorized to invoke this operation.</p>
  */
 export declare class ForbiddenException extends __BaseException {
@@ -15,6 +19,7 @@ export declare class ForbiddenException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
 }
 /**
+ * @public
  * <p>The connection with the provided id no longer exists.</p>
  */
 export declare class GoneException extends __BaseException {
@@ -26,6 +31,7 @@ export declare class GoneException extends __BaseException {
     constructor(opts: __ExceptionOptionType<GoneException, __BaseException>);
 }
 /**
+ * @public
  * <p>The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.</p>
  */
 export declare class LimitExceededException extends __BaseException {
@@ -36,9 +42,15 @@ export declare class LimitExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface GetConnectionRequest {
     ConnectionId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface Identity {
     /**
      * <p>The source IP address of the TCP connection making the request to API Gateway.</p>
@@ -49,6 +61,9 @@ export interface Identity {
      */
     UserAgent: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetConnectionResponse {
     /**
      * <p>The time in ISO 8601 format for when the connection was established.</p>
@@ -61,6 +76,7 @@ export interface GetConnectionResponse {
     LastActiveAt?: Date;
 }
 /**
+ * @public
  * <p>The data has exceeded the maximum size allowed.</p>
  */
 export declare class PayloadTooLargeException extends __BaseException {
@@ -72,6 +88,9 @@ export declare class PayloadTooLargeException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<PayloadTooLargeException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface PostToConnectionRequest {
     /**
      * <p>The data to be sent to the client specified by its connection id.</p>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-apigatewaymanagementapi",
   "description": "AWS SDK for JavaScript Apigatewaymanagementapi Client for Node.js, Browser and React Native",
-  "version": "3.295.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,37 +20,37 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.295.0",
-    "@aws-sdk/config-resolver": "3.295.0",
-    "@aws-sdk/credential-provider-node": "3.295.0",
-    "@aws-sdk/fetch-http-handler": "3.295.0",
-    "@aws-sdk/hash-node": "3.295.0",
-    "@aws-sdk/invalid-dependency": "3.295.0",
-    "@aws-sdk/middleware-content-length": "3.295.0",
-    "@aws-sdk/middleware-endpoint": "3.295.0",
-    "@aws-sdk/middleware-host-header": "3.295.0",
-    "@aws-sdk/middleware-logger": "3.295.0",
-    "@aws-sdk/middleware-recursion-detection": "3.295.0",
-    "@aws-sdk/middleware-retry": "3.295.0",
-    "@aws-sdk/middleware-serde": "3.295.0",
-    "@aws-sdk/middleware-signing": "3.295.0",
-    "@aws-sdk/middleware-stack": "3.295.0",
-    "@aws-sdk/middleware-user-agent": "3.295.0",
-    "@aws-sdk/node-config-provider": "3.295.0",
-    "@aws-sdk/node-http-handler": "3.295.0",
-    "@aws-sdk/protocol-http": "3.295.0",
-    "@aws-sdk/smithy-client": "3.295.0",
-    "@aws-sdk/types": "3.295.0",
-    "@aws-sdk/url-parser": "3.295.0",
+    "@aws-sdk/client-sts": "3.297.0",
+    "@aws-sdk/config-resolver": "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",
+    "@aws-sdk/middleware-content-length": "3.296.0",
+    "@aws-sdk/middleware-endpoint": "3.296.0",
+    "@aws-sdk/middleware-host-header": "3.296.0",
+    "@aws-sdk/middleware-logger": "3.296.0",
+    "@aws-sdk/middleware-recursion-detection": "3.296.0",
+    "@aws-sdk/middleware-retry": "3.296.0",
+    "@aws-sdk/middleware-serde": "3.296.0",
+    "@aws-sdk/middleware-signing": "3.296.0",
+    "@aws-sdk/middleware-stack": "3.296.0",
+    "@aws-sdk/middleware-user-agent": "3.296.0",
+    "@aws-sdk/node-config-provider": "3.296.0",
+    "@aws-sdk/node-http-handler": "3.296.0",
+    "@aws-sdk/protocol-http": "3.296.0",
+    "@aws-sdk/smithy-client": "3.296.0",
+    "@aws-sdk/types": "3.296.0",
+    "@aws-sdk/url-parser": "3.296.0",
     "@aws-sdk/util-base64": "3.295.0",
     "@aws-sdk/util-body-length-browser": "3.295.0",
     "@aws-sdk/util-body-length-node": "3.295.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.295.0",
-    "@aws-sdk/util-defaults-mode-node": "3.295.0",
-    "@aws-sdk/util-endpoints": "3.295.0",
-    "@aws-sdk/util-retry": "3.295.0",
-    "@aws-sdk/util-user-agent-browser": "3.295.0",
-    "@aws-sdk/util-user-agent-node": "3.295.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.296.0",
+    "@aws-sdk/util-defaults-mode-node": "3.296.0",
+    "@aws-sdk/util-endpoints": "3.296.0",
+    "@aws-sdk/util-retry": "3.296.0",
+    "@aws-sdk/util-user-agent-browser": "3.296.0",
+    "@aws-sdk/util-user-agent-node": "3.296.0",
     "@aws-sdk/util-utf8": "3.295.0",
     "tslib": "^2.5.0"
   },