[ aws . personalize-events ]

put-items

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-items
--dataset-arn <value>
--items <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataset-arn (string)

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

--items (list)

A list of item data.

(structure)

Represents item metadata added to an Items dataset using the PutItems API. For more information see Importing Items Incrementally .

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

Shorthand Syntax:

itemId=string,properties=string ...

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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