- 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.
UpdateRecommenderConfigurationCommand
Updates an Amazon Pinpoint configuration for a recommender model.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PinpointClient, UpdateRecommenderConfigurationCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
// const { PinpointClient, UpdateRecommenderConfigurationCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
const client = new PinpointClient(config);
const input = { // UpdateRecommenderConfigurationRequest
RecommenderId: "STRING_VALUE", // required
UpdateRecommenderConfiguration: { // UpdateRecommenderConfigurationShape
Attributes: { // MapOf__string
"<keys>": "STRING_VALUE",
},
Description: "STRING_VALUE",
Name: "STRING_VALUE",
RecommendationProviderIdType: "STRING_VALUE",
RecommendationProviderRoleArn: "STRING_VALUE", // required
RecommendationProviderUri: "STRING_VALUE", // required
RecommendationTransformerUri: "STRING_VALUE",
RecommendationsDisplayName: "STRING_VALUE",
RecommendationsPerMessage: Number("int"),
},
};
const command = new UpdateRecommenderConfigurationCommand(input);
const response = await client.send(command);
// { // UpdateRecommenderConfigurationResponse
// RecommenderConfigurationResponse: { // RecommenderConfigurationResponse
// Attributes: { // MapOf__string
// "<keys>": "STRING_VALUE",
// },
// CreationDate: "STRING_VALUE", // required
// Description: "STRING_VALUE",
// Id: "STRING_VALUE", // required
// LastModifiedDate: "STRING_VALUE", // required
// Name: "STRING_VALUE",
// RecommendationProviderIdType: "STRING_VALUE",
// RecommendationProviderRoleArn: "STRING_VALUE", // required
// RecommendationProviderUri: "STRING_VALUE", // required
// RecommendationTransformerUri: "STRING_VALUE",
// RecommendationsDisplayName: "STRING_VALUE",
// RecommendationsPerMessage: Number("int"),
// },
// };
UpdateRecommenderConfigurationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
RecommenderId Required | string | undefined | The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console. |
UpdateRecommenderConfiguration Required | UpdateRecommenderConfigurationShape | undefined | Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model. |
UpdateRecommenderConfigurationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
RecommenderConfigurationResponse Required | RecommenderConfigurationResponse | undefined | Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | Provides information about an API request or response. |
ForbiddenException | client | Provides information about an API request or response. |
InternalServerErrorException | server | Provides information about an API request or response. |
MethodNotAllowedException | client | Provides information about an API request or response. |
NotFoundException | client | Provides information about an API request or response. |
PayloadTooLargeException | client | Provides information about an API request or response. |
TooManyRequestsException | client | Provides information about an API request or response. |
PinpointServiceException | Base exception class for all service exceptions from Pinpoint service. |