put_users

put_users(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters

• datasetArn (string) --

  [REQUIRED]

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

• users (list) --

  [REQUIRED]

  A list of user data.

  • (dict) --

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

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

Returns

None

Exceptions

• PersonalizeEvents.Client.exceptions.InvalidInputException
• PersonalizeEvents.Client.exceptions.ResourceNotFoundException
• PersonalizeEvents.Client.exceptions.ResourceInUseException