NAME

Paws::PersonalizeRuntime::GetPersonalizedRanking - Arguments for method GetPersonalizedRanking on Paws::PersonalizeRuntime

DESCRIPTION

This class represents the parameters used for calling the method GetPersonalizedRanking on the Amazon Personalize Runtime service. Use the attributes of this class as arguments to method GetPersonalizedRanking.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetPersonalizedRanking.

SYNOPSIS

    my $personalize-runtime = Paws->service('PersonalizeRuntime');
    my $GetPersonalizedRankingResponse =
      $personalize -runtime->GetPersonalizedRanking(
      CampaignArn => 'MyArn',
      InputList   => [
        'MyItemID', ...    # max: 256
      ],
      UserId  => 'MyUserID',
      Context => {
        'MyAttributeName' =>
          'MyAttributeValue',    # key: max: 150, value: max: 1000
      },    # OPTIONAL
      FilterArn    => 'MyArn',    # OPTIONAL
      FilterValues => {
        'MyFilterAttributeName' =>
          'MyFilterAttributeValue',    # key: max: 50, value: max: 1000
      },    # OPTIONAL
      );
    # Results:
    my $PersonalizedRanking =
      $GetPersonalizedRankingResponse->PersonalizedRanking;
    my $RecommendationId = $GetPersonalizedRankingResponse->RecommendationId;
 # Returns a L<Paws::PersonalizeRuntime::GetPersonalizedRankingResponse> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/personalize-runtime/GetPersonalizedRanking>

ATTRIBUTES

REQUIRED CampaignArn => Str

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Context => Paws::PersonalizeRuntime::Context

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.

FilterArn => Str

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).

FilterValues => Paws::PersonalizeRuntime::FilterValues

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).

REQUIRED InputList => ArrayRef[Str|Undef]

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.

REQUIRED UserId => Str

The user for which you want the campaign to provide a personalized ranking.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>