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.

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 Events.

  • Field Details

  • Method Details

    • putEvents

      default CompletableFuture<PutEventsResponse> putEvents(PutEventsRequest putEventsRequest)

      Records user interaction event data. For more information see Recording 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:

    • putEvents

      default CompletableFuture<PutEventsResponse> putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)

      Records user interaction event data. For more information see Recording 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.
      • 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 Incrementally.

      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:

    • putItems

      default CompletableFuture<PutItemsResponse> putItems(Consumer<PutItemsRequest.Builder> putItemsRequest)

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


      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.
      • 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 Incrementally.

      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:

    • putUsers

      default CompletableFuture<PutUsersResponse> putUsers(Consumer<PutUsersRequest.Builder> putUsersRequest)

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


      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.
      • 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.