com.amazonaws.services.personalizeruntime

Class AmazonPersonalizeRuntimeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.personalizeruntime.AmazonPersonalizeRuntimeClient

All Implemented Interfaces:

AmazonPersonalizeRuntime

Direct Known Subclasses:

AmazonPersonalizeRuntimeAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonPersonalizeRuntimeClient
extends AmazonWebServiceClient
implements AmazonPersonalizeRuntime

Client for accessing Amazon Personalize Runtime. All service calls made using this client are blocking, and will not return until the service call completes.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.personalizeruntime.AmazonPersonalizeRuntime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonPersonalizeRuntimeClientBuilder	builder()
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 request) Re-ranks a list of recommended items for the given user.
GetRecommendationsResult	getRecommendations(GetRecommendationsRequest request) Returns a list of recommended items.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.personalizeruntime.AmazonPersonalizeRuntime

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonPersonalizeRuntimeClientBuilder builder()

getPersonalizedRanking

public GetPersonalizedRankingResult getPersonalizedRanking(GetPersonalizedRankingRequest request)

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.

Specified by:

getPersonalizedRanking in interface AmazonPersonalizeRuntime

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

public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request)

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.

Specified by:

getRecommendations in interface AmazonPersonalizeRuntime

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonPersonalizeRuntime

Parameters:

request - The originally executed request

Returns:

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