software.amazon.awssdk.services.personalizeruntime

Interface PersonalizeRuntimeAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface PersonalizeRuntimeAsyncClient
extends SdkClient

Service client for accessing Amazon Personalize Runtime asynchronously. This can be created using the static builder() method.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static PersonalizeRuntimeAsyncClientBuilder	builder() Create a builder that can be used to configure and create a PersonalizeRuntimeAsyncClient.
static PersonalizeRuntimeAsyncClient	create() Create a PersonalizeRuntimeAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<GetPersonalizedRankingResponse>	getPersonalizedRanking(Consumer<GetPersonalizedRankingRequest.Builder> getPersonalizedRankingRequest) Re-ranks a list of recommended items for the given user.
default CompletableFuture<GetPersonalizedRankingResponse>	getPersonalizedRanking(GetPersonalizedRankingRequest getPersonalizedRankingRequest) Re-ranks a list of recommended items for the given user.
default CompletableFuture<GetRecommendationsResponse>	getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) Returns a list of recommended items.
default CompletableFuture<GetRecommendationsResponse>	getRecommendations(GetRecommendationsRequest getRecommendationsRequest) Returns a list of recommended items.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

create

static PersonalizeRuntimeAsyncClient create()

Create a PersonalizeRuntimeAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static PersonalizeRuntimeAsyncClientBuilder builder()

Create a builder that can be used to configure and create a PersonalizeRuntimeAsyncClient.

getPersonalizedRanking

default CompletableFuture<GetPersonalizedRankingResponse> 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:

A Java Future containing the result of the GetPersonalizedRanking operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException The specified resource does not exist.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getPersonalizedRanking

default CompletableFuture<GetPersonalizedRankingResponse> getPersonalizedRanking(Consumer<GetPersonalizedRankingRequest.Builder> 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.

This is a convenience which creates an instance of the GetPersonalizedRankingRequest.Builder avoiding the need to create one manually via GetPersonalizedRankingRequest.builder()

Parameters:

getPersonalizedRankingRequest - A Consumer that will call methods on GetPersonalizedRankingRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetPersonalizedRanking operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException The specified resource does not exist.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getRecommendations

default CompletableFuture<GetRecommendationsResponse> 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:

A Java Future containing the result of the GetRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException The specified resource does not exist.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getRecommendations

default CompletableFuture<GetRecommendationsResponse> getRecommendations(Consumer<GetRecommendationsRequest.Builder> 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.

This is a convenience which creates an instance of the GetRecommendationsRequest.Builder avoiding the need to create one manually via GetRecommendationsRequest.builder()

Parameters:

getRecommendationsRequest - A Consumer that will call methods on GetRecommendationsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException The specified resource does not exist.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation