@aws-sdk/client-iotfleetwise 3.296.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTFleetWiseClient";
 import { RegisterAccountRequest, RegisterAccountResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link RegisterAccountCommand}.
  */
 export interface RegisterAccountCommandInput extends RegisterAccountRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RegisterAccountCommand}.
  */
 export interface RegisterAccountCommandOutput extends RegisterAccountResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can
  *             transfer your vehicle data to the Amazon Web Services Cloud. For more information, including
  *             step-by-step procedures, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html">Setting up
@@ -35,6 +40,8 @@ export interface RegisterAccountCommandOutput extends RegisterAccountResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param RegisterAccountCommandInput - {@link RegisterAccountCommandInput}
+ * @returns {@link RegisterAccountCommandOutput}
  * @see {@link RegisterAccountCommandInput} for command's `input` shape.
  * @see {@link RegisterAccountCommandOutput} for command's `response` shape.
  * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
@@ -63,11 +70,20 @@ export interface RegisterAccountCommandOutput extends RegisterAccountResponse, _
 export declare class RegisterAccountCommand extends $Command<RegisterAccountCommandInput, RegisterAccountCommandOutput, IoTFleetWiseClientResolvedConfig> {
     readonly input: RegisterAccountCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RegisterAccountCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTFleetWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterAccountCommandInput, RegisterAccountCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTFleetWiseClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds to or modifies the tags of the given resource. Tags are metadata which can be
  *             used to manage a resource.</p>
  * @example
@@ -26,6 +31,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
@@ -50,11 +57,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IoTFleetWiseClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTFleetWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTFleetWiseClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes the given tags (metadata) from the resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IoTFleetWiseClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTFleetWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTFleetWiseClient";
 import { UpdateDecoderManifestRequest, UpdateDecoderManifestResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateDecoderManifestCommand}.
  */
 export interface UpdateDecoderManifestCommandInput extends UpdateDecoderManifestRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDecoderManifestCommand}.
  */
 export interface UpdateDecoderManifestCommandOutput extends UpdateDecoderManifestResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p> Updates a decoder manifest.</p>
  *         <p>A decoder manifest can only be updated when the status is <code>DRAFT</code>. Only
  *                 <code>ACTIVE</code> decoder manifests can be associated with vehicles.</p>
@@ -27,6 +32,8 @@ export interface UpdateDecoderManifestCommandOutput extends UpdateDecoderManifes
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDecoderManifestCommandInput - {@link UpdateDecoderManifestCommandInput}
+ * @returns {@link UpdateDecoderManifestCommandOutput}
  * @see {@link UpdateDecoderManifestCommandInput} for command's `input` shape.
  * @see {@link UpdateDecoderManifestCommandOutput} for command's `response` shape.
  * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
@@ -61,11 +68,20 @@ export interface UpdateDecoderManifestCommandOutput extends UpdateDecoderManifes
 export declare class UpdateDecoderManifestCommand extends $Command<UpdateDecoderManifestCommandInput, UpdateDecoderManifestCommandOutput, IoTFleetWiseClientResolvedConfig> {
     readonly input: UpdateDecoderManifestCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDecoderManifestCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTFleetWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDecoderManifestCommandInput, UpdateDecoderManifestCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTFleetWiseClient";
 import { UpdateFleetRequest, UpdateFleetResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateFleetCommand}.
  */
 export interface UpdateFleetCommandInput extends UpdateFleetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateFleetCommand}.
  */
 export interface UpdateFleetCommandOutput extends UpdateFleetResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p> Updates the description of an existing fleet. </p>
  *         <note>
  *             <p>If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response
@@ -29,6 +34,8 @@ export interface UpdateFleetCommandOutput extends UpdateFleetResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateFleetCommandInput - {@link UpdateFleetCommandInput}
+ * @returns {@link UpdateFleetCommandOutput}
  * @see {@link UpdateFleetCommandInput} for command's `input` shape.
  * @see {@link UpdateFleetCommandOutput} for command's `response` shape.
  * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
@@ -57,11 +64,20 @@ export interface UpdateFleetCommandOutput extends UpdateFleetResponse, __Metadat
 export declare class UpdateFleetCommand extends $Command<UpdateFleetCommandInput, UpdateFleetCommandOutput, IoTFleetWiseClientResolvedConfig> {
     readonly input: UpdateFleetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateFleetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTFleetWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFleetCommandInput, UpdateFleetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTFleetWiseClient";
 import { UpdateModelManifestRequest, UpdateModelManifestResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateModelManifestCommand}.
  */
 export interface UpdateModelManifestCommandInput extends UpdateModelManifestRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateModelManifestCommand}.
  */
 export interface UpdateModelManifestCommandOutput extends UpdateModelManifestResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p> Updates a vehicle model (model manifest). If created vehicles are associated with a
  *             vehicle model, it can't be updated.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateModelManifestCommandOutput extends UpdateModelManifestRes
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateModelManifestCommandInput - {@link UpdateModelManifestCommandInput}
+ * @returns {@link UpdateModelManifestCommandOutput}
  * @see {@link UpdateModelManifestCommandInput} for command's `input` shape.
  * @see {@link UpdateModelManifestCommandOutput} for command's `response` shape.
  * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
@@ -57,11 +64,20 @@ export interface UpdateModelManifestCommandOutput extends UpdateModelManifestRes
 export declare class UpdateModelManifestCommand extends $Command<UpdateModelManifestCommandInput, UpdateModelManifestCommandOutput, IoTFleetWiseClientResolvedConfig> {
     readonly input: UpdateModelManifestCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateModelManifestCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTFleetWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateModelManifestCommandInput, UpdateModelManifestCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTFleetWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTFleetWiseClient";
 import { UpdateSignalCatalogRequest, UpdateSignalCatalogResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateSignalCatalogCommand}.
  */
 export interface UpdateSignalCatalogCommandInput extends UpdateSignalCatalogRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateSignalCatalogCommand}.
  */
 export interface UpdateSignalCatalogCommandOutput extends UpdateSignalCatalogResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p> Updates a signal catalog. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateSignalCatalogCommandOutput extends UpdateSignalCatalogRes
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateSignalCatalogCommandInput - {@link UpdateSignalCatalogCommandInput}
+ * @returns {@link UpdateSignalCatalogCommandOutput}
  * @see {@link UpdateSignalCatalogCommandInput} for command's `input` shape.
  * @see {@link UpdateSignalCatalogCommandOutput} for command's `response` shape.
  * @see {@link IoTFleetWiseClientResolvedConfig | config} for IoTFleetWiseClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UpdateSignalCatalogCommandOutput extends UpdateSignalCatalogRes
 export declare class UpdateSignalCatalogCommand extends $Command<UpdateSignalCatalogCommandInput, UpdateSignalCatalogCommandOutput, IoTFleetWiseClientResolvedConfig> {
     readonly input: UpdateSignalCatalogCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateSignalCatalogCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTFleetWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateSignalCatalogCommandInput, UpdateSignalCatalogCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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