Package software.amazon.awssdk.services.personalizeevents

Interface PersonalizeEventsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

Amazon Personalize can consume real-time user event data, such as stream or click data, and use it for model training either alone or combined with historical data. For more information see Recording item interaction events.

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 PersonalizeEventsClientBuilder	builder()	Create a builder that can be used to configure and create a PersonalizeEventsClient.
static PersonalizeEventsClient	create()	Create a PersonalizeEventsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default PutActionInteractionsResponse	putActionInteractions(Consumer<PutActionInteractionsRequest.Builder> putActionInteractionsRequest)	Records action interaction event data.
default PutActionInteractionsResponse	putActionInteractions(PutActionInteractionsRequest putActionInteractionsRequest)	Records action interaction event data.
default PutActionsResponse	putActions(Consumer<PutActionsRequest.Builder> putActionsRequest)	Adds one or more actions to an Actions dataset.
default PutActionsResponse	putActions(PutActionsRequest putActionsRequest)	Adds one or more actions to an Actions dataset.
default PutEventsResponse	putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)	Records item interaction event data.
default PutEventsResponse	putEvents(PutEventsRequest putEventsRequest)	Records item interaction event data.
default PutItemsResponse	putItems(Consumer<PutItemsRequest.Builder> putItemsRequest)	Adds one or more items to an Items dataset.
default PutItemsResponse	putItems(PutItemsRequest putItemsRequest)	Adds one or more items to an Items dataset.
default PutUsersResponse	putUsers(Consumer<PutUsersRequest.Builder> putUsersRequest)	Adds one or more users to a Users dataset.
default PutUsersResponse	putUsers(PutUsersRequest putUsersRequest)	Adds one or more users to a Users dataset.
default PersonalizeEventsServiceClientConfiguration	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

putActionInteractions

default PutActionInteractionsResponse putActionInteractions(PutActionInteractionsRequest putActionInteractionsRequest)
                                                     throws InvalidInputException,
                                                            ResourceNotFoundException,
                                                            ResourceInUseException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            PersonalizeEventsException

Records action interaction event data. An action interaction event is an interaction between a user and an action. For example, a user taking an action, such a enrolling in a membership program or downloading your app.

For more information about recording action interactions, see Recording action interaction events. For more information about actions in an Actions dataset, see Actions dataset.

Parameters:

putActionInteractionsRequest -

Returns:

Result of the PutActionInteractions operation returned by the service.

Throws:

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

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

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.

PersonalizeEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putActionInteractions

default PutActionInteractionsResponse putActionInteractions(Consumer<PutActionInteractionsRequest.Builder> putActionInteractionsRequest)
                                                     throws InvalidInputException,
                                                            ResourceNotFoundException,
                                                            ResourceInUseException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            PersonalizeEventsException

Records action interaction event data. An action interaction event is an interaction between a user and an action. For example, a user taking an action, such a enrolling in a membership program or downloading your app.

For more information about recording action interactions, see Recording action interaction events. For more information about actions in an Actions dataset, see Actions dataset.

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

Parameters:

putActionInteractionsRequest - A Consumer that will call methods on PutActionInteractionsRequest.Builder to create a request.

Returns:

Result of the PutActionInteractions operation returned by the service.

Throws:

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

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

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.

PersonalizeEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putActions

default PutActionsResponse putActions(PutActionsRequest putActionsRequest)
                               throws InvalidInputException,
                                      ResourceNotFoundException,
                                      ResourceInUseException,
                                      AwsServiceException,
                                      SdkClientException,
                                      PersonalizeEventsException

Adds one or more actions to an Actions dataset. For more information see Importing actions individually.

Parameters:

putActionsRequest -

Returns:

Result of the PutActions operation returned by the service.

Throws:

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

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

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.

PersonalizeEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putActions

default PutActionsResponse putActions(Consumer<PutActionsRequest.Builder> putActionsRequest)
                               throws InvalidInputException,
                                      ResourceNotFoundException,
                                      ResourceInUseException,
                                      AwsServiceException,
                                      SdkClientException,
                                      PersonalizeEventsException

Adds one or more actions to an Actions dataset. For more information see Importing actions individually.

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

Parameters:

putActionsRequest - A Consumer that will call methods on PutActionsRequest.Builder to create a request.

Returns:

Result of the PutActions operation returned by the service.

Throws:

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

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

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.

PersonalizeEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putEvents

default PutEventsResponse putEvents(PutEventsRequest putEventsRequest)
                             throws InvalidInputException,
                                    AwsServiceException,
                                    SdkClientException,
                                    PersonalizeEventsException

Records item interaction event data. For more information see Recording item interaction events.

Parameters:

putEventsRequest -

Returns:

Result of the PutEvents operation returned by the service.

Throws:

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

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.

PersonalizeEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putEvents

default PutEventsResponse putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)
                             throws InvalidInputException,
                                    AwsServiceException,
                                    SdkClientException,
                                    PersonalizeEventsException

Records item interaction event data. For more information see Recording item interaction events.

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

Parameters:

putEventsRequest - A Consumer that will call methods on PutEventsRequest.Builder to create a request.

Returns:

Result of the PutEvents operation returned by the service.

Throws:

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

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.

PersonalizeEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putItems

default PutItemsResponse putItems(PutItemsRequest putItemsRequest)
                           throws InvalidInputException,
                                  ResourceNotFoundException,
                                  ResourceInUseException,
                                  AwsServiceException,
                                  SdkClientException,
                                  PersonalizeEventsException

Adds one or more items to an Items dataset. For more information see Importing items individually.

Parameters:

putItemsRequest -

Returns:

Result of the PutItems operation returned by the service.

Throws:

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

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

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.

PersonalizeEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putItems

default PutItemsResponse putItems(Consumer<PutItemsRequest.Builder> putItemsRequest)
                           throws InvalidInputException,
                                  ResourceNotFoundException,
                                  ResourceInUseException,
                                  AwsServiceException,
                                  SdkClientException,
                                  PersonalizeEventsException

Adds one or more items to an Items dataset. For more information see Importing items individually.

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

Parameters:

putItemsRequest - A Consumer that will call methods on PutItemsRequest.Builder to create a request.

Returns:

Result of the PutItems operation returned by the service.

Throws:

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

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

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.

PersonalizeEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putUsers

default PutUsersResponse putUsers(PutUsersRequest putUsersRequest)
                           throws InvalidInputException,
                                  ResourceNotFoundException,
                                  ResourceInUseException,
                                  AwsServiceException,
                                  SdkClientException,
                                  PersonalizeEventsException

Adds one or more users to a Users dataset. For more information see Importing users individually.

Parameters:

putUsersRequest -

Returns:

Result of the PutUsers operation returned by the service.

Throws:

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

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

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.

PersonalizeEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putUsers

default PutUsersResponse putUsers(Consumer<PutUsersRequest.Builder> putUsersRequest)
                           throws InvalidInputException,
                                  ResourceNotFoundException,
                                  ResourceInUseException,
                                  AwsServiceException,
                                  SdkClientException,
                                  PersonalizeEventsException

Adds one or more users to a Users dataset. For more information see Importing users individually.

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

Parameters:

putUsersRequest - A Consumer that will call methods on PutUsersRequest.Builder to create a request.

Returns:

Result of the PutUsers operation returned by the service.

Throws:

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

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

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.

PersonalizeEventsException - 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 PersonalizeEventsClient create()

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

builder

static PersonalizeEventsClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default PersonalizeEventsServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient