cdk-lambda-subminute 2.0.310 → 2.0.311
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/.jsii +3 -3
- package/lib/cdk-lambda-subminute.js +3 -3
- package/node_modules/aws-sdk/CHANGELOG.md +52 -1
- package/node_modules/aws-sdk/README.md +1 -3
- package/node_modules/aws-sdk/apis/accessanalyzer-2019-11-01.min.json +423 -86
- package/node_modules/aws-sdk/apis/accessanalyzer-2019-11-01.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/amp-2020-08-01.min.json +320 -3
- package/node_modules/aws-sdk/apis/amp-2020-08-01.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/amp-2020-08-01.waiters2.json +33 -0
- package/node_modules/aws-sdk/apis/appsync-2017-07-25.min.json +141 -6
- package/node_modules/aws-sdk/apis/b2bi-2022-06-23.examples.json +714 -0
- package/node_modules/aws-sdk/apis/b2bi-2022-06-23.min.json +1095 -0
- package/node_modules/aws-sdk/apis/b2bi-2022-06-23.paginators.json +28 -0
- package/node_modules/aws-sdk/apis/backup-2018-11-15.min.json +855 -84
- package/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json +18 -0
- package/node_modules/aws-sdk/apis/bcm-data-exports-2023-11-26.examples.json +5 -0
- package/node_modules/aws-sdk/apis/bcm-data-exports-2023-11-26.min.json +470 -0
- package/node_modules/aws-sdk/apis/bcm-data-exports-2023-11-26.paginators.json +22 -0
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +67 -24
- package/node_modules/aws-sdk/apis/codestar-connections-2019-12-01.min.json +590 -3
- package/node_modules/aws-sdk/apis/codestar-connections-2019-12-01.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/compute-optimizer-2019-11-01.min.json +243 -39
- package/node_modules/aws-sdk/apis/config-2014-11-12.min.json +204 -169
- package/node_modules/aws-sdk/apis/controltower-2018-05-10.min.json +317 -13
- package/node_modules/aws-sdk/apis/controltower-2018-05-10.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/cost-optimization-hub-2022-07-26.examples.json +5 -0
- package/node_modules/aws-sdk/apis/cost-optimization-hub-2022-07-26.min.json +757 -0
- package/node_modules/aws-sdk/apis/cost-optimization-hub-2022-07-26.paginators.json +22 -0
- package/node_modules/aws-sdk/apis/detective-2018-10-26.min.json +294 -0
- package/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json +108 -107
- package/node_modules/aws-sdk/apis/eks-2017-11-01.min.json +211 -4
- package/node_modules/aws-sdk/apis/eks-2017-11-01.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/eks-auth-2023-11-26.examples.json +5 -0
- package/node_modules/aws-sdk/apis/eks-auth-2023-11-26.min.json +104 -0
- package/node_modules/aws-sdk/apis/eks-auth-2023-11-26.paginators.json +4 -0
- package/node_modules/aws-sdk/apis/eks-auth-2023-11-26.waiters2.json +5 -0
- package/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.min.json +71 -33
- package/node_modules/aws-sdk/apis/elasticfilesystem-2015-02-01.paginators.json +18 -3
- package/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.min.json +403 -75
- package/node_modules/aws-sdk/apis/elasticloadbalancingv2-2015-12-01.paginators.json +15 -0
- package/node_modules/aws-sdk/apis/fis-2020-12-01.min.json +366 -15
- package/node_modules/aws-sdk/apis/fis-2020-12-01.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/freetier-2023-09-07.examples.json +5 -0
- package/node_modules/aws-sdk/apis/freetier-2023-09-07.min.json +105 -0
- package/node_modules/aws-sdk/apis/freetier-2023-09-07.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +259 -135
- package/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json +64 -0
- package/node_modules/aws-sdk/apis/iotfleetwise-2021-06-17.min.json +159 -33
- package/node_modules/aws-sdk/apis/lakeformation-2017-03-31.min.json +126 -35
- package/node_modules/aws-sdk/apis/logs-2014-03-28.min.json +310 -36
- package/node_modules/aws-sdk/apis/logs-2014-03-28.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/managedblockchain-2018-09-24.min.json +58 -50
- package/node_modules/aws-sdk/apis/metadata.json +25 -0
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.min.json +633 -331
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/personalize-2018-05-22.min.json +85 -52
- package/node_modules/aws-sdk/apis/personalize-events-2018-03-22.min.json +97 -5
- package/node_modules/aws-sdk/apis/personalize-runtime-2018-05-22.min.json +68 -11
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +398 -268
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +14 -2
- package/node_modules/aws-sdk/apis/repostspace-2022-05-13.examples.json +5 -0
- package/node_modules/aws-sdk/apis/repostspace-2022-05-13.min.json +447 -0
- package/node_modules/aws-sdk/apis/repostspace-2022-05-13.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/runtime.lex.v2-2020-08-07.min.json +25 -24
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +142 -142
- package/node_modules/aws-sdk/apis/s3-2006-03-01.min.json +45 -0
- package/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json +1330 -314
- package/node_modules/aws-sdk/apis/s3control-2018-08-20.paginators.json +15 -0
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.min.json +111 -50
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.examples.json +526 -10
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +1057 -352
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/states-2016-11-23.min.json +85 -0
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +268 -70
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json +119 -96
- package/node_modules/aws-sdk/apis/workspaces-thin-client-2023-08-22.examples.json +5 -0
- package/node_modules/aws-sdk/apis/workspaces-thin-client-2023-08-22.min.json +777 -0
- package/node_modules/aws-sdk/apis/workspaces-thin-client-2023-08-22.paginators.json +22 -0
- package/node_modules/aws-sdk/clients/accessanalyzer.d.ts +374 -5
- package/node_modules/aws-sdk/clients/all.d.ts +7 -0
- package/node_modules/aws-sdk/clients/all.js +8 -1
- package/node_modules/aws-sdk/clients/amp.d.ts +322 -0
- package/node_modules/aws-sdk/clients/appsync.d.ts +169 -0
- package/node_modules/aws-sdk/clients/b2bi.d.ts +1388 -0
- package/node_modules/aws-sdk/clients/b2bi.js +18 -0
- package/node_modules/aws-sdk/clients/backup.d.ts +848 -45
- package/node_modules/aws-sdk/clients/bcmdataexports.d.ts +589 -0
- package/node_modules/aws-sdk/clients/bcmdataexports.js +18 -0
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +76 -2
- package/node_modules/aws-sdk/clients/cloudwatchlogs.d.ts +413 -1
- package/node_modules/aws-sdk/clients/codestarconnections.d.ts +727 -0
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +307 -6
- package/node_modules/aws-sdk/clients/configservice.d.ts +60 -11
- package/node_modules/aws-sdk/clients/controltower.d.ts +319 -25
- package/node_modules/aws-sdk/clients/costoptimizationhub.d.ts +1283 -0
- package/node_modules/aws-sdk/clients/costoptimizationhub.js +18 -0
- package/node_modules/aws-sdk/clients/detective.d.ts +469 -0
- package/node_modules/aws-sdk/clients/ecs.d.ts +10 -5
- package/node_modules/aws-sdk/clients/efs.d.ts +75 -33
- package/node_modules/aws-sdk/clients/eks.d.ts +237 -15
- package/node_modules/aws-sdk/clients/eksauth.d.ts +124 -0
- package/node_modules/aws-sdk/clients/eksauth.js +19 -0
- package/node_modules/aws-sdk/clients/elbv2.d.ts +433 -4
- package/node_modules/aws-sdk/clients/fis.d.ts +383 -3
- package/node_modules/aws-sdk/clients/freetier.d.ts +149 -0
- package/node_modules/aws-sdk/clients/freetier.js +18 -0
- package/node_modules/aws-sdk/clients/fsx.d.ts +194 -21
- package/node_modules/aws-sdk/clients/glue.d.ts +3 -3
- package/node_modules/aws-sdk/clients/guardduty.d.ts +82 -11
- package/node_modules/aws-sdk/clients/iotfleetwise.d.ts +198 -13
- package/node_modules/aws-sdk/clients/lakeformation.d.ts +118 -2
- package/node_modules/aws-sdk/clients/lexmodelsv2.d.ts +343 -2
- package/node_modules/aws-sdk/clients/lexruntimev2.d.ts +14 -9
- package/node_modules/aws-sdk/clients/managedblockchain.d.ts +26 -5
- package/node_modules/aws-sdk/clients/personalize.d.ts +65 -20
- package/node_modules/aws-sdk/clients/personalizeevents.d.ts +102 -12
- package/node_modules/aws-sdk/clients/personalizeruntime.d.ts +72 -2
- package/node_modules/aws-sdk/clients/quicksight.d.ts +124 -0
- package/node_modules/aws-sdk/clients/rds.d.ts +80 -80
- package/node_modules/aws-sdk/clients/redshift.d.ts +16 -0
- package/node_modules/aws-sdk/clients/repostspace.d.ts +458 -0
- package/node_modules/aws-sdk/clients/repostspace.js +18 -0
- package/node_modules/aws-sdk/clients/s3.d.ts +2 -2
- package/node_modules/aws-sdk/clients/s3control.d.ts +841 -13
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +94 -5
- package/node_modules/aws-sdk/clients/securityhub.d.ts +908 -15
- package/node_modules/aws-sdk/clients/stepfunctions.d.ts +153 -8
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +312 -46
- package/node_modules/aws-sdk/clients/workspaces.d.ts +43 -1
- package/node_modules/aws-sdk/clients/workspacesthinclient.d.ts +895 -0
- package/node_modules/aws-sdk/clients/workspacesthinclient.js +18 -0
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +2 -2
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +321 -55
- package/node_modules/aws-sdk/dist/aws-sdk.js +2045 -597
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +104 -104
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +14 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +3 -3
@@ -12,11 +12,11 @@ declare class Personalize extends Service {
|
|
12
12
|
constructor(options?: Personalize.Types.ClientConfiguration)
|
13
13
|
config: Config & Personalize.Types.ClientConfiguration;
|
14
14
|
/**
|
15
|
-
*
|
15
|
+
* Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket. To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file. For more information, see Creating a batch inference job . If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data. For more information about generating themes, see Batch recommendations with themes from Content Generator . You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.
|
16
16
|
*/
|
17
17
|
createBatchInferenceJob(params: Personalize.Types.CreateBatchInferenceJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateBatchInferenceJobResponse) => void): Request<Personalize.Types.CreateBatchInferenceJobResponse, AWSError>;
|
18
18
|
/**
|
19
|
-
*
|
19
|
+
* Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket. To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file. For more information, see Creating a batch inference job . If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data. For more information about generating themes, see Batch recommendations with themes from Content Generator . You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.
|
20
20
|
*/
|
21
21
|
createBatchInferenceJob(callback?: (err: AWSError, data: Personalize.Types.CreateBatchInferenceJobResponse) => void): Request<Personalize.Types.CreateBatchInferenceJobResponse, AWSError>;
|
22
22
|
/**
|
@@ -36,11 +36,11 @@ declare class Personalize extends Service {
|
|
36
36
|
*/
|
37
37
|
createCampaign(callback?: (err: AWSError, data: Personalize.Types.CreateCampaignResponse) => void): Request<Personalize.Types.CreateCampaignResponse, AWSError>;
|
38
38
|
/**
|
39
|
-
* Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are
|
39
|
+
* Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are 5 types of datasets: Item interactions Items Users Action interactions Actions Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution). A dataset can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset
|
40
40
|
*/
|
41
41
|
createDataset(params: Personalize.Types.CreateDatasetRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetResponse) => void): Request<Personalize.Types.CreateDatasetResponse, AWSError>;
|
42
42
|
/**
|
43
|
-
* Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are
|
43
|
+
* Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are 5 types of datasets: Item interactions Items Users Action interactions Actions Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution). A dataset can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset
|
44
44
|
*/
|
45
45
|
createDataset(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetResponse) => void): Request<Personalize.Types.CreateDatasetResponse, AWSError>;
|
46
46
|
/**
|
@@ -52,27 +52,27 @@ declare class Personalize extends Service {
|
|
52
52
|
*/
|
53
53
|
createDatasetExportJob(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetExportJobResponse) => void): Request<Personalize.Types.CreateDatasetExportJobResponse, AWSError>;
|
54
54
|
/**
|
55
|
-
* Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:
|
55
|
+
* Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset: Item interactions Items Users Actions Action interactions A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
|
56
56
|
*/
|
57
57
|
createDatasetGroup(params: Personalize.Types.CreateDatasetGroupRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
|
58
58
|
/**
|
59
|
-
* Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:
|
59
|
+
* Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset: Item interactions Items Users Actions Action interactions A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
|
60
60
|
*/
|
61
61
|
createDatasetGroup(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
|
62
62
|
/**
|
63
|
-
* Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.
|
63
|
+
* Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations. By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation. Status A dataset import job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
|
64
64
|
*/
|
65
65
|
createDatasetImportJob(params: Personalize.Types.CreateDatasetImportJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
|
66
66
|
/**
|
67
|
-
* Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.
|
67
|
+
* Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations. By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation. Status A dataset import job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
|
68
68
|
*/
|
69
69
|
createDatasetImportJob(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
|
70
70
|
/**
|
71
|
-
* Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the
|
71
|
+
* Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker. The event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker
|
72
72
|
*/
|
73
73
|
createEventTracker(params: Personalize.Types.CreateEventTrackerRequest, callback?: (err: AWSError, data: Personalize.Types.CreateEventTrackerResponse) => void): Request<Personalize.Types.CreateEventTrackerResponse, AWSError>;
|
74
74
|
/**
|
75
|
-
* Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the
|
75
|
+
* Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker. The event tracker can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker
|
76
76
|
*/
|
77
77
|
createEventTracker(callback?: (err: AWSError, data: Personalize.Types.CreateEventTrackerResponse) => void): Request<Personalize.Types.CreateEventTrackerResponse, AWSError>;
|
78
78
|
/**
|
@@ -148,11 +148,11 @@ declare class Personalize extends Service {
|
|
148
148
|
*/
|
149
149
|
deleteDatasetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
150
150
|
/**
|
151
|
-
* Deletes the event tracker. Does not delete the
|
151
|
+
* Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.
|
152
152
|
*/
|
153
153
|
deleteEventTracker(params: Personalize.Types.DeleteEventTrackerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
154
154
|
/**
|
155
|
-
* Deletes the event tracker. Does not delete the
|
155
|
+
* Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.
|
156
156
|
*/
|
157
157
|
deleteEventTracker(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
158
158
|
/**
|
@@ -516,11 +516,11 @@ declare class Personalize extends Service {
|
|
516
516
|
*/
|
517
517
|
untagResource(callback?: (err: AWSError, data: Personalize.Types.UntagResourceResponse) => void): Request<Personalize.Types.UntagResourceResponse, AWSError>;
|
518
518
|
/**
|
519
|
-
*
|
519
|
+
* Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration, such as the exploration configuration. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation. You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active. For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.
|
520
520
|
*/
|
521
521
|
updateCampaign(params: Personalize.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.UpdateCampaignResponse) => void): Request<Personalize.Types.UpdateCampaignResponse, AWSError>;
|
522
522
|
/**
|
523
|
-
*
|
523
|
+
* Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration, such as the exploration configuration. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation. You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active. For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.
|
524
524
|
*/
|
525
525
|
updateCampaign(callback?: (err: AWSError, data: Personalize.Types.UpdateCampaignResponse) => void): Request<Personalize.Types.UpdateCampaignResponse, AWSError>;
|
526
526
|
/**
|
@@ -662,6 +662,14 @@ declare namespace Personalize {
|
|
662
662
|
* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
|
663
663
|
*/
|
664
664
|
roleArn?: RoleArn;
|
665
|
+
/**
|
666
|
+
* The job's mode.
|
667
|
+
*/
|
668
|
+
batchInferenceJobMode?: BatchInferenceJobMode;
|
669
|
+
/**
|
670
|
+
* The job's theme generation settings.
|
671
|
+
*/
|
672
|
+
themeGenerationConfig?: ThemeGenerationConfig;
|
665
673
|
/**
|
666
674
|
* The status of the batch inference job. The status is one of the following values: PENDING IN PROGRESS ACTIVE CREATE FAILED
|
667
675
|
*/
|
@@ -687,6 +695,7 @@ declare namespace Personalize {
|
|
687
695
|
*/
|
688
696
|
s3DataSource: S3DataConfig;
|
689
697
|
}
|
698
|
+
export type BatchInferenceJobMode = "BATCH_INFERENCE"|"THEME_GENERATION"|string;
|
690
699
|
export interface BatchInferenceJobOutput {
|
691
700
|
/**
|
692
701
|
* Information on the Amazon S3 bucket in which the batch inference job's output is stored.
|
@@ -722,6 +731,10 @@ declare namespace Personalize {
|
|
722
731
|
* The ARN of the solution version used by the batch inference job.
|
723
732
|
*/
|
724
733
|
solutionVersionArn?: Arn;
|
734
|
+
/**
|
735
|
+
* The job's mode.
|
736
|
+
*/
|
737
|
+
batchInferenceJobMode?: BatchInferenceJobMode;
|
725
738
|
}
|
726
739
|
export type BatchInferenceJobs = BatchInferenceJobSummary[];
|
727
740
|
export interface BatchSegmentJob {
|
@@ -856,6 +869,10 @@ declare namespace Personalize {
|
|
856
869
|
* Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.
|
857
870
|
*/
|
858
871
|
itemExplorationConfig?: HyperParameters;
|
872
|
+
/**
|
873
|
+
* Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.
|
874
|
+
*/
|
875
|
+
enableMetadataWithRecommendations?: Boolean;
|
859
876
|
}
|
860
877
|
export interface CampaignSummary {
|
861
878
|
/**
|
@@ -980,6 +997,14 @@ declare namespace Personalize {
|
|
980
997
|
* A list of tags to apply to the batch inference job.
|
981
998
|
*/
|
982
999
|
tags?: Tags;
|
1000
|
+
/**
|
1001
|
+
* The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE. When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
|
1002
|
+
*/
|
1003
|
+
batchInferenceJobMode?: BatchInferenceJobMode;
|
1004
|
+
/**
|
1005
|
+
* For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
|
1006
|
+
*/
|
1007
|
+
themeGenerationConfig?: ThemeGenerationConfig;
|
983
1008
|
}
|
984
1009
|
export interface CreateBatchInferenceJobResponse {
|
985
1010
|
/**
|
@@ -1169,7 +1194,7 @@ declare namespace Personalize {
|
|
1169
1194
|
*/
|
1170
1195
|
datasetGroupArn: Arn;
|
1171
1196
|
/**
|
1172
|
-
* The type of dataset. One of the following (case insensitive) values: Interactions Items Users
|
1197
|
+
* The type of dataset. One of the following (case insensitive) values: Interactions Items Users Actions Action_Interactions
|
1173
1198
|
*/
|
1174
1199
|
datasetType: DatasetType;
|
1175
1200
|
/**
|
@@ -1353,7 +1378,7 @@ declare namespace Personalize {
|
|
1353
1378
|
*/
|
1354
1379
|
solutionArn: Arn;
|
1355
1380
|
/**
|
1356
|
-
* The scope of training to be performed when creating the solution version. The FULL
|
1381
|
+
* The scope of training to be performed when creating the solution version. The default is FULL. This creates a completely new model based on the entirety of the training data from the datasets in your dataset group. If you use User-Personalization, you can specify a training mode of UPDATE. This updates the model to consider new items for recommendations. It is not a full retraining. You should still complete a full retraining weekly. If you specify UPDATE, Amazon Personalize will stop automatic updates for the solution version. To resume updates, create a new solution with training mode set to FULL and deploy it in a campaign. For more information about automatic updates, see Automatic updates. The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the legacy HRNN-Coldstart recipe.
|
1357
1382
|
*/
|
1358
1383
|
trainingMode?: TrainingMode;
|
1359
1384
|
/**
|
@@ -1387,7 +1412,7 @@ declare namespace Personalize {
|
|
1387
1412
|
*/
|
1388
1413
|
datasetGroupArn?: Arn;
|
1389
1414
|
/**
|
1390
|
-
* One of the following values: Interactions Items Users
|
1415
|
+
* One of the following values: Interactions Items Users Actions Action_Interactions
|
1391
1416
|
*/
|
1392
1417
|
datasetType?: DatasetType;
|
1393
1418
|
/**
|
@@ -1410,6 +1435,10 @@ declare namespace Personalize {
|
|
1410
1435
|
* Describes the latest update to the dataset.
|
1411
1436
|
*/
|
1412
1437
|
latestDatasetUpdate?: DatasetUpdateSummary;
|
1438
|
+
/**
|
1439
|
+
* The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.
|
1440
|
+
*/
|
1441
|
+
trackingId?: TrackingId;
|
1413
1442
|
}
|
1414
1443
|
export interface DatasetExportJob {
|
1415
1444
|
/**
|
@@ -1497,7 +1526,7 @@ declare namespace Personalize {
|
|
1497
1526
|
*/
|
1498
1527
|
status?: Status;
|
1499
1528
|
/**
|
1500
|
-
* The ARN of the IAM role that has permissions to
|
1529
|
+
* The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
|
1501
1530
|
*/
|
1502
1531
|
roleArn?: RoleArn;
|
1503
1532
|
/**
|
@@ -2145,6 +2174,12 @@ declare namespace Personalize {
|
|
2145
2174
|
}
|
2146
2175
|
export type FeatureTransformationParameters = {[key: string]: ParameterValue};
|
2147
2176
|
export type FeaturizationParameters = {[key: string]: ParameterValue};
|
2177
|
+
export interface FieldsForThemeGeneration {
|
2178
|
+
/**
|
2179
|
+
* The name of the Items dataset column that stores the name of each item in the dataset.
|
2180
|
+
*/
|
2181
|
+
itemName: ColumnName;
|
2182
|
+
}
|
2148
2183
|
export interface Filter {
|
2149
2184
|
/**
|
2150
2185
|
* The name of the filter.
|
@@ -2449,7 +2484,7 @@ declare namespace Personalize {
|
|
2449
2484
|
*/
|
2450
2485
|
datasetGroupArn?: Arn;
|
2451
2486
|
/**
|
2452
|
-
* A token returned from the previous call to
|
2487
|
+
* A token returned from the previous call to ListDatasets for getting the next set of dataset import jobs (if they exist).
|
2453
2488
|
*/
|
2454
2489
|
nextToken?: NextToken;
|
2455
2490
|
/**
|
@@ -2929,6 +2964,10 @@ declare namespace Personalize {
|
|
2929
2964
|
* Specifies the training data configuration to use when creating a domain recommender.
|
2930
2965
|
*/
|
2931
2966
|
trainingDataConfig?: TrainingDataConfig;
|
2967
|
+
/**
|
2968
|
+
* Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.
|
2969
|
+
*/
|
2970
|
+
enableMetadataWithRecommendations?: Boolean;
|
2932
2971
|
}
|
2933
2972
|
export interface RecommenderSummary {
|
2934
2973
|
/**
|
@@ -3065,7 +3104,7 @@ declare namespace Personalize {
|
|
3065
3104
|
*/
|
3066
3105
|
hpoConfig?: HPOConfig;
|
3067
3106
|
/**
|
3068
|
-
* Lists the
|
3107
|
+
* Lists the algorithm hyperparameters and their values.
|
3069
3108
|
*/
|
3070
3109
|
algorithmHyperParameters?: HyperParameters;
|
3071
3110
|
/**
|
@@ -3258,6 +3297,12 @@ declare namespace Personalize {
|
|
3258
3297
|
}
|
3259
3298
|
export type TagValue = string;
|
3260
3299
|
export type Tags = Tag[];
|
3300
|
+
export interface ThemeGenerationConfig {
|
3301
|
+
/**
|
3302
|
+
* Fields used to generate descriptive themes for a batch inference job.
|
3303
|
+
*/
|
3304
|
+
fieldsForThemeGeneration: FieldsForThemeGeneration;
|
3305
|
+
}
|
3261
3306
|
export type TrackingId = string;
|
3262
3307
|
export interface TrainingDataConfig {
|
3263
3308
|
/**
|
@@ -12,52 +12,122 @@ declare class PersonalizeEvents extends Service {
|
|
12
12
|
constructor(options?: PersonalizeEvents.Types.ClientConfiguration)
|
13
13
|
config: Config & PersonalizeEvents.Types.ClientConfiguration;
|
14
14
|
/**
|
15
|
-
* Records
|
15
|
+
* Records action interaction event data. An action interaction event is an interaction between a user and an action. For example, a user taking an action, such a enrolling in a membership program or downloading your app. For more information about recording action interactions, see Recording action interaction events. For more information about actions in an Actions dataset, see Actions dataset.
|
16
|
+
*/
|
17
|
+
putActionInteractions(params: PersonalizeEvents.Types.PutActionInteractionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
18
|
+
/**
|
19
|
+
* Records action interaction event data. An action interaction event is an interaction between a user and an action. For example, a user taking an action, such a enrolling in a membership program or downloading your app. For more information about recording action interactions, see Recording action interaction events. For more information about actions in an Actions dataset, see Actions dataset.
|
20
|
+
*/
|
21
|
+
putActionInteractions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
22
|
+
/**
|
23
|
+
* Adds one or more actions to an Actions dataset. For more information see Importing actions individually.
|
24
|
+
*/
|
25
|
+
putActions(params: PersonalizeEvents.Types.PutActionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
26
|
+
/**
|
27
|
+
* Adds one or more actions to an Actions dataset. For more information see Importing actions individually.
|
28
|
+
*/
|
29
|
+
putActions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
30
|
+
/**
|
31
|
+
* Records item interaction event data. For more information see Recording item interaction events.
|
16
32
|
*/
|
17
33
|
putEvents(params: PersonalizeEvents.Types.PutEventsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
18
34
|
/**
|
19
|
-
* Records
|
35
|
+
* Records item interaction event data. For more information see Recording item interaction events.
|
20
36
|
*/
|
21
37
|
putEvents(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
22
38
|
/**
|
23
|
-
* Adds one or more items to an Items dataset. For more information see Importing
|
39
|
+
* Adds one or more items to an Items dataset. For more information see Importing items individually.
|
24
40
|
*/
|
25
41
|
putItems(params: PersonalizeEvents.Types.PutItemsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
26
42
|
/**
|
27
|
-
* Adds one or more items to an Items dataset. For more information see Importing
|
43
|
+
* Adds one or more items to an Items dataset. For more information see Importing items individually.
|
28
44
|
*/
|
29
45
|
putItems(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
30
46
|
/**
|
31
|
-
* Adds one or more users to a Users dataset. For more information see Importing
|
47
|
+
* Adds one or more users to a Users dataset. For more information see Importing users individually.
|
32
48
|
*/
|
33
49
|
putUsers(params: PersonalizeEvents.Types.PutUsersRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
34
50
|
/**
|
35
|
-
* Adds one or more users to a Users dataset. For more information see Importing
|
51
|
+
* Adds one or more users to a Users dataset. For more information see Importing users individually.
|
36
52
|
*/
|
37
53
|
putUsers(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
38
54
|
}
|
39
55
|
declare namespace PersonalizeEvents {
|
56
|
+
export interface Action {
|
57
|
+
/**
|
58
|
+
* The ID associated with the action.
|
59
|
+
*/
|
60
|
+
actionId: StringType;
|
61
|
+
/**
|
62
|
+
* A string map of action-specific metadata. Each element in the map consists of a key-value pair. For example, {"value": "100"}. The keys use camel case names that match the fields in the schema for the Actions dataset. In the previous example, the value matches the 'VALUE' field defined in the Actions schema. For categorical string data, to include multiple categories for a single action, separate each category with a pipe separator (|). For example, \"Deluxe|Premium\".
|
63
|
+
*/
|
64
|
+
properties?: ActionProperties;
|
65
|
+
}
|
66
|
+
export type ActionId = string;
|
67
|
+
export type ActionImpression = ActionId[];
|
68
|
+
export interface ActionInteraction {
|
69
|
+
/**
|
70
|
+
* The ID of the action the user interacted with. This corresponds to the ACTION_ID field of the Action interaction schema.
|
71
|
+
*/
|
72
|
+
actionId: ActionId;
|
73
|
+
/**
|
74
|
+
* The ID of the user who interacted with the action. This corresponds to the USER_ID field of the Action interaction schema.
|
75
|
+
*/
|
76
|
+
userId?: UserId;
|
77
|
+
/**
|
78
|
+
* The ID associated with the user's visit. Your application generates a unique sessionId when a user first visits your website or uses your application.
|
79
|
+
*/
|
80
|
+
sessionId: StringType;
|
81
|
+
/**
|
82
|
+
* The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.
|
83
|
+
*/
|
84
|
+
timestamp: _Date;
|
85
|
+
/**
|
86
|
+
* The type of action interaction event. You can specify Viewed, Taken, and Not Taken event types. For more information about action interaction event type data, see Event type data.
|
87
|
+
*/
|
88
|
+
eventType: StringType;
|
89
|
+
/**
|
90
|
+
* An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.
|
91
|
+
*/
|
92
|
+
eventId?: StringType;
|
93
|
+
/**
|
94
|
+
* The ID of the list of recommendations that contains the action the user interacted with.
|
95
|
+
*/
|
96
|
+
recommendationId?: RecommendationId;
|
97
|
+
/**
|
98
|
+
* A list of action IDs that represents the sequence of actions you have shown the user. For example, ["actionId1", "actionId2", "actionId3"]. Amazon Personalize doesn't use impressions data from action interaction events. Instead, record multiple events for each action and use the Viewed event type.
|
99
|
+
*/
|
100
|
+
impression?: ActionImpression;
|
101
|
+
/**
|
102
|
+
* A string map of event-specific data that you might choose to record. For example, if a user takes an action, other than the action ID, you might also send the number of actions taken by the user. Each item in the map consists of a key-value pair. For example, {"numberOfActions": "12"} The keys use camel case names that match the fields in the Action interactions schema. In the above example, the numberOfActions would match the 'NUMBER_OF_ACTIONS' field defined in the Action interactions schema. The following can't be included as a keyword for properties (case insensitive). userId sessionId eventType timestamp recommendationId impression
|
103
|
+
*/
|
104
|
+
properties?: ActionInteractionProperties;
|
105
|
+
}
|
106
|
+
export type ActionInteractionProperties = string;
|
107
|
+
export type ActionInteractionsList = ActionInteraction[];
|
108
|
+
export type ActionList = Action[];
|
109
|
+
export type ActionProperties = string;
|
40
110
|
export type Arn = string;
|
41
111
|
export type _Date = Date;
|
42
112
|
export interface Event {
|
43
113
|
/**
|
44
|
-
* An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to
|
114
|
+
* An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.
|
45
115
|
*/
|
46
116
|
eventId?: StringType;
|
47
117
|
/**
|
48
|
-
* The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your
|
118
|
+
* The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Item interactions dataset's schema and depends on the types of events you are tracking.
|
49
119
|
*/
|
50
120
|
eventType: StringType;
|
51
121
|
/**
|
52
|
-
* The event value that corresponds to the EVENT_VALUE field of the
|
122
|
+
* The event value that corresponds to the EVENT_VALUE field of the Item interactions schema.
|
53
123
|
*/
|
54
124
|
eventValue?: FloatType;
|
55
125
|
/**
|
56
|
-
* The item ID key that corresponds to the ITEM_ID field of the
|
126
|
+
* The item ID key that corresponds to the ITEM_ID field of the Item interactions dataset's schema.
|
57
127
|
*/
|
58
128
|
itemId?: ItemId;
|
59
129
|
/**
|
60
|
-
* A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user. Each item 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
|
130
|
+
* A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user. Each item 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 Item interactions dataset's schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Item interactions dataset's schema. The following can't be included as a keyword for properties (case insensitive). userId sessionId eventType timestamp recommendationId impression
|
61
131
|
*/
|
62
132
|
properties?: EventPropertiesJSON;
|
63
133
|
/**
|
@@ -101,6 +171,26 @@ declare namespace PersonalizeEvents {
|
|
101
171
|
*/
|
102
172
|
eventAttributionSource: EventAttributionSource;
|
103
173
|
}
|
174
|
+
export interface PutActionInteractionsRequest {
|
175
|
+
/**
|
176
|
+
* The ID of your action interaction event tracker. When you create an Action interactions dataset, Amazon Personalize creates an action interaction event tracker for you. For more information, see Action interaction event tracker ID.
|
177
|
+
*/
|
178
|
+
trackingId: StringType;
|
179
|
+
/**
|
180
|
+
* A list of action interaction events from the session.
|
181
|
+
*/
|
182
|
+
actionInteractions: ActionInteractionsList;
|
183
|
+
}
|
184
|
+
export interface PutActionsRequest {
|
185
|
+
/**
|
186
|
+
* The Amazon Resource Name (ARN) of the Actions dataset you are adding the action or actions to.
|
187
|
+
*/
|
188
|
+
datasetArn: Arn;
|
189
|
+
/**
|
190
|
+
* A list of action data.
|
191
|
+
*/
|
192
|
+
actions: ActionList;
|
193
|
+
}
|
104
194
|
export interface PutEventsRequest {
|
105
195
|
/**
|
106
196
|
* The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.
|
@@ -111,7 +201,7 @@ declare namespace PersonalizeEvents {
|
|
111
201
|
*/
|
112
202
|
userId?: UserId;
|
113
203
|
/**
|
114
|
-
* 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. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording
|
204
|
+
* 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. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording item interaction events.
|
115
205
|
*/
|
116
206
|
sessionId: StringType;
|
117
207
|
/**
|
@@ -11,6 +11,14 @@ declare class PersonalizeRuntime extends Service {
|
|
11
11
|
*/
|
12
12
|
constructor(options?: PersonalizeRuntime.Types.ClientConfiguration)
|
13
13
|
config: Config & PersonalizeRuntime.Types.ClientConfiguration;
|
14
|
+
/**
|
15
|
+
* Returns a list of recommended actions in sorted in descending order by prediction score. Use the GetActionRecommendations API if you have a custom campaign that deploys a solution version trained with a PERSONALIZED_ACTIONS recipe. For more information about PERSONALIZED_ACTIONS recipes, see PERSONALIZED_ACTIONS recipes. For more information about getting action recommendations, see Getting action recommendations.
|
16
|
+
*/
|
17
|
+
getActionRecommendations(params: PersonalizeRuntime.Types.GetActionRecommendationsRequest, callback?: (err: AWSError, data: PersonalizeRuntime.Types.GetActionRecommendationsResponse) => void): Request<PersonalizeRuntime.Types.GetActionRecommendationsResponse, AWSError>;
|
18
|
+
/**
|
19
|
+
* Returns a list of recommended actions in sorted in descending order by prediction score. Use the GetActionRecommendations API if you have a custom campaign that deploys a solution version trained with a PERSONALIZED_ACTIONS recipe. For more information about PERSONALIZED_ACTIONS recipes, see PERSONALIZED_ACTIONS recipes. For more information about getting action recommendations, see Getting action recommendations.
|
20
|
+
*/
|
21
|
+
getActionRecommendations(callback?: (err: AWSError, data: PersonalizeRuntime.Types.GetActionRecommendationsResponse) => void): Request<PersonalizeRuntime.Types.GetActionRecommendationsResponse, AWSError>;
|
14
22
|
/**
|
15
23
|
* Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user. The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.
|
16
24
|
*/
|
@@ -29,20 +37,58 @@ declare class PersonalizeRuntime extends Service {
|
|
29
37
|
getRecommendations(callback?: (err: AWSError, data: PersonalizeRuntime.Types.GetRecommendationsResponse) => void): Request<PersonalizeRuntime.Types.GetRecommendationsResponse, AWSError>;
|
30
38
|
}
|
31
39
|
declare namespace PersonalizeRuntime {
|
40
|
+
export type ActionID = string;
|
41
|
+
export type ActionList = PredictedAction[];
|
32
42
|
export type Arn = string;
|
33
43
|
export type AttributeName = string;
|
34
44
|
export type AttributeValue = string;
|
45
|
+
export type ColumnName = string;
|
46
|
+
export type ColumnNamesList = ColumnName[];
|
47
|
+
export type ColumnValue = string;
|
35
48
|
export type Context = {[key: string]: AttributeValue};
|
49
|
+
export type DatasetType = string;
|
36
50
|
export type FilterAttributeName = string;
|
37
51
|
export type FilterAttributeValue = string;
|
38
52
|
export type FilterValues = {[key: string]: FilterAttributeValue};
|
53
|
+
export interface GetActionRecommendationsRequest {
|
54
|
+
/**
|
55
|
+
* The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.
|
56
|
+
*/
|
57
|
+
campaignArn?: Arn;
|
58
|
+
/**
|
59
|
+
* The user ID of the user to provide action recommendations for.
|
60
|
+
*/
|
61
|
+
userId?: UserID;
|
62
|
+
/**
|
63
|
+
* The number of results to return. The default is 5. The maximum is 100.
|
64
|
+
*/
|
65
|
+
numResults?: NumResults;
|
66
|
+
/**
|
67
|
+
* The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations. When using this parameter, be sure the filter resource is ACTIVE.
|
68
|
+
*/
|
69
|
+
filterArn?: Arn;
|
70
|
+
/**
|
71
|
+
* The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma. For filter expressions that use an INCLUDE element to include actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, you can omit the filter-values. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations. For more information, see Filtering recommendations and user segments.
|
72
|
+
*/
|
73
|
+
filterValues?: FilterValues;
|
74
|
+
}
|
75
|
+
export interface GetActionRecommendationsResponse {
|
76
|
+
/**
|
77
|
+
* A list of action recommendations sorted in descending order by prediction score. There can be a maximum of 100 actions in the list. For information about action scores, see How action recommendation scoring works.
|
78
|
+
*/
|
79
|
+
actionList?: ActionList;
|
80
|
+
/**
|
81
|
+
* The ID of the recommendation.
|
82
|
+
*/
|
83
|
+
recommendationId?: RecommendationID;
|
84
|
+
}
|
39
85
|
export interface GetPersonalizedRankingRequest {
|
40
86
|
/**
|
41
87
|
* The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
|
42
88
|
*/
|
43
89
|
campaignArn: Arn;
|
44
90
|
/**
|
45
|
-
* A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list.
|
91
|
+
* A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
|
46
92
|
*/
|
47
93
|
inputList: InputList;
|
48
94
|
/**
|
@@ -61,6 +107,10 @@ declare namespace PersonalizeRuntime {
|
|
61
107
|
* The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma. For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations. For more information, see Filtering Recommendations.
|
62
108
|
*/
|
63
109
|
filterValues?: FilterValues;
|
110
|
+
/**
|
111
|
+
* If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.
|
112
|
+
*/
|
113
|
+
metadataColumns?: MetadataColumns;
|
64
114
|
}
|
65
115
|
export interface GetPersonalizedRankingResponse {
|
66
116
|
/**
|
@@ -86,7 +136,7 @@ declare namespace PersonalizeRuntime {
|
|
86
136
|
*/
|
87
137
|
userId?: UserID;
|
88
138
|
/**
|
89
|
-
* The number of results to return. The default is 25.
|
139
|
+
* The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
|
90
140
|
*/
|
91
141
|
numResults?: NumResults;
|
92
142
|
/**
|
@@ -109,6 +159,10 @@ declare namespace PersonalizeRuntime {
|
|
109
159
|
* The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.
|
110
160
|
*/
|
111
161
|
promotions?: PromotionList;
|
162
|
+
/**
|
163
|
+
* If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.
|
164
|
+
*/
|
165
|
+
metadataColumns?: MetadataColumns;
|
112
166
|
}
|
113
167
|
export interface GetRecommendationsResponse {
|
114
168
|
/**
|
@@ -123,9 +177,21 @@ declare namespace PersonalizeRuntime {
|
|
123
177
|
export type InputList = ItemID[];
|
124
178
|
export type ItemID = string;
|
125
179
|
export type ItemList = PredictedItem[];
|
180
|
+
export type Metadata = {[key: string]: ColumnValue};
|
181
|
+
export type MetadataColumns = {[key: string]: ColumnNamesList};
|
126
182
|
export type Name = string;
|
127
183
|
export type NumResults = number;
|
128
184
|
export type PercentPromotedItems = number;
|
185
|
+
export interface PredictedAction {
|
186
|
+
/**
|
187
|
+
* The ID of the recommended action.
|
188
|
+
*/
|
189
|
+
actionId?: ActionID;
|
190
|
+
/**
|
191
|
+
* The score of the recommended action. For information about action scores, see How action recommendation scoring works.
|
192
|
+
*/
|
193
|
+
score?: Score;
|
194
|
+
}
|
129
195
|
export interface PredictedItem {
|
130
196
|
/**
|
131
197
|
* The recommended item ID.
|
@@ -139,6 +205,10 @@ declare namespace PersonalizeRuntime {
|
|
139
205
|
* The name of the promotion that included the predicted item.
|
140
206
|
*/
|
141
207
|
promotionName?: Name;
|
208
|
+
/**
|
209
|
+
* Metadata about the item from your Items dataset.
|
210
|
+
*/
|
211
|
+
metadata?: Metadata;
|
142
212
|
}
|
143
213
|
export interface Promotion {
|
144
214
|
/**
|