« blib/lib/Paws/PersonalizeRuntime/GetPersonalizedRankingResponse.pm
↑ Summary
blib/lib/Paws/PersonalizeRuntime/GetRecommendationsResponse.pm »
| 1 | |||
| 2 | package Paws::PersonalizeRuntime::GetRecommendations; | ||
| 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 ItemId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'itemId'); | ||
| 9 | has NumResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'numResults'); | ||
| 10 | has UserId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'userId'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetRecommendations'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/recommendations'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PersonalizeRuntime::GetRecommendationsResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::PersonalizeRuntime::GetRecommendations - Arguments for method GetRecommendations on L<Paws::PersonalizeRuntime> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method GetRecommendations on the | ||
| 29 | L<Amazon Personalize Runtime|Paws::PersonalizeRuntime> service. Use the attributes of this class | ||
| 30 | as arguments to method GetRecommendations. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRecommendations. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $personalize-runtime = Paws->service('PersonalizeRuntime'); | ||
| 37 | my $GetRecommendationsResponse = $personalize -runtime->GetRecommendations( | ||
| 38 | CampaignArn => 'MyArn', | ||
| 39 | Context => { | ||
| 40 | 'MyAttributeName' => | ||
| 41 | 'MyAttributeValue', # key: max: 150, value: max: 1000 | ||
| 42 | }, # OPTIONAL | ||
| 43 | FilterArn => 'MyArn', # OPTIONAL | ||
| 44 | FilterValues => { | ||
| 45 | 'MyFilterAttributeName' => | ||
| 46 | 'MyFilterAttributeValue', # key: max: 50, value: max: 1000 | ||
| 47 | }, # OPTIONAL | ||
| 48 | ItemId => 'MyItemID', # OPTIONAL | ||
| 49 | NumResults => 1, # OPTIONAL | ||
| 50 | UserId => 'MyUserID', # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $ItemList = $GetRecommendationsResponse->ItemList; | ||
| 55 | my $RecommendationId = $GetRecommendationsResponse->RecommendationId; | ||
| 56 | |||
| 57 | # Returns a L<Paws::PersonalizeRuntime::GetRecommendationsResponse> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/personalize-runtime/GetRecommendations> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> CampaignArn => Str | ||
| 66 | |||
| 67 | The Amazon Resource Name (ARN) of the campaign to use for getting | ||
| 68 | recommendations. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 Context => L<Paws::PersonalizeRuntime::Context> | ||
| 73 | |||
| 74 | The contextual metadata to use when getting recommendations. Contextual | ||
| 75 | metadata includes any interaction information that might be relevant | ||
| 76 | when getting a user's recommendations, such as the user's current | ||
| 77 | location or device type. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 FilterArn => Str | ||
| 82 | |||
| 83 | The ARN of the filter to apply to the returned recommendations. For | ||
| 84 | more information, see Filtering Recommendations | ||
| 85 | (https://docs.aws.amazon.com/personalize/latest/dg/filter.html). | ||
| 86 | |||
| 87 | When using this parameter, be sure the filter resource is C<ACTIVE>. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 FilterValues => L<Paws::PersonalizeRuntime::FilterValues> | ||
| 92 | |||
| 93 | The values to use when filtering recommendations. For each placeholder | ||
| 94 | parameter in your filter expression, provide the parameter name (in | ||
| 95 | matching case) as a key and the filter value(s) as the corresponding | ||
| 96 | value. Separate multiple values for one parameter with a comma. | ||
| 97 | |||
| 98 | For filter expressions that use an C<INCLUDE> element to include items, | ||
| 99 | you must provide values for all parameters that are defined in the | ||
| 100 | expression. For filters with expressions that use an C<EXCLUDE> element | ||
| 101 | to exclude items, you can omit the C<filter-values>.In this case, | ||
| 102 | Amazon Personalize doesn't use that portion of the expression to filter | ||
| 103 | recommendations. | ||
| 104 | |||
| 105 | For more information, see Filtering Recommendations | ||
| 106 | (https://docs.aws.amazon.com/personalize/latest/dg/filter.html). | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 ItemId => Str | ||
| 111 | |||
| 112 | The item ID to provide recommendations for. | ||
| 113 | |||
| 114 | Required for C<RELATED_ITEMS> recipe type. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 NumResults => Int | ||
| 119 | |||
| 120 | The number of results to return. The default is 25. The maximum is 500. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 UserId => Str | ||
| 125 | |||
| 126 | The user ID to provide recommendations for. | ||
| 127 | |||
| 128 | Required for C<USER_PERSONALIZATION> recipe type. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, documenting arguments for method GetRecommendations in L<Paws::PersonalizeRuntime> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |