We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.PersonalizeEvents

Inherits:
AWS.Service show all
Identifier:
personalizeevents
API Version:
2018-03-22
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using PersonalizeEvents

var personalizeevents = new AWS.PersonalizeEvents();
personalizeevents.putActionInteractions(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the PersonalizeEvents object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var personalizeevents = new AWS.PersonalizeEvents({apiVersion: '2018-03-22'});

You can also set the API version globally in AWS.config.apiVersions using the personalizeevents service identifier:

AWS.config.apiVersions = {
  personalizeevents: '2018-03-22',
  // other service API versions
};

var personalizeevents = new AWS.PersonalizeEvents();

Version:

  • 2018-03-22

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.PersonalizeEvents(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a PersonalizeEvents object

var personalizeevents = new AWS.PersonalizeEvents({apiVersion: '2018-03-22'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.PersonalizeEvents.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.PersonalizeEvents.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.PersonalizeEvents.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

putActionInteractions(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putActionInteractions operation

var params = {
  actionInteractions: [ /* required */
    {
      actionId: 'STRING_VALUE', /* required */
      eventType: 'STRING_VALUE', /* required */
      sessionId: 'STRING_VALUE', /* required */
      timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      eventId: 'STRING_VALUE',
      impression: [
        'STRING_VALUE',
        /* more items */
      ],
      properties: any /* This value will be JSON encoded on your behalf with JSON.stringify() */,
      recommendationId: 'STRING_VALUE',
      userId: 'STRING_VALUE'
    },
    /* more items */
  ],
  trackingId: 'STRING_VALUE' /* required */
};
personalizeevents.putActionInteractions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • trackingId — (String)

      The ID of your action interaction event tracker. When you create an Action interactions dataset, Amazon Personalize creates an action interaction event tracker for you. For more information, see Action interaction event tracker ID.

    • actionInteractions — (Array<map>)

      A list of action interaction events from the session.

      • actionId — required — (String)

        The ID of the action the user interacted with. This corresponds to the ACTION_ID field of the Action interaction schema.

      • userId — (String)

        The ID of the user who interacted with the action. This corresponds to the USER_ID field of the Action interaction schema.

      • sessionId — required — (String)

        The ID associated with the user's visit. Your application generates a unique sessionId when a user first visits your website or uses your application.

      • timestamp — required — (Date)

        The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.

      • eventType — required — (String)

        The type of action interaction event. You can specify Viewed, Taken, and Not Taken event types. For more information about action interaction event type data, see Event type data.

      • eventId — (String)

        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 distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.

      • recommendationId — (String)

        The ID of the list of recommendations that contains the action the user interacted with.

      • impression — (Array<String>)

        A list of action IDs that represents the sequence of actions you have shown the user. For example, ["actionId1", "actionId2", "actionId3"]. Amazon Personalize doesn't use impressions data from action interaction events. Instead, record multiple events for each action and use the Viewed event type.

      • properties — (String)

        A string map of event-specific data that you might choose to record. For example, if a user takes an action, other than the action ID, you might also send the number of actions taken by the user.

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

        {"numberOfActions": "12"}

        The keys use camel case names that match the fields in the Action interactions schema. In the above example, the numberOfActions would match the 'NUMBER_OF_ACTIONS' field defined in the Action interactions schema.

        The following can't be included as a keyword for properties (case insensitive).

        • userId

        • sessionId

        • eventType

        • timestamp

        • recommendationId

        • impression

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putActions(params = {}, callback) ⇒ AWS.Request

Adds one or more actions to an Actions dataset. For more information see Importing actions individually.

Service Reference:

Examples:

Calling the putActions operation

var params = {
  actions: [ /* required */
    {
      actionId: 'STRING_VALUE', /* required */
      properties: any /* This value will be JSON encoded on your behalf with JSON.stringify() */
    },
    /* more items */
  ],
  datasetArn: 'STRING_VALUE' /* required */
};
personalizeevents.putActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • datasetArn — (String)

      The Amazon Resource Name (ARN) of the Actions dataset you are adding the action or actions to.

    • actions — (Array<map>)

      A list of action data.

      • actionId — required — (String)

        The ID associated with the action.

      • properties — (String)

        A string map of action-specific metadata. Each element in the map consists of a key-value pair. For example, {"value": "100"}.

        The keys use camel case names that match the fields in the schema for the Actions dataset. In the previous example, the value matches the 'VALUE' field defined in the Actions schema. For categorical string data, to include multiple categories for a single action, separate each category with a pipe separator (|). For example, \"Deluxe|Premium\".

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putEvents(params = {}, callback) ⇒ AWS.Request

Records item interaction event data. For more information see Recording item interaction events.

Service Reference:

Examples:

Calling the putEvents operation

var params = {
  eventList: [ /* required */
    {
      eventType: 'STRING_VALUE', /* required */
      sentAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      eventId: 'STRING_VALUE',
      eventValue: 'NUMBER_VALUE',
      impression: [
        'STRING_VALUE',
        /* more items */
      ],
      itemId: 'STRING_VALUE',
      metricAttribution: {
        eventAttributionSource: 'STRING_VALUE' /* required */
      },
      properties: any /* This value will be JSON encoded on your behalf with JSON.stringify() */,
      recommendationId: 'STRING_VALUE'
    },
    /* more items */
  ],
  sessionId: 'STRING_VALUE', /* required */
  trackingId: 'STRING_VALUE', /* required */
  userId: 'STRING_VALUE'
};
personalizeevents.putEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • trackingId — (String)

      The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.

    • userId — (String)

      The user associated with the event.

    • sessionId — (String)

      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 item interaction events.

    • eventList — (Array<map>)

      A list of event data from the session.

      • eventId — (String)

        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 distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.

      • eventType — required — (String)

        The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Item interactions dataset's schema and depends on the types of events you are tracking.

      • eventValue — (Float)

        The event value that corresponds to the EVENT_VALUE field of the Item interactions schema.

      • itemId — (String)

        The item ID key that corresponds to the ITEM_ID field of the Item interactions dataset's schema.

      • properties — (String)

        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 Item interactions dataset's schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Item interactions dataset's schema.

        The following can't be included as a keyword for properties (case insensitive).

        • userId

        • sessionId

        • eventType

        • timestamp

        • recommendationId

        • impression

      • sentAt — required — (Date)

        The timestamp (in Unix time) on the client side when the event occurred.

      • recommendationId — (String)

        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.

      • impression — (Array<String>)

        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.

      • metricAttribution — (map)

        Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

        • eventAttributionSource — required — (String)

          The source of the event, such as a third party.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putItems(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putItems operation

var params = {
  datasetArn: 'STRING_VALUE', /* required */
  items: [ /* required */
    {
      itemId: 'STRING_VALUE', /* required */
      properties: any /* This value will be JSON encoded on your behalf with JSON.stringify() */
    },
    /* more items */
  ]
};
personalizeevents.putItems(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • datasetArn — (String)

      The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.

    • items — (Array<map>)

      A list of item data.

      • itemId — required — (String)

        The ID associated with the item.

      • properties — (String)

        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\".

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putUsers(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putUsers operation

var params = {
  datasetArn: 'STRING_VALUE', /* required */
  users: [ /* required */
    {
      userId: 'STRING_VALUE', /* required */
      properties: any /* This value will be JSON encoded on your behalf with JSON.stringify() */
    },
    /* more items */
  ]
};
personalizeevents.putUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • datasetArn — (String)

      The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.

    • users — (Array<map>)

      A list of user data.

      • userId — required — (String)

        The ID associated with the user.

      • properties — (String)

        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\".

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.