1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
|
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package personalizeruntime
import (
"fmt"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/private/protocol"
)
const opGetPersonalizedRanking = "GetPersonalizedRanking"
// GetPersonalizedRankingRequest generates a "aws/request.Request" representing the
// client's request for the GetPersonalizedRanking operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See GetPersonalizedRanking for more information on using the GetPersonalizedRanking
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the GetPersonalizedRankingRequest method.
// req, resp := client.GetPersonalizedRankingRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRanking
func (c *PersonalizeRuntime) GetPersonalizedRankingRequest(input *GetPersonalizedRankingInput) (req *request.Request, output *GetPersonalizedRankingOutput) {
op := &request.Operation{
Name: opGetPersonalizedRanking,
HTTPMethod: "POST",
HTTPPath: "/personalize-ranking",
}
if input == nil {
input = &GetPersonalizedRankingInput{}
}
output = &GetPersonalizedRankingOutput{}
req = c.newRequest(op, input, output)
return
}
// GetPersonalizedRanking API operation for Amazon Personalize Runtime.
//
// Re-ranks a list of recommended items for the given user. The first item in
// the list is deemed the most likely item to be of interest to the user.
//
// The solution backing the campaign must have been created using a recipe of
// type PERSONALIZED_RANKING.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Personalize Runtime's
// API operation GetPersonalizedRanking for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// Provide a valid value for the field or parameter.
//
// - ResourceNotFoundException
// The specified resource does not exist.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRanking
func (c *PersonalizeRuntime) GetPersonalizedRanking(input *GetPersonalizedRankingInput) (*GetPersonalizedRankingOutput, error) {
req, out := c.GetPersonalizedRankingRequest(input)
return out, req.Send()
}
// GetPersonalizedRankingWithContext is the same as GetPersonalizedRanking with the addition of
// the ability to pass a context and additional request options.
//
// See GetPersonalizedRanking for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *PersonalizeRuntime) GetPersonalizedRankingWithContext(ctx aws.Context, input *GetPersonalizedRankingInput, opts ...request.Option) (*GetPersonalizedRankingOutput, error) {
req, out := c.GetPersonalizedRankingRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opGetRecommendations = "GetRecommendations"
// GetRecommendationsRequest generates a "aws/request.Request" representing the
// client's request for the GetRecommendations operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See GetRecommendations for more information on using the GetRecommendations
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the GetRecommendationsRequest method.
// req, resp := client.GetRecommendationsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendations
func (c *PersonalizeRuntime) GetRecommendationsRequest(input *GetRecommendationsInput) (req *request.Request, output *GetRecommendationsOutput) {
op := &request.Operation{
Name: opGetRecommendations,
HTTPMethod: "POST",
HTTPPath: "/recommendations",
}
if input == nil {
input = &GetRecommendationsInput{}
}
output = &GetRecommendationsOutput{}
req = c.newRequest(op, input, output)
return
}
// GetRecommendations API operation for Amazon Personalize Runtime.
//
// Returns a list of recommended items. For campaigns, the campaign's Amazon
// Resource Name (ARN) is required and the required user and item input depends
// on the recipe type used to create the solution backing the campaign as follows:
//
// - USER_PERSONALIZATION - userId required, itemId not used
//
// - RELATED_ITEMS - itemId required, userId not used
//
// Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING
// use the API.
//
// For recommenders, the recommender's ARN is required and the required item
// and user input depends on the use case (domain-based recipe) backing the
// recommender. For information on use case requirements see Choosing recommender
// use cases (https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Personalize Runtime's
// API operation GetRecommendations for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// Provide a valid value for the field or parameter.
//
// - ResourceNotFoundException
// The specified resource does not exist.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendations
func (c *PersonalizeRuntime) GetRecommendations(input *GetRecommendationsInput) (*GetRecommendationsOutput, error) {
req, out := c.GetRecommendationsRequest(input)
return out, req.Send()
}
// GetRecommendationsWithContext is the same as GetRecommendations with the addition of
// the ability to pass a context and additional request options.
//
// See GetRecommendations for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *PersonalizeRuntime) GetRecommendationsWithContext(ctx aws.Context, input *GetRecommendationsInput, opts ...request.Option) (*GetRecommendationsOutput, error) {
req, out := c.GetRecommendationsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
type GetPersonalizedRankingInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the campaign to use for generating the
// personalized ranking.
//
// CampaignArn is a required field
CampaignArn *string `locationName:"campaignArn" type:"string" required:"true"`
// The contextual metadata to use when getting recommendations. Contextual metadata
// includes any interaction information that might be relevant when getting
// a user's recommendations, such as the user's current location or device type.
Context map[string]*string `locationName:"context" type:"map"`
// The Amazon Resource Name (ARN) of a filter you created to include items or
// exclude items from recommendations for a given user. For more information,
// see Filtering Recommendations (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
FilterArn *string `locationName:"filterArn" type:"string"`
// The values to use when filtering recommendations. For each placeholder parameter
// in your filter expression, provide the parameter name (in matching case)
// as a key and the filter value(s) as the corresponding value. Separate multiple
// values for one parameter with a comma.
//
// For filter expressions that use an INCLUDE element to include items, you
// must provide values for all parameters that are defined in the expression.
// For filters with expressions that use an EXCLUDE element to exclude items,
// you can omit the filter-values.In this case, Amazon Personalize doesn't use
// that portion of the expression to filter recommendations.
//
// For more information, see Filtering Recommendations (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
FilterValues map[string]*string `locationName:"filterValues" type:"map"`
// A list of items (by itemId) to rank. If an item was not included in the training
// dataset, the item is appended to the end of the reranked list. The maximum
// is 500.
//
// InputList is a required field
InputList []*string `locationName:"inputList" type:"list" required:"true"`
// The user for which you want the campaign to provide a personalized ranking.
//
// UserId is a required field
UserId *string `locationName:"userId" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetPersonalizedRankingInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetPersonalizedRankingInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetPersonalizedRankingInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetPersonalizedRankingInput"}
if s.CampaignArn == nil {
invalidParams.Add(request.NewErrParamRequired("CampaignArn"))
}
if s.InputList == nil {
invalidParams.Add(request.NewErrParamRequired("InputList"))
}
if s.UserId == nil {
invalidParams.Add(request.NewErrParamRequired("UserId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetCampaignArn sets the CampaignArn field's value.
func (s *GetPersonalizedRankingInput) SetCampaignArn(v string) *GetPersonalizedRankingInput {
s.CampaignArn = &v
return s
}
// SetContext sets the Context field's value.
func (s *GetPersonalizedRankingInput) SetContext(v map[string]*string) *GetPersonalizedRankingInput {
s.Context = v
return s
}
// SetFilterArn sets the FilterArn field's value.
func (s *GetPersonalizedRankingInput) SetFilterArn(v string) *GetPersonalizedRankingInput {
s.FilterArn = &v
return s
}
// SetFilterValues sets the FilterValues field's value.
func (s *GetPersonalizedRankingInput) SetFilterValues(v map[string]*string) *GetPersonalizedRankingInput {
s.FilterValues = v
return s
}
// SetInputList sets the InputList field's value.
func (s *GetPersonalizedRankingInput) SetInputList(v []*string) *GetPersonalizedRankingInput {
s.InputList = v
return s
}
// SetUserId sets the UserId field's value.
func (s *GetPersonalizedRankingInput) SetUserId(v string) *GetPersonalizedRankingInput {
s.UserId = &v
return s
}
type GetPersonalizedRankingOutput struct {
_ struct{} `type:"structure"`
// A list of items in order of most likely interest to the user. The maximum
// is 500.
PersonalizedRanking []*PredictedItem `locationName:"personalizedRanking" type:"list"`
// The ID of the recommendation.
RecommendationId *string `locationName:"recommendationId" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetPersonalizedRankingOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetPersonalizedRankingOutput) GoString() string {
return s.String()
}
// SetPersonalizedRanking sets the PersonalizedRanking field's value.
func (s *GetPersonalizedRankingOutput) SetPersonalizedRanking(v []*PredictedItem) *GetPersonalizedRankingOutput {
s.PersonalizedRanking = v
return s
}
// SetRecommendationId sets the RecommendationId field's value.
func (s *GetPersonalizedRankingOutput) SetRecommendationId(v string) *GetPersonalizedRankingOutput {
s.RecommendationId = &v
return s
}
type GetRecommendationsInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
CampaignArn *string `locationName:"campaignArn" type:"string"`
// The contextual metadata to use when getting recommendations. Contextual metadata
// includes any interaction information that might be relevant when getting
// a user's recommendations, such as the user's current location or device type.
Context map[string]*string `locationName:"context" type:"map"`
// The ARN of the filter to apply to the returned recommendations. For more
// information, see Filtering Recommendations (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
//
// When using this parameter, be sure the filter resource is ACTIVE.
FilterArn *string `locationName:"filterArn" type:"string"`
// The values to use when filtering recommendations. For each placeholder parameter
// in your filter expression, provide the parameter name (in matching case)
// as a key and the filter value(s) as the corresponding value. Separate multiple
// values for one parameter with a comma.
//
// For filter expressions that use an INCLUDE element to include items, you
// must provide values for all parameters that are defined in the expression.
// For filters with expressions that use an EXCLUDE element to exclude items,
// you can omit the filter-values.In this case, Amazon Personalize doesn't use
// that portion of the expression to filter recommendations.
//
// For more information, see Filtering recommendations and user segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
FilterValues map[string]*string `locationName:"filterValues" type:"map"`
// The item ID to provide recommendations for.
//
// Required for RELATED_ITEMS recipe type.
ItemId *string `locationName:"itemId" type:"string"`
// The number of results to return. The default is 25. The maximum is 500.
NumResults *int64 `locationName:"numResults" type:"integer"`
// The promotions to apply to the recommendation request. A promotion defines
// additional business rules that apply to a configurable subset of recommended
// items.
Promotions []*Promotion `locationName:"promotions" type:"list"`
// The Amazon Resource Name (ARN) of the recommender to use to get recommendations.
// Provide a recommender ARN if you created a Domain dataset group with a recommender
// for a domain use case.
RecommenderArn *string `locationName:"recommenderArn" type:"string"`
// The user ID to provide recommendations for.
//
// Required for USER_PERSONALIZATION recipe type.
UserId *string `locationName:"userId" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetRecommendationsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetRecommendationsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetRecommendationsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetRecommendationsInput"}
if s.Promotions != nil {
for i, v := range s.Promotions {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Promotions", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetCampaignArn sets the CampaignArn field's value.
func (s *GetRecommendationsInput) SetCampaignArn(v string) *GetRecommendationsInput {
s.CampaignArn = &v
return s
}
// SetContext sets the Context field's value.
func (s *GetRecommendationsInput) SetContext(v map[string]*string) *GetRecommendationsInput {
s.Context = v
return s
}
// SetFilterArn sets the FilterArn field's value.
func (s *GetRecommendationsInput) SetFilterArn(v string) *GetRecommendationsInput {
s.FilterArn = &v
return s
}
// SetFilterValues sets the FilterValues field's value.
func (s *GetRecommendationsInput) SetFilterValues(v map[string]*string) *GetRecommendationsInput {
s.FilterValues = v
return s
}
// SetItemId sets the ItemId field's value.
func (s *GetRecommendationsInput) SetItemId(v string) *GetRecommendationsInput {
s.ItemId = &v
return s
}
// SetNumResults sets the NumResults field's value.
func (s *GetRecommendationsInput) SetNumResults(v int64) *GetRecommendationsInput {
s.NumResults = &v
return s
}
// SetPromotions sets the Promotions field's value.
func (s *GetRecommendationsInput) SetPromotions(v []*Promotion) *GetRecommendationsInput {
s.Promotions = v
return s
}
// SetRecommenderArn sets the RecommenderArn field's value.
func (s *GetRecommendationsInput) SetRecommenderArn(v string) *GetRecommendationsInput {
s.RecommenderArn = &v
return s
}
// SetUserId sets the UserId field's value.
func (s *GetRecommendationsInput) SetUserId(v string) *GetRecommendationsInput {
s.UserId = &v
return s
}
type GetRecommendationsOutput struct {
_ struct{} `type:"structure"`
// A list of recommendations sorted in descending order by prediction score.
// There can be a maximum of 500 items in the list.
ItemList []*PredictedItem `locationName:"itemList" type:"list"`
// The ID of the recommendation.
RecommendationId *string `locationName:"recommendationId" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetRecommendationsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetRecommendationsOutput) GoString() string {
return s.String()
}
// SetItemList sets the ItemList field's value.
func (s *GetRecommendationsOutput) SetItemList(v []*PredictedItem) *GetRecommendationsOutput {
s.ItemList = v
return s
}
// SetRecommendationId sets the RecommendationId field's value.
func (s *GetRecommendationsOutput) SetRecommendationId(v string) *GetRecommendationsOutput {
s.RecommendationId = &v
return s
}
// Provide a valid value for the field or parameter.
type InvalidInputException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidInputException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidInputException) GoString() string {
return s.String()
}
func newErrorInvalidInputException(v protocol.ResponseMetadata) error {
return &InvalidInputException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *InvalidInputException) Code() string {
return "InvalidInputException"
}
// Message returns the exception's message.
func (s *InvalidInputException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidInputException) OrigErr() error {
return nil
}
func (s *InvalidInputException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *InvalidInputException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *InvalidInputException) RequestID() string {
return s.RespMetadata.RequestID
}
// An object that identifies an item.
//
// The and APIs return a list of PredictedItems.
type PredictedItem struct {
_ struct{} `type:"structure"`
// The recommended item ID.
ItemId *string `locationName:"itemId" type:"string"`
// The name of the promotion that included the predicted item.
PromotionName *string `locationName:"promotionName" min:"1" type:"string"`
// A numeric representation of the model's certainty that the item will be the
// next user selection. For more information on scoring logic, see how-scores-work.
Score *float64 `locationName:"score" type:"double"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictedItem) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictedItem) GoString() string {
return s.String()
}
// SetItemId sets the ItemId field's value.
func (s *PredictedItem) SetItemId(v string) *PredictedItem {
s.ItemId = &v
return s
}
// SetPromotionName sets the PromotionName field's value.
func (s *PredictedItem) SetPromotionName(v string) *PredictedItem {
s.PromotionName = &v
return s
}
// SetScore sets the Score field's value.
func (s *PredictedItem) SetScore(v float64) *PredictedItem {
s.Score = &v
return s
}
// Contains information on a promotion. A promotion defines additional business
// rules that apply to a configurable subset of recommended items.
type Promotion struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the filter used by the promotion. This
// filter defines the criteria for promoted items. For more information, see
// Promotion filters (https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters).
FilterArn *string `locationName:"filterArn" type:"string"`
// The values to use when promoting items. For each placeholder parameter in
// your promotion's filter expression, provide the parameter name (in matching
// case) as a key and the filter value(s) as the corresponding value. Separate
// multiple values for one parameter with a comma.
//
// For filter expressions that use an INCLUDE element to include items, you
// must provide values for all parameters that are defined in the expression.
// For filters with expressions that use an EXCLUDE element to exclude items,
// you can omit the filter-values. In this case, Amazon Personalize doesn't
// use that portion of the expression to filter recommendations.
//
// For more information on creating filters, see Filtering recommendations and
// user segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
FilterValues map[string]*string `locationName:"filterValues" type:"map"`
// The name of the promotion.
Name *string `locationName:"name" min:"1" type:"string"`
// The percentage of recommended items to apply the promotion to.
PercentPromotedItems *int64 `locationName:"percentPromotedItems" min:"1" type:"integer"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Promotion) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Promotion) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Promotion) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "Promotion"}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Name", 1))
}
if s.PercentPromotedItems != nil && *s.PercentPromotedItems < 1 {
invalidParams.Add(request.NewErrParamMinValue("PercentPromotedItems", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilterArn sets the FilterArn field's value.
func (s *Promotion) SetFilterArn(v string) *Promotion {
s.FilterArn = &v
return s
}
// SetFilterValues sets the FilterValues field's value.
func (s *Promotion) SetFilterValues(v map[string]*string) *Promotion {
s.FilterValues = v
return s
}
// SetName sets the Name field's value.
func (s *Promotion) SetName(v string) *Promotion {
s.Name = &v
return s
}
// SetPercentPromotedItems sets the PercentPromotedItems field's value.
func (s *Promotion) SetPercentPromotedItems(v int64) *Promotion {
s.PercentPromotedItems = &v
return s
}
// The specified resource does not exist.
type ResourceNotFoundException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceNotFoundException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceNotFoundException) GoString() string {
return s.String()
}
func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error {
return &ResourceNotFoundException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ResourceNotFoundException) Code() string {
return "ResourceNotFoundException"
}
// Message returns the exception's message.
func (s *ResourceNotFoundException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) OrigErr() error {
return nil
}
func (s *ResourceNotFoundException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ResourceNotFoundException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) RequestID() string {
return s.RespMetadata.RequestID
}
|