Interface PersonalizeEventsAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PersonalizeEventsAsyncClient extends AwsClient
Service client for accessing Amazon Personalize Events asynchronously. This can be created using the staticbuilder()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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
putActionInteractions
default CompletableFuture<PutActionInteractionsResponse> putActionInteractions(PutActionInteractionsRequest putActionInteractionsRequest)
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:
- A Java Future containing the result of the PutActionInteractions 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 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.
- See Also:
- AWS API Documentation
-
putActionInteractions
default CompletableFuture<PutActionInteractionsResponse> putActionInteractions(Consumer<PutActionInteractionsRequest.Builder> putActionInteractionsRequest)
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.Builderavoiding the need to create one manually viaPutActionInteractionsRequest.builder()- Parameters:
putActionInteractionsRequest- AConsumerthat will call methods onPutActionInteractionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutActionInteractions 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 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.
- See Also:
- AWS API Documentation
-
putActions
default CompletableFuture<PutActionsResponse> putActions(PutActionsRequest putActionsRequest)
Adds one or more actions to an Actions dataset. For more information see Importing actions individually.
- Parameters:
putActionsRequest-- Returns:
- A Java Future containing the result of the PutActions 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 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.
- See Also:
- AWS API Documentation
-
putActions
default CompletableFuture<PutActionsResponse> putActions(Consumer<PutActionsRequest.Builder> putActionsRequest)
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.Builderavoiding the need to create one manually viaPutActionsRequest.builder()- Parameters:
putActionsRequest- AConsumerthat will call methods onPutActionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutActions 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 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.
- See Also:
- AWS API Documentation
-
putEvents
default CompletableFuture<PutEventsResponse> putEvents(PutEventsRequest putEventsRequest)
Records item interaction event data. For more information see Recording item interaction events.
- Parameters:
putEventsRequest-- Returns:
- A Java Future containing the result of the PutEvents 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.
- 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.
- See Also:
- AWS API Documentation
-
putEvents
default CompletableFuture<PutEventsResponse> putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)
Records item interaction event data. For more information see Recording item interaction events.
This is a convenience which creates an instance of the
PutEventsRequest.Builderavoiding the need to create one manually viaPutEventsRequest.builder()- Parameters:
putEventsRequest- AConsumerthat will call methods onPutEventsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutEvents 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.
- 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.
- See Also:
- AWS API Documentation
-
putItems
default CompletableFuture<PutItemsResponse> putItems(PutItemsRequest putItemsRequest)
Adds one or more items to an Items dataset. For more information see Importing items individually.
- Parameters:
putItemsRequest-- Returns:
- A Java Future containing the result of the PutItems 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 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.
- See Also:
- AWS API Documentation
-
putItems
default CompletableFuture<PutItemsResponse> putItems(Consumer<PutItemsRequest.Builder> putItemsRequest)
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.Builderavoiding the need to create one manually viaPutItemsRequest.builder()- Parameters:
putItemsRequest- AConsumerthat will call methods onPutItemsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutItems 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 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.
- See Also:
- AWS API Documentation
-
putUsers
default CompletableFuture<PutUsersResponse> putUsers(PutUsersRequest putUsersRequest)
Adds one or more users to a Users dataset. For more information see Importing users individually.
- Parameters:
putUsersRequest-- Returns:
- A Java Future containing the result of the PutUsers 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 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.
- See Also:
- AWS API Documentation
-
putUsers
default CompletableFuture<PutUsersResponse> putUsers(Consumer<PutUsersRequest.Builder> putUsersRequest)
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.Builderavoiding the need to create one manually viaPutUsersRequest.builder()- Parameters:
putUsersRequest- AConsumerthat will call methods onPutUsersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutUsers 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 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.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default PersonalizeEventsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static PersonalizeEventsAsyncClient create()
Create aPersonalizeEventsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static PersonalizeEventsAsyncClientBuilder builder()
Create a builder that can be used to configure and create aPersonalizeEventsAsyncClient.
-
-