Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . personalize-events ]

put-users

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  put-users
--dataset-arn <value>
--users <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--dataset-arn (string)

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

--users (list)

A list of user data.

(structure)

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

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

Shorthand Syntax:

userId=string,properties=string ...

JSON Syntax:

[
  {
    "userId": "string",
    "properties": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

None