| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
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
- defaultService :: Service
- _InvalidInputException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- data PutEvents = PutEvents' (Maybe (Sensitive Text)) Text Text (NonEmpty (Sensitive Event))
- newPutEvents :: Text -> Text -> NonEmpty Event -> PutEvents
- data PutEventsResponse = PutEventsResponse' {
- newPutEventsResponse :: PutEventsResponse
- data PutItems = PutItems' Text (NonEmpty Item)
- newPutItems :: Text -> NonEmpty Item -> PutItems
- data PutItemsResponse = PutItemsResponse' {
- newPutItemsResponse :: PutItemsResponse
- data PutUsers = PutUsers' Text (NonEmpty User)
- newPutUsers :: Text -> NonEmpty User -> PutUsers
- data PutUsersResponse = PutUsersResponse' {
- newPutUsersResponse :: PutUsersResponse
- data Event = Event' (Maybe Text) (Maybe Double) (Maybe (NonEmpty (Sensitive Text))) (Maybe (Sensitive Text)) (Maybe MetricAttribution) (Maybe (Sensitive Text)) (Maybe Text) Text POSIX
- newEvent :: Text -> UTCTime -> Event
- data Item = Item' (Maybe (Sensitive Text)) Text
- newItem :: Text -> Item
- data MetricAttribution = MetricAttribution' Text
- newMetricAttribution :: Text -> MetricAttribution
- data User = User' (Maybe (Sensitive Text)) Text
- newUser :: Text -> User
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 => Fold a ServiceError Source #
Provide a valid value for the field or parameter.
ResourceInUseException
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The specified resource is in use.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Could not find the specified resource.
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.
PutEvents
See: newPutEvents smart constructor.
Instances
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:
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
newPutEventsResponse :: PutEventsResponse Source #
Create a value of PutEventsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutItems
See: newPutItems smart constructor.
Instances
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
| Generic PutItemsResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutItems Associated Types type Rep PutItemsResponse :: Type -> Type # Methods from :: PutItemsResponse -> Rep PutItemsResponse x # to :: Rep PutItemsResponse x -> PutItemsResponse # | |
| Read PutItemsResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutItems Methods readsPrec :: Int -> ReadS PutItemsResponse # readList :: ReadS [PutItemsResponse] # | |
| Show PutItemsResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutItems Methods showsPrec :: Int -> PutItemsResponse -> ShowS # show :: PutItemsResponse -> String # showList :: [PutItemsResponse] -> ShowS # | |
| NFData PutItemsResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutItems Methods rnf :: PutItemsResponse -> () # | |
| Eq PutItemsResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutItems Methods (==) :: PutItemsResponse -> PutItemsResponse -> Bool # (/=) :: PutItemsResponse -> PutItemsResponse -> Bool # | |
| type Rep PutItemsResponse Source # | |
newPutItemsResponse :: PutItemsResponse Source #
Create a value of PutItemsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutUsers
See: newPutUsers smart constructor.
Instances
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
| Generic PutUsersResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutUsers Associated Types type Rep PutUsersResponse :: Type -> Type # Methods from :: PutUsersResponse -> Rep PutUsersResponse x # to :: Rep PutUsersResponse x -> PutUsersResponse # | |
| Read PutUsersResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutUsers Methods readsPrec :: Int -> ReadS PutUsersResponse # readList :: ReadS [PutUsersResponse] # | |
| Show PutUsersResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutUsers Methods showsPrec :: Int -> PutUsersResponse -> ShowS # show :: PutUsersResponse -> String # showList :: [PutUsersResponse] -> ShowS # | |
| NFData PutUsersResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutUsers Methods rnf :: PutUsersResponse -> () # | |
| Eq PutUsersResponse Source # | |
Defined in Amazonka.PersonalizeEvents.PutUsers Methods (==) :: PutUsersResponse -> PutUsersResponse -> Bool # (/=) :: PutUsersResponse -> PutUsersResponse -> Bool # | |
| type Rep PutUsersResponse Source # | |
newPutUsersResponse :: PutUsersResponse Source #
Create a value of PutUsersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
Event
Represents user interaction event information sent using the PutEvents
API.
See: newEvent smart constructor.
Constructors
| Event' (Maybe Text) (Maybe Double) (Maybe (NonEmpty (Sensitive Text))) (Maybe (Sensitive Text)) (Maybe MetricAttribution) (Maybe (Sensitive Text)) (Maybe Text) Text POSIX |
Instances
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: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:eventValue:Event', event_eventValue - The event value that corresponds to the EVENT_VALUE 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"].
Provide a list of items to manually record impressions data for an
event. For more information on recording impressions data, see
Recording impressions data.
$sel:itemId:Event', event_itemId - The item ID key that corresponds to the ITEM_ID field of the
Interactions schema.
$sel:metricAttribution:Event', event_metricAttribution - Contains information about the metric attribution associated with an
event. For more information about metric attributions, see
Measuring impact of recommendations.
$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:recommendationId:Event', event_recommendationId - The ID of the list of recommendations that contains the item the user
interacted with. Provide a recommendationId to have Amazon Personalize
implicitly record the recommendations you show your user as impressions
data. Or provide a recommendationId if you use a metric attribution to
measure the impact of recommendations.
For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.
$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
Represents item metadata added to an Items dataset using the PutItems
API. For more information see
Importing Items Incrementally.
See: newItem smart constructor.
Instances
| ToJSON Item Source # | |
Defined in Amazonka.PersonalizeEvents.Types.Item | |
| Generic Item Source # | |
| Show Item Source # | |
| NFData Item Source # | |
Defined in Amazonka.PersonalizeEvents.Types.Item | |
| Eq Item Source # | |
| Hashable Item Source # | |
Defined in Amazonka.PersonalizeEvents.Types.Item | |
| type Rep Item Source # | |
Defined in Amazonka.PersonalizeEvents.Types.Item type Rep Item = D1 ('MetaData "Item" "Amazonka.PersonalizeEvents.Types.Item" "amazonka-personalize-events-2.0-Fi47jZEjr1NizLD1LiiPl" 'False) (C1 ('MetaCons "Item'" 'PrefixI 'True) (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "itemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
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.
MetricAttribution
data MetricAttribution Source #
Contains information about a metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.
See: newMetricAttribution smart constructor.
Constructors
| MetricAttribution' Text |
Instances
Create a value of MetricAttribution 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:eventAttributionSource:MetricAttribution', metricAttribution_eventAttributionSource - The source of the event, such as a third party.
User
Represents user metadata added to a Users dataset using the PutUsers
API. For more information see
Importing Users Incrementally.
See: newUser smart constructor.
Instances
| ToJSON User Source # | |
Defined in Amazonka.PersonalizeEvents.Types.User | |
| Generic User Source # | |
| Show User Source # | |
| NFData User Source # | |
Defined in Amazonka.PersonalizeEvents.Types.User | |
| Eq User Source # | |
| Hashable User Source # | |
Defined in Amazonka.PersonalizeEvents.Types.User | |
| type Rep User Source # | |
Defined in Amazonka.PersonalizeEvents.Types.User type Rep User = D1 ('MetaData "User" "Amazonka.PersonalizeEvents.Types.User" "amazonka-personalize-events-2.0-Fi47jZEjr1NizLD1LiiPl" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
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.