|
23 | 23 | {"shape":"InvalidInputException"}
|
24 | 24 | ],
|
25 | 25 | "documentation":"<p>Records user interaction event data. For more information see <a>event-record-api</a>.</p>"
|
| 26 | + }, |
| 27 | + "PutItems":{ |
| 28 | + "name":"PutItems", |
| 29 | + "http":{ |
| 30 | + "method":"POST", |
| 31 | + "requestUri":"/items" |
| 32 | + }, |
| 33 | + "input":{"shape":"PutItemsRequest"}, |
| 34 | + "errors":[ |
| 35 | + {"shape":"InvalidInputException"}, |
| 36 | + {"shape":"ResourceNotFoundException"} |
| 37 | + ], |
| 38 | + "documentation":"<p>Adds one or more items to an Items dataset. For more information see <a>importing-items</a>.</p>" |
| 39 | + }, |
| 40 | + "PutUsers":{ |
| 41 | + "name":"PutUsers", |
| 42 | + "http":{ |
| 43 | + "method":"POST", |
| 44 | + "requestUri":"/users" |
| 45 | + }, |
| 46 | + "input":{"shape":"PutUsersRequest"}, |
| 47 | + "errors":[ |
| 48 | + {"shape":"InvalidInputException"}, |
| 49 | + {"shape":"ResourceNotFoundException"} |
| 50 | + ], |
| 51 | + "documentation":"<p>Adds one or more users to a Users dataset. For more information see <a>importing-users</a>.</p>" |
26 | 52 | }
|
27 | 53 | },
|
28 | 54 | "shapes":{
|
| 55 | + "Arn":{ |
| 56 | + "type":"string", |
| 57 | + "max":256, |
| 58 | + "pattern":"arn:([a-z\\d-]+):personalize:.*:.*:.+" |
| 59 | + }, |
29 | 60 | "Date":{"type":"timestamp"},
|
30 | 61 | "ErrorMessage":{"type":"string"},
|
31 | 62 | "Event":{
|
|
41 | 72 | },
|
42 | 73 | "eventType":{
|
43 | 74 | "shape":"StringType",
|
44 |
| - "documentation":"<p>The type of event. This property corresponds to the <code>EVENT_TYPE</code> field of the Interactions schema.</p>" |
| 75 | + "documentation":"<p>The type of event, such as click or download. This property corresponds to the <code>EVENT_TYPE</code> field of your Interactions schema and depends on the types of events you are tracking.</p>" |
45 | 76 | },
|
46 | 77 | "eventValue":{
|
47 | 78 | "shape":"FloatType",
|
|
98 | 129 | "error":{"httpStatusCode":400},
|
99 | 130 | "exception":true
|
100 | 131 | },
|
| 132 | + "Item":{ |
| 133 | + "type":"structure", |
| 134 | + "required":["itemId"], |
| 135 | + "members":{ |
| 136 | + "itemId":{ |
| 137 | + "shape":"StringType", |
| 138 | + "documentation":"<p>The ID associated with the item.</p>" |
| 139 | + }, |
| 140 | + "properties":{ |
| 141 | + "shape":"ItemProperties", |
| 142 | + "documentation":"<p>A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, </p> <p> <code>{\"numberOfRatings\": \"12\"}</code> </p> <p>The keys use camel case names that match the fields in the Items schema. In the above example, the <code>numberOfRatings</code> would match the 'NUMBER_OF_RATINGS' field defined in the Items schema.</p>", |
| 143 | + "jsonvalue":true |
| 144 | + } |
| 145 | + }, |
| 146 | + "documentation":"<p>Represents item metadata added to an Items dataset using the <code>PutItems</code> API.</p>" |
| 147 | + }, |
101 | 148 | "ItemId":{
|
102 | 149 | "type":"string",
|
103 | 150 | "max":256,
|
104 | 151 | "min":1
|
105 | 152 | },
|
| 153 | + "ItemList":{ |
| 154 | + "type":"list", |
| 155 | + "member":{"shape":"Item"}, |
| 156 | + "max":10, |
| 157 | + "min":1 |
| 158 | + }, |
| 159 | + "ItemProperties":{ |
| 160 | + "type":"string", |
| 161 | + "max":1024, |
| 162 | + "min":1 |
| 163 | + }, |
106 | 164 | "PutEventsRequest":{
|
107 | 165 | "type":"structure",
|
108 | 166 | "required":[
|
|
129 | 187 | }
|
130 | 188 | }
|
131 | 189 | },
|
| 190 | + "PutItemsRequest":{ |
| 191 | + "type":"structure", |
| 192 | + "required":[ |
| 193 | + "datasetArn", |
| 194 | + "items" |
| 195 | + ], |
| 196 | + "members":{ |
| 197 | + "datasetArn":{ |
| 198 | + "shape":"Arn", |
| 199 | + "documentation":"<p>The Amazon Resource Number (ARN) of the Items dataset you are adding the item or items to.</p>" |
| 200 | + }, |
| 201 | + "items":{ |
| 202 | + "shape":"ItemList", |
| 203 | + "documentation":"<p>A list of item data.</p>" |
| 204 | + } |
| 205 | + } |
| 206 | + }, |
| 207 | + "PutUsersRequest":{ |
| 208 | + "type":"structure", |
| 209 | + "required":[ |
| 210 | + "datasetArn", |
| 211 | + "users" |
| 212 | + ], |
| 213 | + "members":{ |
| 214 | + "datasetArn":{ |
| 215 | + "shape":"Arn", |
| 216 | + "documentation":"<p>The Amazon Resource Number (ARN) of the Users dataset you are adding the user or users to.</p>" |
| 217 | + }, |
| 218 | + "users":{ |
| 219 | + "shape":"UserList", |
| 220 | + "documentation":"<p>A list of user data.</p>" |
| 221 | + } |
| 222 | + } |
| 223 | + }, |
132 | 224 | "RecommendationId":{
|
133 | 225 | "type":"string",
|
134 | 226 | "max":40,
|
135 | 227 | "min":1
|
136 | 228 | },
|
| 229 | + "ResourceNotFoundException":{ |
| 230 | + "type":"structure", |
| 231 | + "members":{ |
| 232 | + "message":{"shape":"ErrorMessage"} |
| 233 | + }, |
| 234 | + "documentation":"<p>Could not find the specified resource.</p>", |
| 235 | + "error":{"httpStatusCode":404}, |
| 236 | + "exception":true |
| 237 | + }, |
137 | 238 | "StringType":{
|
138 | 239 | "type":"string",
|
139 | 240 | "max":256,
|
140 | 241 | "min":1
|
141 | 242 | },
|
| 243 | + "User":{ |
| 244 | + "type":"structure", |
| 245 | + "required":["userId"], |
| 246 | + "members":{ |
| 247 | + "userId":{ |
| 248 | + "shape":"StringType", |
| 249 | + "documentation":"<p>The ID associated with the user.</p>" |
| 250 | + }, |
| 251 | + "properties":{ |
| 252 | + "shape":"UserProperties", |
| 253 | + "documentation":"<p>A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, </p> <p> <code>{\"numberOfVideosWatched\": \"45\"}</code> </p> <p>The keys use camel case names that match the fields in the Users schema. In the above example, the <code>numberOfVideosWatched</code> would match the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema.</p>", |
| 254 | + "jsonvalue":true |
| 255 | + } |
| 256 | + }, |
| 257 | + "documentation":"<p>Represents user metadata added to a Users dataset using the <code>PutUsers</code> API.</p>" |
| 258 | + }, |
142 | 259 | "UserId":{
|
143 | 260 | "type":"string",
|
144 | 261 | "max":256,
|
145 | 262 | "min":1
|
| 263 | + }, |
| 264 | + "UserList":{ |
| 265 | + "type":"list", |
| 266 | + "member":{"shape":"User"}, |
| 267 | + "max":10, |
| 268 | + "min":1 |
| 269 | + }, |
| 270 | + "UserProperties":{ |
| 271 | + "type":"string", |
| 272 | + "max":1024, |
| 273 | + "min":1 |
146 | 274 | }
|
147 | 275 | },
|
148 | 276 | "documentation":"<p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use it for model training either alone or combined with historical data. For more information see <a>recording-events</a>.</p>"
|
|
0 commit comments