UNPKG

90.8 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class Personalize extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: Personalize.Types.ClientConfiguration)
13 config: Config & Personalize.Types.ClientConfiguration;
14 /**
15 * Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request. Minimum Provisioned TPS and Auto-Scaling A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS, to maintain a 70% utilization. There's a short time delay while the capacity is increased that might cause loss of transactions. It's recommended to start with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary. Status A campaign 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 campaign status, call DescribeCampaign. Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations. Related APIs ListCampaigns DescribeCampaign UpdateCampaign DeleteCampaign
16 */
17 createCampaign(params: Personalize.Types.CreateCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.CreateCampaignResponse) => void): Request<Personalize.Types.CreateCampaignResponse, AWSError>;
18 /**
19 * Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request. Minimum Provisioned TPS and Auto-Scaling A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS, to maintain a 70% utilization. There's a short time delay while the capacity is increased that might cause loss of transactions. It's recommended to start with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary. Status A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the campaign status, call DescribeCampaign. Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations. Related APIs ListCampaigns DescribeCampaign UpdateCampaign DeleteCampaign
20 */
21 createCampaign(callback?: (err: AWSError, data: Personalize.Types.CreateCampaignResponse) => void): Request<Personalize.Types.CreateCampaignResponse, AWSError>;
22 /**
23 * Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are three types of datasets: Interactions Items Users Each dataset type has an associated schema with required field types. Only the 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 &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset
24 */
25 createDataset(params: Personalize.Types.CreateDatasetRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetResponse) => void): Request<Personalize.Types.CreateDatasetResponse, AWSError>;
26 /**
27 * Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are three types of datasets: Interactions Items Users Each dataset type has an associated schema with required field types. Only the 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 &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset
28 */
29 createDataset(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetResponse) => void): Request<Personalize.Types.CreateDatasetResponse, AWSError>;
30 /**
31 * Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; 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 AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS 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
32 */
33 createDatasetGroup(params: Personalize.Types.CreateDatasetGroupRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
34 /**
35 * Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; 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 AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS 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
36 */
37 createDatasetGroup(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
38 /**
39 * 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 AWS Identity and Access Management (IAM) role that has permission to read from the data source. The dataset import job replaces any previous data in the dataset. Status A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; 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
40 */
41 createDatasetImportJob(params: Personalize.Types.CreateDatasetImportJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
42 /**
43 * 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 AWS Identity and Access Management (IAM) role that has permission to read from the data source. The dataset import job replaces any previous data in the dataset. Status A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; 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
44 */
45 createDatasetImportJob(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
46 /**
47 * Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API. When Amazon Personalize creates an event tracker, it also creates an event-interactions dataset in the dataset group associated with the event tracker. The event-interactions dataset stores the event data from the PutEvents call. The contents of this dataset are not available to the user. 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 send event data you include your tracking ID. The tracking ID identifies the customer and authorizes the customer to send the data. The event tracker can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; 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
48 */
49 createEventTracker(params: Personalize.Types.CreateEventTrackerRequest, callback?: (err: AWSError, data: Personalize.Types.CreateEventTrackerResponse) => void): Request<Personalize.Types.CreateEventTrackerResponse, AWSError>;
50 /**
51 * Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API. When Amazon Personalize creates an event tracker, it also creates an event-interactions dataset in the dataset group associated with the event tracker. The event-interactions dataset stores the event data from the PutEvents call. The contents of this dataset are not available to the user. 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 send event data you include your tracking ID. The tracking ID identifies the customer and authorizes the customer to send the data. The event tracker can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; 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
52 */
53 createEventTracker(callback?: (err: AWSError, data: Personalize.Types.CreateEventTrackerResponse) => void): Request<Personalize.Types.CreateEventTrackerResponse, AWSError>;
54 /**
55 * Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset. Related APIs ListSchemas DescribeSchema DeleteSchema
56 */
57 createSchema(params: Personalize.Types.CreateSchemaRequest, callback?: (err: AWSError, data: Personalize.Types.CreateSchemaResponse) => void): Request<Personalize.Types.CreateSchemaResponse, AWSError>;
58 /**
59 * Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset. Related APIs ListSchemas DescribeSchema DeleteSchema
60 */
61 createSchema(callback?: (err: AWSError, data: Personalize.Types.CreateSchemaResponse) => void): Request<Personalize.Types.CreateSchemaResponse, AWSError>;
62 /**
63 * Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created. After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API. To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you. Status A solution can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion. Related APIs ListSolutions CreateSolutionVersion DescribeSolution DeleteSolution ListSolutionVersions DescribeSolutionVersion
64 */
65 createSolution(params: Personalize.Types.CreateSolutionRequest, callback?: (err: AWSError, data: Personalize.Types.CreateSolutionResponse) => void): Request<Personalize.Types.CreateSolutionResponse, AWSError>;
66 /**
67 * Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created. After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API. To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you. Status A solution can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion. Related APIs ListSolutions CreateSolutionVersion DescribeSolution DeleteSolution ListSolutionVersions DescribeSolutionVersion
68 */
69 createSolution(callback?: (err: AWSError, data: Personalize.Types.CreateSolutionResponse) => void): Request<Personalize.Types.CreateSolutionResponse, AWSError>;
70 /**
71 * Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation. Status A solution version can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Related APIs ListSolutionVersions DescribeSolutionVersion ListSolutions CreateSolution DescribeSolution DeleteSolution
72 */
73 createSolutionVersion(params: Personalize.Types.CreateSolutionVersionRequest, callback?: (err: AWSError, data: Personalize.Types.CreateSolutionVersionResponse) => void): Request<Personalize.Types.CreateSolutionVersionResponse, AWSError>;
74 /**
75 * Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation. Status A solution version can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Related APIs ListSolutionVersions DescribeSolutionVersion ListSolutions CreateSolution DescribeSolution DeleteSolution
76 */
77 createSolutionVersion(callback?: (err: AWSError, data: Personalize.Types.CreateSolutionVersionResponse) => void): Request<Personalize.Types.CreateSolutionVersionResponse, AWSError>;
78 /**
79 * Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.
80 */
81 deleteCampaign(params: Personalize.Types.DeleteCampaignRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
82 /**
83 * Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.
84 */
85 deleteCampaign(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
86 /**
87 * Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.
88 */
89 deleteDataset(params: Personalize.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
90 /**
91 * Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.
92 */
93 deleteDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
94 /**
95 * Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group.
96 */
97 deleteDatasetGroup(params: Personalize.Types.DeleteDatasetGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
98 /**
99 * Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group.
100 */
101 deleteDatasetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
102 /**
103 * Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
104 */
105 deleteEventTracker(params: Personalize.Types.DeleteEventTrackerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
106 /**
107 * Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
108 */
109 deleteEventTracker(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
110 /**
111 * Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
112 */
113 deleteSchema(params: Personalize.Types.DeleteSchemaRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
114 /**
115 * Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
116 */
117 deleteSchema(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
118 /**
119 * Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
120 */
121 deleteSolution(params: Personalize.Types.DeleteSolutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
122 /**
123 * Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
124 */
125 deleteSolution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
126 /**
127 * Describes the given algorithm.
128 */
129 describeAlgorithm(params: Personalize.Types.DescribeAlgorithmRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeAlgorithmResponse) => void): Request<Personalize.Types.DescribeAlgorithmResponse, AWSError>;
130 /**
131 * Describes the given algorithm.
132 */
133 describeAlgorithm(callback?: (err: AWSError, data: Personalize.Types.DescribeAlgorithmResponse) => void): Request<Personalize.Types.DescribeAlgorithmResponse, AWSError>;
134 /**
135 * Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. For more information on campaigns, see CreateCampaign.
136 */
137 describeCampaign(params: Personalize.Types.DescribeCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeCampaignResponse) => void): Request<Personalize.Types.DescribeCampaignResponse, AWSError>;
138 /**
139 * Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. For more information on campaigns, see CreateCampaign.
140 */
141 describeCampaign(callback?: (err: AWSError, data: Personalize.Types.DescribeCampaignResponse) => void): Request<Personalize.Types.DescribeCampaignResponse, AWSError>;
142 /**
143 * Describes the given dataset. For more information on datasets, see CreateDataset.
144 */
145 describeDataset(params: Personalize.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetResponse) => void): Request<Personalize.Types.DescribeDatasetResponse, AWSError>;
146 /**
147 * Describes the given dataset. For more information on datasets, see CreateDataset.
148 */
149 describeDataset(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetResponse) => void): Request<Personalize.Types.DescribeDatasetResponse, AWSError>;
150 /**
151 * Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
152 */
153 describeDatasetGroup(params: Personalize.Types.DescribeDatasetGroupRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetGroupResponse) => void): Request<Personalize.Types.DescribeDatasetGroupResponse, AWSError>;
154 /**
155 * Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
156 */
157 describeDatasetGroup(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetGroupResponse) => void): Request<Personalize.Types.DescribeDatasetGroupResponse, AWSError>;
158 /**
159 * Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
160 */
161 describeDatasetImportJob(params: Personalize.Types.DescribeDatasetImportJobRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetImportJobResponse) => void): Request<Personalize.Types.DescribeDatasetImportJobResponse, AWSError>;
162 /**
163 * Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
164 */
165 describeDatasetImportJob(callback?: (err: AWSError, data: Personalize.Types.DescribeDatasetImportJobResponse) => void): Request<Personalize.Types.DescribeDatasetImportJobResponse, AWSError>;
166 /**
167 * Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
168 */
169 describeEventTracker(params: Personalize.Types.DescribeEventTrackerRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeEventTrackerResponse) => void): Request<Personalize.Types.DescribeEventTrackerResponse, AWSError>;
170 /**
171 * Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
172 */
173 describeEventTracker(callback?: (err: AWSError, data: Personalize.Types.DescribeEventTrackerResponse) => void): Request<Personalize.Types.DescribeEventTrackerResponse, AWSError>;
174 /**
175 * Describes the given feature transformation.
176 */
177 describeFeatureTransformation(params: Personalize.Types.DescribeFeatureTransformationRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeFeatureTransformationResponse) => void): Request<Personalize.Types.DescribeFeatureTransformationResponse, AWSError>;
178 /**
179 * Describes the given feature transformation.
180 */
181 describeFeatureTransformation(callback?: (err: AWSError, data: Personalize.Types.DescribeFeatureTransformationResponse) => void): Request<Personalize.Types.DescribeFeatureTransformationResponse, AWSError>;
182 /**
183 * Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
184 */
185 describeRecipe(params: Personalize.Types.DescribeRecipeRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeRecipeResponse) => void): Request<Personalize.Types.DescribeRecipeResponse, AWSError>;
186 /**
187 * Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation information for modifying the input data before training. Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
188 */
189 describeRecipe(callback?: (err: AWSError, data: Personalize.Types.DescribeRecipeResponse) => void): Request<Personalize.Types.DescribeRecipeResponse, AWSError>;
190 /**
191 * Describes a schema. For more information on schemas, see CreateSchema.
192 */
193 describeSchema(params: Personalize.Types.DescribeSchemaRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeSchemaResponse) => void): Request<Personalize.Types.DescribeSchemaResponse, AWSError>;
194 /**
195 * Describes a schema. For more information on schemas, see CreateSchema.
196 */
197 describeSchema(callback?: (err: AWSError, data: Personalize.Types.DescribeSchemaResponse) => void): Request<Personalize.Types.DescribeSchemaResponse, AWSError>;
198 /**
199 * Describes a solution. For more information on solutions, see CreateSolution.
200 */
201 describeSolution(params: Personalize.Types.DescribeSolutionRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionResponse) => void): Request<Personalize.Types.DescribeSolutionResponse, AWSError>;
202 /**
203 * Describes a solution. For more information on solutions, see CreateSolution.
204 */
205 describeSolution(callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionResponse) => void): Request<Personalize.Types.DescribeSolutionResponse, AWSError>;
206 /**
207 * Describes a specific version of a solution. For more information on solutions, see CreateSolution.
208 */
209 describeSolutionVersion(params: Personalize.Types.DescribeSolutionVersionRequest, callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionVersionResponse) => void): Request<Personalize.Types.DescribeSolutionVersionResponse, AWSError>;
210 /**
211 * Describes a specific version of a solution. For more information on solutions, see CreateSolution.
212 */
213 describeSolutionVersion(callback?: (err: AWSError, data: Personalize.Types.DescribeSolutionVersionResponse) => void): Request<Personalize.Types.DescribeSolutionVersionResponse, AWSError>;
214 /**
215 * Gets the metrics for the specified solution version.
216 */
217 getSolutionMetrics(params: Personalize.Types.GetSolutionMetricsRequest, callback?: (err: AWSError, data: Personalize.Types.GetSolutionMetricsResponse) => void): Request<Personalize.Types.GetSolutionMetricsResponse, AWSError>;
218 /**
219 * Gets the metrics for the specified solution version.
220 */
221 getSolutionMetrics(callback?: (err: AWSError, data: Personalize.Types.GetSolutionMetricsResponse) => void): Request<Personalize.Types.GetSolutionMetricsResponse, AWSError>;
222 /**
223 * Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
224 */
225 listCampaigns(params: Personalize.Types.ListCampaignsRequest, callback?: (err: AWSError, data: Personalize.Types.ListCampaignsResponse) => void): Request<Personalize.Types.ListCampaignsResponse, AWSError>;
226 /**
227 * Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
228 */
229 listCampaigns(callback?: (err: AWSError, data: Personalize.Types.ListCampaignsResponse) => void): Request<Personalize.Types.ListCampaignsResponse, AWSError>;
230 /**
231 * Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
232 */
233 listDatasetGroups(params: Personalize.Types.ListDatasetGroupsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetGroupsResponse) => void): Request<Personalize.Types.ListDatasetGroupsResponse, AWSError>;
234 /**
235 * Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
236 */
237 listDatasetGroups(callback?: (err: AWSError, data: Personalize.Types.ListDatasetGroupsResponse) => void): Request<Personalize.Types.ListDatasetGroupsResponse, AWSError>;
238 /**
239 * Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
240 */
241 listDatasetImportJobs(params: Personalize.Types.ListDatasetImportJobsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetImportJobsResponse) => void): Request<Personalize.Types.ListDatasetImportJobsResponse, AWSError>;
242 /**
243 * Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
244 */
245 listDatasetImportJobs(callback?: (err: AWSError, data: Personalize.Types.ListDatasetImportJobsResponse) => void): Request<Personalize.Types.ListDatasetImportJobsResponse, AWSError>;
246 /**
247 * Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
248 */
249 listDatasets(params: Personalize.Types.ListDatasetsRequest, callback?: (err: AWSError, data: Personalize.Types.ListDatasetsResponse) => void): Request<Personalize.Types.ListDatasetsResponse, AWSError>;
250 /**
251 * Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
252 */
253 listDatasets(callback?: (err: AWSError, data: Personalize.Types.ListDatasetsResponse) => void): Request<Personalize.Types.ListDatasetsResponse, AWSError>;
254 /**
255 * Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
256 */
257 listEventTrackers(params: Personalize.Types.ListEventTrackersRequest, callback?: (err: AWSError, data: Personalize.Types.ListEventTrackersResponse) => void): Request<Personalize.Types.ListEventTrackersResponse, AWSError>;
258 /**
259 * Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
260 */
261 listEventTrackers(callback?: (err: AWSError, data: Personalize.Types.ListEventTrackersResponse) => void): Request<Personalize.Types.ListEventTrackersResponse, AWSError>;
262 /**
263 * Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
264 */
265 listRecipes(params: Personalize.Types.ListRecipesRequest, callback?: (err: AWSError, data: Personalize.Types.ListRecipesResponse) => void): Request<Personalize.Types.ListRecipesResponse, AWSError>;
266 /**
267 * Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
268 */
269 listRecipes(callback?: (err: AWSError, data: Personalize.Types.ListRecipesResponse) => void): Request<Personalize.Types.ListRecipesResponse, AWSError>;
270 /**
271 * Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
272 */
273 listSchemas(params: Personalize.Types.ListSchemasRequest, callback?: (err: AWSError, data: Personalize.Types.ListSchemasResponse) => void): Request<Personalize.Types.ListSchemasResponse, AWSError>;
274 /**
275 * Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
276 */
277 listSchemas(callback?: (err: AWSError, data: Personalize.Types.ListSchemasResponse) => void): Request<Personalize.Types.ListSchemasResponse, AWSError>;
278 /**
279 * Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
280 */
281 listSolutionVersions(params: Personalize.Types.ListSolutionVersionsRequest, callback?: (err: AWSError, data: Personalize.Types.ListSolutionVersionsResponse) => void): Request<Personalize.Types.ListSolutionVersionsResponse, AWSError>;
282 /**
283 * Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
284 */
285 listSolutionVersions(callback?: (err: AWSError, data: Personalize.Types.ListSolutionVersionsResponse) => void): Request<Personalize.Types.ListSolutionVersionsResponse, AWSError>;
286 /**
287 * Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
288 */
289 listSolutions(params: Personalize.Types.ListSolutionsRequest, callback?: (err: AWSError, data: Personalize.Types.ListSolutionsResponse) => void): Request<Personalize.Types.ListSolutionsResponse, AWSError>;
290 /**
291 * Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
292 */
293 listSolutions(callback?: (err: AWSError, data: Personalize.Types.ListSolutionsResponse) => void): Request<Personalize.Types.ListSolutionsResponse, AWSError>;
294 /**
295 * Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API. You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations. For more information on campaigns, see CreateCampaign.
296 */
297 updateCampaign(params: Personalize.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: Personalize.Types.UpdateCampaignResponse) => void): Request<Personalize.Types.UpdateCampaignResponse, AWSError>;
298 /**
299 * Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API. You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations. For more information on campaigns, see CreateCampaign.
300 */
301 updateCampaign(callback?: (err: AWSError, data: Personalize.Types.UpdateCampaignResponse) => void): Request<Personalize.Types.UpdateCampaignResponse, AWSError>;
302}
303declare namespace Personalize {
304 export type AccountId = string;
305 export interface Algorithm {
306 /**
307 * The name of the algorithm.
308 */
309 name?: Name;
310 /**
311 * The Amazon Resource Name (ARN) of the algorithm.
312 */
313 algorithmArn?: Arn;
314 /**
315 * The URI of the Docker container for the algorithm image.
316 */
317 algorithmImage?: AlgorithmImage;
318 /**
319 * Specifies the default hyperparameters.
320 */
321 defaultHyperParameters?: HyperParameters;
322 /**
323 * Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
324 */
325 defaultHyperParameterRanges?: DefaultHyperParameterRanges;
326 /**
327 * Specifies the default maximum number of training jobs and parallel training jobs.
328 */
329 defaultResourceConfig?: ResourceConfig;
330 /**
331 * The training input mode.
332 */
333 trainingInputMode?: TrainingInputMode;
334 /**
335 * The Amazon Resource Name (ARN) of the role.
336 */
337 roleArn?: Arn;
338 /**
339 * The date and time (in Unix time) that the algorithm was created.
340 */
341 creationDateTime?: _Date;
342 /**
343 * The date and time (in Unix time) that the algorithm was last updated.
344 */
345 lastUpdatedDateTime?: _Date;
346 }
347 export interface AlgorithmImage {
348 /**
349 * The name of the algorithm image.
350 */
351 name?: Name;
352 /**
353 * The URI of the Docker container for the algorithm image.
354 */
355 dockerURI: DockerURI;
356 }
357 export type Arn = string;
358 export type ArnList = Arn[];
359 export interface AutoMLConfig {
360 /**
361 * The metric to optimize.
362 */
363 metricName?: MetricName;
364 /**
365 * The list of candidate recipes.
366 */
367 recipeList?: ArnList;
368 }
369 export interface AutoMLResult {
370 /**
371 * The Amazon Resource Name (ARN) of the best recipe.
372 */
373 bestRecipeArn?: Arn;
374 }
375 export type AvroSchema = string;
376 export type Boolean = boolean;
377 export interface Campaign {
378 /**
379 * The name of the campaign.
380 */
381 name?: Name;
382 /**
383 * The Amazon Resource Name (ARN) of the campaign.
384 */
385 campaignArn?: Arn;
386 /**
387 * The Amazon Resource Name (ARN) of a specific version of the solution.
388 */
389 solutionVersionArn?: Arn;
390 /**
391 * Specifies the requested minimum provisioned transactions (recommendations) per second.
392 */
393 minProvisionedTPS?: TransactionsPerSecond;
394 /**
395 * The status of the campaign. A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
396 */
397 status?: Status;
398 /**
399 * If a campaign fails, the reason behind the failure.
400 */
401 failureReason?: FailureReason;
402 /**
403 * The date and time (in Unix format) that the campaign was created.
404 */
405 creationDateTime?: _Date;
406 /**
407 * The date and time (in Unix format) that the campaign was last updated.
408 */
409 lastUpdatedDateTime?: _Date;
410 latestCampaignUpdate?: CampaignUpdateSummary;
411 }
412 export interface CampaignSummary {
413 /**
414 * The name of the campaign.
415 */
416 name?: Name;
417 /**
418 * The Amazon Resource Name (ARN) of the campaign.
419 */
420 campaignArn?: Arn;
421 /**
422 * The status of the campaign. A campaign can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
423 */
424 status?: Status;
425 /**
426 * The date and time (in Unix time) that the campaign was created.
427 */
428 creationDateTime?: _Date;
429 /**
430 * The date and time (in Unix time) that the campaign was last updated.
431 */
432 lastUpdatedDateTime?: _Date;
433 /**
434 * If a campaign fails, the reason behind the failure.
435 */
436 failureReason?: FailureReason;
437 }
438 export interface CampaignUpdateSummary {
439 /**
440 * The Amazon Resource Name (ARN) of the deployed solution version.
441 */
442 solutionVersionArn?: Arn;
443 /**
444 * Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
445 */
446 minProvisionedTPS?: TransactionsPerSecond;
447 /**
448 * The status of the campaign update. A campaign update can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
449 */
450 status?: Status;
451 /**
452 * If a campaign update fails, the reason behind the failure.
453 */
454 failureReason?: FailureReason;
455 /**
456 * The date and time (in Unix time) that the campaign update was created.
457 */
458 creationDateTime?: _Date;
459 /**
460 * The date and time (in Unix time) that the campaign update was last updated.
461 */
462 lastUpdatedDateTime?: _Date;
463 }
464 export type Campaigns = CampaignSummary[];
465 export interface CategoricalHyperParameterRange {
466 /**
467 * The name of the hyperparameter.
468 */
469 name?: ParameterName;
470 /**
471 * A list of the categories for the hyperparameter.
472 */
473 values?: CategoricalValues;
474 }
475 export type CategoricalHyperParameterRanges = CategoricalHyperParameterRange[];
476 export type CategoricalValue = string;
477 export type CategoricalValues = CategoricalValue[];
478 export interface ContinuousHyperParameterRange {
479 /**
480 * The name of the hyperparameter.
481 */
482 name?: ParameterName;
483 /**
484 * The minimum allowable value for the hyperparameter.
485 */
486 minValue?: ContinuousMinValue;
487 /**
488 * The maximum allowable value for the hyperparameter.
489 */
490 maxValue?: ContinuousMaxValue;
491 }
492 export type ContinuousHyperParameterRanges = ContinuousHyperParameterRange[];
493 export type ContinuousMaxValue = number;
494 export type ContinuousMinValue = number;
495 export interface CreateCampaignRequest {
496 /**
497 * A name for the new campaign. The campaign name must be unique within your account.
498 */
499 name: Name;
500 /**
501 * The Amazon Resource Name (ARN) of the solution version to deploy.
502 */
503 solutionVersionArn: Arn;
504 /**
505 * Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
506 */
507 minProvisionedTPS: TransactionsPerSecond;
508 }
509 export interface CreateCampaignResponse {
510 /**
511 * The Amazon Resource Name (ARN) of the campaign.
512 */
513 campaignArn?: Arn;
514 }
515 export interface CreateDatasetGroupRequest {
516 /**
517 * The name for the new dataset group.
518 */
519 name: Name;
520 /**
521 * The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM role is only valid when also specifying a KMS key.
522 */
523 roleArn?: RoleArn;
524 /**
525 * The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.
526 */
527 kmsKeyArn?: KmsKeyArn;
528 }
529 export interface CreateDatasetGroupResponse {
530 /**
531 * The Amazon Resource Name (ARN) of the new dataset group.
532 */
533 datasetGroupArn?: Arn;
534 }
535 export interface CreateDatasetImportJobRequest {
536 /**
537 * The name for the dataset import job.
538 */
539 jobName: Name;
540 /**
541 * The ARN of the dataset that receives the imported data.
542 */
543 datasetArn: Arn;
544 /**
545 * The Amazon S3 bucket that contains the training data to import.
546 */
547 dataSource: DataSource;
548 /**
549 * The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
550 */
551 roleArn: RoleArn;
552 }
553 export interface CreateDatasetImportJobResponse {
554 /**
555 * The ARN of the dataset import job.
556 */
557 datasetImportJobArn?: Arn;
558 }
559 export interface CreateDatasetRequest {
560 /**
561 * The name for the dataset.
562 */
563 name: Name;
564 /**
565 * The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
566 */
567 schemaArn: Arn;
568 /**
569 * The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
570 */
571 datasetGroupArn: Arn;
572 /**
573 * The type of dataset. One of the following (case insensitive) values: Interactions Items Users
574 */
575 datasetType: DatasetType;
576 }
577 export interface CreateDatasetResponse {
578 /**
579 * The ARN of the dataset.
580 */
581 datasetArn?: Arn;
582 }
583 export interface CreateEventTrackerRequest {
584 /**
585 * The name for the event tracker.
586 */
587 name: Name;
588 /**
589 * The Amazon Resource Name (ARN) of the dataset group that receives the event data.
590 */
591 datasetGroupArn: Arn;
592 }
593 export interface CreateEventTrackerResponse {
594 /**
595 * The ARN of the event tracker.
596 */
597 eventTrackerArn?: Arn;
598 /**
599 * The ID of the event tracker. Include this ID in requests to the PutEvents API.
600 */
601 trackingId?: TrackingId;
602 }
603 export interface CreateSchemaRequest {
604 /**
605 * The name for the schema.
606 */
607 name: Name;
608 /**
609 * A schema in Avro JSON format.
610 */
611 schema: AvroSchema;
612 }
613 export interface CreateSchemaResponse {
614 /**
615 * The Amazon Resource Name (ARN) of the created schema.
616 */
617 schemaArn?: Arn;
618 }
619 export interface CreateSolutionRequest {
620 /**
621 * The name for the solution.
622 */
623 name: Name;
624 /**
625 * Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false.
626 */
627 performHPO?: Boolean;
628 /**
629 * Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn. When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
630 */
631 performAutoML?: PerformAutoML;
632 /**
633 * The ARN of the recipe to use for model training. Only specified when performAutoML is false.
634 */
635 recipeArn?: Arn;
636 /**
637 * The Amazon Resource Name (ARN) of the dataset group that provides the training data.
638 */
639 datasetGroupArn: Arn;
640 /**
641 * When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.
642 */
643 eventType?: EventType;
644 /**
645 * The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.
646 */
647 solutionConfig?: SolutionConfig;
648 }
649 export interface CreateSolutionResponse {
650 /**
651 * The ARN of the solution.
652 */
653 solutionArn?: Arn;
654 }
655 export interface CreateSolutionVersionRequest {
656 /**
657 * The Amazon Resource Name (ARN) of the solution containing the training configuration information.
658 */
659 solutionArn: Arn;
660 /**
661 * The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one. 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 native-recipe-hrnn-coldstart recipe.
662 */
663 trainingMode?: TrainingMode;
664 }
665 export interface CreateSolutionVersionResponse {
666 /**
667 * The ARN of the new solution version.
668 */
669 solutionVersionArn?: Arn;
670 }
671 export interface DataSource {
672 /**
673 * The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example: s3://bucket-name/training-data.csv
674 */
675 dataLocation?: S3Location;
676 }
677 export interface Dataset {
678 /**
679 * The name of the dataset.
680 */
681 name?: Name;
682 /**
683 * The Amazon Resource Name (ARN) of the dataset that you want metadata for.
684 */
685 datasetArn?: Arn;
686 /**
687 * The Amazon Resource Name (ARN) of the dataset group.
688 */
689 datasetGroupArn?: Arn;
690 /**
691 * One of the following values: Interactions Items Users
692 */
693 datasetType?: DatasetType;
694 /**
695 * The ARN of the associated schema.
696 */
697 schemaArn?: Arn;
698 /**
699 * The status of the dataset. A dataset can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
700 */
701 status?: Status;
702 /**
703 * The creation date and time (in Unix time) of the dataset.
704 */
705 creationDateTime?: _Date;
706 /**
707 * A time stamp that shows when the dataset was updated.
708 */
709 lastUpdatedDateTime?: _Date;
710 }
711 export interface DatasetGroup {
712 /**
713 * The name of the dataset group.
714 */
715 name?: Name;
716 /**
717 * The Amazon Resource Name (ARN) of the dataset group.
718 */
719 datasetGroupArn?: Arn;
720 /**
721 * The current status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING
722 */
723 status?: Status;
724 /**
725 * The ARN of the IAM role that has permissions to create the dataset group.
726 */
727 roleArn?: RoleArn;
728 /**
729 * The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.
730 */
731 kmsKeyArn?: KmsKeyArn;
732 /**
733 * The creation date and time (in Unix time) of the dataset group.
734 */
735 creationDateTime?: _Date;
736 /**
737 * The last update date and time (in Unix time) of the dataset group.
738 */
739 lastUpdatedDateTime?: _Date;
740 /**
741 * If creating a dataset group fails, provides the reason why.
742 */
743 failureReason?: FailureReason;
744 }
745 export interface DatasetGroupSummary {
746 /**
747 * The name of the dataset group.
748 */
749 name?: Name;
750 /**
751 * The Amazon Resource Name (ARN) of the dataset group.
752 */
753 datasetGroupArn?: Arn;
754 /**
755 * The status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING
756 */
757 status?: Status;
758 /**
759 * The date and time (in Unix time) that the dataset group was created.
760 */
761 creationDateTime?: _Date;
762 /**
763 * The date and time (in Unix time) that the dataset group was last updated.
764 */
765 lastUpdatedDateTime?: _Date;
766 /**
767 * If creating a dataset group fails, the reason behind the failure.
768 */
769 failureReason?: FailureReason;
770 }
771 export type DatasetGroups = DatasetGroupSummary[];
772 export interface DatasetImportJob {
773 /**
774 * The name of the import job.
775 */
776 jobName?: Name;
777 /**
778 * The ARN of the dataset import job.
779 */
780 datasetImportJobArn?: Arn;
781 /**
782 * The Amazon Resource Name (ARN) of the dataset that receives the imported data.
783 */
784 datasetArn?: Arn;
785 /**
786 * The Amazon S3 bucket that contains the training data to import.
787 */
788 dataSource?: DataSource;
789 /**
790 * The ARN of the AWS Identity and Access Management (IAM) role that has permissions to read from the Amazon S3 data source.
791 */
792 roleArn?: Arn;
793 /**
794 * The status of the dataset import job. A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
795 */
796 status?: Status;
797 /**
798 * The creation date and time (in Unix time) of the dataset import job.
799 */
800 creationDateTime?: _Date;
801 /**
802 * The date and time (in Unix time) the dataset was last updated.
803 */
804 lastUpdatedDateTime?: _Date;
805 /**
806 * If a dataset import job fails, provides the reason why.
807 */
808 failureReason?: FailureReason;
809 }
810 export interface DatasetImportJobSummary {
811 /**
812 * The Amazon Resource Name (ARN) of the dataset import job.
813 */
814 datasetImportJobArn?: Arn;
815 /**
816 * The name of the dataset import job.
817 */
818 jobName?: Name;
819 /**
820 * The status of the dataset import job. A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
821 */
822 status?: Status;
823 /**
824 * The date and time (in Unix time) that the dataset import job was created.
825 */
826 creationDateTime?: _Date;
827 /**
828 * The date and time (in Unix time) that the dataset was last updated.
829 */
830 lastUpdatedDateTime?: _Date;
831 /**
832 * If a dataset import job fails, the reason behind the failure.
833 */
834 failureReason?: FailureReason;
835 }
836 export type DatasetImportJobs = DatasetImportJobSummary[];
837 export interface DatasetSchema {
838 /**
839 * The name of the schema.
840 */
841 name?: Name;
842 /**
843 * The Amazon Resource Name (ARN) of the schema.
844 */
845 schemaArn?: Arn;
846 /**
847 * The schema.
848 */
849 schema?: AvroSchema;
850 /**
851 * The date and time (in Unix time) that the schema was created.
852 */
853 creationDateTime?: _Date;
854 /**
855 * The date and time (in Unix time) that the schema was last updated.
856 */
857 lastUpdatedDateTime?: _Date;
858 }
859 export interface DatasetSchemaSummary {
860 /**
861 * The name of the schema.
862 */
863 name?: Name;
864 /**
865 * The Amazon Resource Name (ARN) of the schema.
866 */
867 schemaArn?: Arn;
868 /**
869 * The date and time (in Unix time) that the schema was created.
870 */
871 creationDateTime?: _Date;
872 /**
873 * The date and time (in Unix time) that the schema was last updated.
874 */
875 lastUpdatedDateTime?: _Date;
876 }
877 export interface DatasetSummary {
878 /**
879 * The name of the dataset.
880 */
881 name?: Name;
882 /**
883 * The Amazon Resource Name (ARN) of the dataset.
884 */
885 datasetArn?: Arn;
886 /**
887 * The dataset type. One of the following values: Interactions Items Users Event-Interactions
888 */
889 datasetType?: DatasetType;
890 /**
891 * The status of the dataset. A dataset can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
892 */
893 status?: Status;
894 /**
895 * The date and time (in Unix time) that the dataset was created.
896 */
897 creationDateTime?: _Date;
898 /**
899 * The date and time (in Unix time) that the dataset was last updated.
900 */
901 lastUpdatedDateTime?: _Date;
902 }
903 export type DatasetType = string;
904 export type Datasets = DatasetSummary[];
905 export type _Date = Date;
906 export interface DefaultCategoricalHyperParameterRange {
907 /**
908 * The name of the hyperparameter.
909 */
910 name?: ParameterName;
911 /**
912 * A list of the categories for the hyperparameter.
913 */
914 values?: CategoricalValues;
915 /**
916 * Whether the hyperparameter is tunable.
917 */
918 isTunable?: Tunable;
919 }
920 export type DefaultCategoricalHyperParameterRanges = DefaultCategoricalHyperParameterRange[];
921 export interface DefaultContinuousHyperParameterRange {
922 /**
923 * The name of the hyperparameter.
924 */
925 name?: ParameterName;
926 /**
927 * The minimum allowable value for the hyperparameter.
928 */
929 minValue?: ContinuousMinValue;
930 /**
931 * The maximum allowable value for the hyperparameter.
932 */
933 maxValue?: ContinuousMaxValue;
934 /**
935 * Whether the hyperparameter is tunable.
936 */
937 isTunable?: Tunable;
938 }
939 export type DefaultContinuousHyperParameterRanges = DefaultContinuousHyperParameterRange[];
940 export interface DefaultHyperParameterRanges {
941 /**
942 * The integer-valued hyperparameters and their default ranges.
943 */
944 integerHyperParameterRanges?: DefaultIntegerHyperParameterRanges;
945 /**
946 * The continuous hyperparameters and their default ranges.
947 */
948 continuousHyperParameterRanges?: DefaultContinuousHyperParameterRanges;
949 /**
950 * The categorical hyperparameters and their default ranges.
951 */
952 categoricalHyperParameterRanges?: DefaultCategoricalHyperParameterRanges;
953 }
954 export interface DefaultIntegerHyperParameterRange {
955 /**
956 * The name of the hyperparameter.
957 */
958 name?: ParameterName;
959 /**
960 * The minimum allowable value for the hyperparameter.
961 */
962 minValue?: IntegerMinValue;
963 /**
964 * The maximum allowable value for the hyperparameter.
965 */
966 maxValue?: IntegerMaxValue;
967 /**
968 * Indicates whether the hyperparameter is tunable.
969 */
970 isTunable?: Tunable;
971 }
972 export type DefaultIntegerHyperParameterRanges = DefaultIntegerHyperParameterRange[];
973 export interface DeleteCampaignRequest {
974 /**
975 * The Amazon Resource Name (ARN) of the campaign to delete.
976 */
977 campaignArn: Arn;
978 }
979 export interface DeleteDatasetGroupRequest {
980 /**
981 * The ARN of the dataset group to delete.
982 */
983 datasetGroupArn: Arn;
984 }
985 export interface DeleteDatasetRequest {
986 /**
987 * The Amazon Resource Name (ARN) of the dataset to delete.
988 */
989 datasetArn: Arn;
990 }
991 export interface DeleteEventTrackerRequest {
992 /**
993 * The Amazon Resource Name (ARN) of the event tracker to delete.
994 */
995 eventTrackerArn: Arn;
996 }
997 export interface DeleteSchemaRequest {
998 /**
999 * The Amazon Resource Name (ARN) of the schema to delete.
1000 */
1001 schemaArn: Arn;
1002 }
1003 export interface DeleteSolutionRequest {
1004 /**
1005 * The ARN of the solution to delete.
1006 */
1007 solutionArn: Arn;
1008 }
1009 export interface DescribeAlgorithmRequest {
1010 /**
1011 * The Amazon Resource Name (ARN) of the algorithm to describe.
1012 */
1013 algorithmArn: Arn;
1014 }
1015 export interface DescribeAlgorithmResponse {
1016 /**
1017 * A listing of the properties of the algorithm.
1018 */
1019 algorithm?: Algorithm;
1020 }
1021 export interface DescribeCampaignRequest {
1022 /**
1023 * The Amazon Resource Name (ARN) of the campaign.
1024 */
1025 campaignArn: Arn;
1026 }
1027 export interface DescribeCampaignResponse {
1028 /**
1029 * The properties of the campaign.
1030 */
1031 campaign?: Campaign;
1032 }
1033 export interface DescribeDatasetGroupRequest {
1034 /**
1035 * The Amazon Resource Name (ARN) of the dataset group to describe.
1036 */
1037 datasetGroupArn: Arn;
1038 }
1039 export interface DescribeDatasetGroupResponse {
1040 /**
1041 * A listing of the dataset group's properties.
1042 */
1043 datasetGroup?: DatasetGroup;
1044 }
1045 export interface DescribeDatasetImportJobRequest {
1046 /**
1047 * The Amazon Resource Name (ARN) of the dataset import job to describe.
1048 */
1049 datasetImportJobArn: Arn;
1050 }
1051 export interface DescribeDatasetImportJobResponse {
1052 /**
1053 * Information about the dataset import job, including the status. The status is one of the following values: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED
1054 */
1055 datasetImportJob?: DatasetImportJob;
1056 }
1057 export interface DescribeDatasetRequest {
1058 /**
1059 * The Amazon Resource Name (ARN) of the dataset to describe.
1060 */
1061 datasetArn: Arn;
1062 }
1063 export interface DescribeDatasetResponse {
1064 /**
1065 * A listing of the dataset's properties.
1066 */
1067 dataset?: Dataset;
1068 }
1069 export interface DescribeEventTrackerRequest {
1070 /**
1071 * The Amazon Resource Name (ARN) of the event tracker to describe.
1072 */
1073 eventTrackerArn: Arn;
1074 }
1075 export interface DescribeEventTrackerResponse {
1076 /**
1077 * An object that describes the event tracker.
1078 */
1079 eventTracker?: EventTracker;
1080 }
1081 export interface DescribeFeatureTransformationRequest {
1082 /**
1083 * The Amazon Resource Name (ARN) of the feature transformation to describe.
1084 */
1085 featureTransformationArn: Arn;
1086 }
1087 export interface DescribeFeatureTransformationResponse {
1088 /**
1089 * A listing of the FeatureTransformation properties.
1090 */
1091 featureTransformation?: FeatureTransformation;
1092 }
1093 export interface DescribeRecipeRequest {
1094 /**
1095 * The Amazon Resource Name (ARN) of the recipe to describe.
1096 */
1097 recipeArn: Arn;
1098 }
1099 export interface DescribeRecipeResponse {
1100 /**
1101 * An object that describes the recipe.
1102 */
1103 recipe?: Recipe;
1104 }
1105 export interface DescribeSchemaRequest {
1106 /**
1107 * The Amazon Resource Name (ARN) of the schema to retrieve.
1108 */
1109 schemaArn: Arn;
1110 }
1111 export interface DescribeSchemaResponse {
1112 /**
1113 * The requested schema.
1114 */
1115 schema?: DatasetSchema;
1116 }
1117 export interface DescribeSolutionRequest {
1118 /**
1119 * The Amazon Resource Name (ARN) of the solution to describe.
1120 */
1121 solutionArn: Arn;
1122 }
1123 export interface DescribeSolutionResponse {
1124 /**
1125 * An object that describes the solution.
1126 */
1127 solution?: Solution;
1128 }
1129 export interface DescribeSolutionVersionRequest {
1130 /**
1131 * The Amazon Resource Name (ARN) of the solution version.
1132 */
1133 solutionVersionArn: Arn;
1134 }
1135 export interface DescribeSolutionVersionResponse {
1136 /**
1137 * The solution version.
1138 */
1139 solutionVersion?: SolutionVersion;
1140 }
1141 export type Description = string;
1142 export type DockerURI = string;
1143 export interface EventTracker {
1144 /**
1145 * The name of the event tracker.
1146 */
1147 name?: Name;
1148 /**
1149 * The ARN of the event tracker.
1150 */
1151 eventTrackerArn?: Arn;
1152 /**
1153 * The Amazon AWS account that owns the event tracker.
1154 */
1155 accountId?: AccountId;
1156 /**
1157 * The ID of the event tracker. Include this ID in requests to the PutEvents API.
1158 */
1159 trackingId?: TrackingId;
1160 /**
1161 * The Amazon Resource Name (ARN) of the dataset group that receives the event data.
1162 */
1163 datasetGroupArn?: Arn;
1164 /**
1165 * The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
1166 */
1167 status?: Status;
1168 /**
1169 * The date and time (in Unix format) that the event tracker was created.
1170 */
1171 creationDateTime?: _Date;
1172 /**
1173 * The date and time (in Unix time) that the event tracker was last updated.
1174 */
1175 lastUpdatedDateTime?: _Date;
1176 }
1177 export interface EventTrackerSummary {
1178 /**
1179 * The name of the event tracker.
1180 */
1181 name?: Name;
1182 /**
1183 * The Amazon Resource Name (ARN) of the event tracker.
1184 */
1185 eventTrackerArn?: Arn;
1186 /**
1187 * The status of the event tracker. An event tracker can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
1188 */
1189 status?: Status;
1190 /**
1191 * The date and time (in Unix time) that the event tracker was created.
1192 */
1193 creationDateTime?: _Date;
1194 /**
1195 * The date and time (in Unix time) that the event tracker was last updated.
1196 */
1197 lastUpdatedDateTime?: _Date;
1198 }
1199 export type EventTrackers = EventTrackerSummary[];
1200 export type EventType = string;
1201 export type EventValueThreshold = string;
1202 export type FailureReason = string;
1203 export interface FeatureTransformation {
1204 /**
1205 * The name of the feature transformation.
1206 */
1207 name?: Name;
1208 /**
1209 * The Amazon Resource Name (ARN) of the FeatureTransformation object.
1210 */
1211 featureTransformationArn?: Arn;
1212 /**
1213 * Provides the default parameters for feature transformation.
1214 */
1215 defaultParameters?: FeaturizationParameters;
1216 /**
1217 * The creation date and time (in Unix time) of the feature transformation.
1218 */
1219 creationDateTime?: _Date;
1220 /**
1221 * The last update date and time (in Unix time) of the feature transformation.
1222 */
1223 lastUpdatedDateTime?: _Date;
1224 /**
1225 * The status of the feature transformation. A feature transformation can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
1226 */
1227 status?: Status;
1228 }
1229 export type FeatureTransformationParameters = {[key: string]: ParameterValue};
1230 export type FeaturizationParameters = {[key: string]: ParameterValue};
1231 export interface GetSolutionMetricsRequest {
1232 /**
1233 * The Amazon Resource Name (ARN) of the solution version for which to get metrics.
1234 */
1235 solutionVersionArn: Arn;
1236 }
1237 export interface GetSolutionMetricsResponse {
1238 /**
1239 * The same solution version ARN as specified in the request.
1240 */
1241 solutionVersionArn?: Arn;
1242 /**
1243 * The metrics for the solution version.
1244 */
1245 metrics?: Metrics;
1246 }
1247 export interface HPOConfig {
1248 /**
1249 * The metric to optimize during HPO.
1250 */
1251 hpoObjective?: HPOObjective;
1252 /**
1253 * Describes the resource configuration for HPO.
1254 */
1255 hpoResourceConfig?: HPOResourceConfig;
1256 /**
1257 * The hyperparameters and their allowable ranges.
1258 */
1259 algorithmHyperParameterRanges?: HyperParameterRanges;
1260 }
1261 export interface HPOObjective {
1262 /**
1263 * The data type of the metric.
1264 */
1265 type?: HPOObjectiveType;
1266 /**
1267 * The name of the metric.
1268 */
1269 metricName?: MetricName;
1270 /**
1271 * A regular expression for finding the metric in the training job logs.
1272 */
1273 metricRegex?: MetricRegex;
1274 }
1275 export type HPOObjectiveType = string;
1276 export type HPOResource = string;
1277 export interface HPOResourceConfig {
1278 /**
1279 * The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.
1280 */
1281 maxNumberOfTrainingJobs?: HPOResource;
1282 /**
1283 * The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.
1284 */
1285 maxParallelTrainingJobs?: HPOResource;
1286 }
1287 export interface HyperParameterRanges {
1288 /**
1289 * The integer-valued hyperparameters and their ranges.
1290 */
1291 integerHyperParameterRanges?: IntegerHyperParameterRanges;
1292 /**
1293 * The continuous hyperparameters and their ranges.
1294 */
1295 continuousHyperParameterRanges?: ContinuousHyperParameterRanges;
1296 /**
1297 * The categorical hyperparameters and their ranges.
1298 */
1299 categoricalHyperParameterRanges?: CategoricalHyperParameterRanges;
1300 }
1301 export type HyperParameters = {[key: string]: ParameterValue};
1302 export interface IntegerHyperParameterRange {
1303 /**
1304 * The name of the hyperparameter.
1305 */
1306 name?: ParameterName;
1307 /**
1308 * The minimum allowable value for the hyperparameter.
1309 */
1310 minValue?: IntegerMinValue;
1311 /**
1312 * The maximum allowable value for the hyperparameter.
1313 */
1314 maxValue?: IntegerMaxValue;
1315 }
1316 export type IntegerHyperParameterRanges = IntegerHyperParameterRange[];
1317 export type IntegerMaxValue = number;
1318 export type IntegerMinValue = number;
1319 export type KmsKeyArn = string;
1320 export interface ListCampaignsRequest {
1321 /**
1322 * The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.
1323 */
1324 solutionArn?: Arn;
1325 /**
1326 * A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
1327 */
1328 nextToken?: NextToken;
1329 /**
1330 * The maximum number of campaigns to return.
1331 */
1332 maxResults?: MaxResults;
1333 }
1334 export interface ListCampaignsResponse {
1335 /**
1336 * A list of the campaigns.
1337 */
1338 campaigns?: Campaigns;
1339 /**
1340 * A token for getting the next set of campaigns (if they exist).
1341 */
1342 nextToken?: NextToken;
1343 }
1344 export interface ListDatasetGroupsRequest {
1345 /**
1346 * A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).
1347 */
1348 nextToken?: NextToken;
1349 /**
1350 * The maximum number of dataset groups to return.
1351 */
1352 maxResults?: MaxResults;
1353 }
1354 export interface ListDatasetGroupsResponse {
1355 /**
1356 * The list of your dataset groups.
1357 */
1358 datasetGroups?: DatasetGroups;
1359 /**
1360 * A token for getting the next set of dataset groups (if they exist).
1361 */
1362 nextToken?: NextToken;
1363 }
1364 export interface ListDatasetImportJobsRequest {
1365 /**
1366 * The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.
1367 */
1368 datasetArn?: Arn;
1369 /**
1370 * A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).
1371 */
1372 nextToken?: NextToken;
1373 /**
1374 * The maximum number of dataset import jobs to return.
1375 */
1376 maxResults?: MaxResults;
1377 }
1378 export interface ListDatasetImportJobsResponse {
1379 /**
1380 * The list of dataset import jobs.
1381 */
1382 datasetImportJobs?: DatasetImportJobs;
1383 /**
1384 * A token for getting the next set of dataset import jobs (if they exist).
1385 */
1386 nextToken?: NextToken;
1387 }
1388 export interface ListDatasetsRequest {
1389 /**
1390 * The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
1391 */
1392 datasetGroupArn?: Arn;
1393 /**
1394 * A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).
1395 */
1396 nextToken?: NextToken;
1397 /**
1398 * The maximum number of datasets to return.
1399 */
1400 maxResults?: MaxResults;
1401 }
1402 export interface ListDatasetsResponse {
1403 /**
1404 * An array of Dataset objects. Each object provides metadata information.
1405 */
1406 datasets?: Datasets;
1407 /**
1408 * A token for getting the next set of datasets (if they exist).
1409 */
1410 nextToken?: NextToken;
1411 }
1412 export interface ListEventTrackersRequest {
1413 /**
1414 * The ARN of a dataset group used to filter the response.
1415 */
1416 datasetGroupArn?: Arn;
1417 /**
1418 * A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).
1419 */
1420 nextToken?: NextToken;
1421 /**
1422 * The maximum number of event trackers to return.
1423 */
1424 maxResults?: MaxResults;
1425 }
1426 export interface ListEventTrackersResponse {
1427 /**
1428 * A list of event trackers.
1429 */
1430 eventTrackers?: EventTrackers;
1431 /**
1432 * A token for getting the next set of event trackers (if they exist).
1433 */
1434 nextToken?: NextToken;
1435 }
1436 export interface ListRecipesRequest {
1437 /**
1438 * The default is SERVICE.
1439 */
1440 recipeProvider?: RecipeProvider;
1441 /**
1442 * A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
1443 */
1444 nextToken?: NextToken;
1445 /**
1446 * The maximum number of recipes to return.
1447 */
1448 maxResults?: MaxResults;
1449 }
1450 export interface ListRecipesResponse {
1451 /**
1452 * The list of available recipes.
1453 */
1454 recipes?: Recipes;
1455 /**
1456 * A token for getting the next set of recipes.
1457 */
1458 nextToken?: NextToken;
1459 }
1460 export interface ListSchemasRequest {
1461 /**
1462 * A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).
1463 */
1464 nextToken?: NextToken;
1465 /**
1466 * The maximum number of schemas to return.
1467 */
1468 maxResults?: MaxResults;
1469 }
1470 export interface ListSchemasResponse {
1471 /**
1472 * A list of schemas.
1473 */
1474 schemas?: Schemas;
1475 /**
1476 * A token used to get the next set of schemas (if they exist).
1477 */
1478 nextToken?: NextToken;
1479 }
1480 export interface ListSolutionVersionsRequest {
1481 /**
1482 * The Amazon Resource Name (ARN) of the solution.
1483 */
1484 solutionArn?: Arn;
1485 /**
1486 * A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).
1487 */
1488 nextToken?: NextToken;
1489 /**
1490 * The maximum number of solution versions to return.
1491 */
1492 maxResults?: MaxResults;
1493 }
1494 export interface ListSolutionVersionsResponse {
1495 /**
1496 * A list of solution versions describing the version properties.
1497 */
1498 solutionVersions?: SolutionVersions;
1499 /**
1500 * A token for getting the next set of solution versions (if they exist).
1501 */
1502 nextToken?: NextToken;
1503 }
1504 export interface ListSolutionsRequest {
1505 /**
1506 * The Amazon Resource Name (ARN) of the dataset group.
1507 */
1508 datasetGroupArn?: Arn;
1509 /**
1510 * A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).
1511 */
1512 nextToken?: NextToken;
1513 /**
1514 * The maximum number of solutions to return.
1515 */
1516 maxResults?: MaxResults;
1517 }
1518 export interface ListSolutionsResponse {
1519 /**
1520 * A list of the current solutions.
1521 */
1522 solutions?: Solutions;
1523 /**
1524 * A token for getting the next set of solutions (if they exist).
1525 */
1526 nextToken?: NextToken;
1527 }
1528 export type MaxResults = number;
1529 export type MetricName = string;
1530 export type MetricRegex = string;
1531 export type MetricValue = number;
1532 export type Metrics = {[key: string]: MetricValue};
1533 export type Name = string;
1534 export type NextToken = string;
1535 export type ParameterName = string;
1536 export type ParameterValue = string;
1537 export type PerformAutoML = boolean;
1538 export type PerformHPO = boolean;
1539 export interface Recipe {
1540 /**
1541 * The name of the recipe.
1542 */
1543 name?: Name;
1544 /**
1545 * The Amazon Resource Name (ARN) of the recipe.
1546 */
1547 recipeArn?: Arn;
1548 /**
1549 * The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
1550 */
1551 algorithmArn?: Arn;
1552 /**
1553 * The ARN of the FeatureTransformation object.
1554 */
1555 featureTransformationArn?: Arn;
1556 /**
1557 * The status of the recipe.
1558 */
1559 status?: Status;
1560 /**
1561 * The description of the recipe.
1562 */
1563 description?: Description;
1564 /**
1565 * The date and time (in Unix format) that the recipe was created.
1566 */
1567 creationDateTime?: _Date;
1568 /**
1569 * One of the following values: PERSONALIZED_RANKING RELATED_ITEMS USER_PERSONALIZATION
1570 */
1571 recipeType?: RecipeType;
1572 /**
1573 * The date and time (in Unix format) that the recipe was last updated.
1574 */
1575 lastUpdatedDateTime?: _Date;
1576 }
1577 export type RecipeProvider = "SERVICE"|string;
1578 export interface RecipeSummary {
1579 /**
1580 * The name of the recipe.
1581 */
1582 name?: Name;
1583 /**
1584 * The Amazon Resource Name (ARN) of the recipe.
1585 */
1586 recipeArn?: Arn;
1587 /**
1588 * The status of the recipe.
1589 */
1590 status?: Status;
1591 /**
1592 * The date and time (in Unix time) that the recipe was created.
1593 */
1594 creationDateTime?: _Date;
1595 /**
1596 * The date and time (in Unix time) that the recipe was last updated.
1597 */
1598 lastUpdatedDateTime?: _Date;
1599 }
1600 export type RecipeType = string;
1601 export type Recipes = RecipeSummary[];
1602 export type ResourceConfig = {[key: string]: ParameterValue};
1603 export type RoleArn = string;
1604 export type S3Location = string;
1605 export type Schemas = DatasetSchemaSummary[];
1606 export interface Solution {
1607 /**
1608 * The name of the solution.
1609 */
1610 name?: Name;
1611 /**
1612 * The ARN of the solution.
1613 */
1614 solutionArn?: Arn;
1615 /**
1616 * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
1617 */
1618 performHPO?: PerformHPO;
1619 /**
1620 * When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.
1621 */
1622 performAutoML?: PerformAutoML;
1623 /**
1624 * The ARN of the recipe used to create the solution.
1625 */
1626 recipeArn?: Arn;
1627 /**
1628 * The Amazon Resource Name (ARN) of the dataset group that provides the training data.
1629 */
1630 datasetGroupArn?: Arn;
1631 /**
1632 * The event type (for example, 'click' or 'like') that is used for training the model.
1633 */
1634 eventType?: EventType;
1635 /**
1636 * Describes the configuration properties for the solution.
1637 */
1638 solutionConfig?: SolutionConfig;
1639 /**
1640 * When performAutoML is true, specifies the best recipe found.
1641 */
1642 autoMLResult?: AutoMLResult;
1643 /**
1644 * The status of the solution. A solution can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
1645 */
1646 status?: Status;
1647 /**
1648 * The creation date and time (in Unix time) of the solution.
1649 */
1650 creationDateTime?: _Date;
1651 /**
1652 * The date and time (in Unix time) that the solution was last updated.
1653 */
1654 lastUpdatedDateTime?: _Date;
1655 /**
1656 * Describes the latest version of the solution, including the status and the ARN.
1657 */
1658 latestSolutionVersion?: SolutionVersionSummary;
1659 }
1660 export interface SolutionConfig {
1661 /**
1662 * Only events with a value greater than or equal to this threshold are used for training a model.
1663 */
1664 eventValueThreshold?: EventValueThreshold;
1665 /**
1666 * Describes the properties for hyperparameter optimization (HPO). For use with the bring-your-own-recipe feature. Not used with Amazon Personalize predefined recipes.
1667 */
1668 hpoConfig?: HPOConfig;
1669 /**
1670 * Lists the hyperparameter names and ranges.
1671 */
1672 algorithmHyperParameters?: HyperParameters;
1673 /**
1674 * Lists the feature transformation parameters.
1675 */
1676 featureTransformationParameters?: FeatureTransformationParameters;
1677 /**
1678 * The AutoMLConfig object containing a list of recipes to search when AutoML is performed.
1679 */
1680 autoMLConfig?: AutoMLConfig;
1681 }
1682 export interface SolutionSummary {
1683 /**
1684 * The name of the solution.
1685 */
1686 name?: Name;
1687 /**
1688 * The Amazon Resource Name (ARN) of the solution.
1689 */
1690 solutionArn?: Arn;
1691 /**
1692 * The status of the solution. A solution can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING &gt; DELETE IN_PROGRESS
1693 */
1694 status?: Status;
1695 /**
1696 * The date and time (in Unix time) that the solution was created.
1697 */
1698 creationDateTime?: _Date;
1699 /**
1700 * The date and time (in Unix time) that the solution was last updated.
1701 */
1702 lastUpdatedDateTime?: _Date;
1703 }
1704 export interface SolutionVersion {
1705 /**
1706 * The ARN of the solution version.
1707 */
1708 solutionVersionArn?: Arn;
1709 /**
1710 * The ARN of the solution.
1711 */
1712 solutionArn?: Arn;
1713 /**
1714 * Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
1715 */
1716 performHPO?: PerformHPO;
1717 /**
1718 * When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.
1719 */
1720 performAutoML?: PerformAutoML;
1721 /**
1722 * The ARN of the recipe used in the solution.
1723 */
1724 recipeArn?: Arn;
1725 /**
1726 * The event type (for example, 'click' or 'like') that is used for training the model.
1727 */
1728 eventType?: EventType;
1729 /**
1730 * The Amazon Resource Name (ARN) of the dataset group providing the training data.
1731 */
1732 datasetGroupArn?: Arn;
1733 /**
1734 * Describes the configuration properties for the solution.
1735 */
1736 solutionConfig?: SolutionConfig;
1737 /**
1738 * The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
1739 */
1740 trainingHours?: TrainingHours;
1741 /**
1742 * The scope of training used to create the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the training data that has changed since the creation of the last solution version. Choose UPDATE when you want to start recommending items added to the dataset without retraining the model. The UPDATE option can only be used after you've created a solution version with the FULL option and the training solution uses the native-recipe-hrnn-coldstart.
1743 */
1744 trainingMode?: TrainingMode;
1745 /**
1746 * The status of the solution version. A solution version can be in one of the following states: CREATE PENDING CREATE IN_PROGRESS ACTIVE CREATE FAILED
1747 */
1748 status?: Status;
1749 /**
1750 * If training a solution version fails, the reason for the failure.
1751 */
1752 failureReason?: FailureReason;
1753 /**
1754 * The date and time (in Unix time) that this version of the solution was created.
1755 */
1756 creationDateTime?: _Date;
1757 /**
1758 * The date and time (in Unix time) that the solution was last updated.
1759 */
1760 lastUpdatedDateTime?: _Date;
1761 }
1762 export interface SolutionVersionSummary {
1763 /**
1764 * The Amazon Resource Name (ARN) of the solution version.
1765 */
1766 solutionVersionArn?: Arn;
1767 /**
1768 * The status of the solution version. A solution version can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED
1769 */
1770 status?: Status;
1771 /**
1772 * The date and time (in Unix time) that this version of a solution was created.
1773 */
1774 creationDateTime?: _Date;
1775 /**
1776 * The date and time (in Unix time) that the solution version was last updated.
1777 */
1778 lastUpdatedDateTime?: _Date;
1779 /**
1780 * If a solution version fails, the reason behind the failure.
1781 */
1782 failureReason?: FailureReason;
1783 }
1784 export type SolutionVersions = SolutionVersionSummary[];
1785 export type Solutions = SolutionSummary[];
1786 export type Status = string;
1787 export type TrackingId = string;
1788 export type TrainingHours = number;
1789 export type TrainingInputMode = string;
1790 export type TrainingMode = "FULL"|"UPDATE"|string;
1791 export type TransactionsPerSecond = number;
1792 export type Tunable = boolean;
1793 export interface UpdateCampaignRequest {
1794 /**
1795 * The Amazon Resource Name (ARN) of the campaign.
1796 */
1797 campaignArn: Arn;
1798 /**
1799 * The ARN of a new solution version to deploy.
1800 */
1801 solutionVersionArn?: Arn;
1802 /**
1803 * Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
1804 */
1805 minProvisionedTPS?: TransactionsPerSecond;
1806 }
1807 export interface UpdateCampaignResponse {
1808 /**
1809 * The same campaign ARN as given in the request.
1810 */
1811 campaignArn?: Arn;
1812 }
1813 /**
1814 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1815 */
1816 export type apiVersion = "2018-05-22"|"latest"|string;
1817 export interface ClientApiVersions {
1818 /**
1819 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1820 */
1821 apiVersion?: apiVersion;
1822 }
1823 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1824 /**
1825 * Contains interfaces for use with the Personalize client.
1826 */
1827 export import Types = Personalize;
1828}
1829export = Personalize;