libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.PersonalizeEvents

Description

Derived from API version 2018-03-22 of the AWS service descriptions, licensed under Apache 2.0.

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.

Synopsis

Service Configuration

defaultService :: Service Source #

API version 2018-03-22 of the Amazon Personalize Events SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by PersonalizeEvents.

InvalidInputException

_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Provide a valid value for the field or parameter.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Could not find the specified resource.

ResourceInUseException

_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource is in use.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

PutUsers

data PutUsers Source #

See: newPutUsers smart constructor.

Constructors

PutUsers' Text (NonEmpty User) 

Instances

Instances details
Eq PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Read PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Show PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Generic PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Associated Types

type Rep PutUsers :: Type -> Type #

Methods

from :: PutUsers -> Rep PutUsers x #

to :: Rep PutUsers x -> PutUsers #

NFData PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Methods

rnf :: PutUsers -> () #

Hashable PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Methods

hashWithSalt :: Int -> PutUsers -> Int #

hash :: PutUsers -> Int #

ToJSON PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

AWSRequest PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Associated Types

type AWSResponse PutUsers #

ToHeaders PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Methods

toHeaders :: PutUsers -> [Header] #

ToPath PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

ToQuery PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

type Rep PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

type Rep PutUsers = D1 ('MetaData "PutUsers" "Amazonka.PersonalizeEvents.PutUsers" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "PutUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty User))))
type AWSResponse PutUsers Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

newPutUsers Source #

Create a value of PutUsers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:datasetArn:PutUsers', putUsers_datasetArn - The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.

$sel:users:PutUsers', putUsers_users - A list of user data.

data PutUsersResponse Source #

See: newPutUsersResponse smart constructor.

Constructors

PutUsersResponse' 

Instances

Instances details
Eq PutUsersResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Read PutUsersResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Show PutUsersResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Generic PutUsersResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Associated Types

type Rep PutUsersResponse :: Type -> Type #

NFData PutUsersResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

Methods

rnf :: PutUsersResponse -> () #

type Rep PutUsersResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutUsers

type Rep PutUsersResponse = D1 ('MetaData "PutUsersResponse" "Amazonka.PersonalizeEvents.PutUsers" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "PutUsersResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutUsersResponse :: PutUsersResponse Source #

Create a value of PutUsersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

PutItems

data PutItems Source #

See: newPutItems smart constructor.

Constructors

PutItems' Text (NonEmpty Item) 

Instances

Instances details
Eq PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Read PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Show PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Generic PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Associated Types

type Rep PutItems :: Type -> Type #

Methods

from :: PutItems -> Rep PutItems x #

to :: Rep PutItems x -> PutItems #

NFData PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Methods

rnf :: PutItems -> () #

Hashable PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Methods

hashWithSalt :: Int -> PutItems -> Int #

hash :: PutItems -> Int #

ToJSON PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

AWSRequest PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Associated Types

type AWSResponse PutItems #

ToHeaders PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Methods

toHeaders :: PutItems -> [Header] #

ToPath PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

ToQuery PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

type Rep PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

type Rep PutItems = D1 ('MetaData "PutItems" "Amazonka.PersonalizeEvents.PutItems" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "PutItems'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Item))))
type AWSResponse PutItems Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

newPutItems Source #

Create a value of PutItems with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:datasetArn:PutItems', putItems_datasetArn - The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.

$sel:items:PutItems', putItems_items - A list of item data.

data PutItemsResponse Source #

See: newPutItemsResponse smart constructor.

Constructors

PutItemsResponse' 

Instances

Instances details
Eq PutItemsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Read PutItemsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Show PutItemsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Generic PutItemsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Associated Types

type Rep PutItemsResponse :: Type -> Type #

NFData PutItemsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

Methods

rnf :: PutItemsResponse -> () #

type Rep PutItemsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutItems

type Rep PutItemsResponse = D1 ('MetaData "PutItemsResponse" "Amazonka.PersonalizeEvents.PutItems" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "PutItemsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutItemsResponse :: PutItemsResponse Source #

Create a value of PutItemsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

PutEvents

data PutEvents Source #

See: newPutEvents smart constructor.

Instances

Instances details
Eq PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Read PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Show PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Generic PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Associated Types

type Rep PutEvents :: Type -> Type #

NFData PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Methods

rnf :: PutEvents -> () #

Hashable PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

ToJSON PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

AWSRequest PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Associated Types

type AWSResponse PutEvents #

ToHeaders PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Methods

toHeaders :: PutEvents -> [Header] #

ToPath PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

ToQuery PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

type Rep PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

type Rep PutEvents = D1 ('MetaData "PutEvents" "Amazonka.PersonalizeEvents.PutEvents" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "PutEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "trackingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "eventList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Event)))))
type AWSResponse PutEvents Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

newPutEvents Source #

Create a value of PutEvents with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userId:PutEvents', putEvents_userId - The user associated with the event.

$sel:trackingId:PutEvents', putEvents_trackingId - The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.

$sel:sessionId:PutEvents', putEvents_sessionId - The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording Events.

$sel:eventList:PutEvents', putEvents_eventList - A list of event data from the session.

data PutEventsResponse Source #

See: newPutEventsResponse smart constructor.

Constructors

PutEventsResponse' 

Instances

Instances details
Eq PutEventsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Read PutEventsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Show PutEventsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Generic PutEventsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Associated Types

type Rep PutEventsResponse :: Type -> Type #

NFData PutEventsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

Methods

rnf :: PutEventsResponse -> () #

type Rep PutEventsResponse Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.PutEvents

type Rep PutEventsResponse = D1 ('MetaData "PutEventsResponse" "Amazonka.PersonalizeEvents.PutEvents" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "PutEventsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutEventsResponse :: PutEventsResponse Source #

Create a value of PutEventsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Types

Event

data Event Source #

Represents user interaction event information sent using the PutEvents API.

See: newEvent smart constructor.

Instances

Instances details
Eq Event Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Event

Methods

(==) :: Event -> Event -> Bool #

(/=) :: Event -> Event -> Bool #

Read Event Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Event

Show Event Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Event

Methods

showsPrec :: Int -> Event -> ShowS #

show :: Event -> String #

showList :: [Event] -> ShowS #

Generic Event Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Event

Associated Types

type Rep Event :: Type -> Type #

Methods

from :: Event -> Rep Event x #

to :: Rep Event x -> Event #

NFData Event Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Event

Methods

rnf :: Event -> () #

Hashable Event Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Event

Methods

hashWithSalt :: Int -> Event -> Int #

hash :: Event -> Int #

ToJSON Event Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Event

type Rep Event Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Event

newEvent Source #

Create a value of Event with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:recommendationId:Event', event_recommendationId - The ID of the recommendation.

$sel:eventValue:Event', event_eventValue - The event value that corresponds to the EVENT_VALUE field of the Interactions schema.

$sel:itemId:Event', event_itemId - The item ID key that corresponds to the ITEM_ID field of the Interactions schema.

$sel:impression:Event', event_impression - A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"].

$sel:eventId:Event', event_eventId - An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.

$sel:properties:Event', event_properties - A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user.

Each item in the map consists of a key-value pair. For example,

{"numberOfRatings": "12"}

The keys use camel case names that match the fields in the Interactions schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

$sel:eventType:Event', event_eventType - The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Interactions schema and depends on the types of events you are tracking.

$sel:sentAt:Event', event_sentAt - The timestamp (in Unix time) on the client side when the event occurred.

Item

data Item Source #

Represents item metadata added to an Items dataset using the PutItems API. For more information see Importing Items Incrementally.

See: newItem smart constructor.

Constructors

Item' (Maybe Text) Text 

Instances

Instances details
Eq Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

(==) :: Item -> Item -> Bool #

(/=) :: Item -> Item -> Bool #

Read Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Show Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

showsPrec :: Int -> Item -> ShowS #

show :: Item -> String #

showList :: [Item] -> ShowS #

Generic Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Associated Types

type Rep Item :: Type -> Type #

Methods

from :: Item -> Rep Item x #

to :: Rep Item x -> Item #

NFData Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

rnf :: Item -> () #

Hashable Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

hashWithSalt :: Int -> Item -> Int #

hash :: Item -> Int #

ToJSON Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

type Rep Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

type Rep Item = D1 ('MetaData "Item" "Amazonka.PersonalizeEvents.Types.Item" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "Item'" 'PrefixI 'True) (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "itemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newItem Source #

Arguments

:: Text

$sel:itemId:Item'

-> Item 

Create a value of Item with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:properties:Item', item_properties - A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfRatings": "12"}.

The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the numberOfRatings matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (|). For example, \"Horror|Action\".

$sel:itemId:Item', item_itemId - The ID associated with the item.

User

data User Source #

Represents user metadata added to a Users dataset using the PutUsers API. For more information see Importing Users Incrementally.

See: newUser smart constructor.

Constructors

User' (Maybe Text) Text 

Instances

Instances details
Eq User Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

(==) :: User -> User -> Bool #

(/=) :: User -> User -> Bool #

Read User Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.User

Show User Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

showsPrec :: Int -> User -> ShowS #

show :: User -> String #

showList :: [User] -> ShowS #

Generic User Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.User

Associated Types

type Rep User :: Type -> Type #

Methods

from :: User -> Rep User x #

to :: Rep User x -> User #

NFData User Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

rnf :: User -> () #

Hashable User Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

hashWithSalt :: Int -> User -> Int #

hash :: User -> Int #

ToJSON User Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.User

type Rep User Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.User

type Rep User = D1 ('MetaData "User" "Amazonka.PersonalizeEvents.Types.User" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUser Source #

Arguments

:: Text

$sel:userId:User'

-> User 

Create a value of User with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:properties:User', user_properties - A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfVideosWatched": "45"}.

The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the numberOfVideosWatched matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (|). For example, \"Member|Frequent shopper\".

$sel:userId:User', user_userId - The ID associated with the user.