From 2b1a63d60e2e75a7e3c2443a2f72ee3b2bba91d2 Mon Sep 17 00:00:00 2001
From: awstools The request was denied due to request throttling. The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
- * related Amazon Web Services service that's being utilized. The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
+ * service that's being utilized. Base exception class for all service exceptions from LookoutEquipment service. The request was denied due to request throttling. The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
- * related Amazon Web Services service that's being utilized. The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
+ * service that's being utilized. Base exception class for all service exceptions from LookoutEquipment service.
- * Creates a label for an event.
- * Creates a label for an event. The request was denied due to request throttling. The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
- * related Amazon Web Services service that's being utilized. The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
+ * service that's being utilized. Base exception class for all service exceptions from LookoutEquipment service.
- * Creates a group of labels.
- * Creates a group of labels. The request was denied due to request throttling. The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
- * related Amazon Web Services service that's being utilized. The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services
+ * service that's being utilized. Base exception class for all service exceptions from LookoutEquipment service. Creates an ML model for data inference. Creates a machine learning model for data inference. A machine-learning (ML) model is a mathematical model that finds patterns in your data.
- * In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and
- * detects abnormal behavior that could be potential equipment failure (or maintenance
- * events). The models are made by analyzing normal data and abnormalities in machine behavior
- * that have already occurred.
+CreateRetrainingScheduler
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/createretrainingschedulercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/createretrainingschedulercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/createretrainingschedulercommandoutput.html)
+
@@ -291,6 +299,14 @@ DeleteResourcePolicy
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/deleteresourcepolicycommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/deleteresourcepolicycommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/deleteresourcepolicycommandoutput.html)
+
+DeleteRetrainingScheduler
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/deleteretrainingschedulercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/deleteretrainingschedulercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/deleteretrainingschedulercommandoutput.html)
+
@@ -355,6 +371,14 @@ DescribeResourcePolicy
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/describeresourcepolicycommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/describeresourcepolicycommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/describeresourcepolicycommandoutput.html)
+
+DescribeRetrainingScheduler
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/describeretrainingschedulercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/describeretrainingschedulercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/describeretrainingschedulercommandoutput.html)
+
@@ -443,6 +467,14 @@ ListModelVersions
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/listmodelversionscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/listmodelversionscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/listmodelversionscommandoutput.html)
+
+ListRetrainingSchedulers
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/listretrainingschedulerscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/listretrainingschedulerscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/listretrainingschedulerscommandoutput.html)
+
@@ -483,6 +515,14 @@ StartInferenceScheduler
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/startinferenceschedulercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/startinferenceschedulercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/startinferenceschedulercommandoutput.html)
+
+StartRetrainingScheduler
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/startretrainingschedulercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/startretrainingschedulercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/startretrainingschedulercommandoutput.html)
+
@@ -491,6 +531,14 @@ StopInferenceScheduler
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/stopinferenceschedulercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/stopinferenceschedulercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/stopinferenceschedulercommandoutput.html)
+
+StopRetrainingScheduler
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/stopretrainingschedulercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/stopretrainingschedulercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/stopretrainingschedulercommandoutput.html)
+
@@ -532,3 +580,19 @@ UpdateLabelGroup
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/updatelabelgroupcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/updatelabelgroupcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/updatelabelgroupcommandoutput.html)
+UpdateModel
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/updatemodelcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/updatemodelcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/updatemodelcommandoutput.html)
+
+
+UpdateRetrainingScheduler
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/classes/updateretrainingschedulercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/updateretrainingschedulercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-lookoutequipment/interfaces/updateretrainingschedulercommandoutput.html)
+
+
Your model is trained using a portion of the data from your dataset and uses that data * to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. * Another portion of the data is used to evaluate the model's accuracy.
@@ -120,8 +120,8 @@ export interface CreateModelCommandOutput extends CreateModelResponse, __Metadat *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/CreateRetrainingSchedulerCommand.ts b/clients/client-lookoutequipment/src/commands/CreateRetrainingSchedulerCommand.ts new file mode 100644 index 000000000000..141bcf193983 --- /dev/null +++ b/clients/client-lookoutequipment/src/commands/CreateRetrainingSchedulerCommand.ts @@ -0,0 +1,219 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient"; +import { CreateRetrainingSchedulerRequest, CreateRetrainingSchedulerResponse } from "../models/models_0"; +import { de_CreateRetrainingSchedulerCommand, se_CreateRetrainingSchedulerCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link CreateRetrainingSchedulerCommand}. + */ +export interface CreateRetrainingSchedulerCommandInput extends CreateRetrainingSchedulerRequest {} +/** + * @public + * + * The output of {@link CreateRetrainingSchedulerCommand}. + */ +export interface CreateRetrainingSchedulerCommandOutput extends CreateRetrainingSchedulerResponse, __MetadataBearer {} + +/** + * @public + *Creates a retraining scheduler on the specified model.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, CreateRetrainingSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, CreateRetrainingSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const input = { // CreateRetrainingSchedulerRequest + * ModelName: "STRING_VALUE", // required + * RetrainingStartDate: new Date("TIMESTAMP"), + * RetrainingFrequency: "STRING_VALUE", // required + * LookbackWindow: "STRING_VALUE", // required + * PromoteMode: "MANAGED" || "MANUAL", + * ClientToken: "STRING_VALUE", // required + * }; + * const command = new CreateRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * // { // CreateRetrainingSchedulerResponse + * // ModelName: "STRING_VALUE", + * // ModelArn: "STRING_VALUE", + * // Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED", + * // }; + * + * ``` + * + * @param CreateRetrainingSchedulerCommandInput - {@link CreateRetrainingSchedulerCommandInput} + * @returns {@link CreateRetrainingSchedulerCommandOutput} + * @see {@link CreateRetrainingSchedulerCommandInput} for command's `input` shape. + * @see {@link CreateRetrainingSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request could not be completed because you do not have access to the resource. + *
+ * + * @throws {@link ConflictException} (client fault) + *The request could not be completed due to a conflict with the current state of the + * target resource.
+ * + * @throws {@link InternalServerException} (server fault) + *Processing of the request has failed because of an unknown error, exception or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource requested could not be found. Verify the resource ID and retry your + * request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
+ * + * @throws {@link LookoutEquipmentServiceException} + *Base exception class for all service exceptions from LookoutEquipment service.
+ * + * @example Creates a retraining scheduler with manual promote mode + * ```javascript + * // + * const input = { + * "ClientToken": "sample-client-token", + * "LookbackWindow": "P360D", + * "ModelName": "sample-model", + * "PromoteMode": "MANUAL", + * "RetrainingFrequency": "P1M" + * }; + * const command = new CreateRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + * "ModelName": "sample-model", + * "Status": "PENDING" + * } + * *\/ + * // example id: creates-a-retraining-scheduler-with-manual-promote-mode-1694018486212 + * ``` + * + * @example Creates a retraining scheduler with a specific start date + * ```javascript + * // + * const input = { + * "ClientToken": "sample-client-token", + * "LookbackWindow": "P360D", + * "ModelName": "sample-model", + * "RetrainingFrequency": "P1M", + * "RetrainingStartDate": "2024-01-01T00:00:00Z" + * }; + * const command = new CreateRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + * "ModelName": "sample-model", + * "Status": "PENDING" + * } + * *\/ + * // example id: creates-a-retraining-scheduler-with-a-specific-start-date-1694018790519 + * ``` + * + */ +export class CreateRetrainingSchedulerCommand extends $Command< + CreateRetrainingSchedulerCommandInput, + CreateRetrainingSchedulerCommandOutput, + LookoutEquipmentClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateRetrainingSchedulerCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DeleteInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/src/commands/DeleteInferenceSchedulerCommand.ts index 6ec1b87ba693..c1852f0a72ca 100644 --- a/clients/client-lookoutequipment/src/commands/DeleteInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DeleteInferenceSchedulerCommand.ts @@ -36,8 +36,8 @@ export interface DeleteInferenceSchedulerCommandOutput extends __MetadataBearer /** * @public - *Deletes an inference scheduler that has been set up. Already processed output results - * are not affected.
+ *Deletes an inference scheduler that has been set up. Prior inference results will not be + * deleted.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -79,8 +79,8 @@ export interface DeleteInferenceSchedulerCommandOutput extends __MetadataBearer *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DeleteLabelCommand.ts b/clients/client-lookoutequipment/src/commands/DeleteLabelCommand.ts index 3cff07857707..7f405e137f9e 100644 --- a/clients/client-lookoutequipment/src/commands/DeleteLabelCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DeleteLabelCommand.ts @@ -36,9 +36,7 @@ export interface DeleteLabelCommandOutput extends __MetadataBearer {} /** * @public - *- * Deletes a label. - *
+ *Deletes a label.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -81,8 +79,8 @@ export interface DeleteLabelCommandOutput extends __MetadataBearer {} *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DeleteLabelGroupCommand.ts b/clients/client-lookoutequipment/src/commands/DeleteLabelGroupCommand.ts index ba99dac7aca5..7e96ac07459a 100644 --- a/clients/client-lookoutequipment/src/commands/DeleteLabelGroupCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DeleteLabelGroupCommand.ts @@ -36,9 +36,7 @@ export interface DeleteLabelGroupCommandOutput extends __MetadataBearer {} /** * @public - *- * Deletes a group of labels. - *
+ *Deletes a group of labels.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -80,8 +78,8 @@ export interface DeleteLabelGroupCommandOutput extends __MetadataBearer {} *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DeleteModelCommand.ts b/clients/client-lookoutequipment/src/commands/DeleteModelCommand.ts index b6b9211da26d..f3da519826ad 100644 --- a/clients/client-lookoutequipment/src/commands/DeleteModelCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DeleteModelCommand.ts @@ -36,9 +36,8 @@ export interface DeleteModelCommandOutput extends __MetadataBearer {} /** * @public - *Deletes an ML model currently available for Amazon Lookout for Equipment. This will - * prevent it from being used with an inference scheduler, even one that is already set up. - *
+ *Deletes a machine learning model currently available for Amazon Lookout for Equipment. This will prevent it + * from being used with an inference scheduler, even one that is already set up.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -80,8 +79,8 @@ export interface DeleteModelCommandOutput extends __MetadataBearer {} *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DeleteResourcePolicyCommand.ts b/clients/client-lookoutequipment/src/commands/DeleteResourcePolicyCommand.ts index a8761c8e4d4d..6bf22590a595 100644 --- a/clients/client-lookoutequipment/src/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DeleteResourcePolicyCommand.ts @@ -78,8 +78,8 @@ export interface DeleteResourcePolicyCommandOutput extends __MetadataBearer {} *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DeleteRetrainingSchedulerCommand.ts b/clients/client-lookoutequipment/src/commands/DeleteRetrainingSchedulerCommand.ts new file mode 100644 index 000000000000..67cf848669f8 --- /dev/null +++ b/clients/client-lookoutequipment/src/commands/DeleteRetrainingSchedulerCommand.ts @@ -0,0 +1,178 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient"; +import { DeleteRetrainingSchedulerRequest } from "../models/models_0"; +import { de_DeleteRetrainingSchedulerCommand, se_DeleteRetrainingSchedulerCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DeleteRetrainingSchedulerCommand}. + */ +export interface DeleteRetrainingSchedulerCommandInput extends DeleteRetrainingSchedulerRequest {} +/** + * @public + * + * The output of {@link DeleteRetrainingSchedulerCommand}. + */ +export interface DeleteRetrainingSchedulerCommandOutput extends __MetadataBearer {} + +/** + * @public + *Deletes a retraining scheduler from a model. The retraining scheduler must be in the
+ * STOPPED
status.
The request could not be completed because you do not have access to the resource. + *
+ * + * @throws {@link ConflictException} (client fault) + *The request could not be completed due to a conflict with the current state of the + * target resource.
+ * + * @throws {@link InternalServerException} (server fault) + *Processing of the request has failed because of an unknown error, exception or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource requested could not be found. Verify the resource ID and retry your + * request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
+ * + * @throws {@link LookoutEquipmentServiceException} + *Base exception class for all service exceptions from LookoutEquipment service.
+ * + * @example Deletes a retraining scheduler + * ```javascript + * // + * const input = { + * "ModelName": "sample-model" + * }; + * const command = new DeleteRetrainingSchedulerCommand(input); + * await client.send(command); + * // example id: deletes-a-retraining-scheduler-1694019240097 + * ``` + * + */ +export class DeleteRetrainingSchedulerCommand extends $Command< + DeleteRetrainingSchedulerCommandInput, + DeleteRetrainingSchedulerCommandOutput, + LookoutEquipmentClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteRetrainingSchedulerCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DescribeDatasetCommand.ts b/clients/client-lookoutequipment/src/commands/DescribeDatasetCommand.ts index 5362825c27c2..8cc368876186 100644 --- a/clients/client-lookoutequipment/src/commands/DescribeDatasetCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DescribeDatasetCommand.ts @@ -128,8 +128,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _ *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DescribeInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/src/commands/DescribeInferenceSchedulerCommand.ts index d36af6b0e153..214312553900 100644 --- a/clients/client-lookoutequipment/src/commands/DescribeInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DescribeInferenceSchedulerCommand.ts @@ -106,8 +106,8 @@ export interface DescribeInferenceSchedulerCommandOutput extends DescribeInferen *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DescribeLabelCommand.ts b/clients/client-lookoutequipment/src/commands/DescribeLabelCommand.ts index 9257bac26874..a6204db73cb3 100644 --- a/clients/client-lookoutequipment/src/commands/DescribeLabelCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DescribeLabelCommand.ts @@ -36,9 +36,7 @@ export interface DescribeLabelCommandOutput extends DescribeLabelResponse, __Met /** * @public - *- * Returns the name of the label. - *
+ *Returns the name of the label.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -88,8 +86,8 @@ export interface DescribeLabelCommandOutput extends DescribeLabelResponse, __Met *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DescribeLabelGroupCommand.ts b/clients/client-lookoutequipment/src/commands/DescribeLabelGroupCommand.ts index d2d62496603e..57799ec550b6 100644 --- a/clients/client-lookoutequipment/src/commands/DescribeLabelGroupCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DescribeLabelGroupCommand.ts @@ -36,9 +36,7 @@ export interface DescribeLabelGroupCommandOutput extends DescribeLabelGroupRespo /** * @public - *- * Returns information about the label group. - *
+ *Returns information about the label group.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -84,8 +82,8 @@ export interface DescribeLabelGroupCommandOutput extends DescribeLabelGroupRespo *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DescribeModelCommand.ts b/clients/client-lookoutequipment/src/commands/DescribeModelCommand.ts index 05f0d7f7eea8..aa2418cccd31 100644 --- a/clients/client-lookoutequipment/src/commands/DescribeModelCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DescribeModelCommand.ts @@ -36,9 +36,9 @@ export interface DescribeModelCommandOutput extends DescribeModelResponse, __Met /** * @public - *Provides a JSON containing the overall information about a specific ML model, including - * model name and ARN, dataset, training and evaluation information, status, and so on. - *
+ *Provides a JSON containing the overall information about a specific machine learning + * model, including model name and ARN, dataset, training and evaluation information, status, + * and so on.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -89,6 +89,16 @@ export interface DescribeModelCommandOutput extends DescribeModelResponse, __Met * // PreviousActiveModelVersion: Number("long"), * // PreviousActiveModelVersionArn: "STRING_VALUE", * // PreviousModelVersionActivatedAt: new Date("TIMESTAMP"), + * // PriorModelMetrics: "STRING_VALUE", + * // LatestScheduledRetrainingFailedReason: "STRING_VALUE", + * // LatestScheduledRetrainingStatus: "IN_PROGRESS" || "SUCCESS" || "FAILED" || "IMPORT_IN_PROGRESS" || "CANCELED", + * // LatestScheduledRetrainingModelVersion: Number("long"), + * // LatestScheduledRetrainingStartTime: new Date("TIMESTAMP"), + * // LatestScheduledRetrainingAvailableDataInDays: Number("int"), + * // NextScheduledRetrainingStartDate: new Date("TIMESTAMP"), + * // AccumulatedInferenceDataStartTime: new Date("TIMESTAMP"), + * // AccumulatedInferenceDataEndTime: new Date("TIMESTAMP"), + * // RetrainingSchedulerStatus: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED", * // }; * * ``` @@ -115,8 +125,8 @@ export interface DescribeModelCommandOutput extends DescribeModelResponse, __Met *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DescribeModelVersionCommand.ts b/clients/client-lookoutequipment/src/commands/DescribeModelVersionCommand.ts index 022ede255de1..d5b94845c346 100644 --- a/clients/client-lookoutequipment/src/commands/DescribeModelVersionCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DescribeModelVersionCommand.ts @@ -86,6 +86,10 @@ export interface DescribeModelVersionCommandOutput extends DescribeModelVersionR * // ImportJobStartTime: new Date("TIMESTAMP"), * // ImportJobEndTime: new Date("TIMESTAMP"), * // ImportedDataSizeInBytes: Number("long"), + * // PriorModelMetrics: "STRING_VALUE", + * // RetrainingAvailableDataInDays: Number("int"), + * // AutoPromotionResult: "MODEL_PROMOTED" || "MODEL_NOT_PROMOTED" || "RETRAINING_INTERNAL_ERROR" || "RETRAINING_CUSTOMER_ERROR" || "RETRAINING_CANCELLED", + * // AutoPromotionResultReason: "STRING_VALUE", * // }; * * ``` @@ -112,8 +116,8 @@ export interface DescribeModelVersionCommandOutput extends DescribeModelVersionR *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DescribeResourcePolicyCommand.ts b/clients/client-lookoutequipment/src/commands/DescribeResourcePolicyCommand.ts index 02379cdea75b..448045118123 100644 --- a/clients/client-lookoutequipment/src/commands/DescribeResourcePolicyCommand.ts +++ b/clients/client-lookoutequipment/src/commands/DescribeResourcePolicyCommand.ts @@ -79,8 +79,8 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/DescribeRetrainingSchedulerCommand.ts b/clients/client-lookoutequipment/src/commands/DescribeRetrainingSchedulerCommand.ts new file mode 100644 index 000000000000..9f2b2abb1467 --- /dev/null +++ b/clients/client-lookoutequipment/src/commands/DescribeRetrainingSchedulerCommand.ts @@ -0,0 +1,199 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient"; +import { DescribeRetrainingSchedulerRequest, DescribeRetrainingSchedulerResponse } from "../models/models_0"; +import { de_DescribeRetrainingSchedulerCommand, se_DescribeRetrainingSchedulerCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DescribeRetrainingSchedulerCommand}. + */ +export interface DescribeRetrainingSchedulerCommandInput extends DescribeRetrainingSchedulerRequest {} +/** + * @public + * + * The output of {@link DescribeRetrainingSchedulerCommand}. + */ +export interface DescribeRetrainingSchedulerCommandOutput + extends DescribeRetrainingSchedulerResponse, + __MetadataBearer {} + +/** + * @public + *Provides a description of the retraining scheduler, including information such as the + * model name and retraining parameters.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, DescribeRetrainingSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, DescribeRetrainingSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const input = { // DescribeRetrainingSchedulerRequest + * ModelName: "STRING_VALUE", // required + * }; + * const command = new DescribeRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * // { // DescribeRetrainingSchedulerResponse + * // ModelName: "STRING_VALUE", + * // ModelArn: "STRING_VALUE", + * // RetrainingStartDate: new Date("TIMESTAMP"), + * // RetrainingFrequency: "STRING_VALUE", + * // LookbackWindow: "STRING_VALUE", + * // Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED", + * // PromoteMode: "MANAGED" || "MANUAL", + * // CreatedAt: new Date("TIMESTAMP"), + * // UpdatedAt: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param DescribeRetrainingSchedulerCommandInput - {@link DescribeRetrainingSchedulerCommandInput} + * @returns {@link DescribeRetrainingSchedulerCommandOutput} + * @see {@link DescribeRetrainingSchedulerCommandInput} for command's `input` shape. + * @see {@link DescribeRetrainingSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request could not be completed because you do not have access to the resource. + *
+ * + * @throws {@link InternalServerException} (server fault) + *Processing of the request has failed because of an unknown error, exception or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource requested could not be found. Verify the resource ID and retry your + * request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
+ * + * @throws {@link LookoutEquipmentServiceException} + *Base exception class for all service exceptions from LookoutEquipment service.
+ * + * @example Describes a retraining scheduler + * ```javascript + * // + * const input = { + * "ModelName": "sample-model" + * }; + * const command = new DescribeRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "CreatedAt": "2023-10-01T15:00:00Z", + * "LookbackWindow": "P360D", + * "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + * "ModelName": "sample-model", + * "PromoteMode": "MANAGED", + * "RetrainingFrequency": "P1M", + * "RetrainingStartDate": "2023-11-01T00:00:00Z", + * "Status": "RUNNING", + * "UpdatedAt": "2023-10-01T15:00:00Z" + * } + * *\/ + * // example id: describes-a-retraining-scheduler-1694019344252 + * ``` + * + */ +export class DescribeRetrainingSchedulerCommand extends $Command< + DescribeRetrainingSchedulerCommandInput, + DescribeRetrainingSchedulerCommandOutput, + LookoutEquipmentClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeRetrainingSchedulerCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ImportModelVersionCommand.ts b/clients/client-lookoutequipment/src/commands/ImportModelVersionCommand.ts index 93a04855b6db..48b2358da2f8 100644 --- a/clients/client-lookoutequipment/src/commands/ImportModelVersionCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ImportModelVersionCommand.ts @@ -63,6 +63,7 @@ export interface ImportModelVersionCommandOutput extends ImportModelVersionRespo * Value: "STRING_VALUE", // required * }, * ], + * InferenceDataImportStrategy: "NO_IMPORT" || "ADD_WHEN_EMPTY" || "OVERWRITE", * }; * const command = new ImportModelVersionCommand(input); * const response = await client.send(command); @@ -105,8 +106,8 @@ export interface ImportModelVersionCommandOutput extends ImportModelVersionRespo *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListDataIngestionJobsCommand.ts b/clients/client-lookoutequipment/src/commands/ListDataIngestionJobsCommand.ts index bac0b7743801..c7fcab3bd77f 100644 --- a/clients/client-lookoutequipment/src/commands/ListDataIngestionJobsCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListDataIngestionJobsCommand.ts @@ -91,8 +91,8 @@ export interface ListDataIngestionJobsCommandOutput extends ListDataIngestionJob *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListDatasetsCommand.ts b/clients/client-lookoutequipment/src/commands/ListDatasetsCommand.ts index 6e8f698300e8..5e4191e36ea1 100644 --- a/clients/client-lookoutequipment/src/commands/ListDatasetsCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListDatasetsCommand.ts @@ -83,8 +83,8 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListInferenceEventsCommand.ts b/clients/client-lookoutequipment/src/commands/ListInferenceEventsCommand.ts index 6381cd5d6ff0..93a4503d9e56 100644 --- a/clients/client-lookoutequipment/src/commands/ListInferenceEventsCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListInferenceEventsCommand.ts @@ -91,8 +91,8 @@ export interface ListInferenceEventsCommandOutput extends ListInferenceEventsRes *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListInferenceExecutionsCommand.ts b/clients/client-lookoutequipment/src/commands/ListInferenceExecutionsCommand.ts index ccaad2c33dcd..2aa1cbd5e732 100644 --- a/clients/client-lookoutequipment/src/commands/ListInferenceExecutionsCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListInferenceExecutionsCommand.ts @@ -89,6 +89,8 @@ export interface ListInferenceExecutionsCommandOutput extends ListInferenceExecu * // }, * // Status: "IN_PROGRESS" || "SUCCESS" || "FAILED", * // FailedReason: "STRING_VALUE", + * // ModelVersion: Number("long"), + * // ModelVersionArn: "STRING_VALUE", * // }, * // ], * // }; @@ -117,8 +119,8 @@ export interface ListInferenceExecutionsCommandOutput extends ListInferenceExecu *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListInferenceSchedulersCommand.ts b/clients/client-lookoutequipment/src/commands/ListInferenceSchedulersCommand.ts index 7e0477a74b69..e5559bb83441 100644 --- a/clients/client-lookoutequipment/src/commands/ListInferenceSchedulersCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListInferenceSchedulersCommand.ts @@ -89,8 +89,8 @@ export interface ListInferenceSchedulersCommandOutput extends ListInferenceSched *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListLabelGroupsCommand.ts b/clients/client-lookoutequipment/src/commands/ListLabelGroupsCommand.ts index bbd15f38a704..52dc661e38c1 100644 --- a/clients/client-lookoutequipment/src/commands/ListLabelGroupsCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListLabelGroupsCommand.ts @@ -36,9 +36,7 @@ export interface ListLabelGroupsCommandOutput extends ListLabelGroupsResponse, _ /** * @public - *- * Returns a list of the label groups. - *
+ *Returns a list of the label groups.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -84,8 +82,8 @@ export interface ListLabelGroupsCommandOutput extends ListLabelGroupsResponse, _ *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListLabelsCommand.ts b/clients/client-lookoutequipment/src/commands/ListLabelsCommand.ts index 385f0e5ccdce..44888e75e4cf 100644 --- a/clients/client-lookoutequipment/src/commands/ListLabelsCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListLabelsCommand.ts @@ -36,9 +36,7 @@ export interface ListLabelsCommandOutput extends ListLabelsResponse, __MetadataB /** * @public - *- * Provides a list of labels. - *
+ *Provides a list of labels.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -93,8 +91,8 @@ export interface ListLabelsCommandOutput extends ListLabelsResponse, __MetadataB *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListModelVersionsCommand.ts b/clients/client-lookoutequipment/src/commands/ListModelVersionsCommand.ts index 1403744c9cd3..65afdba66de3 100644 --- a/clients/client-lookoutequipment/src/commands/ListModelVersionsCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListModelVersionsCommand.ts @@ -36,9 +36,9 @@ export interface ListModelVersionsCommandOutput extends ListModelVersionsRespons /** * @public - *Generates a list of all model versions for a given model,
- * including the model version, model version ARN, and status. To list a
- * subset of versions, use the MaxModelVersion
and MinModelVersion
fields.
Generates a list of all model versions for a given model, including the model version,
+ * model version ARN, and status. To list a subset of versions, use the
+ * MaxModelVersion
and MinModelVersion
fields.
The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListModelsCommand.ts b/clients/client-lookoutequipment/src/commands/ListModelsCommand.ts index dd650fa2d479..9d4fe8c24625 100644 --- a/clients/client-lookoutequipment/src/commands/ListModelsCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListModelsCommand.ts @@ -65,6 +65,11 @@ export interface ListModelsCommandOutput extends ListModelsResponse, __MetadataB * // CreatedAt: new Date("TIMESTAMP"), * // ActiveModelVersion: Number("long"), * // ActiveModelVersionArn: "STRING_VALUE", + * // LatestScheduledRetrainingStatus: "IN_PROGRESS" || "SUCCESS" || "FAILED" || "IMPORT_IN_PROGRESS" || "CANCELED", + * // LatestScheduledRetrainingModelVersion: Number("long"), + * // LatestScheduledRetrainingStartTime: new Date("TIMESTAMP"), + * // NextScheduledRetrainingStartDate: new Date("TIMESTAMP"), + * // RetrainingSchedulerStatus: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED", * // }, * // ], * // }; @@ -89,8 +94,8 @@ export interface ListModelsCommandOutput extends ListModelsResponse, __MetadataB *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListRetrainingSchedulersCommand.ts b/clients/client-lookoutequipment/src/commands/ListRetrainingSchedulersCommand.ts new file mode 100644 index 000000000000..babecae22ab2 --- /dev/null +++ b/clients/client-lookoutequipment/src/commands/ListRetrainingSchedulersCommand.ts @@ -0,0 +1,212 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient"; +import { ListRetrainingSchedulersRequest, ListRetrainingSchedulersResponse } from "../models/models_0"; +import { de_ListRetrainingSchedulersCommand, se_ListRetrainingSchedulersCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListRetrainingSchedulersCommand}. + */ +export interface ListRetrainingSchedulersCommandInput extends ListRetrainingSchedulersRequest {} +/** + * @public + * + * The output of {@link ListRetrainingSchedulersCommand}. + */ +export interface ListRetrainingSchedulersCommandOutput extends ListRetrainingSchedulersResponse, __MetadataBearer {} + +/** + * @public + *Lists all retraining schedulers in your account, filtering by model name prefix and + * status.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, ListRetrainingSchedulersCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, ListRetrainingSchedulersCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const input = { // ListRetrainingSchedulersRequest + * ModelNameBeginsWith: "STRING_VALUE", + * Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED", + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListRetrainingSchedulersCommand(input); + * const response = await client.send(command); + * // { // ListRetrainingSchedulersResponse + * // RetrainingSchedulerSummaries: [ // RetrainingSchedulerSummaries + * // { // RetrainingSchedulerSummary + * // ModelName: "STRING_VALUE", + * // ModelArn: "STRING_VALUE", + * // Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED", + * // RetrainingStartDate: new Date("TIMESTAMP"), + * // RetrainingFrequency: "STRING_VALUE", + * // LookbackWindow: "STRING_VALUE", + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListRetrainingSchedulersCommandInput - {@link ListRetrainingSchedulersCommandInput} + * @returns {@link ListRetrainingSchedulersCommandOutput} + * @see {@link ListRetrainingSchedulersCommandInput} for command's `input` shape. + * @see {@link ListRetrainingSchedulersCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request could not be completed because you do not have access to the resource. + *
+ * + * @throws {@link InternalServerException} (server fault) + *Processing of the request has failed because of an unknown error, exception or failure. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
+ * + * @throws {@link LookoutEquipmentServiceException} + *Base exception class for all service exceptions from LookoutEquipment service.
+ * + * @example Listing retraining schedulers + * ```javascript + * // + * const input = { + * "MaxResults": 50 + * }; + * const command = new ListRetrainingSchedulersCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "RetrainingSchedulerSummaries": [ + * { + * "LookbackWindow": "P180D", + * "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-1/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + * "ModelName": "sample-model-1", + * "RetrainingFrequency": "P1M", + * "RetrainingStartDate": "2023-06-01T00:00:00Z", + * "Status": "RUNNING" + * }, + * { + * "LookbackWindow": "P180D", + * "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-2/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + * "ModelName": "sample-model-2", + * "RetrainingFrequency": "P30D", + * "RetrainingStartDate": "2023-08-15T00:00:00Z", + * "Status": "RUNNING" + * }, + * { + * "LookbackWindow": "P360D", + * "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-3/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + * "ModelName": "sample-model-3", + * "RetrainingFrequency": "P1M", + * "RetrainingStartDate": "2023-09-01T00:00:00Z", + * "Status": "STOPPED" + * } + * ] + * } + * *\/ + * // example id: listing-retraining-schedulers-1694016740503 + * ``` + * + */ +export class ListRetrainingSchedulersCommand extends $Command< + ListRetrainingSchedulersCommandInput, + ListRetrainingSchedulersCommandOutput, + LookoutEquipmentClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListRetrainingSchedulersCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/ListTagsForResourceCommand.ts b/clients/client-lookoutequipment/src/commands/ListTagsForResourceCommand.ts index 891a81595b34..b1f3ad6e5659 100644 --- a/clients/client-lookoutequipment/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-lookoutequipment/src/commands/ListTagsForResourceCommand.ts @@ -81,8 +81,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/PutResourcePolicyCommand.ts b/clients/client-lookoutequipment/src/commands/PutResourcePolicyCommand.ts index bbb47c259d0a..6ea04861c421 100644 --- a/clients/client-lookoutequipment/src/commands/PutResourcePolicyCommand.ts +++ b/clients/client-lookoutequipment/src/commands/PutResourcePolicyCommand.ts @@ -87,8 +87,8 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/StartDataIngestionJobCommand.ts b/clients/client-lookoutequipment/src/commands/StartDataIngestionJobCommand.ts index e8190c403eb4..cd9588a5cd45 100644 --- a/clients/client-lookoutequipment/src/commands/StartDataIngestionJobCommand.ts +++ b/clients/client-lookoutequipment/src/commands/StartDataIngestionJobCommand.ts @@ -36,8 +36,7 @@ export interface StartDataIngestionJobCommandOutput extends StartDataIngestionJo /** * @public - *Starts a data ingestion job. Amazon Lookout for Equipment returns the job status. - *
+ *Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -94,8 +93,8 @@ export interface StartDataIngestionJobCommandOutput extends StartDataIngestionJo *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/StartInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/src/commands/StartInferenceSchedulerCommand.ts index d2d954b1f361..4e16df720674 100644 --- a/clients/client-lookoutequipment/src/commands/StartInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/src/commands/StartInferenceSchedulerCommand.ts @@ -84,8 +84,8 @@ export interface StartInferenceSchedulerCommandOutput extends StartInferenceSche *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/StartRetrainingSchedulerCommand.ts b/clients/client-lookoutequipment/src/commands/StartRetrainingSchedulerCommand.ts new file mode 100644 index 000000000000..26cb119b47c6 --- /dev/null +++ b/clients/client-lookoutequipment/src/commands/StartRetrainingSchedulerCommand.ts @@ -0,0 +1,185 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient"; +import { StartRetrainingSchedulerRequest, StartRetrainingSchedulerResponse } from "../models/models_0"; +import { de_StartRetrainingSchedulerCommand, se_StartRetrainingSchedulerCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link StartRetrainingSchedulerCommand}. + */ +export interface StartRetrainingSchedulerCommandInput extends StartRetrainingSchedulerRequest {} +/** + * @public + * + * The output of {@link StartRetrainingSchedulerCommand}. + */ +export interface StartRetrainingSchedulerCommandOutput extends StartRetrainingSchedulerResponse, __MetadataBearer {} + +/** + * @public + *Starts a retraining scheduler.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, StartRetrainingSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, StartRetrainingSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const input = { // StartRetrainingSchedulerRequest + * ModelName: "STRING_VALUE", // required + * }; + * const command = new StartRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * // { // StartRetrainingSchedulerResponse + * // ModelName: "STRING_VALUE", + * // ModelArn: "STRING_VALUE", + * // Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED", + * // }; + * + * ``` + * + * @param StartRetrainingSchedulerCommandInput - {@link StartRetrainingSchedulerCommandInput} + * @returns {@link StartRetrainingSchedulerCommandOutput} + * @see {@link StartRetrainingSchedulerCommandInput} for command's `input` shape. + * @see {@link StartRetrainingSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request could not be completed because you do not have access to the resource. + *
+ * + * @throws {@link ConflictException} (client fault) + *The request could not be completed due to a conflict with the current state of the + * target resource.
+ * + * @throws {@link InternalServerException} (server fault) + *Processing of the request has failed because of an unknown error, exception or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource requested could not be found. Verify the resource ID and retry your + * request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
+ * + * @throws {@link LookoutEquipmentServiceException} + *Base exception class for all service exceptions from LookoutEquipment service.
+ * + * @example Starts a retraining scheduler + * ```javascript + * // + * const input = { + * "ModelName": "sample-model" + * }; + * const command = new StartRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + * "ModelName": "sample-model", + * "Status": "PENDING" + * } + * *\/ + * // example id: starts-a-retraining-scheduler-1694019629413 + * ``` + * + */ +export class StartRetrainingSchedulerCommand extends $Command< + StartRetrainingSchedulerCommandInput, + StartRetrainingSchedulerCommandOutput, + LookoutEquipmentClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartRetrainingSchedulerCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/StopRetrainingSchedulerCommand.ts b/clients/client-lookoutequipment/src/commands/StopRetrainingSchedulerCommand.ts new file mode 100644 index 000000000000..4b5fafdfa9f5 --- /dev/null +++ b/clients/client-lookoutequipment/src/commands/StopRetrainingSchedulerCommand.ts @@ -0,0 +1,185 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient"; +import { StopRetrainingSchedulerRequest, StopRetrainingSchedulerResponse } from "../models/models_0"; +import { de_StopRetrainingSchedulerCommand, se_StopRetrainingSchedulerCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link StopRetrainingSchedulerCommand}. + */ +export interface StopRetrainingSchedulerCommandInput extends StopRetrainingSchedulerRequest {} +/** + * @public + * + * The output of {@link StopRetrainingSchedulerCommand}. + */ +export interface StopRetrainingSchedulerCommandOutput extends StopRetrainingSchedulerResponse, __MetadataBearer {} + +/** + * @public + *Stops a retraining scheduler.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, StopRetrainingSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, StopRetrainingSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const input = { // StopRetrainingSchedulerRequest + * ModelName: "STRING_VALUE", // required + * }; + * const command = new StopRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * // { // StopRetrainingSchedulerResponse + * // ModelName: "STRING_VALUE", + * // ModelArn: "STRING_VALUE", + * // Status: "PENDING" || "RUNNING" || "STOPPING" || "STOPPED", + * // }; + * + * ``` + * + * @param StopRetrainingSchedulerCommandInput - {@link StopRetrainingSchedulerCommandInput} + * @returns {@link StopRetrainingSchedulerCommandOutput} + * @see {@link StopRetrainingSchedulerCommandInput} for command's `input` shape. + * @see {@link StopRetrainingSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request could not be completed because you do not have access to the resource. + *
+ * + * @throws {@link ConflictException} (client fault) + *The request could not be completed due to a conflict with the current state of the + * target resource.
+ * + * @throws {@link InternalServerException} (server fault) + *Processing of the request has failed because of an unknown error, exception or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource requested could not be found. Verify the resource ID and retry your + * request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
+ * + * @throws {@link LookoutEquipmentServiceException} + *Base exception class for all service exceptions from LookoutEquipment service.
+ * + * @example Stops a retraining scheduler + * ```javascript + * // + * const input = { + * "ModelName": "sample-model" + * }; + * const command = new StopRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + * "ModelName": "sample-model", + * "Status": "STOPPING" + * } + * *\/ + * // example id: stops-a-retraining-scheduler-1694019734149 + * ``` + * + */ +export class StopRetrainingSchedulerCommand extends $Command< + StopRetrainingSchedulerCommandInput, + StopRetrainingSchedulerCommandOutput, + LookoutEquipmentClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StopRetrainingSchedulerCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAssociates a given tag to a resource in your account. A tag is a key-value pair which - * can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for - * organizing your resources as well as helping you to search and filter by tag. Multiple tags - * can be added to a resource, either when you create it, or later. Up to 50 tags can be - * associated with each resource.
+ * can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your + * resources as well as helping you to search and filter by tag. Multiple tags can be added to + * a resource, either when you create it, or later. Up to 50 tags can be associated with each + * resource. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -87,8 +87,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/UntagResourceCommand.ts b/clients/client-lookoutequipment/src/commands/UntagResourceCommand.ts index 6ca960c60c55..550c14798692 100644 --- a/clients/client-lookoutequipment/src/commands/UntagResourceCommand.ts +++ b/clients/client-lookoutequipment/src/commands/UntagResourceCommand.ts @@ -77,8 +77,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/UpdateActiveModelVersionCommand.ts b/clients/client-lookoutequipment/src/commands/UpdateActiveModelVersionCommand.ts index 621367c6acdd..3cc747632ad8 100644 --- a/clients/client-lookoutequipment/src/commands/UpdateActiveModelVersionCommand.ts +++ b/clients/client-lookoutequipment/src/commands/UpdateActiveModelVersionCommand.ts @@ -86,8 +86,8 @@ export interface UpdateActiveModelVersionCommandOutput extends UpdateActiveModel *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/UpdateInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/src/commands/UpdateInferenceSchedulerCommand.ts index a70a19c493f2..aa9ef1d8f747 100644 --- a/clients/client-lookoutequipment/src/commands/UpdateInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/src/commands/UpdateInferenceSchedulerCommand.ts @@ -99,8 +99,8 @@ export interface UpdateInferenceSchedulerCommandOutput extends __MetadataBearer *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/UpdateLabelGroupCommand.ts b/clients/client-lookoutequipment/src/commands/UpdateLabelGroupCommand.ts index 66050ff8d792..ea4d390bb749 100644 --- a/clients/client-lookoutequipment/src/commands/UpdateLabelGroupCommand.ts +++ b/clients/client-lookoutequipment/src/commands/UpdateLabelGroupCommand.ts @@ -36,9 +36,7 @@ export interface UpdateLabelGroupCommandOutput extends __MetadataBearer {} /** * @public - *- * Updates the label group. - *
+ *Updates the label group.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -83,8 +81,8 @@ export interface UpdateLabelGroupCommandOutput extends __MetadataBearer {} *The request was denied due to request throttling.
* * @throws {@link ValidationException} (client fault) - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
* * @throws {@link LookoutEquipmentServiceException} *Base exception class for all service exceptions from LookoutEquipment service.
diff --git a/clients/client-lookoutequipment/src/commands/UpdateModelCommand.ts b/clients/client-lookoutequipment/src/commands/UpdateModelCommand.ts new file mode 100644 index 000000000000..7411c849a333 --- /dev/null +++ b/clients/client-lookoutequipment/src/commands/UpdateModelCommand.ts @@ -0,0 +1,183 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient"; +import { UpdateModelRequest } from "../models/models_0"; +import { de_UpdateModelCommand, se_UpdateModelCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UpdateModelCommand}. + */ +export interface UpdateModelCommandInput extends UpdateModelRequest {} +/** + * @public + * + * The output of {@link UpdateModelCommand}. + */ +export interface UpdateModelCommandOutput extends __MetadataBearer {} + +/** + * @public + *Updates a model in the account.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, UpdateModelCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, UpdateModelCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const input = { // UpdateModelRequest + * ModelName: "STRING_VALUE", // required + * LabelsInputConfiguration: { // LabelsInputConfiguration + * S3InputConfiguration: { // LabelsS3InputConfiguration + * Bucket: "STRING_VALUE", // required + * Prefix: "STRING_VALUE", + * }, + * LabelGroupName: "STRING_VALUE", + * }, + * RoleArn: "STRING_VALUE", + * }; + * const command = new UpdateModelCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateModelCommandInput - {@link UpdateModelCommandInput} + * @returns {@link UpdateModelCommandOutput} + * @see {@link UpdateModelCommandInput} for command's `input` shape. + * @see {@link UpdateModelCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request could not be completed because you do not have access to the resource. + *
+ * + * @throws {@link ConflictException} (client fault) + *The request could not be completed due to a conflict with the current state of the + * target resource.
+ * + * @throws {@link InternalServerException} (server fault) + *Processing of the request has failed because of an unknown error, exception or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource requested could not be found. Verify the resource ID and retry your + * request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
+ * + * @throws {@link LookoutEquipmentServiceException} + *Base exception class for all service exceptions from LookoutEquipment service.
+ * + * @example Updates a model + * ```javascript + * // + * const input = { + * "LabelsInputConfiguration": { + * "LabelGroupName": "sample-label-group" + * }, + * "ModelName": "sample-model" + * }; + * const command = new UpdateModelCommand(input); + * await client.send(command); + * // example id: updates-a-model-1694020683458 + * ``` + * + */ +export class UpdateModelCommand extends $Command< + UpdateModelCommandInput, + UpdateModelCommandOutput, + LookoutEquipmentClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateModelCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates a retraining scheduler.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, UpdateRetrainingSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, UpdateRetrainingSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const input = { // UpdateRetrainingSchedulerRequest + * ModelName: "STRING_VALUE", // required + * RetrainingStartDate: new Date("TIMESTAMP"), + * RetrainingFrequency: "STRING_VALUE", + * LookbackWindow: "STRING_VALUE", + * PromoteMode: "MANAGED" || "MANUAL", + * }; + * const command = new UpdateRetrainingSchedulerCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateRetrainingSchedulerCommandInput - {@link UpdateRetrainingSchedulerCommandInput} + * @returns {@link UpdateRetrainingSchedulerCommandOutput} + * @see {@link UpdateRetrainingSchedulerCommandInput} for command's `input` shape. + * @see {@link UpdateRetrainingSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request could not be completed because you do not have access to the resource. + *
+ * + * @throws {@link ConflictException} (client fault) + *The request could not be completed due to a conflict with the current state of the + * target resource.
+ * + * @throws {@link InternalServerException} (server fault) + *Processing of the request has failed because of an unknown error, exception or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource requested could not be found. Verify the resource ID and retry your + * request.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
+ * + * @throws {@link LookoutEquipmentServiceException} + *Base exception class for all service exceptions from LookoutEquipment service.
+ * + * @example Updates a retraining scheduler + * ```javascript + * // + * const input = { + * "ModelName": "sample-model", + * "RetrainingFrequency": "P1Y", + * "RetrainingStartDate": "2024-01-01T00:00:00Z" + * }; + * const command = new UpdateRetrainingSchedulerCommand(input); + * await client.send(command); + * // example id: updates-a-retraining-scheduler-1694019840918 + * ``` + * + */ +export class UpdateRetrainingSchedulerCommand extends $Command< + UpdateRetrainingSchedulerCommandInput, + UpdateRetrainingSchedulerCommandOutput, + LookoutEquipmentClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateRetrainingSchedulerCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe request could not be completed due to a conflict with the current state of the @@ -59,8 +76,7 @@ export class ConflictException extends __BaseException { export interface DatasetSchema { /** * @public - *
- *
+ *The data schema used within the given dataset.
*/ InlineDataSchema?: __LazyJsonString | string; } @@ -229,8 +245,8 @@ export class ThrottlingException extends __BaseException { /** * @public - *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a - * related Amazon Web Services service that's being utilized.
+ *The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services + * service that's being utilized.
*/ export class ValidationException extends __BaseException { readonly name: "ValidationException" = "ValidationException"; @@ -379,8 +395,8 @@ export type DataUploadFrequency = (typeof DataUploadFrequency)[keyof typeof Data export interface CreateInferenceSchedulerRequest { /** * @public - *The name of the previously trained ML model being used to create the inference - * scheduler.
+ *The name of the previously trained machine learning model being used to create the + * inference scheduler.
*/ ModelName: string | undefined; @@ -393,20 +409,25 @@ export interface CreateInferenceSchedulerRequest { /** * @public *The interval (in minutes) of planned delay at the start of each inference segment. For - * example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the - * configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 - * bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and - * restart the scheduler when uploading new data.
- *For more information, see Understanding the inference process.
+ * example, if inference is set to run every ten minutes, the delay is set to five minutes and + * the time is 09:08. The inference scheduler will wake up at the configured interval (which, + * without a delay configured, would be 09:10) plus the additional five minute delay time (so + * 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the + * same frequency, so that you don't have to stop and restart the scheduler when uploading new + * data. + *For more information, see Understanding + * the inference process.
*/ DataDelayOffsetInMinutes?: number; /** * @public - *How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen - * is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 - * minutes. This frequency also determines how often Amazon Lookout for Equipment runs inference on your data.
- *For more information, see Understanding the inference process.
+ *How often data is uploaded to the source Amazon S3 bucket for the input data. The value + * chosen is the length of time between data uploads. For instance, if you select 5 minutes, + * Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This + * frequency also determines how often Amazon Lookout for Equipment runs inference on your data.
+ *For more information, see Understanding + * the inference process.
*/ DataUploadFrequency: DataUploadFrequency | string | undefined; @@ -535,69 +556,59 @@ export type LabelRating = (typeof LabelRating)[keyof typeof LabelRating]; export interface CreateLabelRequest { /** * @public - *- * The name of a group of labels.
- *Data in this field will be retained for service usage. Follow best practices for the security of your data. - *
+ *The name of a group of labels.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ LabelGroupName: string | undefined; /** * @public - *- * The start time of the labeled event. - *
+ *The start time of the labeled event.
*/ StartTime: Date | undefined; /** * @public - *- * The end time of the labeled event. - *
+ *The end time of the labeled event.
*/ EndTime: Date | undefined; /** * @public - *- * Indicates whether a labeled event represents an anomaly. - *
+ *Indicates whether a labeled event represents an anomaly.
*/ Rating: LabelRating | string | undefined; /** * @public - *- * Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.
- *Data in this field will be retained for service usage. Follow best practices for the security of your data. - *
+ *Provides additional information about the label. The fault code must be defined in the + * FaultCodes attribute of the label group.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ FaultCode?: string; /** * @public - *- * Metadata providing additional information about the label. - *
- *Data in this field will be retained for service usage. Follow best practices for the security of your data.
+ *Metadata providing additional information about the label.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ Notes?: string; /** * @public - *- * Indicates that a label pertains to a particular piece of equipment. - *
- *Data in this field will be retained for service usage. Follow best practices for the security of your data.
+ *Indicates that a label pertains to a particular piece of equipment.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ Equipment?: string; /** * @public - *- * A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one. - *
+ *A unique identifier for the request to create a label. If you do not set the client + * request token, Lookout for Equipment generates one.
*/ ClientToken?: string; } @@ -608,9 +619,7 @@ export interface CreateLabelRequest { export interface CreateLabelResponse { /** * @public - *- * The ID of the label that you have created. - *
+ *The ID of the label that you have created.
*/ LabelId?: string; } @@ -621,35 +630,33 @@ export interface CreateLabelResponse { export interface CreateLabelGroupRequest { /** * @public - *- * Names a group of labels.
- *Data in this field will be retained for service usage. Follow best practices for the security of your data. - *
+ *Names a group of labels.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ LabelGroupName: string | undefined; /** * @public - *- * The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.
- *Data in this field will be retained for service usage. Follow best practices for the security of your data.
+ *The acceptable fault codes (indicating the type of anomaly associated with the label) + * that can be used with this label group.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ FaultCodes?: string[]; /** * @public - *- * A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one. - *
+ *A unique identifier for the request to create a label group. If you do not set the + * client request token, Lookout for Equipment generates one.
*/ ClientToken?: string; /** * @public - *- * Tags that provide metadata about the label group you are creating. - *
- *Data in this field will be retained for service usage. Follow best practices for the security of your data.
+ *Tags that provide metadata about the label group you are creating.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ Tags?: Tag[]; } @@ -660,17 +667,14 @@ export interface CreateLabelGroupRequest { export interface CreateLabelGroupResponse { /** * @public - *- * The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data. - *
+ *The name of the label group that you have created. Data in this field will be retained + * for service usage. Follow best practices for the security of your data.
*/ LabelGroupName?: string; /** * @public - *- * The Amazon Resource Name (ARN) of the label group that you have created. - *
+ *The Amazon Resource Name (ARN) of the label group that you have created.
*/ LabelGroupArn?: string; } @@ -701,10 +705,9 @@ export type TargetSamplingRate = (typeof TargetSamplingRate)[keyof typeof Target /** * @public *The configuration is the TargetSamplingRate
, which is the sampling rate of
- * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
- * data that has been collected at a 1 second level and you want the system to resample the
- * data at a 1 minute rate before training, the TargetSamplingRate
is 1
- * minute.
TargetSamplingRate
is 1 minute.
* When providing a value for the TargetSamplingRate
, you must attach the
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
* PT1S, the value for a 15 minute rate is PT15M,
@@ -714,10 +717,10 @@ export type TargetSamplingRate = (typeof TargetSamplingRate)[keyof typeof Target
export interface DataPreProcessingConfiguration {
/**
* @public
- *
The sampling rate of the data after post processing by Amazon Lookout for Equipment. For
- * example, if you provide data that has been collected at a 1 second level and you want the
- * system to resample the data at a 1 minute rate before training, the
- * TargetSamplingRate
is 1 minute.
The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you
+ * provide data that has been collected at a 1 second level and you want the system to
+ * resample the data at a 1 minute rate before training, the TargetSamplingRate
+ * is 1 minute.
When providing a value for the TargetSamplingRate
, you must attach the
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
* PT1S, the value for a 15 minute rate is PT15M,
@@ -760,9 +763,7 @@ export interface LabelsInputConfiguration {
/**
* @public
- *
- * The name of the label group to be used for label data. - *
+ *The name of the label group to be used for label data.
*/ LabelGroupName?: string; } @@ -773,26 +774,26 @@ export interface LabelsInputConfiguration { export interface CreateModelRequest { /** * @public - *The name for the ML model to be created.
+ *The name for the machine learning model to be created.
*/ ModelName: string | undefined; /** * @public - *The name of the dataset for the ML model being created.
+ *The name of the dataset for the machine learning model being created.
*/ DatasetName: string | undefined; /** * @public - *The data schema for the ML model being created.
+ *The data schema for the machine learning model being created.
*/ DatasetSchema?: DatasetSchema; /** * @public - *The input configuration for the labels being used for the ML model that's being created. - *
+ *The input configuration for the labels being used for the machine learning model that's + * being created.
*/ LabelsInputConfiguration?: LabelsInputConfiguration; @@ -806,45 +807,44 @@ export interface CreateModelRequest { /** * @public *Indicates the time reference in the dataset that should be used to begin the subset of - * training data for the ML model.
+ * training data for the machine learning model. */ TrainingDataStartTime?: Date; /** * @public *Indicates the time reference in the dataset that should be used to end the subset of - * training data for the ML model.
+ * training data for the machine learning model. */ TrainingDataEndTime?: Date; /** * @public *Indicates the time reference in the dataset that should be used to begin the subset of - * evaluation data for the ML model.
+ * evaluation data for the machine learning model. */ EvaluationDataStartTime?: Date; /** * @public *Indicates the time reference in the dataset that should be used to end the subset of - * evaluation data for the ML model.
+ * evaluation data for the machine learning model. */ EvaluationDataEndTime?: Date; /** * @public *The Amazon Resource Name (ARN) of a role with permission to access the data source - * being used to create the ML model.
+ * being used to create the machine learning model. */ RoleArn?: string; /** * @public *The configuration is the TargetSamplingRate
, which is the sampling rate of
- * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
- * data that has been collected at a 1 second level and you want the system to resample the
- * data at a 1 minute rate before training, the TargetSamplingRate
is 1
- * minute.
TargetSamplingRate
is 1 minute.
* When providing a value for the TargetSamplingRate
, you must attach the
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
* PT1S, the value for a 15 minute rate is PT15M,
@@ -862,7 +862,7 @@ export interface CreateModelRequest {
/**
* @public
- *
Any tags associated with the ML model being created.
+ *Any tags associated with the machine learning model being created.
*/ Tags?: Tag[]; @@ -908,6 +908,119 @@ export interface CreateModelResponse { Status?: ModelStatus | string; } +/** + * @public + * @enum + */ +export const ModelPromoteMode = { + MANAGED: "MANAGED", + MANUAL: "MANUAL", +} as const; + +/** + * @public + */ +export type ModelPromoteMode = (typeof ModelPromoteMode)[keyof typeof ModelPromoteMode]; + +/** + * @public + */ +export interface CreateRetrainingSchedulerRequest { + /** + * @public + *The name of the model to add the retraining scheduler to.
+ */ + ModelName: string | undefined; + + /** + * @public + *The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the + * nearest UTC day.
+ */ + RetrainingStartDate?: Date; + + /** + * @public + *This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in + * terms of Years, Months, and/or Days (note: other parameters like Time are not currently + * supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For + * example, the following values are valid:
+ *P3M15D – Every 3 months and 15 days
+ *P2M – Every 2 months
+ *P150D – Every 150 days
+ *The number of past days of data that will be used for retraining.
+ */ + LookbackWindow: string | undefined; + + /** + * @public + *Indicates how the service will use new models. In MANAGED
mode, new models
+ * will automatically be used for inference if they have better performance than the current
+ * model. In MANUAL
mode, the new models will not be used until they
+ * are manually activated.
A unique identifier for the request. If you do not set the client request token, Amazon + * Lookout for Equipment generates one.
+ */ + ClientToken?: string; +} + +/** + * @public + * @enum + */ +export const RetrainingSchedulerStatus = { + PENDING: "PENDING", + RUNNING: "RUNNING", + STOPPED: "STOPPED", + STOPPING: "STOPPING", +} as const; + +/** + * @public + */ +export type RetrainingSchedulerStatus = (typeof RetrainingSchedulerStatus)[keyof typeof RetrainingSchedulerStatus]; + +/** + * @public + */ +export interface CreateRetrainingSchedulerResponse { + /** + * @public + *The name of the model that you added the retraining scheduler to.
+ */ + ModelName?: string; + + /** + * @public + *The ARN of the model that you added the retraining scheduler to.
+ */ + ModelArn?: string; + + /** + * @public + *The status of the retraining scheduler.
+ */ + Status?: RetrainingSchedulerStatus | string; +} + /** * @public */ @@ -936,17 +1049,15 @@ export interface DeleteInferenceSchedulerRequest { export interface DeleteLabelRequest { /** * @public - *- * The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data. - *
+ *The name of the label group that contains the label that you want to delete. Data in + * this field will be retained for service usage. Follow best practices for the security of + * your data.
*/ LabelGroupName: string | undefined; /** * @public - *- * The ID of the label that you want to delete. - *
+ *The ID of the label that you want to delete.
*/ LabelId: string | undefined; } @@ -957,9 +1068,8 @@ export interface DeleteLabelRequest { export interface DeleteLabelGroupRequest { /** * @public - *- * The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data. - *
+ *The name of the label group that you want to delete. Data in this field will be + * retained for service usage. Follow best practices for the security of your data.
*/ LabelGroupName: string | undefined; } @@ -970,7 +1080,7 @@ export interface DeleteLabelGroupRequest { export interface DeleteModelRequest { /** * @public - *The name of the ML model to be deleted.
+ *The name of the machine learning model to be deleted.
*/ ModelName: string | undefined; } @@ -981,11 +1091,23 @@ export interface DeleteModelRequest { export interface DeleteResourcePolicyRequest { /** * @public - *The Amazon Resource Name (ARN) of the resource for which the resource policy should be deleted.
+ *The Amazon Resource Name (ARN) of the resource for which the resource policy should be + * deleted.
*/ ResourceArn: string | undefined; } +/** + * @public + */ +export interface DeleteRetrainingSchedulerRequest { + /** + * @public + *The name of the model whose retraining scheduler you want to delete.
+ */ + ModelName: string | undefined; +} + /** * @public */ @@ -1214,9 +1336,13 @@ export interface IngestionS3InputConfiguration { /** * @public - *- * The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern \{prefix\}/\{component_name\}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.
- *Valid Values: \{prefix\}/\{component_name\}_* | \{prefix\}/\{component_name\}/* | \{prefix\}/\{component_name\}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)
+ *The pattern for matching the Amazon S3 files that will be used for ingestion. + * If the schema was created previously without any KeyPattern, then the default KeyPattern + * \{prefix\}/\{component_name\}/* is used to download files from Amazon S3 according to + * the schema. This field is required when ingestion is being done for the first time.
+ *Valid Values: \{prefix\}/\{component_name\}_* | \{prefix\}/\{component_name\}/* | + * \{prefix\}/\{component_name\}[DELIMITER]* (Allowed delimiters : space, dot, underscore, + * hyphen)
*/ KeyPattern?: string; } @@ -1344,8 +1470,8 @@ export interface DescribeDataIngestionJobResponse { /** * @public - *The Amazon Resource Name (ARN) of the source dataset from which the data - * used for the data ingestion job was imported from.
+ *The Amazon Resource Name (ARN) of the source dataset from which the data used for the + * data ingestion job was imported from.
*/ SourceDatasetArn?: string; } @@ -1455,8 +1581,8 @@ export interface DescribeDatasetResponse { /** * @public - *The Amazon Resource Name (ARN) of the source dataset from which the - * current data being described was imported from.
+ *The Amazon Resource Name (ARN) of the source dataset from which the current data being + * described was imported from.
*/ SourceDatasetArn?: string; } @@ -1492,14 +1618,15 @@ export type LatestInferenceResult = (typeof LatestInferenceResult)[keyof typeof export interface DescribeInferenceSchedulerResponse { /** * @public - *The Amazon Resource Name (ARN) of the ML model of the inference scheduler being - * described.
+ *The Amazon Resource Name (ARN) of the machine learning model of the inference scheduler + * being described.
*/ ModelArn?: string; /** * @public - *The name of the ML model of the inference scheduler being described.
+ *The name of the machine learning model of the inference scheduler being described. + *
*/ ModelName?: string; @@ -1537,9 +1664,9 @@ export interface DescribeInferenceSchedulerResponse { * @public *Specifies how often data is uploaded to the source S3 bucket for the input data. This * value is the length of time between data uploads. For instance, if you select 5 minutes, - * Amazon Lookout for Equipment will upload the real-time data to the source bucket once every - * 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a - * scheduled inference on your data. In this example, it starts once every 5 minutes.
+ * Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This + * frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In + * this example, it starts once every 5 minutes. */ DataUploadFrequency?: DataUploadFrequency | string; @@ -1597,17 +1724,13 @@ export interface DescribeInferenceSchedulerResponse { export interface DescribeLabelRequest { /** * @public - *- * Returns the name of the group containing the label. - *
+ *Returns the name of the group containing the label.
*/ LabelGroupName: string | undefined; /** * @public - *- * Returns the ID of the label. - *
+ *Returns the ID of the label.
*/ LabelId: string | undefined; } @@ -1618,81 +1741,65 @@ export interface DescribeLabelRequest { export interface DescribeLabelResponse { /** * @public - *- * The name of the requested label group. - *
+ *The name of the requested label group.
*/ LabelGroupName?: string; /** * @public - *- * The Amazon Resource Name (ARN) of the requested label group. - *
+ *The Amazon Resource Name (ARN) of the requested label group.
*/ LabelGroupArn?: string; /** * @public - *- * The ID of the requested label. - *
+ *The ID of the requested label.
*/ LabelId?: string; /** * @public - *- * The start time of the requested label. - *
+ *The start time of the requested label.
*/ StartTime?: Date; /** * @public - *- * The end time of the requested label. - *
+ *The end time of the requested label.
*/ EndTime?: Date; /** * @public - *- * Indicates whether a labeled event represents an anomaly. - *
+ *Indicates whether a labeled event represents an anomaly.
*/ Rating?: LabelRating | string; /** * @public - *- * Indicates the type of anomaly associated with the label. - *
- *Data in this field will be retained for service usage. Follow best practices for the security of your data.
+ *Indicates the type of anomaly associated with the label.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ FaultCode?: string; /** * @public *Metadata providing additional information about the label.
- *Data in this field will be retained for service usage. Follow best practices for the security of your data.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ Notes?: string; /** * @public - *- * Indicates that a label pertains to a particular piece of equipment. - *
+ *Indicates that a label pertains to a particular piece of equipment.
*/ Equipment?: string; /** * @public - *- * The time at which the label was created. - *
+ *The time at which the label was created.
*/ CreatedAt?: Date; } @@ -1703,9 +1810,7 @@ export interface DescribeLabelResponse { export interface DescribeLabelGroupRequest { /** * @public - *- * Returns the name of the label group. - *
+ *Returns the name of the label group.
*/ LabelGroupName: string | undefined; } @@ -1716,41 +1821,32 @@ export interface DescribeLabelGroupRequest { export interface DescribeLabelGroupResponse { /** * @public - *- * The name of the label group. - *
+ *The name of the label group.
*/ LabelGroupName?: string; /** * @public - *- * The Amazon Resource Name (ARN) of the label group. - *
+ *The Amazon Resource Name (ARN) of the label group.
*/ LabelGroupArn?: string; /** * @public - *- * Codes indicating the type of anomaly associated with the labels in the lagbel group. + *
Codes indicating the type of anomaly associated with the labels in the lagbel group. *
*/ FaultCodes?: string[]; /** * @public - *- * The time at which the label group was created. - *
+ *The time at which the label group was created.
*/ CreatedAt?: Date; /** * @public - *- * The time at which the label group was updated. - *
+ *The time at which the label group was updated.
*/ UpdatedAt?: Date; } @@ -1761,37 +1857,54 @@ export interface DescribeLabelGroupResponse { export interface DescribeModelRequest { /** * @public - *The name of the ML model to be described.
+ *The name of the machine learning model to be described.
*/ ModelName: string | undefined; } +/** + * @public + * @enum + */ +export const ModelVersionStatus = { + CANCELED: "CANCELED", + FAILED: "FAILED", + IMPORT_IN_PROGRESS: "IMPORT_IN_PROGRESS", + IN_PROGRESS: "IN_PROGRESS", + SUCCESS: "SUCCESS", +} as const; + +/** + * @public + */ +export type ModelVersionStatus = (typeof ModelVersionStatus)[keyof typeof ModelVersionStatus]; + /** * @public */ export interface DescribeModelResponse { /** * @public - *The name of the ML model being described.
+ *The name of the machine learning model being described.
*/ ModelName?: string; /** * @public - *The Amazon Resource Name (ARN) of the ML model being described.
+ *The Amazon Resource Name (ARN) of the machine learning model being described.
*/ ModelArn?: string; /** * @public - *The name of the dataset being used by the ML being described.
+ *The name of the dataset being used by the machine learning being described.
*/ DatasetName?: string; /** * @public - *The Amazon Resouce Name (ARN) of the dataset used to create the ML model being - * described.
+ *The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model + * being described.
*/ DatasetArn?: string; @@ -1812,45 +1925,44 @@ export interface DescribeModelResponse { /** * @public *Indicates the time reference in the dataset that was used to begin the subset of - * training data for the ML model.
+ * training data for the machine learning model. */ TrainingDataStartTime?: Date; /** * @public *Indicates the time reference in the dataset that was used to end the subset of training - * data for the ML model.
+ * data for the machine learning model. */ TrainingDataEndTime?: Date; /** * @public *Indicates the time reference in the dataset that was used to begin the subset of - * evaluation data for the ML model.
+ * evaluation data for the machine learning model. */ EvaluationDataStartTime?: Date; /** * @public *Indicates the time reference in the dataset that was used to end the subset of - * evaluation data for the ML model.
+ * evaluation data for the machine learning model. */ EvaluationDataEndTime?: Date; /** * @public *The Amazon Resource Name (ARN) of a role with permission to access the data source for - * the ML model being described.
+ * the machine learning model being described. */ RoleArn?: string; /** * @public *The configuration is the TargetSamplingRate
, which is the sampling rate of
- * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
- * data that has been collected at a 1 second level and you want the system to resample the
- * data at a 1 minute rate before training, the TargetSamplingRate
is 1
- * minute.
TargetSamplingRate
is 1 minute.
* When providing a value for the TargetSamplingRate
, you must attach the
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
* PT1S, the value for a 15 minute rate is PT15M,
@@ -1868,20 +1980,21 @@ export interface DescribeModelResponse {
/**
* @public
- *
Indicates the time at which the training of the ML model began.
+ *Indicates the time at which the training of the machine learning model began.
*/ TrainingExecutionStartTime?: Date; /** * @public - *Indicates the time at which the training of the ML model was completed.
+ *Indicates the time at which the training of the machine learning model was completed. + *
*/ TrainingExecutionEndTime?: Date; /** * @public - *If the training of the ML model failed, this indicates the reason for that failure. - *
+ *If the training of the machine learning model failed, this indicates the reason for that + * failure.
*/ FailedReason?: string; @@ -1895,14 +2008,14 @@ export interface DescribeModelResponse { /** * @public - *Indicates the last time the ML model was updated. The type of update is not specified. - *
+ *Indicates the last time the machine learning model was updated. The type of update is + * not specified.
*/ LastUpdatedTime?: Date; /** * @public - *Indicates the time and date at which the ML model was created.
+ *Indicates the time and date at which the machine learning model was created.
*/ CreatedAt?: Date; @@ -1916,43 +2029,43 @@ export interface DescribeModelResponse { /** * @public *Indicates that the asset associated with this sensor has been shut off. As long as this - * condition is met, Lookout for Equipment will not use data from this asset for training, - * evaluation, or inference.
+ * condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or + * inference. */ OffCondition?: string; /** * @public - *The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version - * was imported.
+ *The Amazon Resource Name (ARN) of the source model version. This field appears if the + * active model version was imported.
*/ SourceModelVersionArn?: string; /** * @public - *The date and time when the import job was started. - * This field appears if the active model version was imported.
+ *The date and time when the import job was started. This field appears if the active + * model version was imported.
*/ ImportJobStartTime?: Date; /** * @public - *The date and time when the import job was completed. - * This field appears if the active model version was imported.
+ *The date and time when the import job was completed. This field appears if the active + * model version was imported.
*/ ImportJobEndTime?: Date; /** * @public - *The name of the model version used by the inference schedular when running a - * scheduled inference execution.
+ *The name of the model version used by the inference schedular when running a scheduled + * inference execution.
*/ ActiveModelVersion?: number; /** * @public - *The Amazon Resource Name (ARN) of the model version used by the - * inference scheduler when running a scheduled inference execution.
+ *The Amazon Resource Name (ARN) of the model version used by the inference scheduler when + * running a scheduled inference execution.
*/ ActiveModelVersionArn?: string; @@ -1964,8 +2077,8 @@ export interface DescribeModelResponse { /** * @public - *The model version that was set as the active model version prior to the - * current active model version.
+ *The model version that was set as the active model version prior to the current active + * model version.
*/ PreviousActiveModelVersion?: number; @@ -1981,6 +2094,71 @@ export interface DescribeModelResponse { *The date and time when the previous active model version was activated.
*/ PreviousModelVersionActivatedAt?: Date; + + /** + * @public + *If the model version was retrained, this field shows a summary of the performance of the + * prior model on the new training range. You can use the information in this JSON-formatted + * object to compare the new model version and the prior model version.
+ */ + PriorModelMetrics?: __LazyJsonString | string; + + /** + * @public + *If the model version was generated by retraining and the training failed, this indicates + * the reason for that failure.
+ */ + LatestScheduledRetrainingFailedReason?: string; + + /** + * @public + *Indicates the status of the most recent scheduled retraining run.
+ */ + LatestScheduledRetrainingStatus?: ModelVersionStatus | string; + + /** + * @public + *Indicates the most recent model version that was generated by retraining.
+ */ + LatestScheduledRetrainingModelVersion?: number; + + /** + * @public + *Indicates the start time of the most recent scheduled retraining run.
+ */ + LatestScheduledRetrainingStartTime?: Date; + + /** + * @public + *Indicates the number of days of data used in the most recent scheduled retraining run. + *
+ */ + LatestScheduledRetrainingAvailableDataInDays?: number; + + /** + * @public + *Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment + * truncates the time you provide to the nearest UTC day.
+ */ + NextScheduledRetrainingStartDate?: Date; + + /** + * @public + *Indicates the start time of the inference data that has been accumulated.
+ */ + AccumulatedInferenceDataStartTime?: Date; + + /** + * @public + *Indicates the end time of the inference data that has been accumulated.
+ */ + AccumulatedInferenceDataEndTime?: Date; + + /** + * @public + *Indicates the status of the retraining scheduler.
+ */ + RetrainingSchedulerStatus?: RetrainingSchedulerStatus | string; } /** @@ -2015,23 +2193,6 @@ export const ModelVersionSourceType = { */ export type ModelVersionSourceType = (typeof ModelVersionSourceType)[keyof typeof ModelVersionSourceType]; -/** - * @public - * @enum - */ -export const ModelVersionStatus = { - CANCELED: "CANCELED", - FAILED: "FAILED", - IMPORT_IN_PROGRESS: "IMPORT_IN_PROGRESS", - IN_PROGRESS: "IN_PROGRESS", - SUCCESS: "SUCCESS", -} as const; - -/** - * @public - */ -export type ModelVersionStatus = (typeof ModelVersionStatus)[keyof typeof ModelVersionStatus]; - /** * @public */ @@ -2044,7 +2205,8 @@ export interface DescribeModelVersionResponse { /** * @public - *The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.
+ *The Amazon Resource Name (ARN) of the parent machine learning model that this version + * belong to.
*/ ModelArn?: string; @@ -2099,49 +2261,48 @@ export interface DescribeModelVersionResponse { /** * @public - *The date on which the training data began being gathered. If you imported - * the version, this is the date that the training data in the source - * version began being gathered.
+ *The date on which the training data began being gathered. If you imported the version, + * this is the date that the training data in the source version began being gathered.
*/ TrainingDataStartTime?: Date; /** * @public - *The date on which the training data finished being gathered. - * If you imported the version, this is the date that the training data in the - * source version finished being gathered.
+ *The date on which the training data finished being gathered. If you imported the + * version, this is the date that the training data in the source version finished being + * gathered.
*/ TrainingDataEndTime?: Date; /** * @public - *The date on which the data in the evaluation set began being gathered. - * If you imported the version, this is the date that the evaluation set data in - * the source version began being gathered.
+ *The date on which the data in the evaluation set began being gathered. If you imported + * the version, this is the date that the evaluation set data in the source version began + * being gathered.
*/ EvaluationDataStartTime?: Date; /** * @public - *The date on which the data in the evaluation set began being gathered. - * If you imported the version, this is the date that the evaluation set data in the - * source version finished being gathered.
+ *The date on which the data in the evaluation set began being gathered. If you imported + * the version, this is the date that the evaluation set data in the source version finished + * being gathered.
*/ EvaluationDataEndTime?: Date; /** * @public - *The Amazon Resource Name (ARN) of the role that was used to train the model version.
+ *The Amazon Resource Name (ARN) of the role that was used to train the model + * version.
*/ RoleArn?: string; /** * @public *The configuration is the TargetSamplingRate
, which is the sampling rate of
- * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
- * data that has been collected at a 1 second level and you want the system to resample the
- * data at a 1 minute rate before training, the TargetSamplingRate
is 1
- * minute.
TargetSamplingRate
is 1 minute.
* When providing a value for the TargetSamplingRate
, you must attach the
* prefix "PT" to the rate you want. The value for a 1 second rate is therefore
* PT1S, the value for a 15 minute rate is PT15M,
@@ -2170,9 +2331,8 @@ export interface DescribeModelVersionResponse {
/**
* @public
- *
Shows an aggregated summary, in JSON format, of the model's - * performance within the evaluation time range. These metrics - * are created when evaluating the model.
+ *Shows an aggregated summary, in JSON format, of the model's performance within the + * evaluation time range. These metrics are created when evaluating the model.
*/ ModelMetrics?: string; @@ -2184,52 +2344,85 @@ export interface DescribeModelVersionResponse { /** * @public - *Indicates the time and date at which the machine learning model version was created.
+ *Indicates the time and date at which the machine learning model version was + * created.
*/ CreatedAt?: Date; /** * @public *The identifier of the KMS key key used to encrypt model version data by - * Amazon Lookout for Equipment.
+ * Amazon Lookout for Equipment. */ ServerSideKmsKeyId?: string; /** * @public - *Indicates that the asset associated with this sensor has been - * shut off. As long as this condition is met, Lookout for Equipment - * will not use data from this asset for training, evaluation, or inference.
+ *Indicates that the asset associated with this sensor has been shut off. As long as this + * condition is met, Lookout for Equipment will not use data from this asset for training, + * evaluation, or inference.
*/ OffCondition?: string; /** * @public - *If model version was imported, then this field is the arn - * of the source model version.
+ *If model version was imported, then this field is the arn of the source model + * version.
*/ SourceModelVersionArn?: string; /** * @public - *The date and time when the import job began. - * This field appears if the model version was imported.
+ *The date and time when the import job began. This field appears if the model version was + * imported.
*/ ImportJobStartTime?: Date; /** * @public - *The date and time when the import job completed. - * This field appears if the model version was imported.
+ *The date and time when the import job completed. This field appears if the model version + * was imported.
*/ ImportJobEndTime?: Date; /** * @public - *The size in bytes of the imported data. - * This field appears if the model version was imported.
+ *The size in bytes of the imported data. This field appears if the model version was + * imported.
*/ ImportedDataSizeInBytes?: number; + + /** + * @public + *If the model version was retrained, this field shows a summary of the performance of the + * prior model on the new training range. You can use the information in this JSON-formatted + * object to compare the new model version and the prior model version.
+ */ + PriorModelMetrics?: string; + + /** + * @public + *Indicates the number of days of data used in the most recent scheduled retraining run. + *
+ */ + RetrainingAvailableDataInDays?: number; + + /** + * @public + *Indicates whether the model version was promoted to be the active version after + * retraining or if there was an error with or cancellation of the retraining.
+ */ + AutoPromotionResult?: AutoPromotionResult | string; + + /** + * @public + *Indicates the reason for the AutoPromotionResult
. For example, a model
+ * might not be promoted if its performance was worse than the active version, if there was an
+ * error during training, or if the retraining scheduler was using MANUAL
promote
+ * mode. The model will be promoted in MANAGED
promote mode if the performance is
+ * better than the previous model.
The Amazon Resource Name (ARN) of the resource that is associated with the resource policy.
+ *The Amazon Resource Name (ARN) of the resource that is associated with the resource + * policy.
*/ ResourceArn: string | undefined; } @@ -2275,54 +2469,130 @@ export interface DescribeResourcePolicyResponse { /** * @public */ -export interface ImportDatasetRequest { +export interface DescribeRetrainingSchedulerRequest { /** * @public - *The Amazon Resource Name (ARN) of the dataset to import.
+ *The name of the model that the retraining scheduler is attached to.
*/ - SourceDatasetArn: string | undefined; + ModelName: string | undefined; +} +/** + * @public + */ +export interface DescribeRetrainingSchedulerResponse { /** * @public - *The name of the machine learning dataset to be created. If the dataset already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled with the name of the source dataset.
+ *The name of the model that the retraining scheduler is attached to.
*/ - DatasetName?: string; + ModelName?: string; /** * @public - *A unique identifier for the request. - * If you do not set the client request token, - * Amazon Lookout for Equipment generates one.
+ *The ARN of the model that the retraining scheduler is attached to.
*/ - ClientToken?: string; + ModelArn?: string; /** * @public - *Provides the identifier of the KMS key key used to - * encrypt model data by Amazon Lookout for Equipment.
+ *The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the + * nearest UTC day.
*/ - ServerSideKmsKeyId?: string; + RetrainingStartDate?: Date; /** * @public - *Any tags associated with the dataset to be created.
+ *The frequency at which the model retraining is set. This follows the ISO 8601 + * guidelines.
*/ - Tags?: Tag[]; -} + RetrainingFrequency?: string; -/** - * @public - */ -export interface ImportDatasetResponse { /** * @public - *The name of the created machine learning dataset.
+ *The number of past days of data used for retraining.
*/ - DatasetName?: string; + LookbackWindow?: string; /** * @public - *The Amazon Resource Name (ARN) of the dataset that was imported.
+ *The status of the retraining scheduler.
+ */ + Status?: RetrainingSchedulerStatus | string; + + /** + * @public + *Indicates how the service uses new models. In MANAGED
mode, new models are
+ * used for inference if they have better performance than the current model. In
+ * MANUAL
mode, the new models are not used until they are manually
+ * activated.
Indicates the time and date at which the retraining scheduler was created.
+ */ + CreatedAt?: Date; + + /** + * @public + *Indicates the time and date at which the retraining scheduler was updated.
+ */ + UpdatedAt?: Date; +} + +/** + * @public + */ +export interface ImportDatasetRequest { + /** + * @public + *The Amazon Resource Name (ARN) of the dataset to import.
+ */ + SourceDatasetArn: string | undefined; + + /** + * @public + *The name of the machine learning dataset to be created. If the dataset already exists, + * Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled + * with the name of the source dataset.
+ */ + DatasetName?: string; + + /** + * @public + *A unique identifier for the request. If you do not set the client request token, + * Amazon Lookout for Equipment generates one.
+ */ + ClientToken?: string; + + /** + * @public + *Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment. + *
+ */ + ServerSideKmsKeyId?: string; + + /** + * @public + *Any tags associated with the dataset to be created.
+ */ + Tags?: Tag[]; +} + +/** + * @public + */ +export interface ImportDatasetResponse { + /** + * @public + *The name of the created machine learning dataset.
+ */ + DatasetName?: string; + + /** + * @public + *The Amazon Resource Name (ARN) of the dataset that was imported.
*/ DatasetArn?: string; @@ -2339,6 +2609,22 @@ export interface ImportDatasetResponse { JobId?: string; } +/** + * @public + * @enum + */ +export const InferenceDataImportStrategy = { + ADD_WHEN_EMPTY: "ADD_WHEN_EMPTY", + NO_IMPORT: "NO_IMPORT", + OVERWRITE: "OVERWRITE", +} as const; + +/** + * @public + */ +export type InferenceDataImportStrategy = + (typeof InferenceDataImportStrategy)[keyof typeof InferenceDataImportStrategy]; + /** * @public */ @@ -2351,9 +2637,9 @@ export interface ImportModelVersionRequest { /** * @public - *The name for the machine learning model to be created. - * If the model already exists, Amazon Lookout for Equipment creates a new version. - * If you do not specify this field, it is filled with the name of the source model.
+ *The name for the machine learning model to be created. If the model already exists, + * Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the + * name of the source model.
*/ ModelName?: string; @@ -2372,22 +2658,22 @@ export interface ImportModelVersionRequest { /** * @public - *A unique identifier for the request. If you do not set the client request - * token, Amazon Lookout for Equipment generates one.
+ *A unique identifier for the request. If you do not set the client request token, + * Amazon Lookout for Equipment generates one.
*/ ClientToken?: string; /** * @public - *The Amazon Resource Name (ARN) of a role with permission to - * access the data source being used to create the machine learning model.
+ *The Amazon Resource Name (ARN) of a role with permission to access the data source being + * used to create the machine learning model.
*/ RoleArn?: string; /** * @public - *Provides the identifier of the KMS key key used to encrypt - * model data by Amazon Lookout for Equipment.
+ *Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment. + *
*/ ServerSideKmsKeyId?: string; @@ -2396,6 +2682,26 @@ export interface ImportModelVersionRequest { *The tags associated with the machine learning model to be created.
*/ Tags?: Tag[]; + + /** + * @public + *Indicates how to import the accumulated inference data when a model version is imported. + * The possible values are as follows:
+ *NO_IMPORT – Don't import the data.
+ *ADD_WHEN_EMPTY – Only import the data from the source model if there is no + * existing data in the target model.
+ *OVERWRITE – Import the data from the source model and overwrite the + * existing data in the target model.
+ *Lookout for Equipment will return all the inference events with an end time equal to or greater than the - * start time given.
+ *Lookout for Equipment will return all the inference events with an end time equal to or greater than + * the start time given.
*/ IntervalStartTime: Date | undefined; /** * @public - *Returns all the inference events with an end start time equal to or greater than less than the end time given.
+ *Returns all the inference events with an end start time equal to or greater than less + * than the end time given.
*/ IntervalEndTime: Date | undefined; } @@ -2736,15 +3043,15 @@ export interface ListInferenceExecutionsRequest { /** * @public - *The time reference in the inferenced dataset after which Amazon Lookout for Equipment - * started the inference execution.
+ *The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference + * execution.
*/ DataStartTimeAfter?: Date; /** * @public - *The time reference in the inferenced dataset before which Amazon Lookout for Equipment - * stopped the inference execution.
+ *The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the + * inference execution.
*/ DataEndTimeBefore?: Date; @@ -2763,13 +3070,14 @@ export interface ListInferenceExecutionsRequest { export interface InferenceExecutionSummary { /** * @public - *The name of the ML model being used for the inference execution.
+ *The name of the machine learning model being used for the inference execution.
*/ ModelName?: string; /** * @public - *The Amazon Resource Name (ARN) of the ML model used for the inference execution.
+ *The Amazon Resource Name (ARN) of the machine learning model used for the inference + * execution.
*/ ModelArn?: string; @@ -2824,8 +3132,7 @@ export interface InferenceExecutionSummary { /** * @public - *- *
+ *The S3 object that the inference execution results were uploaded to.
*/ CustomerResultObject?: S3Object; @@ -2840,6 +3147,19 @@ export interface InferenceExecutionSummary { *Specifies the reason for failure when an inference execution has failed.
*/ FailedReason?: string; + + /** + * @public + *The model version used for the inference execution.
+ */ + ModelVersion?: number; + + /** + * @public + *The Amazon Resource Number (ARN) of the model version used for the inference + * execution.
+ */ + ModelVersionArn?: string; } /** @@ -2887,7 +3207,8 @@ export interface ListInferenceSchedulersRequest { /** * @public - *The name of the ML model used by the inference scheduler to be listed.
+ *The name of the machine learning model used by the inference scheduler to be listed. + *
*/ ModelName?: string; @@ -2906,13 +3227,14 @@ export interface ListInferenceSchedulersRequest { export interface InferenceSchedulerSummary { /** * @public - *The name of the ML model used for the inference scheduler.
+ *The name of the machine learning model used for the inference scheduler.
*/ ModelName?: string; /** * @public - *The Amazon Resource Name (ARN) of the ML model used by the inference scheduler.
+ *The Amazon Resource Name (ARN) of the machine learning model used by the inference + * scheduler.
*/ ModelArn?: string; @@ -2951,8 +3273,8 @@ export interface InferenceSchedulerSummary { *How often data is uploaded to the source S3 bucket for the input data. This value is the * length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout * for Equipment will upload the real-time data to the source bucket once every 5 minutes. - * This frequency also determines how often Amazon Lookout for Equipment starts a scheduled - * inference on your data. In this example, it starts once every 5 minutes.
+ * This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your + * data. In this example, it starts once every 5 minutes. */ DataUploadFrequency?: DataUploadFrequency | string; @@ -2989,65 +3311,50 @@ export interface ListInferenceSchedulersResponse { export interface ListLabelGroupsRequest { /** * @public - *- * The beginning of the name of the label groups to be listed. - *
+ *The beginning of the name of the label groups to be listed.
*/ LabelGroupNameBeginsWith?: string; /** * @public - *- * An opaque pagination token indicating where to continue the listing of label groups. + *
An opaque pagination token indicating where to continue the listing of label groups. *
*/ NextToken?: string; /** * @public - *- * Specifies the maximum number of label groups to list. - *
+ *Specifies the maximum number of label groups to list.
*/ MaxResults?: number; } /** * @public - *- * Contains information about the label group. - *
+ *Contains information about the label group.
*/ export interface LabelGroupSummary { /** * @public - *- * The name of the label group. - *
+ *The name of the label group.
*/ LabelGroupName?: string; /** * @public - *- * The Amazon Resource Name (ARN) of the label group. - *
+ *The Amazon Resource Name (ARN) of the label group.
*/ LabelGroupArn?: string; /** * @public - *- * The time at which the label group was created. - *
+ *The time at which the label group was created.
*/ CreatedAt?: Date; /** * @public - *- * The time at which the label group was updated. - *
+ *The time at which the label group was updated.
*/ UpdatedAt?: Date; } @@ -3058,17 +3365,14 @@ export interface LabelGroupSummary { export interface ListLabelGroupsResponse { /** * @public - *- * An opaque pagination token indicating where to continue the listing of label groups. + *
An opaque pagination token indicating where to continue the listing of label groups. *
*/ NextToken?: string; /** * @public - *- * A summary of the label groups. - *
+ *A summary of the label groups.
*/ LabelGroupSummaries?: LabelGroupSummary[]; } @@ -3079,138 +3383,107 @@ export interface ListLabelGroupsResponse { export interface ListLabelsRequest { /** * @public - *- * Retruns the name of the label group. - *
+ *Retruns the name of the label group.
*/ LabelGroupName: string | undefined; /** * @public - *- * Returns all the labels with a end time equal to or later than the start time given. + *
Returns all the labels with a end time equal to or later than the start time given. *
*/ IntervalStartTime?: Date; /** * @public - *- * Returns all labels with a start time earlier than the end time given. - *
+ *Returns all labels with a start time earlier than the end time given.
*/ IntervalEndTime?: Date; /** * @public - *- * Returns labels with a particular fault code. - *
+ *Returns labels with a particular fault code.
*/ FaultCode?: string; /** * @public - *- * Lists the labels that pertain to a particular piece of equipment. - *
+ *Lists the labels that pertain to a particular piece of equipment.
*/ Equipment?: string; /** * @public - *- * An opaque pagination token indicating where to continue the listing of label groups. + *
An opaque pagination token indicating where to continue the listing of label groups. *
*/ NextToken?: string; /** * @public - *- * Specifies the maximum number of labels to list. - *
+ *Specifies the maximum number of labels to list.
*/ MaxResults?: number; } /** * @public - *- * Information about the label. - *
+ *Information about the label.
*/ export interface LabelSummary { /** * @public - *- * The name of the label group. - *
+ *The name of the label group.
*/ LabelGroupName?: string; /** * @public - *- * The ID of the label. - *
+ *The ID of the label.
*/ LabelId?: string; /** * @public - *- * The Amazon Resource Name (ARN) of the label group. - *
+ *The Amazon Resource Name (ARN) of the label group.
*/ LabelGroupArn?: string; /** * @public - *- * The timestamp indicating the start of the label. - *
+ *The timestamp indicating the start of the label.
*/ StartTime?: Date; /** * @public - *- * The timestamp indicating the end of the label. - *
+ *The timestamp indicating the end of the label.
*/ EndTime?: Date; /** * @public - *- * Indicates whether a labeled event represents an anomaly. - *
+ *Indicates whether a labeled event represents an anomaly.
*/ Rating?: LabelRating | string; /** * @public - *- * Indicates the type of anomaly associated with the label. - *
- *Data in this field will be retained for service usage. Follow best practices for the security of your data.
+ *Indicates the type of anomaly associated with the label.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ FaultCode?: string; /** * @public - *- * Indicates that a label pertains to a particular piece of equipment. - *
+ *Indicates that a label pertains to a particular piece of equipment.
*/ Equipment?: string; /** * @public - *- * The time at which the label was created. - *
+ *The time at which the label was created.
*/ CreatedAt?: Date; } @@ -3221,17 +3494,14 @@ export interface LabelSummary { export interface ListLabelsResponse { /** * @public - *- * An opaque pagination token indicating where to continue the listing of datasets. + *
An opaque pagination token indicating where to continue the listing of datasets. *
*/ NextToken?: string; /** * @public - *- * A summary of the items in the label group. - *
+ *A summary of the items in the label group.
*/ LabelSummaries?: LabelSummary[]; } @@ -3242,57 +3512,58 @@ export interface ListLabelsResponse { export interface ListModelsRequest { /** * @public - *An opaque pagination token indicating where to continue the listing of ML models. - *
+ *An opaque pagination token indicating where to continue the listing of machine learning + * models.
*/ NextToken?: string; /** * @public - *Specifies the maximum number of ML models to list.
+ *Specifies the maximum number of machine learning models to list.
*/ MaxResults?: number; /** * @public - *The status of the ML model.
+ *The status of the machine learning model.
*/ Status?: ModelStatus | string; /** * @public - *The beginning of the name of the ML models being listed.
+ *The beginning of the name of the machine learning models being listed.
*/ ModelNameBeginsWith?: string; /** * @public - *The beginning of the name of the dataset of the ML models to be listed.
+ *The beginning of the name of the dataset of the machine learning models to be listed. + *
*/ DatasetNameBeginsWith?: string; } /** * @public - *Provides information about the specified ML model, including dataset and model names and - * ARNs, as well as status.
+ *Provides information about the specified machine learning model, including dataset and + * model names and ARNs, as well as status.
*/ export interface ModelSummary { /** * @public - *The name of the ML model.
+ *The name of the machine learning model.
*/ ModelName?: string; /** * @public - *The Amazon Resource Name (ARN) of the ML model.
+ *The Amazon Resource Name (ARN) of the machine learning model.
*/ ModelArn?: string; /** * @public - *The name of the dataset being used for the ML model.
+ *The name of the dataset being used for the machine learning model.
*/ DatasetName?: string; @@ -3304,7 +3575,7 @@ export interface ModelSummary { /** * @public - *Indicates the status of the ML model.
+ *Indicates the status of the machine learning model.
*/ Status?: ModelStatus | string; @@ -3323,11 +3594,42 @@ export interface ModelSummary { /** * @public - *The Amazon Resource Name (ARN) of the model version that is set as active. The active model version - * is the model version that the inference scheduler uses to run an inference + *
The Amazon Resource Name (ARN) of the model version that is set as active. The active + * model version is the model version that the inference scheduler uses to run an inference * execution.
*/ ActiveModelVersionArn?: string; + + /** + * @public + *Indicates the status of the most recent scheduled retraining run.
+ */ + LatestScheduledRetrainingStatus?: ModelVersionStatus | string; + + /** + * @public + *Indicates the most recent model version that was generated by retraining.
+ */ + LatestScheduledRetrainingModelVersion?: number; + + /** + * @public + *Indicates the start time of the most recent scheduled retraining run.
+ */ + LatestScheduledRetrainingStartTime?: Date; + + /** + * @public + *Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates + * the time you provide to the nearest UTC day.
+ */ + NextScheduledRetrainingStartDate?: Date; + + /** + * @public + *Indicates the status of the retraining scheduler.
+ */ + RetrainingSchedulerStatus?: RetrainingSchedulerStatus | string; } /** @@ -3336,8 +3638,8 @@ export interface ModelSummary { export interface ListModelsResponse { /** * @public - *An opaque pagination token indicating where to continue the listing of ML models. - *
+ *An opaque pagination token indicating where to continue the listing of machine learning + * models.
*/ NextToken?: string; @@ -3355,17 +3657,17 @@ export interface ListModelsResponse { export interface ListModelVersionsRequest { /** * @public - *Then name of the machine learning model for which the - * model versions are to be listed.
+ *Then name of the machine learning model for which the model versions are to be + * listed.
*/ ModelName: string | undefined; /** * @public - *If the total number of results exceeds the limit that the response can
- * display, the response returns an opaque pagination token indicating where to
- * continue the listing of machine learning model versions. Use this token in the NextToken
- * field in the request to list the next page of results.
If the total number of results exceeds the limit that the response can display, the
+ * response returns an opaque pagination token indicating where to continue the listing of
+ * machine learning model versions. Use this token in the NextToken
field in the
+ * request to list the next page of results.
The Amazon Resource Name (ARN) of the model that this model version is a version of.
+ *The Amazon Resource Name (ARN) of the model that this model version is a version + * of.
*/ ModelArn?: string; @@ -3466,21 +3769,117 @@ export interface ModelVersionSummary { export interface ListModelVersionsResponse { /** * @public - *If the total number of results exceeds the limit that the response can
- * display, the response returns an opaque pagination token indicating where to
- * continue the listing of machine learning model versions. Use this token in the NextToken
- * field in the request to list the next page of results.
If the total number of results exceeds the limit that the response can display, the
+ * response returns an opaque pagination token indicating where to continue the listing of
+ * machine learning model versions. Use this token in the NextToken
field in the
+ * request to list the next page of results.
Provides information on the specified model version, - * including the created time, model and dataset ARNs, and status.
+ *Provides information on the specified model version, including the created time, model + * and dataset ARNs, and status.
*/ ModelVersionSummaries?: ModelVersionSummary[]; } +/** + * @public + */ +export interface ListRetrainingSchedulersRequest { + /** + * @public + *Specify this field to only list retraining schedulers whose machine learning models + * begin with the value you specify.
+ */ + ModelNameBeginsWith?: string; + + /** + * @public + *Specify this field to only list retraining schedulers whose status matches the value you + * specify.
+ */ + Status?: RetrainingSchedulerStatus | string; + + /** + * @public + *If the number of results exceeds the maximum, a pagination token is returned. Use the + * token in the request to show the next page of retraining schedulers.
+ */ + NextToken?: string; + + /** + * @public + *Specifies the maximum number of retraining schedulers to list.
+ */ + MaxResults?: number; +} + +/** + * @public + *Provides information about the specified retraining scheduler, including model name, + * status, start date, frequency, and lookback window.
+ */ +export interface RetrainingSchedulerSummary { + /** + * @public + *The name of the model that the retraining scheduler is attached to.
+ */ + ModelName?: string; + + /** + * @public + *The ARN of the model that the retraining scheduler is attached to.
+ */ + ModelArn?: string; + + /** + * @public + *The status of the retraining scheduler.
+ */ + Status?: RetrainingSchedulerStatus | string; + + /** + * @public + *The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the + * nearest UTC day.
+ */ + RetrainingStartDate?: Date; + + /** + * @public + *The frequency at which the model retraining is set. This follows the ISO 8601 + * guidelines.
+ */ + RetrainingFrequency?: string; + + /** + * @public + *The number of past days of data used for retraining.
+ */ + LookbackWindow?: string; +} + +/** + * @public + */ +export interface ListRetrainingSchedulersResponse { + /** + * @public + *Provides information on the specified retraining scheduler, including the model name, + * model ARN, status, and start date.
+ */ + RetrainingSchedulerSummaries?: RetrainingSchedulerSummary[]; + + /** + * @public + *If the number of results exceeds the maximum, this pagination token is returned. Use + * this token in the request to show the next page of retraining schedulers.
+ */ + NextToken?: string; +} + /** * @public */ @@ -3783,8 +4182,8 @@ export interface ListTagsForResourceResponse { export interface PutResourcePolicyRequest { /** * @public - *The Amazon Resource Name (ARN) of the resource for which the - * policy is being created.
+ *The Amazon Resource Name (ARN) of the resource for which the policy is being + * created.
*/ ResourceArn: string | undefined; @@ -3802,9 +4201,8 @@ export interface PutResourcePolicyRequest { /** * @public - *A unique identifier for the request. - * If you do not set the client request token, Amazon Lookout for Equipment - * generates one.
+ *A unique identifier for the request. If you do not set the client request token, + * Amazon Lookout for Equipment generates one.
*/ ClientToken?: string; } @@ -3815,8 +4213,7 @@ export interface PutResourcePolicyRequest { export interface PutResourcePolicyResponse { /** * @public - *The Amazon Resource Name (ARN) of the resource for which the - * policy was created.
+ *The Amazon Resource Name (ARN) of the resource for which the policy was created.
*/ ResourceArn?: string; @@ -3893,14 +4290,14 @@ export interface StartInferenceSchedulerRequest { export interface StartInferenceSchedulerResponse { /** * @public - *The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler. - *
+ *The Amazon Resource Name (ARN) of the machine learning model being used by the inference + * scheduler.
*/ ModelArn?: string; /** * @public - *The name of the ML model being used by the inference scheduler.
+ *The name of the machine learning model being used by the inference scheduler.
*/ ModelName?: string; @@ -3923,6 +4320,40 @@ export interface StartInferenceSchedulerResponse { Status?: InferenceSchedulerStatus | string; } +/** + * @public + */ +export interface StartRetrainingSchedulerRequest { + /** + * @public + *The name of the model whose retraining scheduler you want to start.
+ */ + ModelName: string | undefined; +} + +/** + * @public + */ +export interface StartRetrainingSchedulerResponse { + /** + * @public + *The name of the model whose retraining scheduler is being started.
+ */ + ModelName?: string; + + /** + * @public + *The ARN of the model whose retraining scheduler is being started.
+ */ + ModelArn?: string; + + /** + * @public + *The status of the retraining scheduler.
+ */ + Status?: RetrainingSchedulerStatus | string; +} + /** * @public */ @@ -3940,14 +4371,15 @@ export interface StopInferenceSchedulerRequest { export interface StopInferenceSchedulerResponse { /** * @public - *The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being - * stopped.
+ *The Amazon Resource Name (ARN) of the machine learning model used by the inference + * scheduler being stopped.
*/ ModelArn?: string; /** * @public - *The name of the ML model used by the inference scheduler being stopped.
+ *The name of the machine learning model used by the inference scheduler being stopped. + *
*/ ModelName?: string; @@ -3970,6 +4402,40 @@ export interface StopInferenceSchedulerResponse { Status?: InferenceSchedulerStatus | string; } +/** + * @public + */ +export interface StopRetrainingSchedulerRequest { + /** + * @public + *The name of the model whose retraining scheduler you want to stop.
+ */ + ModelName: string | undefined; +} + +/** + * @public + */ +export interface StopRetrainingSchedulerResponse { + /** + * @public + *The name of the model whose retraining scheduler is being stopped.
+ */ + ModelName?: string; + + /** + * @public + *The ARN of the model whose retraining scheduler is being stopped.
+ */ + ModelArn?: string; + + /** + * @public + *The status of the retraining scheduler.
+ */ + Status?: RetrainingSchedulerStatus | string; +} + /** * @public */ @@ -4023,15 +4489,15 @@ export interface UntagResourceResponse {} export interface UpdateActiveModelVersionRequest { /** * @public - *The name of the machine learning model for which the active model version - * is being set.
+ *The name of the machine learning model for which the active model version is being + * set.
*/ ModelName: string | undefined; /** * @public - *The version of the machine learning model for which the active model version - * is being set.
+ *The version of the machine learning model for which the active model version is being + * set.
*/ ModelVersion: number | undefined; } @@ -4042,42 +4508,43 @@ export interface UpdateActiveModelVersionRequest { export interface UpdateActiveModelVersionResponse { /** * @public - *The name of the machine learning model for which the active model version was set.
+ *The name of the machine learning model for which the active model version was + * set.
*/ ModelName?: string; /** * @public - *The Amazon Resource Name (ARN) of the machine learning model for which - * the active model version was set.
+ *The Amazon Resource Name (ARN) of the machine learning model for which the active model + * version was set.
*/ ModelArn?: string; /** * @public - *The version that is currently active of the machine learning model - * for which the active model version was set.
+ *The version that is currently active of the machine learning model for which the active + * model version was set.
*/ CurrentActiveVersion?: number; /** * @public - *The previous version that was active of the machine learning model - * for which the active model version was set.
+ *The previous version that was active of the machine learning model for which the active + * model version was set.
*/ PreviousActiveVersion?: number; /** * @public - *The Amazon Resource Name (ARN) of the machine learning model version that is the - * current active model version.
+ *The Amazon Resource Name (ARN) of the machine learning model version that is the current + * active model version.
*/ CurrentActiveVersionArn?: string; /** * @public *The Amazon Resource Name (ARN) of the machine learning model version that was the - * previous active model version.
+ * previous active model version. */ PreviousActiveVersionArn?: string; } @@ -4109,8 +4576,8 @@ export interface UpdateInferenceSchedulerRequest { *How often data is uploaded to the source S3 bucket for the input data. The value chosen * is the length of time between data uploads. For instance, if you select 5 minutes, Amazon * Lookout for Equipment will upload the real-time data to the source bucket once every 5 - * minutes. This frequency also determines how often Amazon Lookout for Equipment starts a - * scheduled inference on your data. In this example, it starts once every 5 minutes.
+ * minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on + * your data. In this example, it starts once every 5 minutes. */ DataUploadFrequency?: DataUploadFrequency | string; @@ -4142,18 +4609,92 @@ export interface UpdateInferenceSchedulerRequest { export interface UpdateLabelGroupRequest { /** * @public - *- * The name of the label group to be updated. - *
+ *The name of the label group to be updated.
*/ LabelGroupName: string | undefined; /** * @public - *- * Updates the code indicating the type of anomaly associated with the label. - *
- *Data in this field will be retained for service usage. Follow best practices for the security of your data.
+ *Updates the code indicating the type of anomaly associated with the label.
+ *Data in this field will be retained for service usage. Follow best practices for the + * security of your data.
*/ FaultCodes?: string[]; } + +/** + * @public + */ +export interface UpdateModelRequest { + /** + * @public + *The name of the model to update.
+ */ + ModelName: string | undefined; + + /** + * @public + *Contains the configuration information for the S3 location being used to hold label + * data.
+ */ + LabelsInputConfiguration?: LabelsInputConfiguration; + + /** + * @public + *The ARN of the model to update.
+ */ + RoleArn?: string; +} + +/** + * @public + */ +export interface UpdateRetrainingSchedulerRequest { + /** + * @public + *The name of the model whose retraining scheduler you want to update.
+ */ + ModelName: string | undefined; + + /** + * @public + *The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the + * nearest UTC day.
+ */ + RetrainingStartDate?: Date; + + /** + * @public + *This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in + * terms of Years, Months, and/or Days (note: other parameters like Time are not currently + * supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For + * example, the following values are valid:
+ *P3M15D – Every 3 months and 15 days
+ *P2M – Every 2 months
+ *P150D – Every 150 days
+ *The number of past days of data that will be used for retraining.
+ */ + LookbackWindow?: string; + + /** + * @public + *Indicates how the service will use new models. In MANAGED
mode, new models
+ * will automatically be used for inference if they have better performance than the current
+ * model. In MANUAL
mode, the new models will not be used until they
+ * are manually activated.