All Known Subinterfaces:

AmazonPersonalizeRuntimeAsync

All Known Implementing Classes:

AbstractAmazonPersonalizeRuntime, AbstractAmazonPersonalizeRuntimeAsync, AmazonPersonalizeRuntimeAsyncClient, AmazonPersonalizeRuntimeClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPersonalizeRuntime

• Field Summary

  Fields

  Modifier and Type	Field and Description
  static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  GetActionRecommendationsResult	getActionRecommendations (GetActionRecommendationsRequest getActionRecommendationsRequest) Returns a list of recommended actions in sorted in descending order by prediction score.
  ResponseMetadata	getCachedResponseMetadata (AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
  GetPersonalizedRankingResult	getPersonalizedRanking (GetPersonalizedRankingRequest getPersonalizedRankingRequest) Re-ranks a list of recommended items for the given user.
  GetRecommendationsResult	getRecommendations (GetRecommendationsRequest getRecommendationsRequest) Returns a list of recommended items.
  void	shutdown () Shuts down this client object, releasing any resources that might be held open.

• Field Detail

  • ENDPOINT_PREFIX

    static final String ENDPOINT_PREFIX

    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

    See Also:

    RegionUtils.getRegionsForService(String), Constant Field Values

• Method Detail

  • getActionRecommendations

    GetActionRecommendationsResult getActionRecommendations(GetActionRecommendationsRequest getActionRecommendationsRequest)

    Returns a list of recommended actions in sorted in descending order by prediction score. Use the GetActionRecommendations API if you have a custom campaign that deploys a solution version trained with a PERSONALIZED_ACTIONS recipe.

    For more information about PERSONALIZED_ACTIONS recipes, see PERSONALIZED_ACTIONS recipes. For more information about getting action recommendations, see Getting action recommendations.

    Parameters:

    getActionRecommendationsRequest -

    Returns:

    Result of the GetActionRecommendations operation returned by the service.

    Throws:

    InvalidInputException - Provide a valid value for the field or parameter.

    ResourceNotFoundException - The specified resource does not exist.

    See Also:

    AWS API Documentation

  • getPersonalizedRanking

    GetPersonalizedRankingResult getPersonalizedRanking(GetPersonalizedRankingRequest getPersonalizedRankingRequest)

    Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.

    The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.

    Parameters:

    getPersonalizedRankingRequest -

    Returns:

    Result of the GetPersonalizedRanking operation returned by the service.

    Throws:

    InvalidInputException - Provide a valid value for the field or parameter.

    ResourceNotFoundException - The specified resource does not exist.

    See Also:

    AWS API Documentation

  • getRecommendations

    GetRecommendationsResult getRecommendations(GetRecommendationsRequest getRecommendationsRequest)

    Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows:

    • USER_PERSONALIZATION - userId required, itemId not used

    • RELATED_ITEMS - itemId required, userId not used

    Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.

    For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see Choosing recommender use cases.

    Parameters:

    getRecommendationsRequest -

    Returns:

    Result of the GetRecommendations operation returned by the service.

    Throws:

    InvalidInputException - Provide a valid value for the field or parameter.

    ResourceNotFoundException - The specified resource does not exist.

    See Also:

    AWS API Documentation

  • shutdown

    void shutdown()

    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

  • getCachedResponseMetadata

    ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

    Parameters:

    request - The originally executed request.

    Returns:

    The response metadata for the specified request, or null if none is available.