@aws-sdk/client-ec2-instance-connect 3.296.0 → 3.297.0

package/dist-types/EC2InstanceConnect.d.ts

@@ -3,12 +3,14 @@ import { SendSerialConsoleSSHPublicKeyCommandInput, SendSerialConsoleSSHPublicKe
 import { SendSSHPublicKeyCommandInput, SendSSHPublicKeyCommandOutput } from "./commands/SendSSHPublicKeyCommand";
 import { EC2InstanceConnectClient } from "./EC2InstanceConnectClient";
 /**
+ * @public
  * <p>Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH
  *             public keys to EC2, providing users a simple and secure way to connect to their
  *             instances.</p>
  */
 export declare class EC2InstanceConnect extends EC2InstanceConnectClient {
     /**
+     * @public
      * <p>Pushes an SSH public key to the specified EC2 instance. The key remains for 60
      *             seconds, which gives you 60 seconds to establish a serial console connection to the
      *             instance using SSH. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html">EC2 Serial Console</a> in
@@ -18,6 +20,7 @@ export declare class EC2InstanceConnect extends EC2InstanceConnectClient {
     sendSerialConsoleSSHPublicKey(args: SendSerialConsoleSSHPublicKeyCommandInput, cb: (err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void): void;
     sendSerialConsoleSSHPublicKey(args: SendSerialConsoleSSHPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendSerialConsoleSSHPublicKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Pushes an SSH public key to the specified EC2 instance for use by the specified user.
      *             The key remains for 60 seconds. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect.html">Connect to
      *                 your Linux instance using EC2 Instance Connect</a> in the <i>Amazon EC2

package/dist-types/EC2InstanceConnectClient.d.ts

@@ -10,15 +10,24 @@ import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as
 import { SendSerialConsoleSSHPublicKeyCommandInput, SendSerialConsoleSSHPublicKeyCommandOutput } from "./commands/SendSerialConsoleSSHPublicKeyCommand";
 import { SendSSHPublicKeyCommandInput, SendSSHPublicKeyCommandOutput } from "./commands/SendSSHPublicKeyCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = SendSSHPublicKeyCommandInput | SendSerialConsoleSSHPublicKeyCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = SendSSHPublicKeyCommandOutput | SendSerialConsoleSSHPublicKeyCommandOutput;
+/**
+ * @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 EC2InstanceConnectClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of EC2InstanceConnectClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of EC2InstanceConnectClient class constructor that set the region, credentials and other options.
  */
 export interface EC2InstanceConnectClientConfig extends EC2InstanceConnectClientConfigType {
 }
+/**
+ * @public
+ */
 type EC2InstanceConnectClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of EC2InstanceConnectClient class. This is resolved and normalized from the {@link EC2InstanceConnectClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of EC2InstanceConnectClient class. This is resolved and normalized from the {@link EC2InstanceConnectClientConfig | constructor configuration interface}.
  */
 export interface EC2InstanceConnectClientResolvedConfig extends EC2InstanceConnectClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH
  *             public keys to EC2, providing users a simple and secure way to connect to their
  *             instances.</p>

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { EC2InstanceConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2InstanceConnectClient";
 import { SendSSHPublicKeyRequest, SendSSHPublicKeyResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SendSSHPublicKeyCommand}.
  */
 export interface SendSSHPublicKeyCommandInput extends SendSSHPublicKeyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SendSSHPublicKeyCommand}.
  */
 export interface SendSSHPublicKeyCommandOutput extends SendSSHPublicKeyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Pushes an SSH public key to the specified EC2 instance for use by the specified user.
  *             The key remains for 60 seconds. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect.html">Connect to
  *                 your Linux instance using EC2 Instance Connect</a> in the <i>Amazon EC2
@@ -28,6 +33,8 @@ export interface SendSSHPublicKeyCommandOutput extends SendSSHPublicKeyResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param SendSSHPublicKeyCommandInput - {@link SendSSHPublicKeyCommandInput}
+ * @returns {@link SendSSHPublicKeyCommandOutput}
  * @see {@link SendSSHPublicKeyCommandInput} for command's `input` shape.
  * @see {@link SendSSHPublicKeyCommandOutput} for command's `response` shape.
  * @see {@link EC2InstanceConnectClientResolvedConfig | config} for EC2InstanceConnectClient's `config` shape.
@@ -81,11 +88,20 @@ export interface SendSSHPublicKeyCommandOutput extends SendSSHPublicKeyResponse,
 export declare class SendSSHPublicKeyCommand extends $Command<SendSSHPublicKeyCommandInput, SendSSHPublicKeyCommandOutput, EC2InstanceConnectClientResolvedConfig> {
     readonly input: SendSSHPublicKeyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SendSSHPublicKeyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EC2InstanceConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendSSHPublicKeyCommandInput, SendSSHPublicKeyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { EC2InstanceConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2InstanceConnectClient";
 import { SendSerialConsoleSSHPublicKeyRequest, SendSerialConsoleSSHPublicKeyResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SendSerialConsoleSSHPublicKeyCommand}.
  */
 export interface SendSerialConsoleSSHPublicKeyCommandInput extends SendSerialConsoleSSHPublicKeyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SendSerialConsoleSSHPublicKeyCommand}.
  */
 export interface SendSerialConsoleSSHPublicKeyCommandOutput extends SendSerialConsoleSSHPublicKeyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Pushes an SSH public key to the specified EC2 instance. The key remains for 60
  *             seconds, which gives you 60 seconds to establish a serial console connection to the
  *             instance using SSH. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html">EC2 Serial Console</a> in
@@ -28,6 +33,8 @@ export interface SendSerialConsoleSSHPublicKeyCommandOutput extends SendSerialCo
  * const response = await client.send(command);
  * ```
  *
+ * @param SendSerialConsoleSSHPublicKeyCommandInput - {@link SendSerialConsoleSSHPublicKeyCommandInput}
+ * @returns {@link SendSerialConsoleSSHPublicKeyCommandOutput}
  * @see {@link SendSerialConsoleSSHPublicKeyCommandInput} for command's `input` shape.
  * @see {@link SendSerialConsoleSSHPublicKeyCommandOutput} for command's `response` shape.
  * @see {@link EC2InstanceConnectClientResolvedConfig | config} for EC2InstanceConnectClient's `config` shape.
@@ -76,11 +83,20 @@ export interface SendSerialConsoleSSHPublicKeyCommandOutput extends SendSerialCo
 export declare class SendSerialConsoleSSHPublicKeyCommand extends $Command<SendSerialConsoleSSHPublicKeyCommandInput, SendSerialConsoleSSHPublicKeyCommandOutput, EC2InstanceConnectClientResolvedConfig> {
     readonly input: SendSerialConsoleSSHPublicKeyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SendSerialConsoleSSHPublicKeyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EC2InstanceConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendSerialConsoleSSHPublicKeyCommandInput, SendSerialConsoleSSHPublicKeyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { EC2InstanceConnectServiceException as __BaseException } from "./EC2InstanceConnectServiceException";
 /**
+ * @public
  * <p>Either your AWS credentials are not valid or you do not have access to the EC2 instance.</p>
  */
 export declare class AuthException extends __BaseException {
@@ -13,6 +14,7 @@ export declare class AuthException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AuthException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified instance was not found.</p>
  */
 export declare class EC2InstanceNotFoundException extends __BaseException {
@@ -25,6 +27,7 @@ export declare class EC2InstanceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<EC2InstanceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>Unable to connect because the instance is not in a valid state.
  *             Connecting to a stopped or terminated instance is not supported. If the instance is stopped,
  *             start your instance, and try to connect again.</p>
@@ -39,6 +42,7 @@ export declare class EC2InstanceStateInvalidException extends __BaseException {
     constructor(opts: __ExceptionOptionType<EC2InstanceStateInvalidException, __BaseException>);
 }
 /**
+ * @public
  * <p>The instance type is not supported for connecting via the serial console. Only Nitro
  *             instance types are currently supported.</p>
  */
@@ -52,6 +56,7 @@ export declare class EC2InstanceTypeInvalidException extends __BaseException {
     constructor(opts: __ExceptionOptionType<EC2InstanceTypeInvalidException, __BaseException>);
 }
 /**
+ * @public
  * <p>The instance is currently unavailable. Wait a few minutes and try again.</p>
  */
 export declare class EC2InstanceUnavailableException extends __BaseException {
@@ -64,6 +69,7 @@ export declare class EC2InstanceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<EC2InstanceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>One of the parameters is not valid.</p>
  */
 export declare class InvalidArgsException extends __BaseException {
@@ -75,6 +81,9 @@ export declare class InvalidArgsException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidArgsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface SendSerialConsoleSSHPublicKeyRequest {
     /**
      * <p>The ID of the EC2 instance.</p>
@@ -92,6 +101,9 @@ export interface SendSerialConsoleSSHPublicKeyRequest {
      */
     SSHPublicKey: string | undefined;
 }
+/**
+ * @public
+ */
 export interface SendSerialConsoleSSHPublicKeyResponse {
     /**
      * <p>The ID of the request. Please provide this ID when contacting AWS Support for assistance.</p>
@@ -103,6 +115,7 @@ export interface SendSerialConsoleSSHPublicKeyResponse {
     Success?: boolean;
 }
 /**
+ * @public
  * <p>Your account is not authorized to use the EC2 Serial Console. To authorize your
  *             account, run the EnableSerialConsoleAccess API. For more information, see
  *             <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableSerialConsoleAccess.html">EnableSerialConsoleAccess</a> in the <i>Amazon EC2 API Reference</i>.</p>
@@ -117,6 +130,7 @@ export declare class SerialConsoleAccessDisabledException extends __BaseExceptio
     constructor(opts: __ExceptionOptionType<SerialConsoleAccessDisabledException, __BaseException>);
 }
 /**
+ * @public
  * <p>The instance currently has 1 active serial console session. Only 1 session is supported at a time.</p>
  */
 export declare class SerialConsoleSessionLimitExceededException extends __BaseException {
@@ -129,6 +143,7 @@ export declare class SerialConsoleSessionLimitExceededException extends __BaseEx
     constructor(opts: __ExceptionOptionType<SerialConsoleSessionLimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>Unable to start a serial console session. Please try again.</p>
  */
 export declare class SerialConsoleSessionUnavailableException extends __BaseException {
@@ -141,6 +156,7 @@ export declare class SerialConsoleSessionUnavailableException extends __BaseExce
     constructor(opts: __ExceptionOptionType<SerialConsoleSessionUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service encountered an error. Follow the instructions in the error message and try again.</p>
  */
 export declare class ServiceException extends __BaseException {
@@ -153,6 +169,7 @@ export declare class ServiceException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceException, __BaseException>);
 }
 /**
+ * @public
  * <p>The requests were made too frequently and have been throttled. Wait a while and try again.
  *             To increase the limit on your request frequency, contact AWS Support.</p>
  */
@@ -165,6 +182,9 @@ export declare class ThrottlingException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface SendSSHPublicKeyRequest {
     /**
      * <p>The ID of the EC2 instance.</p>
@@ -183,6 +203,9 @@ export interface SendSSHPublicKeyRequest {
      */
     AvailabilityZone?: string;
 }
+/**
+ * @public
+ */
 export interface SendSSHPublicKeyResponse {
     /**
      * <p>The ID of the request. Please provide this ID when contacting AWS Support for assistance.</p>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-ec2-instance-connect",
   "description": "AWS SDK for JavaScript Ec2 Instance Connect 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",