Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Personalize.CreateEventTracker

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker.

The event tracker can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS

To get the status of the event tracker, call DescribeEventTracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

ListEventTrackers
DescribeEventTracker
DeleteEventTracker

Creating a Request

data CreateEventTracker Source #

See: newCreateEventTracker smart constructor.

Constructors

CreateEventTracker'
Fields name :: Text The name for the event tracker. datasetGroupArn :: Text The Amazon Resource Name (ARN) of the dataset group that receives the event data.

Instances

Instances details

Eq CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods (==) :: CreateEventTracker -> CreateEventTracker -> Bool # (/=) :: CreateEventTracker -> CreateEventTracker -> Bool #
Read CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods readsPrec :: Int -> ReadS CreateEventTracker # readList :: ReadS [CreateEventTracker] # readPrec :: ReadPrec CreateEventTracker # readListPrec :: ReadPrec [CreateEventTracker] #
Show CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods showsPrec :: Int -> CreateEventTracker -> ShowS # show :: CreateEventTracker -> String # showList :: [CreateEventTracker] -> ShowS #
Generic CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Associated Types type Rep CreateEventTracker :: Type -> Type # Methods from :: CreateEventTracker -> Rep CreateEventTracker x # to :: Rep CreateEventTracker x -> CreateEventTracker #
NFData CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods rnf :: CreateEventTracker -> () #
Hashable CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods hashWithSalt :: Int -> CreateEventTracker -> Int # hash :: CreateEventTracker -> Int #
ToJSON CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods toJSON :: CreateEventTracker -> Value # toEncoding :: CreateEventTracker -> Encoding # toJSONList :: [CreateEventTracker] -> Value # toEncodingList :: [CreateEventTracker] -> Encoding #
AWSRequest CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Associated Types type AWSResponse CreateEventTracker # Methods request :: CreateEventTracker -> Request CreateEventTracker # response :: MonadResource m => Logger -> Service -> Proxy CreateEventTracker -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEventTracker))) #
ToHeaders CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods toHeaders :: CreateEventTracker -> [Header] #
ToPath CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods toPath :: CreateEventTracker -> ByteString #
ToQuery CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods toQuery :: CreateEventTracker -> QueryString #
type Rep CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker type Rep CreateEventTracker = D1 ('MetaData "CreateEventTracker" "Amazonka.Personalize.CreateEventTracker" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CreateEventTracker'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateEventTracker Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker type AWSResponse CreateEventTracker = CreateEventTrackerResponse

newCreateEventTracker Source #

Arguments

:: Text	`$sel:name:CreateEventTracker'`
-> Text	`$sel:datasetGroupArn:CreateEventTracker'`
-> CreateEventTracker

Create a value of CreateEventTracker 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:name:CreateEventTracker', createEventTracker_name - The name for the event tracker.

$sel:datasetGroupArn:CreateEventTracker', createEventTracker_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that receives the event data.

Request Lenses

createEventTracker_name :: Lens' CreateEventTracker Text Source #

The name for the event tracker.

createEventTracker_datasetGroupArn :: Lens' CreateEventTracker Text Source #

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

Destructuring the Response

data CreateEventTrackerResponse Source #

See: newCreateEventTrackerResponse smart constructor.

Constructors

CreateEventTrackerResponse'
Fields trackingId :: Maybe Text The ID of the event tracker. Include this ID in requests to the PutEvents API. eventTrackerArn :: Maybe Text The ARN of the event tracker. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateEventTrackerResponse Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods (==) :: CreateEventTrackerResponse -> CreateEventTrackerResponse -> Bool # (/=) :: CreateEventTrackerResponse -> CreateEventTrackerResponse -> Bool #
Read CreateEventTrackerResponse Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods readsPrec :: Int -> ReadS CreateEventTrackerResponse # readList :: ReadS [CreateEventTrackerResponse] # readPrec :: ReadPrec CreateEventTrackerResponse # readListPrec :: ReadPrec [CreateEventTrackerResponse] #
Show CreateEventTrackerResponse Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods showsPrec :: Int -> CreateEventTrackerResponse -> ShowS # show :: CreateEventTrackerResponse -> String # showList :: [CreateEventTrackerResponse] -> ShowS #
Generic CreateEventTrackerResponse Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Associated Types type Rep CreateEventTrackerResponse :: Type -> Type # Methods from :: CreateEventTrackerResponse -> Rep CreateEventTrackerResponse x # to :: Rep CreateEventTrackerResponse x -> CreateEventTrackerResponse #
NFData CreateEventTrackerResponse Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker Methods rnf :: CreateEventTrackerResponse -> () #
type Rep CreateEventTrackerResponse Source #
Instance details Defined in Amazonka.Personalize.CreateEventTracker type Rep CreateEventTrackerResponse = D1 ('MetaData "CreateEventTrackerResponse" "Amazonka.Personalize.CreateEventTracker" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CreateEventTrackerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trackingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "eventTrackerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateEventTrackerResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEventTrackerResponse'`
-> CreateEventTrackerResponse

Create a value of CreateEventTrackerResponse 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:trackingId:CreateEventTrackerResponse', createEventTrackerResponse_trackingId - The ID of the event tracker. Include this ID in requests to the PutEvents API.

$sel:eventTrackerArn:CreateEventTrackerResponse', createEventTrackerResponse_eventTrackerArn - The ARN of the event tracker.

$sel:httpStatus:CreateEventTrackerResponse', createEventTrackerResponse_httpStatus - The response's http status code.

Response Lenses

createEventTrackerResponse_trackingId :: Lens' CreateEventTrackerResponse (Maybe Text) Source #

The ID of the event tracker. Include this ID in requests to the PutEvents API.

createEventTrackerResponse_eventTrackerArn :: Lens' CreateEventTrackerResponse (Maybe Text) Source #

The ARN of the event tracker.

createEventTrackerResponse_httpStatus :: Lens' CreateEventTrackerResponse Int Source #

The response's http status code.