Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class StopModelCommandProtected

Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call DescribeModel.

After the model hosting stops, the Status of the model is TRAINED.

This operation requires permissions to perform the lookoutvision:StopModel operation.

Example

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

import { LookoutVisionClient, StopModelCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import
// const { LookoutVisionClient, StopModelCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import
const client = new LookoutVisionClient(config);
const input = { // StopModelRequest
ProjectName: "STRING_VALUE", // required
ModelVersion: "STRING_VALUE", // required
ClientToken: "STRING_VALUE",
};
const command = new StopModelCommand(input);
const response = await client.send(command);
// { // StopModelResponse
// Status: "STARTING_HOSTING" || "HOSTED" || "HOSTING_FAILED" || "STOPPING_HOSTING" || "SYSTEM_UPDATING",
// };

Param

StopModelCommandInput

Returns

StopModelCommandOutput

See

Throws

AccessDeniedException (client fault)

You are not authorized to perform the action.

Throws

ConflictException (client fault)

The update or deletion of a resource caused an inconsistent state.

Throws

InternalServerException (server fault)

Amazon Lookout for Vision experienced a service issue. Try your call again.

Throws

ResourceNotFoundException (client fault)

The resource could not be found.

Throws

ThrottlingException (client fault)

Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

Throws

ValidationException (client fault)

An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

Throws

LookoutVisionServiceException

Base exception class for all service exceptions from LookoutVision service.

Hierarchy

Constructors

Properties

middlewareStack: MiddlewareStack<StopModelCommandInput, StopModelCommandOutput>

Methods