Package software.amazon.awssdk.services.personalizeruntime

Interface PersonalizeRuntimeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface PersonalizeRuntimeClient
extends AwsClient

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

Field Summary

Fields

Modifier and Type	Field	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	Description
static PersonalizeRuntimeClientBuilder	builder()	Create a builder that can be used to configure and create a PersonalizeRuntimeClient.
static PersonalizeRuntimeClient	create()	Create a PersonalizeRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetActionRecommendationsResponse	getActionRecommendations(Consumer<GetActionRecommendationsRequest.Builder> getActionRecommendationsRequest)	Returns a list of recommended actions in sorted in descending order by prediction score.
default GetActionRecommendationsResponse	getActionRecommendations(GetActionRecommendationsRequest getActionRecommendationsRequest)	Returns a list of recommended actions in sorted in descending order by prediction score.
default GetPersonalizedRankingResponse	getPersonalizedRanking(Consumer<GetPersonalizedRankingRequest.Builder> getPersonalizedRankingRequest)	Re-ranks a list of recommended items for the given user.
default GetPersonalizedRankingResponse	getPersonalizedRanking(GetPersonalizedRankingRequest getPersonalizedRankingRequest)	Re-ranks a list of recommended items for the given user.
default GetRecommendationsResponse	getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest)	Returns a list of recommended items.
default GetRecommendationsResponse	getRecommendations(GetRecommendationsRequest getRecommendationsRequest)	Returns a list of recommended items.
default PersonalizeRuntimeServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

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

close

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

serviceName

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

getActionRecommendations

default GetActionRecommendationsResponse getActionRecommendations(GetActionRecommendationsRequest getActionRecommendationsRequest)
                                                           throws InvalidInputException,
                                                                  ResourceNotFoundException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  PersonalizeRuntimeException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getActionRecommendations

default GetActionRecommendationsResponse getActionRecommendations(Consumer<GetActionRecommendationsRequest.Builder> getActionRecommendationsRequest)
                                                           throws InvalidInputException,
                                                                  ResourceNotFoundException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  PersonalizeRuntimeException

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.

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

Parameters:

getActionRecommendationsRequest - A Consumer that will call methods on GetActionRecommendationsRequest.Builder to create a request.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getPersonalizedRanking

default GetPersonalizedRankingResponse getPersonalizedRanking(GetPersonalizedRankingRequest getPersonalizedRankingRequest)
                                                       throws InvalidInputException,
                                                              ResourceNotFoundException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              PersonalizeRuntimeException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getPersonalizedRanking

default GetPersonalizedRankingResponse getPersonalizedRanking(Consumer<GetPersonalizedRankingRequest.Builder> getPersonalizedRankingRequest)
                                                       throws InvalidInputException,
                                                              ResourceNotFoundException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              PersonalizeRuntimeException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getRecommendations

default GetRecommendationsResponse getRecommendations(GetRecommendationsRequest getRecommendationsRequest)
                                               throws InvalidInputException,
                                                      ResourceNotFoundException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      PersonalizeRuntimeException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getRecommendations

default GetRecommendationsResponse getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest)
                                               throws InvalidInputException,
                                                      ResourceNotFoundException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      PersonalizeRuntimeException

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.

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

create

static PersonalizeRuntimeClient create()

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

builder

static PersonalizeRuntimeClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default PersonalizeRuntimeServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient