@aws-sdk/client-personalize-events 3.36.0 → 3.36.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,17 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.36.1](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.0...v3.36.1) (2021-10-12)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **clients:** emitDeclarationOnly in tsconfig.types.json ([#2893](https://github.com/aws/aws-sdk-js-v3/issues/2893)) ([6dc3d56](https://github.com/aws/aws-sdk-js-v3/commit/6dc3d56c20809c90cbdc4dd48627eeebc64af99d))
12
+
13
+
14
+
15
+
16
+
6
17
  # [3.36.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.35.0...v3.36.0) (2021-10-08)
7
18
 
8
19
 
@@ -5,11 +5,6 @@ const PutEventsCommand_1 = require("./commands/PutEventsCommand");
5
5
  const PutItemsCommand_1 = require("./commands/PutItemsCommand");
6
6
  const PutUsersCommand_1 = require("./commands/PutUsersCommand");
7
7
  const PersonalizeEventsClient_1 = require("./PersonalizeEventsClient");
8
- /**
9
- * <p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use
10
- * it for model training either alone or combined with historical data. For more information see
11
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
12
- */
13
8
  class PersonalizeEvents extends PersonalizeEventsClient_1.PersonalizeEventsClient {
14
9
  putEvents(args, optionsOrCb, cb) {
15
10
  const command = new PutEventsCommand_1.PutEventsCommand(args);
@@ -10,11 +10,6 @@ const middleware_signing_1 = require("@aws-sdk/middleware-signing");
10
10
  const middleware_user_agent_1 = require("@aws-sdk/middleware-user-agent");
11
11
  const smithy_client_1 = require("@aws-sdk/smithy-client");
12
12
  const runtimeConfig_1 = require("./runtimeConfig");
13
- /**
14
- * <p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use
15
- * it for model training either alone or combined with historical data. For more information see
16
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
17
- */
18
13
  class PersonalizeEventsClient extends smithy_client_1.Client {
19
14
  constructor(configuration) {
20
15
  const _config_0 = runtimeConfig_1.getRuntimeConfig(configuration);
@@ -33,11 +28,6 @@ class PersonalizeEventsClient extends smithy_client_1.Client {
33
28
  this.middlewareStack.use(middleware_signing_1.getAwsAuthPlugin(this.config));
34
29
  this.middlewareStack.use(middleware_user_agent_1.getUserAgentPlugin(this.config));
35
30
  }
36
- /**
37
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
38
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
39
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
40
- */
41
31
  destroy() {
42
32
  super.destroy();
43
33
  }
@@ -5,36 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_restJson1_1 = require("../protocols/Aws_restJson1");
8
- /**
9
- * <p>Records user interaction event data. For more information see
10
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { PersonalizeEventsClient, PutEventsCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import
15
- * // const { PersonalizeEventsClient, PutEventsCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import
16
- * const client = new PersonalizeEventsClient(config);
17
- * const command = new PutEventsCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link PutEventsCommandInput} for command's `input` shape.
22
- * @see {@link PutEventsCommandOutput} for command's `response` shape.
23
- * @see {@link PersonalizeEventsClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
26
8
  class PutEventsCommand extends smithy_client_1.Command {
27
- // Start section: command_properties
28
- // End section: command_properties
29
9
  constructor(input) {
30
- // Start section: command_constructor
31
10
  super();
32
11
  this.input = input;
33
- // End section: command_constructor
34
12
  }
35
- /**
36
- * @internal
37
- */
38
13
  resolveMiddleware(clientStack, configuration, options) {
39
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
40
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,37 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_restJson1_1 = require("../protocols/Aws_restJson1");
8
- /**
9
- * <p>Adds one or more items to an Items dataset. For more information see
10
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing Items Incrementally</a>.
11
- * </p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { PersonalizeEventsClient, PutItemsCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import
16
- * // const { PersonalizeEventsClient, PutItemsCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import
17
- * const client = new PersonalizeEventsClient(config);
18
- * const command = new PutItemsCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link PutItemsCommandInput} for command's `input` shape.
23
- * @see {@link PutItemsCommandOutput} for command's `response` shape.
24
- * @see {@link PersonalizeEventsClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
27
8
  class PutItemsCommand extends smithy_client_1.Command {
28
- // Start section: command_properties
29
- // End section: command_properties
30
9
  constructor(input) {
31
- // Start section: command_constructor
32
10
  super();
33
11
  this.input = input;
34
- // End section: command_constructor
35
12
  }
36
- /**
37
- * @internal
38
- */
39
13
  resolveMiddleware(clientStack, configuration, options) {
40
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
41
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,36 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_restJson1_1 = require("../protocols/Aws_restJson1");
8
- /**
9
- * <p>Adds one or more users to a Users dataset. For more information see
10
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing Users Incrementally</a>.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { PersonalizeEventsClient, PutUsersCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import
15
- * // const { PersonalizeEventsClient, PutUsersCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import
16
- * const client = new PersonalizeEventsClient(config);
17
- * const command = new PutUsersCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link PutUsersCommandInput} for command's `input` shape.
22
- * @see {@link PutUsersCommandOutput} for command's `response` shape.
23
- * @see {@link PersonalizeEventsClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
26
8
  class PutUsersCommand extends smithy_client_1.Command {
27
- // Start section: command_properties
28
- // End section: command_properties
29
9
  constructor(input) {
30
- // Start section: command_constructor
31
10
  super();
32
11
  this.input = input;
33
- // End section: command_constructor
34
12
  }
35
- /**
36
- * @internal
37
- */
38
13
  resolveMiddleware(clientStack, configuration, options) {
39
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
40
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -3,81 +3,54 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.PutUsersRequest = exports.User = exports.ResourceNotFoundException = exports.ResourceInUseException = exports.PutItemsRequest = exports.Item = exports.PutEventsRequest = exports.Event = exports.InvalidInputException = void 0;
4
4
  var InvalidInputException;
5
5
  (function (InvalidInputException) {
6
- /**
7
- * @internal
8
- */
9
6
  InvalidInputException.filterSensitiveLog = (obj) => ({
10
7
  ...obj,
11
8
  });
12
9
  })(InvalidInputException = exports.InvalidInputException || (exports.InvalidInputException = {}));
13
10
  var Event;
14
11
  (function (Event) {
15
- /**
16
- * @internal
17
- */
18
12
  Event.filterSensitiveLog = (obj) => ({
19
13
  ...obj,
20
14
  });
21
15
  })(Event = exports.Event || (exports.Event = {}));
22
16
  var PutEventsRequest;
23
17
  (function (PutEventsRequest) {
24
- /**
25
- * @internal
26
- */
27
18
  PutEventsRequest.filterSensitiveLog = (obj) => ({
28
19
  ...obj,
29
20
  });
30
21
  })(PutEventsRequest = exports.PutEventsRequest || (exports.PutEventsRequest = {}));
31
22
  var Item;
32
23
  (function (Item) {
33
- /**
34
- * @internal
35
- */
36
24
  Item.filterSensitiveLog = (obj) => ({
37
25
  ...obj,
38
26
  });
39
27
  })(Item = exports.Item || (exports.Item = {}));
40
28
  var PutItemsRequest;
41
29
  (function (PutItemsRequest) {
42
- /**
43
- * @internal
44
- */
45
30
  PutItemsRequest.filterSensitiveLog = (obj) => ({
46
31
  ...obj,
47
32
  });
48
33
  })(PutItemsRequest = exports.PutItemsRequest || (exports.PutItemsRequest = {}));
49
34
  var ResourceInUseException;
50
35
  (function (ResourceInUseException) {
51
- /**
52
- * @internal
53
- */
54
36
  ResourceInUseException.filterSensitiveLog = (obj) => ({
55
37
  ...obj,
56
38
  });
57
39
  })(ResourceInUseException = exports.ResourceInUseException || (exports.ResourceInUseException = {}));
58
40
  var ResourceNotFoundException;
59
41
  (function (ResourceNotFoundException) {
60
- /**
61
- * @internal
62
- */
63
42
  ResourceNotFoundException.filterSensitiveLog = (obj) => ({
64
43
  ...obj,
65
44
  });
66
45
  })(ResourceNotFoundException = exports.ResourceNotFoundException || (exports.ResourceNotFoundException = {}));
67
46
  var User;
68
47
  (function (User) {
69
- /**
70
- * @internal
71
- */
72
48
  User.filterSensitiveLog = (obj) => ({
73
49
  ...obj,
74
50
  });
75
51
  })(User = exports.User || (exports.User = {}));
76
52
  var PutUsersRequest;
77
53
  (function (PutUsersRequest) {
78
- /**
79
- * @internal
80
- */
81
54
  PutUsersRequest.filterSensitiveLog = (obj) => ({
82
55
  ...obj,
83
56
  });
@@ -356,14 +356,12 @@ const deserializeMetadata = (output) => {
356
356
  cfId: output.headers["x-amz-cf-id"],
357
357
  });
358
358
  };
359
- // Collect low-level response body stream to Uint8Array.
360
359
  const collectBody = (streamBody = new Uint8Array(), context) => {
361
360
  if (streamBody instanceof Uint8Array) {
362
361
  return Promise.resolve(streamBody);
363
362
  }
364
363
  return context.streamCollector(streamBody) || Promise.resolve(new Uint8Array());
365
364
  };
366
- // Encode Uint8Array data into string with utf-8.
367
365
  const collectBodyString = (streamBody, context) => collectBody(streamBody, context).then((body) => context.utf8Encoder(body));
368
366
  const isSerializableHeaderValue = (value) => value !== undefined &&
369
367
  value !== null &&
@@ -376,9 +374,6 @@ const parseBody = (streamBody, context) => collectBodyString(streamBody, context
376
374
  }
377
375
  return {};
378
376
  });
379
- /**
380
- * Load an error code for the aws.rest-json-1.1 protocol.
381
- */
382
377
  const loadRestJsonErrorCode = (output, data) => {
383
378
  const findKey = (object, key) => Object.keys(object).find((k) => k.toLowerCase() === key.toLowerCase());
384
379
  const sanitizeErrorCode = (rawValue) => {
@@ -2,8 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getRuntimeConfig = void 0;
4
4
  const tslib_1 = require("tslib");
5
- // @ts-ignore: package.json will be imported from dist folders
6
- const package_json_1 = tslib_1.__importDefault(require("../package.json")); // eslint-disable-line
5
+ const package_json_1 = tslib_1.__importDefault(require("../package.json"));
7
6
  const sha256_browser_1 = require("@aws-crypto/sha256-browser");
8
7
  const fetch_http_handler_1 = require("@aws-sdk/fetch-http-handler");
9
8
  const invalid_dependency_1 = require("@aws-sdk/invalid-dependency");
@@ -13,9 +12,6 @@ const util_body_length_browser_1 = require("@aws-sdk/util-body-length-browser");
13
12
  const util_user_agent_browser_1 = require("@aws-sdk/util-user-agent-browser");
14
13
  const util_utf8_browser_1 = require("@aws-sdk/util-utf8-browser");
15
14
  const runtimeConfig_shared_1 = require("./runtimeConfig.shared");
16
- /**
17
- * @internal
18
- */
19
15
  const getRuntimeConfig = (config) => {
20
16
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
21
17
  const clientSharedValues = runtimeConfig_shared_1.getRuntimeConfig(config);
@@ -2,8 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getRuntimeConfig = void 0;
4
4
  const tslib_1 = require("tslib");
5
- // @ts-ignore: package.json will be imported from dist folders
6
- const package_json_1 = tslib_1.__importDefault(require("../package.json")); // eslint-disable-line
5
+ const package_json_1 = tslib_1.__importDefault(require("../package.json"));
7
6
  const client_sts_1 = require("@aws-sdk/client-sts");
8
7
  const config_resolver_1 = require("@aws-sdk/config-resolver");
9
8
  const credential_provider_node_1 = require("@aws-sdk/credential-provider-node");
@@ -17,9 +16,6 @@ const util_user_agent_node_1 = require("@aws-sdk/util-user-agent-node");
17
16
  const util_utf8_node_1 = require("@aws-sdk/util-utf8-node");
18
17
  const runtimeConfig_shared_1 = require("./runtimeConfig.shared");
19
18
  const smithy_client_1 = require("@aws-sdk/smithy-client");
20
- /**
21
- * @internal
22
- */
23
19
  const getRuntimeConfig = (config) => {
24
20
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
25
21
  smithy_client_1.emitWarningIfUnsupportedVersion(process.version);
@@ -3,9 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getRuntimeConfig = void 0;
4
4
  const sha256_js_1 = require("@aws-crypto/sha256-js");
5
5
  const runtimeConfig_browser_1 = require("./runtimeConfig.browser");
6
- /**
7
- * @internal
8
- */
9
6
  const getRuntimeConfig = (config) => {
10
7
  var _a;
11
8
  const browserDefaults = runtimeConfig_browser_1.getRuntimeConfig(config);
@@ -3,9 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getRuntimeConfig = void 0;
4
4
  const url_parser_1 = require("@aws-sdk/url-parser");
5
5
  const endpoints_1 = require("./endpoints");
6
- /**
7
- * @internal
8
- */
9
6
  const getRuntimeConfig = (config) => {
10
7
  var _a, _b, _c, _d, _e;
11
8
  return ({
@@ -3,31 +3,17 @@ import { PutEventsCommandInput, PutEventsCommandOutput } from "./commands/PutEve
3
3
  import { PutItemsCommandInput, PutItemsCommandOutput } from "./commands/PutItemsCommand";
4
4
  import { PutUsersCommandInput, PutUsersCommandOutput } from "./commands/PutUsersCommand";
5
5
  import { PersonalizeEventsClient } from "./PersonalizeEventsClient";
6
- /**
7
- * <p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use
8
- * it for model training either alone or combined with historical data. For more information see
9
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
10
- */
6
+
11
7
  export declare class PersonalizeEvents extends PersonalizeEventsClient {
12
- /**
13
- * <p>Records user interaction event data. For more information see
14
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
15
- */
8
+
16
9
  putEvents(args: PutEventsCommandInput, options?: __HttpHandlerOptions): Promise<PutEventsCommandOutput>;
17
10
  putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void;
18
11
  putEvents(args: PutEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventsCommandOutput) => void): void;
19
- /**
20
- * <p>Adds one or more items to an Items dataset. For more information see
21
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing Items Incrementally</a>.
22
- * </p>
23
- */
12
+
24
13
  putItems(args: PutItemsCommandInput, options?: __HttpHandlerOptions): Promise<PutItemsCommandOutput>;
25
14
  putItems(args: PutItemsCommandInput, cb: (err: any, data?: PutItemsCommandOutput) => void): void;
26
15
  putItems(args: PutItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutItemsCommandOutput) => void): void;
27
- /**
28
- * <p>Adds one or more users to a Users dataset. For more information see
29
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing Users Incrementally</a>.</p>
30
- */
16
+
31
17
  putUsers(args: PutUsersCommandInput, options?: __HttpHandlerOptions): Promise<PutUsersCommandOutput>;
32
18
  putUsers(args: PutUsersCommandInput, cb: (err: any, data?: PutUsersCommandOutput) => void): void;
33
19
  putUsers(args: PutUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutUsersCommandOutput) => void): void;
@@ -12,126 +12,59 @@ import { PutUsersCommandInput, PutUsersCommandOutput } from "./commands/PutUsers
12
12
  export declare type ServiceInputTypes = PutEventsCommandInput | PutItemsCommandInput | PutUsersCommandInput;
13
13
  export declare type ServiceOutputTypes = PutEventsCommandOutput | PutItemsCommandOutput | PutUsersCommandOutput;
14
14
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
15
- /**
16
- * The HTTP handler to use. Fetch in browser and Https in Nodejs.
17
- */
15
+
18
16
  requestHandler?: __HttpHandler;
19
- /**
20
- * A constructor for a class implementing the {@link __Hash} interface
21
- * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
22
- * @internal
23
- */
17
+
24
18
  sha256?: __HashConstructor;
25
- /**
26
- * The function that will be used to convert strings into HTTP endpoints.
27
- * @internal
28
- */
19
+
29
20
  urlParser?: __UrlParser;
30
- /**
31
- * A function that can calculate the length of a request body.
32
- * @internal
33
- */
21
+
34
22
  bodyLengthChecker?: (body: any) => number | undefined;
35
- /**
36
- * A function that converts a stream into an array of bytes.
37
- * @internal
38
- */
23
+
39
24
  streamCollector?: __StreamCollector;
40
- /**
41
- * The function that will be used to convert a base64-encoded string to a byte array.
42
- * @internal
43
- */
25
+
44
26
  base64Decoder?: __Decoder;
45
- /**
46
- * The function that will be used to convert binary data to a base64-encoded string.
47
- * @internal
48
- */
27
+
49
28
  base64Encoder?: __Encoder;
50
- /**
51
- * The function that will be used to convert a UTF8-encoded string to a byte array.
52
- * @internal
53
- */
29
+
54
30
  utf8Decoder?: __Decoder;
55
- /**
56
- * The function that will be used to convert binary data to a UTF-8 encoded string.
57
- * @internal
58
- */
31
+
59
32
  utf8Encoder?: __Encoder;
60
- /**
61
- * The runtime environment.
62
- * @internal
63
- */
33
+
64
34
  runtime?: string;
65
- /**
66
- * Disable dyanamically changing the endpoint of the client based on the hostPrefix
67
- * trait of an operation.
68
- */
35
+
69
36
  disableHostPrefix?: boolean;
70
- /**
71
- * Value for how many times a request will be made at most in case of retry.
72
- */
37
+
73
38
  maxAttempts?: number | __Provider<number>;
74
- /**
75
- * Specifies which retry algorithm to use.
76
- */
39
+
77
40
  retryMode?: string | __Provider<string>;
78
- /**
79
- * Optional logger for logging debug/info/warn/error.
80
- */
41
+
81
42
  logger?: __Logger;
82
- /**
83
- * Unique service identifier.
84
- * @internal
85
- */
43
+
86
44
  serviceId?: string;
87
- /**
88
- * The AWS region to which this client will send requests
89
- */
45
+
90
46
  region?: string | __Provider<string>;
91
- /**
92
- * Default credentials provider; Not available in browser runtime.
93
- * @internal
94
- */
47
+
95
48
  credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
96
- /**
97
- * Fetch related hostname, signing name or signing region with given region.
98
- * @internal
99
- */
49
+
100
50
  regionInfoProvider?: RegionInfoProvider;
101
- /**
102
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
103
- * @internal
104
- */
51
+
105
52
  defaultUserAgentProvider?: Provider<__UserAgent>;
106
53
  }
107
54
  declare type PersonalizeEventsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
108
- /**
109
- * The configuration interface of PersonalizeEventsClient class constructor that set the region, credentials and other options.
110
- */
55
+
111
56
  export interface PersonalizeEventsClientConfig extends PersonalizeEventsClientConfigType {
112
57
  }
113
58
  declare type PersonalizeEventsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
114
- /**
115
- * The resolved configuration interface of PersonalizeEventsClient class. This is resolved and normalized from the {@link PersonalizeEventsClientConfig | constructor configuration interface}.
116
- */
59
+
117
60
  export interface PersonalizeEventsClientResolvedConfig extends PersonalizeEventsClientResolvedConfigType {
118
61
  }
119
- /**
120
- * <p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use
121
- * it for model training either alone or combined with historical data. For more information see
122
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
123
- */
62
+
124
63
  export declare class PersonalizeEventsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PersonalizeEventsClientResolvedConfig> {
125
- /**
126
- * The resolved configuration of PersonalizeEventsClient class. This is resolved and normalized from the {@link PersonalizeEventsClientConfig | constructor configuration interface}.
127
- */
64
+
128
65
  readonly config: PersonalizeEventsClientResolvedConfig;
129
66
  constructor(configuration: PersonalizeEventsClientConfig);
130
- /**
131
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
132
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
133
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
134
- */
67
+
135
68
  destroy(): void;
136
69
  }
137
70
  export {};
@@ -6,30 +6,11 @@ export interface PutEventsCommandInput extends PutEventsRequest {
6
6
  }
7
7
  export interface PutEventsCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Records user interaction event data. For more information see
11
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { PersonalizeEventsClient, PutEventsCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import
16
- * // const { PersonalizeEventsClient, PutEventsCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import
17
- * const client = new PersonalizeEventsClient(config);
18
- * const command = new PutEventsCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link PutEventsCommandInput} for command's `input` shape.
23
- * @see {@link PutEventsCommandOutput} for command's `response` shape.
24
- * @see {@link PersonalizeEventsClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class PutEventsCommand extends $Command<PutEventsCommandInput, PutEventsCommandOutput, PersonalizeEventsClientResolvedConfig> {
28
11
  readonly input: PutEventsCommandInput;
29
12
  constructor(input: PutEventsCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutEventsCommandInput, PutEventsCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,31 +6,11 @@ export interface PutItemsCommandInput extends PutItemsRequest {
6
6
  }
7
7
  export interface PutItemsCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Adds one or more items to an Items dataset. For more information see
11
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing Items Incrementally</a>.
12
- * </p>
13
- * @example
14
- * Use a bare-bones client and the command you need to make an API call.
15
- * ```javascript
16
- * import { PersonalizeEventsClient, PutItemsCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import
17
- * // const { PersonalizeEventsClient, PutItemsCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import
18
- * const client = new PersonalizeEventsClient(config);
19
- * const command = new PutItemsCommand(input);
20
- * const response = await client.send(command);
21
- * ```
22
- *
23
- * @see {@link PutItemsCommandInput} for command's `input` shape.
24
- * @see {@link PutItemsCommandOutput} for command's `response` shape.
25
- * @see {@link PersonalizeEventsClientResolvedConfig | config} for command's `input` shape.
26
- *
27
- */
9
+
28
10
  export declare class PutItemsCommand extends $Command<PutItemsCommandInput, PutItemsCommandOutput, PersonalizeEventsClientResolvedConfig> {
29
11
  readonly input: PutItemsCommandInput;
30
12
  constructor(input: PutItemsCommandInput);
31
- /**
32
- * @internal
33
- */
13
+
34
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutItemsCommandInput, PutItemsCommandOutput>;
35
15
  private serialize;
36
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface PutUsersCommandInput extends PutUsersRequest {
6
6
  }
7
7
  export interface PutUsersCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Adds one or more users to a Users dataset. For more information see
11
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing Users Incrementally</a>.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { PersonalizeEventsClient, PutUsersCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import
16
- * // const { PersonalizeEventsClient, PutUsersCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import
17
- * const client = new PersonalizeEventsClient(config);
18
- * const command = new PutUsersCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link PutUsersCommandInput} for command's `input` shape.
23
- * @see {@link PutUsersCommandOutput} for command's `response` shape.
24
- * @see {@link PersonalizeEventsClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class PutUsersCommand extends $Command<PutUsersCommandInput, PutUsersCommandOutput, PersonalizeEventsClientResolvedConfig> {
28
11
  readonly input: PutUsersCommandInput;
29
12
  constructor(input: PutUsersCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutUsersCommandInput, PutUsersCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -1,216 +1,111 @@
1
1
  import { LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
2
2
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
- /**
4
- * <p>Provide a valid value for the field or parameter.</p>
5
- */
3
+
6
4
  export interface InvalidInputException extends __SmithyException, $MetadataBearer {
7
5
  name: "InvalidInputException";
8
6
  $fault: "client";
9
7
  message?: string;
10
8
  }
11
9
  export declare namespace InvalidInputException {
12
- /**
13
- * @internal
14
- */
10
+
15
11
  const filterSensitiveLog: (obj: InvalidInputException) => any;
16
12
  }
17
- /**
18
- * <p>Represents user interaction event information sent using the
19
- * <code>PutEvents</code> API.</p>
20
- */
13
+
21
14
  export interface Event {
22
- /**
23
- * <p>An ID associated with the event. If an event ID is not provided, Amazon Personalize generates
24
- * a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses
25
- * the event ID to distinquish unique events. Any subsequent events after the first with the
26
- * same event ID are not used in model training.</p>
27
- */
15
+
28
16
  eventId?: string;
29
- /**
30
- * <p>The type of event, such as click or download. This property corresponds to the <code>EVENT_TYPE</code>
31
- * field of your Interactions schema and depends on the types of events you are tracking.</p>
32
- */
17
+
33
18
  eventType: string | undefined;
34
- /**
35
- * <p>The event value that corresponds to the <code>EVENT_VALUE</code> field of the Interactions schema.</p>
36
- */
19
+
37
20
  eventValue?: number;
38
- /**
39
- * <p>The item ID key that corresponds to the <code>ITEM_ID</code> field of the Interactions schema.</p>
40
- */
21
+
41
22
  itemId?: string;
42
- /**
43
- * <p>A string map of event-specific data that you might choose to record. For example, if a
44
- * user rates a movie on your site, other than movie ID (<code>itemId</code>) and rating (<code>eventValue</code>)
45
- * , you might also send the number of movie ratings made by the user.</p>
46
- * <p>Each item in the map consists of a key-value pair. For example,</p>
47
- *
48
- * <p>
49
- * <code>{"numberOfRatings": "12"}</code>
50
- * </p>
51
- * <p>The keys use camel case names that match the fields in the Interactions
52
- * schema. In the above example, the <code>numberOfRatings</code> would match the
53
- * 'NUMBER_OF_RATINGS' field defined in the Interactions schema.</p>
54
- */
23
+
55
24
  properties?: __LazyJsonString | string;
56
- /**
57
- * <p>The timestamp (in Unix time) on the client side when the event occurred.</p>
58
- */
25
+
59
26
  sentAt: Date | undefined;
60
- /**
61
- * <p>The ID of the recommendation.</p>
62
- */
27
+
63
28
  recommendationId?: string;
64
- /**
65
- * <p>A list of item IDs that represents the sequence of items you have shown the user. For example, <code>["itemId1", "itemId2", "itemId3"]</code>.</p>
66
- */
29
+
67
30
  impression?: string[];
68
31
  }
69
32
  export declare namespace Event {
70
- /**
71
- * @internal
72
- */
33
+
73
34
  const filterSensitiveLog: (obj: Event) => any;
74
35
  }
75
36
  export interface PutEventsRequest {
76
- /**
77
- * <p>The tracking ID for the event.
78
- * The ID is generated by a call to the
79
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a> API.</p>
80
- */
37
+
81
38
  trackingId: string | undefined;
82
- /**
83
- * <p>The user associated with the event.</p>
84
- */
39
+
85
40
  userId?: string;
86
- /**
87
- * <p>The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application.
88
- * Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see
89
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
90
- */
41
+
91
42
  sessionId: string | undefined;
92
- /**
93
- * <p>A list of event data from the session.</p>
94
- */
43
+
95
44
  eventList: Event[] | undefined;
96
45
  }
97
46
  export declare namespace PutEventsRequest {
98
- /**
99
- * @internal
100
- */
47
+
101
48
  const filterSensitiveLog: (obj: PutEventsRequest) => any;
102
49
  }
103
- /**
104
- * <p>Represents item metadata added to an Items dataset using the
105
- * <code>PutItems</code> API. For more information see
106
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing Items Incrementally</a>.
107
- * </p>
108
- */
50
+
109
51
  export interface Item {
110
- /**
111
- * <p>The ID associated with the item.</p>
112
- */
52
+
113
53
  itemId: string | undefined;
114
- /**
115
- * <p>A string map of item-specific metadata. Each element in the map consists of a key-value pair.
116
- * For example, <code>{"numberOfRatings": "12"}</code>.</p>
117
- * <p>The keys use camel case names that match the fields in the schema for the Items
118
- * dataset. In the previous example, the <code>numberOfRatings</code> matches the
119
- * 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item,
120
- * separate each category with a pipe separator (<code>|</code>). For example, <code>\"Horror|Action\"</code>.</p>
121
- */
54
+
122
55
  properties?: __LazyJsonString | string;
123
56
  }
124
57
  export declare namespace Item {
125
- /**
126
- * @internal
127
- */
58
+
128
59
  const filterSensitiveLog: (obj: Item) => any;
129
60
  }
130
61
  export interface PutItemsRequest {
131
- /**
132
- * <p>The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.</p>
133
- */
62
+
134
63
  datasetArn: string | undefined;
135
- /**
136
- * <p>A list of item data.</p>
137
- */
64
+
138
65
  items: Item[] | undefined;
139
66
  }
140
67
  export declare namespace PutItemsRequest {
141
- /**
142
- * @internal
143
- */
68
+
144
69
  const filterSensitiveLog: (obj: PutItemsRequest) => any;
145
70
  }
146
- /**
147
- * <p>The specified resource is in use.</p>
148
- */
71
+
149
72
  export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
150
73
  name: "ResourceInUseException";
151
74
  $fault: "client";
152
75
  message?: string;
153
76
  }
154
77
  export declare namespace ResourceInUseException {
155
- /**
156
- * @internal
157
- */
78
+
158
79
  const filterSensitiveLog: (obj: ResourceInUseException) => any;
159
80
  }
160
- /**
161
- * <p>Could not find the specified resource.</p>
162
- */
81
+
163
82
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
164
83
  name: "ResourceNotFoundException";
165
84
  $fault: "client";
166
85
  message?: string;
167
86
  }
168
87
  export declare namespace ResourceNotFoundException {
169
- /**
170
- * @internal
171
- */
88
+
172
89
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
173
90
  }
174
- /**
175
- * <p>Represents user metadata added to a Users dataset using the
176
- * <code>PutUsers</code> API. For more information see
177
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing Users Incrementally</a>.</p>
178
- */
91
+
179
92
  export interface User {
180
- /**
181
- * <p>The ID associated with the user.</p>
182
- */
93
+
183
94
  userId: string | undefined;
184
- /**
185
- * <p>A string map of user-specific metadata. Each element in the map consists of a key-value pair.
186
- * For example, <code>{"numberOfVideosWatched": "45"}</code>.</p>
187
- * <p>The keys use camel case names that match the fields in the schema for the Users
188
- * dataset. In the previous example, the <code>numberOfVideosWatched</code> matches the
189
- * 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data,
190
- * to include multiple categories for a single user, separate each category with a pipe separator (<code>|</code>).
191
- * For example, <code>\"Member|Frequent shopper\"</code>.</p>
192
- */
95
+
193
96
  properties?: __LazyJsonString | string;
194
97
  }
195
98
  export declare namespace User {
196
- /**
197
- * @internal
198
- */
99
+
199
100
  const filterSensitiveLog: (obj: User) => any;
200
101
  }
201
102
  export interface PutUsersRequest {
202
- /**
203
- * <p>The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.</p>
204
- */
103
+
205
104
  datasetArn: string | undefined;
206
- /**
207
- * <p>A list of user data.</p>
208
- */
105
+
209
106
  users: User[] | undefined;
210
107
  }
211
108
  export declare namespace PutUsersRequest {
212
- /**
213
- * @internal
214
- */
109
+
215
110
  const filterSensitiveLog: (obj: PutUsersRequest) => any;
216
111
  }
@@ -1,8 +1,6 @@
1
1
  import { FetchHttpHandler } from "@aws-sdk/fetch-http-handler";
2
2
  import { PersonalizeEventsClientConfig } from "./PersonalizeEventsClient";
3
- /**
4
- * @internal
5
- */
3
+
6
4
  export declare const getRuntimeConfig: (config: PersonalizeEventsClientConfig) => {
7
5
  runtime: string;
8
6
  base64Decoder: import("@aws-sdk/types").Decoder;
@@ -1,8 +1,6 @@
1
1
  import { NodeHttpHandler } from "@aws-sdk/node-http-handler";
2
2
  import { PersonalizeEventsClientConfig } from "./PersonalizeEventsClient";
3
- /**
4
- * @internal
5
- */
3
+
6
4
  export declare const getRuntimeConfig: (config: PersonalizeEventsClientConfig) => {
7
5
  runtime: string;
8
6
  base64Decoder: import("@aws-sdk/types").Decoder;
@@ -1,7 +1,5 @@
1
1
  import { PersonalizeEventsClientConfig } from "./PersonalizeEventsClient";
2
- /**
3
- * @internal
4
- */
2
+
5
3
  export declare const getRuntimeConfig: (config: PersonalizeEventsClientConfig) => {
6
4
  runtime: string;
7
5
  sha256: import("@aws-sdk/types").HashConstructor;
@@ -1,8 +1,6 @@
1
1
  import { Logger as __Logger } from "@aws-sdk/types";
2
2
  import { PersonalizeEventsClientConfig } from "./PersonalizeEventsClient";
3
- /**
4
- * @internal
5
- */
3
+
6
4
  export declare const getRuntimeConfig: (config: PersonalizeEventsClientConfig) => {
7
5
  apiVersion: string;
8
6
  disableHostPrefix: boolean;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-personalize-events",
3
3
  "description": "AWS SDK for JavaScript Personalize Events Client for Node.js, Browser and React Native",
4
- "version": "3.36.0",
4
+ "version": "3.36.1",
5
5
  "scripts": {
6
6
  "build": "yarn build:cjs && yarn build:es && yarn build:types",
7
7
  "build:cjs": "tsc -p tsconfig.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "^1.0.0",
23
23
  "@aws-crypto/sha256-js": "^1.0.0",
24
- "@aws-sdk/client-sts": "3.36.0",
24
+ "@aws-sdk/client-sts": "3.36.1",
25
25
  "@aws-sdk/config-resolver": "3.36.0",
26
- "@aws-sdk/credential-provider-node": "3.36.0",
26
+ "@aws-sdk/credential-provider-node": "3.36.1",
27
27
  "@aws-sdk/fetch-http-handler": "3.36.0",
28
28
  "@aws-sdk/hash-node": "3.36.0",
29
29
  "@aws-sdk/invalid-dependency": "3.36.0",