com.amazonaws.services.personalizeevents

Interface AmazonPersonalizeEvents

All Known Subinterfaces:

AmazonPersonalizeEventsAsync

All Known Implementing Classes:

AbstractAmazonPersonalizeEvents, AbstractAmazonPersonalizeEventsAsync, AmazonPersonalizeEventsAsyncClient, AmazonPersonalizeEventsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPersonalizeEvents

Interface for accessing Amazon Personalize Events.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPersonalizeEvents instead.

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 and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
PutActionInteractionsResult	putActionInteractions(PutActionInteractionsRequest putActionInteractionsRequest) Records action interaction event data.
PutActionsResult	putActions(PutActionsRequest putActionsRequest) Adds one or more actions to an Actions dataset.
PutEventsResult	putEvents(PutEventsRequest putEventsRequest) Records item interaction event data.
PutItemsResult	putItems(PutItemsRequest putItemsRequest) Adds one or more items to an Items dataset.
PutUsersResult	putUsers(PutUsersRequest putUsersRequest) Adds one or more users to a Users dataset.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

putActionInteractions

PutActionInteractionsResult 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:

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.

See Also:

AWS API Documentation

putActions

PutActionsResult putActions(PutActionsRequest putActionsRequest)

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.

See Also:

AWS API Documentation

putEvents

PutEventsResult putEvents(PutEventsRequest putEventsRequest)

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.

See Also:

AWS API Documentation

putItems

PutItemsResult putItems(PutItemsRequest putItemsRequest)

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.

See Also:

AWS API Documentation

putUsers

PutUsersResult putUsers(PutUsersRequest putUsersRequest)

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.