- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
StartRecommenderCommand
Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PersonalizeClient, StartRecommenderCommand } from "@aws-sdk/client-personalize"; // ES Modules import
// const { PersonalizeClient, StartRecommenderCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
const client = new PersonalizeClient(config);
const input = { // StartRecommenderRequest
recommenderArn: "STRING_VALUE", // required
};
const command = new StartRecommenderCommand(input);
const response = await client.send(command);
// { // StartRecommenderResponse
// recommenderArn: "STRING_VALUE",
// };
StartRecommenderCommand Input
See StartRecommenderCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
recommenderArnRequired | string | undefined | The Amazon Resource Name (ARN) of the recommender to start. |
StartRecommenderCommand Output
See StartRecommenderCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
recommenderArn | string | undefined | The Amazon Resource Name (ARN) of the recommender you started. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InvalidInputException | client | Provide a valid value for the field or parameter. |
| ResourceInUseException | client | The specified resource is in use. |
| ResourceNotFoundException | client | Could not find the specified resource. |
| PersonalizeServiceException | Base exception class for all service exceptions from Personalize service. |