com.amazonaws.services.personalizeruntime

Interface AmazonPersonalizeRuntime

All Known Subinterfaces:

AmazonPersonalizeRuntimeAsync

All Known Implementing Classes:

AbstractAmazonPersonalizeRuntime, AbstractAmazonPersonalizeRuntimeAsync, AmazonPersonalizeRuntimeAsyncClient, AmazonPersonalizeRuntimeClient

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

Interface for accessing Amazon Personalize Runtime.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPersonalizeRuntime instead.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
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

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. The required input depends on the recipe type used to create the solution backing the campaign, as follows:

• RELATED_ITEMS - itemId required, userId not used

• USER_PERSONALIZATION - itemId optional, userId required

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

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.