blib/lib/Paws/PersonalizeRuntime/GetPersonalizedRanking.pm untested

filter: Statementstmt 0.0% 0 / 22 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 24 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::PersonalizeRuntime::GetPersonalizedRanking;
3 use Moose;
4 has CampaignArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'campaignArn', required => 1);
5 has Context => (is => 'ro', isa => 'Paws::PersonalizeRuntime::Context', traits => ['NameInRequest'], request_name => 'context');
6 has FilterArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterArn');
7 has FilterValues => (is => 'ro', isa => 'Paws::PersonalizeRuntime::FilterValues', traits => ['NameInRequest'], request_name => 'filterValues');
8 has InputList => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'inputList', required => 1);
9 has UserId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'userId', required => 1);
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetPersonalizedRanking');
14 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/personalize-ranking');
15 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PersonalizeRuntime::GetPersonalizedRankingResponse');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::PersonalizeRuntime::GetPersonalizedRanking - Arguments for method GetPersonalizedRanking on L<Paws::PersonalizeRuntime>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method GetPersonalizedRanking on the
28 L<Amazon Personalize Runtime|Paws::PersonalizeRuntime> service. Use the attributes of this class
29 as arguments to method GetPersonalizedRanking.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetPersonalizedRanking.
32  
33 =head1 SYNOPSIS
34  
35 my $personalize-runtime = Paws->service('PersonalizeRuntime');
36 my $GetPersonalizedRankingResponse =
37 $personalize -runtime->GetPersonalizedRanking(
38 CampaignArn => 'MyArn',
39 InputList => [
40 'MyItemID', ... # max: 256
41 ],
42 UserId => 'MyUserID',
43 Context => {
44 'MyAttributeName' =>
45 'MyAttributeValue', # key: max: 150, value: max: 1000
46 }, # OPTIONAL
47 FilterArn => 'MyArn', # OPTIONAL
48 FilterValues => {
49 'MyFilterAttributeName' =>
50 'MyFilterAttributeValue', # key: max: 50, value: max: 1000
51 }, # OPTIONAL
52 );
53  
54 # Results:
55 my $PersonalizedRanking =
56 $GetPersonalizedRankingResponse->PersonalizedRanking;
57 my $RecommendationId = $GetPersonalizedRankingResponse->RecommendationId;
58  
59 # Returns a L<Paws::PersonalizeRuntime::GetPersonalizedRankingResponse> object.
60  
61 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
62 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/personalize-runtime/GetPersonalizedRanking>
63  
64 =head1 ATTRIBUTES
65  
66  
67 =head2 B<REQUIRED> CampaignArn => Str
68  
69 The Amazon Resource Name (ARN) of the campaign to use for generating
70 the personalized ranking.
71  
72  
73  
74 =head2 Context => L<Paws::PersonalizeRuntime::Context>
75  
76 The contextual metadata to use when getting recommendations. Contextual
77 metadata includes any interaction information that might be relevant
78 when getting a user's recommendations, such as the user's current
79 location or device type.
80  
81  
82  
83 =head2 FilterArn => Str
84  
85 The Amazon Resource Name (ARN) of a filter you created to include items
86 or exclude items from recommendations for a given user. For more
87 information, see Filtering Recommendations
88 (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
89  
90  
91  
92 =head2 FilterValues => L<Paws::PersonalizeRuntime::FilterValues>
93  
94 The values to use when filtering recommendations. For each placeholder
95 parameter in your filter expression, provide the parameter name (in
96 matching case) as a key and the filter value(s) as the corresponding
97 value. Separate multiple values for one parameter with a comma.
98  
99 For filter expressions that use an C<INCLUDE> element to include items,
100 you must provide values for all parameters that are defined in the
101 expression. For filters with expressions that use an C<EXCLUDE> element
102 to exclude items, you can omit the C<filter-values>.In this case,
103 Amazon Personalize doesn't use that portion of the expression to filter
104 recommendations.
105  
106 For more information, see Filtering Recommendations
107 (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
108  
109  
110  
111 =head2 B<REQUIRED> InputList => ArrayRef[Str|Undef]
112  
113 A list of items (by C<itemId>) to rank. If an item was not included in
114 the training dataset, the item is appended to the end of the reranked
115 list. The maximum is 500.
116  
117  
118  
119 =head2 B<REQUIRED> UserId => Str
120  
121 The user for which you want the campaign to provide a personalized
122 ranking.
123  
124  
125  
126  
127 =head1 SEE ALSO
128  
129 This class forms part of L<Paws>, documenting arguments for method GetPersonalizedRanking in L<Paws::PersonalizeRuntime>
130  
131 =head1 BUGS and CONTRIBUTIONS
132  
133 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
134  
135 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
136  
137 =cut
138