Package software.amazon.awssdk.services.personalizeevents

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 static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference 
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • 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.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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • 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.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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • 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.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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • 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.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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • 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.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:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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:

    • serviceClientConfiguration

      default PersonalizeEventsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static PersonalizeEventsAsyncClient create()
      Create a PersonalizeEventsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static PersonalizeEventsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a PersonalizeEventsAsyncClient.