StopRetrainingSchedulerCommand

Stops a retraining scheduler.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

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",
// };

Example Usage

 Loading code editorLoading code editor

StopRetrainingSchedulerCommand Input

Parameter
Type
Description
ModelName
Required
string | undefined

The name of the model whose retraining scheduler you want to stop.

StopRetrainingSchedulerCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ModelArn
string | undefined

The ARN of the model whose retraining scheduler is being stopped.

ModelName
string | undefined

The name of the model whose retraining scheduler is being stopped.

Status
RetrainingSchedulerStatus | undefined

The status of the retraining scheduler.

Throws

Name
Fault
Details
AccessDeniedException
client

The request could not be completed because you do not have access to the resource.

ConflictException
client

The request could not be completed due to a conflict with the current state of the target resource.

InternalServerException
server

Processing of the request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

LookoutEquipmentServiceException
Base exception class for all service exceptions from LookoutEquipment service.