Package software.amazon.awssdk.services.personalizeruntime.model

Interface GetActionRecommendationsRequest.Builder

    • Method Detail

      • campaignArn

        GetActionRecommendationsRequest.Builder campaignArn​(String campaignArn)

        The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

        Parameters:
        campaignArn - The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userId

        GetActionRecommendationsRequest.Builder userId​(String userId)

        The user ID of the user to provide action recommendations for.

        Parameters:
        userId - The user ID of the user to provide action recommendations for.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • numResults

        GetActionRecommendationsRequest.Builder numResults​(Integer numResults)

        The number of results to return. The default is 5. The maximum is 100.

        Parameters:
        numResults - The number of results to return. The default is 5. The maximum is 100.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filterArn

        GetActionRecommendationsRequest.Builder filterArn​(String filterArn)

        The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

        When using this parameter, be sure the filter resource is ACTIVE.

        Parameters:
        filterArn - The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

        When using this parameter, be sure the filter resource is ACTIVE.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filterValues

        GetActionRecommendationsRequest.Builder filterValues​(Map<String,​String> 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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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.

        Parameters:
        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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.