NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $personalize-runtime = Paws->service('PersonalizeRuntime');
    my $GetRecommendationsResponse = $personalize -runtime->GetRecommendations(
      CampaignArn => 'MyArn',
      Context     => {
        'MyAttributeName' =>
          'MyAttributeValue',    # key: max: 150, value: max: 1000
      },    # OPTIONAL
      FilterArn    => 'MyArn',    # OPTIONAL
      FilterValues => {
        'MyFilterAttributeName' =>
          'MyFilterAttributeValue',    # key: max: 50, value: max: 1000
      },    # OPTIONAL
      ItemId     => 'MyItemID',    # OPTIONAL
      NumResults => 1,             # OPTIONAL
      UserId     => 'MyUserID',    # OPTIONAL
    );

    # Results:
    my $ItemList         = $GetRecommendationsResponse->ItemList;
    my $RecommendationId = $GetRecommendationsResponse->RecommendationId;

    # Returns a L<Paws::PersonalizeRuntime::GetRecommendationsResponse> 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/GetRecommendations

ATTRIBUTES

REQUIRED CampaignArn => Str

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

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

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

ItemId => Str

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

NumResults => Int

The number of results to return. The default is 25. The maximum is 500.

UserId => Str

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetRecommendations in Paws::PersonalizeRuntime

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

cpanm Paws

perl -MCPAN -e shell
install Paws