Amazon Personalize Events

2020/10/02 - Amazon Personalize Events - 2 new api methods

Changes  Adds new APIs to write item and user records to Datasets.

PutUsers (new) Link ¶

Adds one or more users to a Users dataset. For more information see importing-users .

See also: AWS API Documentation

Request Syntax

client.put_users(
    datasetArn='string',
    users=[
        {
            'userId': 'string',
            'properties': 'string'
        },
    ]
)
type datasetArn

string

param datasetArn

[REQUIRED]

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

type users

list

param users

[REQUIRED]

A list of user data.

  • (dict) --

    Represents user metadata added to a Users dataset using the PutUsers API.

    • userId (string) -- [REQUIRED]

      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 Users schema. In the above example, the numberOfVideosWatched would match the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema.

returns

None

PutItems (new) Link ¶

Adds one or more items to an Items dataset. For more information see importing-items .

See also: AWS API Documentation

Request Syntax

client.put_items(
    datasetArn='string',
    items=[
        {
            'itemId': 'string',
            'properties': 'string'
        },
    ]
)
type datasetArn

string

param datasetArn

[REQUIRED]

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

type items

list

param items

[REQUIRED]

A list of item data.

  • (dict) --

    Represents item metadata added to an Items dataset using the PutItems API.

    • itemId (string) -- [REQUIRED]

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

returns

None