@aws-sdk/client-sagemaker-edge 3.296.0 → 3.297.0

package/dist-types/SagemakerEdge.d.ts

@@ -4,22 +4,26 @@ import { GetDeviceRegistrationCommandInput, GetDeviceRegistrationCommandOutput }
 import { SendHeartbeatCommandInput, SendHeartbeatCommandOutput } from "./commands/SendHeartbeatCommand";
 import { SagemakerEdgeClient } from "./SagemakerEdgeClient";
 /**
+ * @public
  * <p>SageMaker Edge Manager dataplane service for communicating with active agents.</p>
  */
 export declare class SagemakerEdge extends SagemakerEdgeClient {
     /**
+     * @public
      * <p>Use to get the active deployments from a device.</p>
      */
     getDeployments(args: GetDeploymentsCommandInput, options?: __HttpHandlerOptions): Promise<GetDeploymentsCommandOutput>;
     getDeployments(args: GetDeploymentsCommandInput, cb: (err: any, data?: GetDeploymentsCommandOutput) => void): void;
     getDeployments(args: GetDeploymentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeploymentsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Use to check if a device is registered with SageMaker Edge Manager.</p>
      */
     getDeviceRegistration(args: GetDeviceRegistrationCommandInput, options?: __HttpHandlerOptions): Promise<GetDeviceRegistrationCommandOutput>;
     getDeviceRegistration(args: GetDeviceRegistrationCommandInput, cb: (err: any, data?: GetDeviceRegistrationCommandOutput) => void): void;
     getDeviceRegistration(args: GetDeviceRegistrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceRegistrationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Use to get the current status of devices registered on SageMaker Edge Manager.</p>
      */
     sendHeartbeat(args: SendHeartbeatCommandInput, options?: __HttpHandlerOptions): Promise<SendHeartbeatCommandOutput>;

package/dist-types/SagemakerEdgeClient.d.ts

@@ -11,15 +11,24 @@ import { GetDeploymentsCommandInput, GetDeploymentsCommandOutput } from "./comma
 import { GetDeviceRegistrationCommandInput, GetDeviceRegistrationCommandOutput } from "./commands/GetDeviceRegistrationCommand";
 import { SendHeartbeatCommandInput, SendHeartbeatCommandOutput } from "./commands/SendHeartbeatCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = GetDeploymentsCommandInput | GetDeviceRegistrationCommandInput | SendHeartbeatCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = GetDeploymentsCommandOutput | GetDeviceRegistrationCommandOutput | SendHeartbeatCommandOutput;
+/**
+ * @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,23 +118,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 SagemakerEdgeClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of SagemakerEdgeClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of SagemakerEdgeClient class constructor that set the region, credentials and other options.
  */
 export interface SagemakerEdgeClientConfig extends SagemakerEdgeClientConfigType {
 }
+/**
+ * @public
+ */
 type SagemakerEdgeClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of SagemakerEdgeClient class. This is resolved and normalized from the {@link SagemakerEdgeClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of SagemakerEdgeClient class. This is resolved and normalized from the {@link SagemakerEdgeClientConfig | constructor configuration interface}.
  */
 export interface SagemakerEdgeClientResolvedConfig extends SagemakerEdgeClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>SageMaker Edge Manager dataplane service for communicating with active agents.</p>
  */
 export declare class SagemakerEdgeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SagemakerEdgeClientResolvedConfig> {

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetDeploymentsRequest, GetDeploymentsResult } from "../models/models_0";
 import { SagemakerEdgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SagemakerEdgeClient";
 /**
+ * @public
+ *
  * The input for {@link GetDeploymentsCommand}.
  */
 export interface GetDeploymentsCommandInput extends GetDeploymentsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetDeploymentsCommand}.
  */
 export interface GetDeploymentsCommandOutput extends GetDeploymentsResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Use to get the active deployments from a device.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetDeploymentsCommandOutput extends GetDeploymentsResult, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param GetDeploymentsCommandInput - {@link GetDeploymentsCommandInput}
+ * @returns {@link GetDeploymentsCommandOutput}
  * @see {@link GetDeploymentsCommandInput} for command's `input` shape.
  * @see {@link GetDeploymentsCommandOutput} for command's `response` shape.
  * @see {@link SagemakerEdgeClientResolvedConfig | config} for SagemakerEdgeClient's `config` shape.
@@ -38,11 +45,20 @@ export interface GetDeploymentsCommandOutput extends GetDeploymentsResult, __Met
 export declare class GetDeploymentsCommand extends $Command<GetDeploymentsCommandInput, GetDeploymentsCommandOutput, SagemakerEdgeClientResolvedConfig> {
     readonly input: GetDeploymentsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetDeploymentsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SagemakerEdgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDeploymentsCommandInput, GetDeploymentsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetDeviceRegistrationRequest, GetDeviceRegistrationResult } from "../models/models_0";
 import { SagemakerEdgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SagemakerEdgeClient";
 /**
+ * @public
+ *
  * The input for {@link GetDeviceRegistrationCommand}.
  */
 export interface GetDeviceRegistrationCommandInput extends GetDeviceRegistrationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetDeviceRegistrationCommand}.
  */
 export interface GetDeviceRegistrationCommandOutput extends GetDeviceRegistrationResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Use to check if a device is registered with SageMaker Edge Manager.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetDeviceRegistrationCommandOutput extends GetDeviceRegistratio
  * const response = await client.send(command);
  * ```
  *
+ * @param GetDeviceRegistrationCommandInput - {@link GetDeviceRegistrationCommandInput}
+ * @returns {@link GetDeviceRegistrationCommandOutput}
  * @see {@link GetDeviceRegistrationCommandInput} for command's `input` shape.
  * @see {@link GetDeviceRegistrationCommandOutput} for command's `response` shape.
  * @see {@link SagemakerEdgeClientResolvedConfig | config} for SagemakerEdgeClient's `config` shape.
@@ -38,11 +45,20 @@ export interface GetDeviceRegistrationCommandOutput extends GetDeviceRegistratio
 export declare class GetDeviceRegistrationCommand extends $Command<GetDeviceRegistrationCommandInput, GetDeviceRegistrationCommandOutput, SagemakerEdgeClientResolvedConfig> {
     readonly input: GetDeviceRegistrationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetDeviceRegistrationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SagemakerEdgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDeviceRegistrationCommandInput, GetDeviceRegistrationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { SendHeartbeatRequest } from "../models/models_0";
 import { SagemakerEdgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SagemakerEdgeClient";
 /**
+ * @public
+ *
  * The input for {@link SendHeartbeatCommand}.
  */
 export interface SendHeartbeatCommandInput extends SendHeartbeatRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SendHeartbeatCommand}.
  */
 export interface SendHeartbeatCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Use to get the current status of devices registered on SageMaker Edge Manager.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface SendHeartbeatCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param SendHeartbeatCommandInput - {@link SendHeartbeatCommandInput}
+ * @returns {@link SendHeartbeatCommandOutput}
  * @see {@link SendHeartbeatCommandInput} for command's `input` shape.
  * @see {@link SendHeartbeatCommandOutput} for command's `response` shape.
  * @see {@link SagemakerEdgeClientResolvedConfig | config} for SagemakerEdgeClient's `config` shape.
@@ -38,11 +45,20 @@ export interface SendHeartbeatCommandOutput extends __MetadataBearer {
 export declare class SendHeartbeatCommand extends $Command<SendHeartbeatCommandInput, SendHeartbeatCommandOutput, SagemakerEdgeClientResolvedConfig> {
     readonly input: SendHeartbeatCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SendHeartbeatCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SagemakerEdgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendHeartbeatCommandInput, SendHeartbeatCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

@@ -1,5 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { SagemakerEdgeServiceException as __BaseException } from "./SagemakerEdgeServiceException";
+/**
+ * @public
+ */
 export interface GetDeploymentsRequest {
     /**
      * <p>The unique name of the device you want to get the configuration of active deployments from.</p>
@@ -10,10 +13,14 @@ export interface GetDeploymentsRequest {
      */
     DeviceFleetName: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ChecksumType {
     Sha1 = "SHA1"
 }
 /**
+ * @public
  * <p>Information about the checksum of a model deployed on a device.</p>
  */
 export interface Checksum {
@@ -26,11 +33,15 @@ export interface Checksum {
      */
     Sum?: string;
 }
+/**
+ * @public
+ */
 export declare enum ModelState {
     Deploy = "DEPLOY",
     Undeploy = "UNDEPLOY"
 }
 /**
+ * @public
  * <p></p>
  */
 export interface Definition {
@@ -51,14 +62,21 @@ export interface Definition {
      */
     State?: ModelState | string;
 }
+/**
+ * @public
+ */
 export declare enum FailureHandlingPolicy {
     DoNothing = "DO_NOTHING",
     RollbackOnFailure = "ROLLBACK_ON_FAILURE"
 }
+/**
+ * @public
+ */
 export declare enum DeploymentType {
     Model = "Model"
 }
 /**
+ * @public
  * <p>Information about a deployment on an edge device that is registered with SageMaker Edge Manager.</p>
  */
 export interface EdgeDeployment {
@@ -79,6 +97,9 @@ export interface EdgeDeployment {
      */
     Definitions?: Definition[];
 }
+/**
+ * @public
+ */
 export interface GetDeploymentsResult {
     /**
      * <p>Returns a list of the configurations of the active deployments on the device.</p>
@@ -86,6 +107,7 @@ export interface GetDeploymentsResult {
     Deployments?: EdgeDeployment[];
 }
 /**
+ * @public
  * <p>An internal failure occurred. Try your request again. If the problem
  *       persists, contact Amazon Web Services customer support.</p>
  */
@@ -98,6 +120,9 @@ export declare class InternalServiceException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServiceException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface GetDeviceRegistrationRequest {
     /**
      * <p>The unique name of the device you want to get the registration status from.</p>
@@ -108,6 +133,9 @@ export interface GetDeviceRegistrationRequest {
      */
     DeviceFleetName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetDeviceRegistrationResult {
     /**
      * <p>Describes if the device is currently registered with SageMaker Edge Manager.</p>
@@ -119,6 +147,7 @@ export interface GetDeviceRegistrationResult {
     CacheTTL?: string;
 }
 /**
+ * @public
  * <p>Information required for edge device metrics.</p>
  */
 export interface EdgeMetric {
@@ -139,11 +168,15 @@ export interface EdgeMetric {
      */
     Timestamp?: Date;
 }
+/**
+ * @public
+ */
 export declare enum DeploymentStatus {
     Fail = "FAIL",
     Success = "SUCCESS"
 }
 /**
+ * @public
  * <p></p>
  */
 export interface DeploymentModel {
@@ -181,6 +214,7 @@ export interface DeploymentModel {
     RollbackFailureReason?: string;
 }
 /**
+ * @public
  * <p>Information about the result of a deployment on an edge device that is registered with SageMaker Edge Manager.</p>
  */
 export interface DeploymentResult {
@@ -210,6 +244,7 @@ export interface DeploymentResult {
     DeploymentModels?: DeploymentModel[];
 }
 /**
+ * @public
  * <p>Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.</p>
  */
 export interface Model {
@@ -234,6 +269,9 @@ export interface Model {
      */
     ModelMetrics?: EdgeMetric[];
 }
+/**
+ * @public
+ */
 export interface SendHeartbeatRequest {
     /**
      * <p>For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.</p>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-sagemaker-edge",
   "description": "AWS SDK for JavaScript Sagemaker Edge 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",