Amazon Personalize 2018-05-22
- Client: Aws\Personalize\PersonalizeClient
- Service ID: personalize
- Version: 2018-05-22
This page describes the parameters and results for the operations of the Amazon Personalize (2018-05-22), and shows how to use the Aws\Personalize\PersonalizeClient object to call the described operations. This documentation is specific to the 2018-05-22 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateBatchInferenceJob ( array $params = [] )
Creates a batch inference job.
- CreateBatchSegmentJob ( array $params = [] )
Creates a batch segment job.
- CreateCampaign ( array $params = [] )
Creates a campaign that deploys a solution version.
- CreateDataset ( array $params = [] )
Creates an empty dataset and adds it to the specified dataset group.
- CreateDatasetExportJob ( array $params = [] )
Creates a job that exports data from your dataset to an Amazon S3 bucket.
- CreateDatasetGroup ( array $params = [] )
Creates an empty dataset group.
- CreateDatasetImportJob ( array $params = [] )
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset.
- CreateEventTracker ( array $params = [] )
Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
- CreateFilter ( array $params = [] )
Creates a recommendation filter.
- CreateRecommender ( array $params = [] )
Creates a recommender with the recipe (a Domain dataset group use case) you specify.
- CreateSchema ( array $params = [] )
Creates an Amazon Personalize schema from the specified schema string.
- CreateSolution ( array $params = [] )
Creates the configuration for training a model.
- CreateSolutionVersion ( array $params = [] )
Trains or retrains an active solution in a Custom dataset group.
- DeleteCampaign ( array $params = [] )
Removes a campaign by deleting the solution deployment.
- DeleteDataset ( array $params = [] )
Deletes a dataset.
- DeleteDatasetGroup ( array $params = [] )
Deletes a dataset group.
- DeleteEventTracker ( array $params = [] )
Deletes the event tracker.
- DeleteFilter ( array $params = [] )
Deletes a filter.
- DeleteRecommender ( array $params = [] )
Deactivates and removes a recommender.
- DeleteSchema ( array $params = [] )
Deletes a schema.
- DeleteSolution ( array $params = [] )
Deletes all versions of a solution and the Solution object itself.
- DescribeAlgorithm ( array $params = [] )
Describes the given algorithm.
- DescribeBatchInferenceJob ( array $params = [] )
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
- DescribeBatchSegmentJob ( array $params = [] )
Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
- DescribeCampaign ( array $params = [] )
Describes the given campaign, including its status.
- DescribeDataset ( array $params = [] )
Describes the given dataset.
- DescribeDatasetExportJob ( array $params = [] )
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
- DescribeDatasetGroup ( array $params = [] )
Describes the given dataset group.
- DescribeDatasetImportJob ( array $params = [] )
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
- DescribeEventTracker ( array $params = [] )
Describes an event tracker.
- DescribeFeatureTransformation ( array $params = [] )
Describes the given feature transformation.
- DescribeFilter ( array $params = [] )
Describes a filter's properties.
- DescribeRecipe ( array $params = [] )
Describes a recipe.
- DescribeRecommender ( array $params = [] )
Describes the given recommender, including its status.
- DescribeSchema ( array $params = [] )
Describes a schema.
- DescribeSolution ( array $params = [] )
Describes a solution.
- DescribeSolutionVersion ( array $params = [] )
Describes a specific version of a solution.
- GetSolutionMetrics ( array $params = [] )
Gets the metrics for the specified solution version.
- ListBatchInferenceJobs ( array $params = [] )
Gets a list of the batch inference jobs that have been performed off of a solution version.
- ListBatchSegmentJobs ( array $params = [] )
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
- ListCampaigns ( array $params = [] )
Returns a list of campaigns that use the given solution.
- ListDatasetExportJobs ( array $params = [] )
Returns a list of dataset export jobs that use the given dataset.
- ListDatasetGroups ( array $params = [] )
Returns a list of dataset groups.
- ListDatasetImportJobs ( array $params = [] )
Returns a list of dataset import jobs that use the given dataset.
- ListDatasets ( array $params = [] )
Returns the list of datasets contained in the given dataset group.
- ListEventTrackers ( array $params = [] )
Returns the list of event trackers associated with the account.
- ListFilters ( array $params = [] )
Lists all filters that belong to a given dataset group.
- ListRecipes ( array $params = [] )
Returns a list of available recipes.
- ListRecommenders ( array $params = [] )
Returns a list of recommenders in a given Domain dataset group.
- ListSchemas ( array $params = [] )
Returns the list of schemas associated with the account.
- ListSolutionVersions ( array $params = [] )
Returns a list of solution versions for the given solution.
- ListSolutions ( array $params = [] )
Returns a list of solutions that use the given dataset group.
- ListTagsForResource ( array $params = [] )
Get a list of tags attached to a resource.
- StartRecommender ( array $params = [] )
Starts a recommender that is INACTIVE.
- StopRecommender ( array $params = [] )
Stops a recommender that is ACTIVE.
- StopSolutionVersionCreation ( array $params = [] )
Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
- TagResource ( array $params = [] )
Add a list of tags to a resource.
- UntagResource ( array $params = [] )
Remove tags that are attached to a resource.
- UpdateCampaign ( array $params = [] )
Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.
- UpdateRecommender ( array $params = [] )
Updates the recommender to modify the recommender configuration.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateBatchInferenceJob
$result = $client->createBatchInferenceJob([/* ... */]); $promise = $client->createBatchInferenceJobAsync([/* ... */]);
Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Creating a batch inference job.
Parameter Syntax
$result = $client->createBatchInferenceJob([
'batchInferenceJobConfig' => [
'itemExplorationConfig' => ['<string>', ...],
],
'filterArn' => '<string>',
'jobInput' => [ // REQUIRED
's3DataSource' => [ // REQUIRED
'kmsKeyArn' => '<string>',
'path' => '<string>', // REQUIRED
],
],
'jobName' => '<string>', // REQUIRED
'jobOutput' => [ // REQUIRED
's3DataDestination' => [ // REQUIRED
'kmsKeyArn' => '<string>',
'path' => '<string>', // REQUIRED
],
],
'numResults' => <integer>,
'roleArn' => '<string>', // REQUIRED
'solutionVersionArn' => '<string>', // REQUIRED
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- batchInferenceJobConfig
-
- Type: BatchInferenceJobConfig structure
The configuration details of a batch inference job.
- filterArn
-
- Type: string
The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
- jobInput
-
- Required: Yes
- Type: BatchInferenceJobInput structure
The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
- jobName
-
- Required: Yes
- Type: string
The name of the batch inference job to create.
- jobOutput
-
- Required: Yes
- Type: BatchInferenceJobOutput structure
The path to the Amazon S3 bucket where the job's output will be stored.
- numResults
-
- Type: int
The number of recommendations to retrieve.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
- solutionVersionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the batch inference job.
Result Syntax
[
'batchInferenceJobArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The limit on the number of requests per second has been exceeded.
-
Could not find the specified resource.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateBatchSegmentJob
$result = $client->createBatchSegmentJob([/* ... */]); $promise = $client->createBatchSegmentJobAsync([/* ... */]);
Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.
Parameter Syntax
$result = $client->createBatchSegmentJob([
'filterArn' => '<string>',
'jobInput' => [ // REQUIRED
's3DataSource' => [ // REQUIRED
'kmsKeyArn' => '<string>',
'path' => '<string>', // REQUIRED
],
],
'jobName' => '<string>', // REQUIRED
'jobOutput' => [ // REQUIRED
's3DataDestination' => [ // REQUIRED
'kmsKeyArn' => '<string>',
'path' => '<string>', // REQUIRED
],
],
'numResults' => <integer>,
'roleArn' => '<string>', // REQUIRED
'solutionVersionArn' => '<string>', // REQUIRED
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- filterArn
-
- Type: string
The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.
- jobInput
-
- Required: Yes
- Type: BatchSegmentJobInput structure
The Amazon S3 path for the input data used to generate the batch segment job.
- jobName
-
- Required: Yes
- Type: string
The name of the batch segment job to create.
- jobOutput
-
- Required: Yes
- Type: BatchSegmentJobOutput structure
The Amazon S3 path for the bucket where the job's output will be stored.
- numResults
-
- Type: int
The number of predicted users generated by the batch segment job for each line of input data.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
- solutionVersionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the batch segment job.
Result Syntax
[
'batchSegmentJobArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The limit on the number of requests per second has been exceeded.
-
Could not find the specified resource.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateCampaign
$result = $client->createCampaign([/* ... */]); $promise = $client->createCampaignAsync([/* ... */]);
Creates a campaign that deploys 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. There's a short time delay while the capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting 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
Parameter Syntax
$result = $client->createCampaign([
'campaignConfig' => [
'itemExplorationConfig' => ['<string>', ...],
],
'minProvisionedTPS' => <integer>,
'name' => '<string>', // REQUIRED
'solutionVersionArn' => '<string>', // REQUIRED
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- campaignConfig
-
- Type: CampaignConfig structure
The configuration details of a campaign.
- minProvisionedTPS
-
- Type: int
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
- name
-
- Required: Yes
- Type: string
A name for the new campaign. The campaign name must be unique within your account.
- solutionVersionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the solution version to deploy.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the campaign.
Result Syntax
[
'campaignArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The limit on the number of requests per second has been exceeded.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateDataset
$result = $client->createDataset([/* ... */]); $promise = $client->createDatasetAsync([/* ... */]);
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 > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the dataset, call DescribeDataset.
Related APIs
Parameter Syntax
$result = $client->createDataset([
'datasetGroupArn' => '<string>', // REQUIRED
'datasetType' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'schemaArn' => '<string>', // REQUIRED
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- datasetGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
- datasetType
-
- Required: Yes
- Type: string
The type of dataset.
One of the following (case insensitive) values:
-
Interactions
-
Items
-
Users
- name
-
- Required: Yes
- Type: string
The name for the dataset.
- schemaArn
-
- Required: Yes
- Type: string
The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the dataset.
Result Syntax
[
'datasetArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The limit on the number of requests per second has been exceeded.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateDatasetExportJob
$result = $client->createDatasetExportJob([/* ... */]); $promise = $client->createDatasetExportJobAsync([/* ... */]);
Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.
Status
A dataset export job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export 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.
Parameter Syntax
$result = $client->createDatasetExportJob([
'datasetArn' => '<string>', // REQUIRED
'ingestionMode' => 'BULK|PUT|ALL',
'jobName' => '<string>', // REQUIRED
'jobOutput' => [ // REQUIRED
's3DataDestination' => [ // REQUIRED
'kmsKeyArn' => '<string>',
'path' => '<string>', // REQUIRED
],
],
'roleArn' => '<string>', // REQUIRED
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- datasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the dataset that contains the data to export.
- ingestionMode
-
- Type: string
The data to export, based on how you imported the data. You can choose to export only
BULKdata that you imported using a dataset import job, onlyPUTdata that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), orALLfor both types. The default value isPUT. - jobName
-
- Required: Yes
- Type: string
The name for the dataset export job.
- jobOutput
-
- Required: Yes
- Type: DatasetExportJobOutput structure
The path to the Amazon S3 bucket where the job's output is stored.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the dataset export job.
Result Syntax
[
'datasetExportJobArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The limit on the number of requests per second has been exceeded.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateDatasetGroup
$result = $client->createDatasetGroup([/* ... */]); $promise = $client->createDatasetGroupAsync([/* ... */]);
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:
-
Interactions
-
Items
-
Users
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
Related APIs
Parameter Syntax
$result = $client->createDatasetGroup([
'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
'kmsKeyArn' => '<string>',
'name' => '<string>', // REQUIRED
'roleArn' => '<string>',
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- domain
-
- Type: string
The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
- kmsKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
- name
-
- Required: Yes
- Type: string
The name for the new dataset group.
- roleArn
-
- Type: string
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.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the dataset group.
Result Syntax
[
'datasetGroupArn' => '<string>',
'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
]
Result Details
Members
Errors
-
Provide a valid value for the field or parameter.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The limit on the number of requests per second has been exceeded.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateDatasetImportJob
$result = $client->createDatasetImportJob([/* ... */]); $promise = $client->createDatasetImportJobAsync([/* ... */]);
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.
The dataset import job replaces any existing data in the dataset that you imported in bulk.
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
Parameter Syntax
$result = $client->createDatasetImportJob([
'dataSource' => [ // REQUIRED
'dataLocation' => '<string>',
],
'datasetArn' => '<string>', // REQUIRED
'jobName' => '<string>', // REQUIRED
'roleArn' => '<string>', // REQUIRED
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- dataSource
-
- Required: Yes
- Type: DataSource structure
The Amazon S3 bucket that contains the training data to import.
- datasetArn
-
- Required: Yes
- Type: string
The ARN of the dataset that receives the imported data.
- jobName
-
- Required: Yes
- Type: string
The name for the dataset import job.
- roleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the dataset import job.
Result Syntax
[
'datasetImportJobArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The limit on the number of requests per second has been exceeded.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateEventTracker
$result = $client->createEventTracker([/* ... */]); $promise = $client->createEventTrackerAsync([/* ... */]);
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 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
Parameter Syntax
$result = $client->createEventTracker([
'datasetGroupArn' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
Result Syntax
[
'eventTrackerArn' => '<string>',
'trackingId' => '<string>',
]
Result Details
Members
- eventTrackerArn
-
- Type: string
The ARN of the event tracker.
- trackingId
-
- Type: string
The ID of the event tracker. Include this ID in requests to the PutEvents API.
Errors
-
Provide a valid value for the field or parameter.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
Could not find the specified resource.
-
The limit on the number of requests per second has been exceeded.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateFilter
$result = $client->createFilter([/* ... */]); $promise = $client->createFilterAsync([/* ... */]);
Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
Parameter Syntax
$result = $client->createFilter([
'datasetGroupArn' => '<string>', // REQUIRED
'filterExpression' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- datasetGroupArn
-
- Required: Yes
- Type: string
The ARN of the dataset group that the filter will belong to.
- filterExpression
-
- Required: Yes
- Type: string
The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.
- name
-
- Required: Yes
- Type: string
The name of the filter to create.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the filter.
Result Syntax
[
'filterArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
Could not find the specified resource.
-
The limit on the number of requests per second has been exceeded.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateRecommender
$result = $client->createRecommender([/* ... */]); $promise = $client->createRecommenderAsync([/* ... */]);
Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Minimum recommendation requests per second
When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.
If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond. There's a short time delay while the capacity is increased that might cause loss of requests.
Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary.
Status
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations.
Related APIs
Parameter Syntax
$result = $client->createRecommender([
'datasetGroupArn' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'recipeArn' => '<string>', // REQUIRED
'recommenderConfig' => [
'itemExplorationConfig' => ['<string>', ...],
'minRecommendationRequestsPerSecond' => <integer>,
],
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- datasetGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
- name
-
- Required: Yes
- Type: string
The name of the recommender.
- recipeArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.
- recommenderConfig
-
- Type: RecommenderConfig structure
The configuration details of the recommender.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the recommender.
Result Syntax
[
'recommenderArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
Could not find the specified resource.
-
The limit on the number of requests per second has been exceeded.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateSchema
$result = $client->createSchema([/* ... */]); $promise = $client->createSchemaAsync([/* ... */]);
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. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
Related APIs
Parameter Syntax
$result = $client->createSchema([
'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
'name' => '<string>', // REQUIRED
'schema' => '<string>', // REQUIRED
]);
Parameter Details
Members
- domain
-
- Type: string
The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.
- name
-
- Required: Yes
- Type: string
The name for the schema.
- schema
-
- Required: Yes
- Type: string
A schema in Avro JSON format.
Result Syntax
[
'schemaArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
The limit on the number of requests per second has been exceeded.
CreateSolution
$result = $client->createSolution([/* ... */]); $promise = $client->createSolutionAsync([/* ... */]);
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.
Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.
Status
A solution 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 solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.
Related APIs
Parameter Syntax
$result = $client->createSolution([
'datasetGroupArn' => '<string>', // REQUIRED
'eventType' => '<string>',
'name' => '<string>', // REQUIRED
'performAutoML' => true || false,
'performHPO' => true || false,
'recipeArn' => '<string>',
'solutionConfig' => [
'algorithmHyperParameters' => ['<string>', ...],
'autoMLConfig' => [
'metricName' => '<string>',
'recipeList' => ['<string>', ...],
],
'eventValueThreshold' => '<string>',
'featureTransformationParameters' => ['<string>', ...],
'hpoConfig' => [
'algorithmHyperParameterRanges' => [
'categoricalHyperParameterRanges' => [
[
'name' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'continuousHyperParameterRanges' => [
[
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
],
// ...
],
'integerHyperParameterRanges' => [
[
'maxValue' => <integer>,
'minValue' => <integer>,
'name' => '<string>',
],
// ...
],
],
'hpoObjective' => [
'metricName' => '<string>',
'metricRegex' => '<string>',
'type' => '<string>',
],
'hpoResourceConfig' => [
'maxNumberOfTrainingJobs' => '<string>',
'maxParallelTrainingJobs' => '<string>',
],
],
'optimizationObjective' => [
'itemAttribute' => '<string>',
'objectiveSensitivity' => 'LOW|MEDIUM|HIGH|OFF',
],
],
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- datasetGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
- eventType
-
- Type: string
When your have multiple event types (using an
EVENT_TYPEschema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.If you do not provide an
eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type. - name
-
- Required: Yes
- Type: string
The name for the solution.
- performAutoML
-
- Type: boolean
Whether to perform automated machine learning (AutoML). The default is
false. For this case, you must specifyrecipeArn.When set to
true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omitrecipeArn. 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. - performHPO
-
- Type: boolean
Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is
false.When performing AutoML, this parameter is always
trueand you should not set it tofalse. - recipeArn
-
- Type: string
The ARN of the recipe to use for model training. Only specified when
performAutoMLis false. - solutionConfig
-
- Type: SolutionConfig structure
The configuration to use with the solution. When
performAutoMLis set to true, Amazon Personalize only evaluates theautoMLConfigsection of the solution configuration.Amazon Personalize doesn't support configuring the
hpoObjectiveat this time. - tags
-
- Type: Array of Tag structures
A list of tags to apply to the solution.
Result Syntax
[
'solutionArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
Could not find the specified resource.
-
The limit on the number of requests per second has been exceeded.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
CreateSolutionVersion
$result = $client->createSolutionVersion([/* ... */]); $promise = $client->createSolutionVersionAsync([/* ... */]);
Trains or retrains an active solution in a Custom dataset group. 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
-
CREATE IN_PROGRESS
-
ACTIVE
-
CREATE FAILED
-
CREATE STOPPING
-
CREATE STOPPED
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
Parameter Syntax
$result = $client->createSolutionVersion([
'solutionArn' => '<string>', // REQUIRED
'tags' => [
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
'trainingMode' => 'FULL|UPDATE',
]);
Parameter Details
Members
- solutionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the solution containing the training configuration information.
- tags
-
- Type: Array of Tag structures
A list of tags to apply to the solution version.
- trainingMode
-
- Type: string
The scope of training to be performed when creating the solution version. The
FULLoption trains the solution version based on the entirety of the input solution's training data, while theUPDATEoption processes only the data that has changed in comparison to the input solution. ChooseUPDATEwhen you want to incrementally update your solution version instead of creating an entirely new one.The
UPDATEoption can only be used when you already have an active solution version created from the input solution using theFULLoption and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.
Result Syntax
[
'solutionVersionArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The limit on the number of requests per second has been exceeded.
-
The specified resource is in use.
-
You have exceeded the maximum number of tags you can apply to this resource.
DeleteCampaign
$result = $client->deleteCampaign([/* ... */]); $promise = $client->deleteCampaignAsync([/* ... */]);
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 information on creating campaigns, see CreateCampaign.
Parameter Syntax
$result = $client->deleteCampaign([
'campaignArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
DeleteDataset
$result = $client->deleteDataset([/* ... */]); $promise = $client->deleteDatasetAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteDataset([
'datasetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
DeleteDatasetGroup
$result = $client->deleteDatasetGroup([/* ... */]); $promise = $client->deleteDatasetGroupAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteDatasetGroup([
'datasetGroupArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
DeleteEventTracker
$result = $client->deleteEventTracker([/* ... */]); $promise = $client->deleteEventTrackerAsync([/* ... */]);
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
Parameter Syntax
$result = $client->deleteEventTracker([
'eventTrackerArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
DeleteFilter
$result = $client->deleteFilter([/* ... */]); $promise = $client->deleteFilterAsync([/* ... */]);
Deletes a filter.
Parameter Syntax
$result = $client->deleteFilter([
'filterArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
DeleteRecommender
$result = $client->deleteRecommender([/* ... */]); $promise = $client->deleteRecommenderAsync([/* ... */]);
Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
Parameter Syntax
$result = $client->deleteRecommender([
'recommenderArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
DeleteSchema
$result = $client->deleteSchema([/* ... */]); $promise = $client->deleteSchemaAsync([/* ... */]);
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
Parameter Syntax
$result = $client->deleteSchema([
'schemaArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
DeleteSolution
$result = $client->deleteSolution([/* ... */]); $promise = $client->deleteSolutionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteSolution([
'solutionArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
DescribeAlgorithm
$result = $client->describeAlgorithm([/* ... */]); $promise = $client->describeAlgorithmAsync([/* ... */]);
Describes the given algorithm.
Parameter Syntax
$result = $client->describeAlgorithm([
'algorithmArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'algorithm' => [
'algorithmArn' => '<string>',
'algorithmImage' => [
'dockerURI' => '<string>',
'name' => '<string>',
],
'creationDateTime' => <DateTime>,
'defaultHyperParameterRanges' => [
'categoricalHyperParameterRanges' => [
[
'isTunable' => true || false,
'name' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'continuousHyperParameterRanges' => [
[
'isTunable' => true || false,
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
],
// ...
],
'integerHyperParameterRanges' => [
[
'isTunable' => true || false,
'maxValue' => <integer>,
'minValue' => <integer>,
'name' => '<string>',
],
// ...
],
],
'defaultHyperParameters' => ['<string>', ...],
'defaultResourceConfig' => ['<string>', ...],
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'roleArn' => '<string>',
'trainingInputMode' => '<string>',
],
]
Result Details
Members
- algorithm
-
- Type: Algorithm structure
A listing of the properties of the algorithm.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeBatchInferenceJob
$result = $client->describeBatchInferenceJob([/* ... */]); $promise = $client->describeBatchInferenceJobAsync([/* ... */]);
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
Parameter Syntax
$result = $client->describeBatchInferenceJob([
'batchInferenceJobArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'batchInferenceJob' => [
'batchInferenceJobArn' => '<string>',
'batchInferenceJobConfig' => [
'itemExplorationConfig' => ['<string>', ...],
],
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'filterArn' => '<string>',
'jobInput' => [
's3DataSource' => [
'kmsKeyArn' => '<string>',
'path' => '<string>',
],
],
'jobName' => '<string>',
'jobOutput' => [
's3DataDestination' => [
'kmsKeyArn' => '<string>',
'path' => '<string>',
],
],
'lastUpdatedDateTime' => <DateTime>,
'numResults' => <integer>,
'roleArn' => '<string>',
'solutionVersionArn' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- batchInferenceJob
-
- Type: BatchInferenceJob structure
Information on the specified batch inference job.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeBatchSegmentJob
$result = $client->describeBatchSegmentJob([/* ... */]); $promise = $client->describeBatchSegmentJobAsync([/* ... */]);
Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
Parameter Syntax
$result = $client->describeBatchSegmentJob([
'batchSegmentJobArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'batchSegmentJob' => [
'batchSegmentJobArn' => '<string>',
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'filterArn' => '<string>',
'jobInput' => [
's3DataSource' => [
'kmsKeyArn' => '<string>',
'path' => '<string>',
],
],
'jobName' => '<string>',
'jobOutput' => [
's3DataDestination' => [
'kmsKeyArn' => '<string>',
'path' => '<string>',
],
],
'lastUpdatedDateTime' => <DateTime>,
'numResults' => <integer>,
'roleArn' => '<string>',
'solutionVersionArn' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- batchSegmentJob
-
- Type: BatchSegmentJob structure
Information on the specified batch segment job.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeCampaign
$result = $client->describeCampaign([/* ... */]); $promise = $client->describeCampaignAsync([/* ... */]);
Describes the given campaign, including its 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
When the status is CREATE FAILED, the response includes the failureReason key, which describes why.
For more information on campaigns, see CreateCampaign.
Parameter Syntax
$result = $client->describeCampaign([
'campaignArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'campaign' => [
'campaignArn' => '<string>',
'campaignConfig' => [
'itemExplorationConfig' => ['<string>', ...],
],
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'latestCampaignUpdate' => [
'campaignConfig' => [
'itemExplorationConfig' => ['<string>', ...],
],
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'minProvisionedTPS' => <integer>,
'solutionVersionArn' => '<string>',
'status' => '<string>',
],
'minProvisionedTPS' => <integer>,
'name' => '<string>',
'solutionVersionArn' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- campaign
-
- Type: Campaign structure
The properties of the campaign.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeDataset
$result = $client->describeDataset([/* ... */]); $promise = $client->describeDatasetAsync([/* ... */]);
Describes the given dataset. For more information on datasets, see CreateDataset.
Parameter Syntax
$result = $client->describeDataset([
'datasetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'dataset' => [
'creationDateTime' => <DateTime>,
'datasetArn' => '<string>',
'datasetGroupArn' => '<string>',
'datasetType' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'schemaArn' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- dataset
-
- Type: Dataset structure
A listing of the dataset's properties.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeDatasetExportJob
$result = $client->describeDatasetExportJob([/* ... */]); $promise = $client->describeDatasetExportJobAsync([/* ... */]);
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
Parameter Syntax
$result = $client->describeDatasetExportJob([
'datasetExportJobArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'datasetExportJob' => [
'creationDateTime' => <DateTime>,
'datasetArn' => '<string>',
'datasetExportJobArn' => '<string>',
'failureReason' => '<string>',
'ingestionMode' => 'BULK|PUT|ALL',
'jobName' => '<string>',
'jobOutput' => [
's3DataDestination' => [
'kmsKeyArn' => '<string>',
'path' => '<string>',
],
],
'lastUpdatedDateTime' => <DateTime>,
'roleArn' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- datasetExportJob
-
- Type: DatasetExportJob structure
Information about the dataset export job, including the status.
The status is one of the following values:
-
CREATE PENDING
-
CREATE IN_PROGRESS
-
ACTIVE
-
CREATE FAILED
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeDatasetGroup
$result = $client->describeDatasetGroup([/* ... */]); $promise = $client->describeDatasetGroupAsync([/* ... */]);
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
Parameter Syntax
$result = $client->describeDatasetGroup([
'datasetGroupArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'datasetGroup' => [
'creationDateTime' => <DateTime>,
'datasetGroupArn' => '<string>',
'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
'failureReason' => '<string>',
'kmsKeyArn' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'roleArn' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- datasetGroup
-
- Type: DatasetGroup structure
A listing of the dataset group's properties.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeDatasetImportJob
$result = $client->describeDatasetImportJob([/* ... */]); $promise = $client->describeDatasetImportJobAsync([/* ... */]);
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
Parameter Syntax
$result = $client->describeDatasetImportJob([
'datasetImportJobArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'datasetImportJob' => [
'creationDateTime' => <DateTime>,
'dataSource' => [
'dataLocation' => '<string>',
],
'datasetArn' => '<string>',
'datasetImportJobArn' => '<string>',
'failureReason' => '<string>',
'jobName' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'roleArn' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- datasetImportJob
-
- Type: DatasetImportJob structure
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
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeEventTracker
$result = $client->describeEventTracker([/* ... */]); $promise = $client->describeEventTrackerAsync([/* ... */]);
Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
Parameter Syntax
$result = $client->describeEventTracker([
'eventTrackerArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'eventTracker' => [
'accountId' => '<string>',
'creationDateTime' => <DateTime>,
'datasetGroupArn' => '<string>',
'eventTrackerArn' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'status' => '<string>',
'trackingId' => '<string>',
],
]
Result Details
Members
- eventTracker
-
- Type: EventTracker structure
An object that describes the event tracker.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeFeatureTransformation
$result = $client->describeFeatureTransformation([/* ... */]); $promise = $client->describeFeatureTransformationAsync([/* ... */]);
Describes the given feature transformation.
Parameter Syntax
$result = $client->describeFeatureTransformation([
'featureTransformationArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'featureTransformation' => [
'creationDateTime' => <DateTime>,
'defaultParameters' => ['<string>', ...],
'featureTransformationArn' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- featureTransformation
-
- Type: FeatureTransformation structure
A listing of the FeatureTransformation properties.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeFilter
$result = $client->describeFilter([/* ... */]); $promise = $client->describeFilterAsync([/* ... */]);
Describes a filter's properties.
Parameter Syntax
$result = $client->describeFilter([
'filterArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'filter' => [
'creationDateTime' => <DateTime>,
'datasetGroupArn' => '<string>',
'failureReason' => '<string>',
'filterArn' => '<string>',
'filterExpression' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- filter
-
- Type: Filter structure
The filter's details.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeRecipe
$result = $client->describeRecipe([/* ... */]); $promise = $client->describeRecipeAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->describeRecipe([
'recipeArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'recipe' => [
'algorithmArn' => '<string>',
'creationDateTime' => <DateTime>,
'description' => '<string>',
'featureTransformationArn' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'recipeArn' => '<string>',
'recipeType' => '<string>',
'status' => '<string>',
],
]
Result Details
Members
- recipe
-
- Type: Recipe structure
An object that describes the recipe.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeRecommender
$result = $client->describeRecommender([/* ... */]); $promise = $client->describeRecommenderAsync([/* ... */]);
Describes the given recommender, including its status.
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
When the status is CREATE FAILED, the response includes the failureReason key, which describes why.
The modelMetrics key is null when the recommender is being created or deleted.
For more information on recommenders, see CreateRecommender.
Parameter Syntax
$result = $client->describeRecommender([
'recommenderArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'recommender' => [
'creationDateTime' => <DateTime>,
'datasetGroupArn' => '<string>',
'failureReason' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'latestRecommenderUpdate' => [
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'recommenderConfig' => [
'itemExplorationConfig' => ['<string>', ...],
'minRecommendationRequestsPerSecond' => <integer>,
],
'status' => '<string>',
],
'modelMetrics' => [<float>, ...],
'name' => '<string>',
'recipeArn' => '<string>',
'recommenderArn' => '<string>',
'recommenderConfig' => [
'itemExplorationConfig' => ['<string>', ...],
'minRecommendationRequestsPerSecond' => <integer>,
],
'status' => '<string>',
],
]
Result Details
Members
- recommender
-
- Type: Recommender structure
The properties of the recommender.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeSchema
$result = $client->describeSchema([/* ... */]); $promise = $client->describeSchemaAsync([/* ... */]);
Describes a schema. For more information on schemas, see CreateSchema.
Parameter Syntax
$result = $client->describeSchema([
'schemaArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'schema' => [
'creationDateTime' => <DateTime>,
'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'schema' => '<string>',
'schemaArn' => '<string>',
],
]
Result Details
Members
- schema
-
- Type: DatasetSchema structure
The requested schema.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeSolution
$result = $client->describeSolution([/* ... */]); $promise = $client->describeSolutionAsync([/* ... */]);
Describes a solution. For more information on solutions, see CreateSolution.
Parameter Syntax
$result = $client->describeSolution([
'solutionArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'solution' => [
'autoMLResult' => [
'bestRecipeArn' => '<string>',
],
'creationDateTime' => <DateTime>,
'datasetGroupArn' => '<string>',
'eventType' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'latestSolutionVersion' => [
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'solutionVersionArn' => '<string>',
'status' => '<string>',
],
'name' => '<string>',
'performAutoML' => true || false,
'performHPO' => true || false,
'recipeArn' => '<string>',
'solutionArn' => '<string>',
'solutionConfig' => [
'algorithmHyperParameters' => ['<string>', ...],
'autoMLConfig' => [
'metricName' => '<string>',
'recipeList' => ['<string>', ...],
],
'eventValueThreshold' => '<string>',
'featureTransformationParameters' => ['<string>', ...],
'hpoConfig' => [
'algorithmHyperParameterRanges' => [
'categoricalHyperParameterRanges' => [
[
'name' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'continuousHyperParameterRanges' => [
[
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
],
// ...
],
'integerHyperParameterRanges' => [
[
'maxValue' => <integer>,
'minValue' => <integer>,
'name' => '<string>',
],
// ...
],
],
'hpoObjective' => [
'metricName' => '<string>',
'metricRegex' => '<string>',
'type' => '<string>',
],
'hpoResourceConfig' => [
'maxNumberOfTrainingJobs' => '<string>',
'maxParallelTrainingJobs' => '<string>',
],
],
'optimizationObjective' => [
'itemAttribute' => '<string>',
'objectiveSensitivity' => 'LOW|MEDIUM|HIGH|OFF',
],
],
'status' => '<string>',
],
]
Result Details
Members
- solution
-
- Type: Solution structure
An object that describes the solution.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
DescribeSolutionVersion
$result = $client->describeSolutionVersion([/* ... */]); $promise = $client->describeSolutionVersionAsync([/* ... */]);
Describes a specific version of a solution. For more information on solutions, see CreateSolution
Parameter Syntax
$result = $client->describeSolutionVersion([
'solutionVersionArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'solutionVersion' => [
'creationDateTime' => <DateTime>,
'datasetGroupArn' => '<string>',
'eventType' => '<string>',
'failureReason' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'performAutoML' => true || false,
'performHPO' => true || false,
'recipeArn' => '<string>',
'solutionArn' => '<string>',
'solutionConfig' => [
'algorithmHyperParameters' => ['<string>', ...],
'autoMLConfig' => [
'metricName' => '<string>',
'recipeList' => ['<string>', ...],
],
'eventValueThreshold' => '<string>',
'featureTransformationParameters' => ['<string>', ...],
'hpoConfig' => [
'algorithmHyperParameterRanges' => [
'categoricalHyperParameterRanges' => [
[
'name' => '<string>',
'values' => ['<string>', ...],
],
// ...
],
'continuousHyperParameterRanges' => [
[
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
],
// ...
],
'integerHyperParameterRanges' => [
[
'maxValue' => <integer>,
'minValue' => <integer>,
'name' => '<string>',
],
// ...
],
],
'hpoObjective' => [
'metricName' => '<string>',
'metricRegex' => '<string>',
'type' => '<string>',
],
'hpoResourceConfig' => [
'maxNumberOfTrainingJobs' => '<string>',
'maxParallelTrainingJobs' => '<string>',
],
],
'optimizationObjective' => [
'itemAttribute' => '<string>',
'objectiveSensitivity' => 'LOW|MEDIUM|HIGH|OFF',
],
],
'solutionVersionArn' => '<string>',
'status' => '<string>',
'trainingHours' => <float>,
'trainingMode' => 'FULL|UPDATE',
'tunedHPOParams' => [
'algorithmHyperParameters' => ['<string>', ...],
],
],
]
Result Details
Members
- solutionVersion
-
- Type: SolutionVersion structure
The solution version.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
GetSolutionMetrics
$result = $client->getSolutionMetrics([/* ... */]); $promise = $client->getSolutionMetricsAsync([/* ... */]);
Gets the metrics for the specified solution version.
Parameter Syntax
$result = $client->getSolutionMetrics([
'solutionVersionArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'metrics' => [<float>, ...],
'solutionVersionArn' => '<string>',
]
Result Details
Members
- metrics
-
- Type: Associative array of custom strings keys (MetricName) to doubles
The metrics for the solution version. For more information, see Evaluating a solution version with metrics .
- solutionVersionArn
-
- Type: string
The same solution version ARN as specified in the request.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
ListBatchInferenceJobs
$result = $client->listBatchInferenceJobs([/* ... */]); $promise = $client->listBatchInferenceJobsAsync([/* ... */]);
Gets a list of the batch inference jobs that have been performed off of a solution version.
Parameter Syntax
$result = $client->listBatchInferenceJobs([
'maxResults' => <integer>,
'nextToken' => '<string>',
'solutionVersionArn' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of batch inference job results to return in each page. The default value is 100.
- nextToken
-
- Type: string
The token to request the next page of results.
- solutionVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.
Result Syntax
[
'batchInferenceJobs' => [
[
'batchInferenceJobArn' => '<string>',
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'jobName' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'solutionVersionArn' => '<string>',
'status' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- batchInferenceJobs
-
- Type: Array of BatchInferenceJobSummary structures
A list containing information on each job that is returned.
- nextToken
-
- Type: string
The token to use to retrieve the next page of results. The value is
nullwhen there are no more results to return.
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListBatchSegmentJobs
$result = $client->listBatchSegmentJobs([/* ... */]); $promise = $client->listBatchSegmentJobsAsync([/* ... */]);
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
Parameter Syntax
$result = $client->listBatchSegmentJobs([
'maxResults' => <integer>,
'nextToken' => '<string>',
'solutionVersionArn' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of batch segment job results to return in each page. The default value is 100.
- nextToken
-
- Type: string
The token to request the next page of results.
- solutionVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
Result Syntax
[
'batchSegmentJobs' => [
[
'batchSegmentJobArn' => '<string>',
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'jobName' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'solutionVersionArn' => '<string>',
'status' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- batchSegmentJobs
-
- Type: Array of BatchSegmentJobSummary structures
A list containing information on each job that is returned.
- nextToken
-
- Type: string
The token to use to retrieve the next page of results. The value is
nullwhen there are no more results to return.
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListCampaigns
$result = $client->listCampaigns([/* ... */]); $promise = $client->listCampaignsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listCampaigns([
'maxResults' => <integer>,
'nextToken' => '<string>',
'solutionArn' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of campaigns to return.
- nextToken
-
- Type: string
A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
- solutionArn
-
- Type: string
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.
Result Syntax
[
'campaigns' => [
[
'campaignArn' => '<string>',
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'status' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- campaigns
-
- Type: Array of CampaignSummary structures
A list of the campaigns.
- nextToken
-
- Type: string
A token for getting the next set of campaigns (if they exist).
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListDatasetExportJobs
$result = $client->listDatasetExportJobs([/* ... */]); $promise = $client->listDatasetExportJobsAsync([/* ... */]);
Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
Parameter Syntax
$result = $client->listDatasetExportJobs([
'datasetArn' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- datasetArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.
- maxResults
-
- Type: int
The maximum number of dataset export jobs to return.
- nextToken
-
- Type: string
A token returned from the previous call to
ListDatasetExportJobsfor getting the next set of dataset export jobs (if they exist).
Result Syntax
[
'datasetExportJobs' => [
[
'creationDateTime' => <DateTime>,
'datasetExportJobArn' => '<string>',
'failureReason' => '<string>',
'jobName' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'status' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- datasetExportJobs
-
- Type: Array of DatasetExportJobSummary structures
The list of dataset export jobs.
- nextToken
-
- Type: string
A token for getting the next set of dataset export jobs (if they exist).
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListDatasetGroups
$result = $client->listDatasetGroups([/* ... */]); $promise = $client->listDatasetGroupsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listDatasetGroups([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'datasetGroups' => [
[
'creationDateTime' => <DateTime>,
'datasetGroupArn' => '<string>',
'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
'failureReason' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'status' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- datasetGroups
-
- Type: Array of DatasetGroupSummary structures
The list of your dataset groups.
- nextToken
-
- Type: string
A token for getting the next set of dataset groups (if they exist).
Errors
-
The token is not valid.
ListDatasetImportJobs
$result = $client->listDatasetImportJobs([/* ... */]); $promise = $client->listDatasetImportJobsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listDatasetImportJobs([
'datasetArn' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- datasetArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.
- maxResults
-
- Type: int
The maximum number of dataset import jobs to return.
- nextToken
-
- Type: string
A token returned from the previous call to
ListDatasetImportJobsfor getting the next set of dataset import jobs (if they exist).
Result Syntax
[
'datasetImportJobs' => [
[
'creationDateTime' => <DateTime>,
'datasetImportJobArn' => '<string>',
'failureReason' => '<string>',
'jobName' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'status' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- datasetImportJobs
-
- Type: Array of DatasetImportJobSummary structures
The list of dataset import jobs.
- nextToken
-
- Type: string
A token for getting the next set of dataset import jobs (if they exist).
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListDatasets
$result = $client->listDatasets([/* ... */]); $promise = $client->listDatasetsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listDatasets([
'datasetGroupArn' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
- maxResults
-
- Type: int
The maximum number of datasets to return.
- nextToken
-
- Type: string
A token returned from the previous call to
ListDatasetImportJobsfor getting the next set of dataset import jobs (if they exist).
Result Syntax
[
'datasets' => [
[
'creationDateTime' => <DateTime>,
'datasetArn' => '<string>',
'datasetType' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'status' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- datasets
-
- Type: Array of DatasetSummary structures
An array of
Datasetobjects. Each object provides metadata information. - nextToken
-
- Type: string
A token for getting the next set of datasets (if they exist).
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListEventTrackers
$result = $client->listEventTrackers([/* ... */]); $promise = $client->listEventTrackersAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listEventTrackers([
'datasetGroupArn' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'eventTrackers' => [
[
'creationDateTime' => <DateTime>,
'eventTrackerArn' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'status' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- eventTrackers
-
- Type: Array of EventTrackerSummary structures
A list of event trackers.
- nextToken
-
- Type: string
A token for getting the next set of event trackers (if they exist).
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListFilters
$result = $client->listFilters([/* ... */]); $promise = $client->listFiltersAsync([/* ... */]);
Lists all filters that belong to a given dataset group.
Parameter Syntax
$result = $client->listFilters([
'datasetGroupArn' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Filters' => [
[
'creationDateTime' => <DateTime>,
'datasetGroupArn' => '<string>',
'failureReason' => '<string>',
'filterArn' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'status' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- Filters
-
- Type: Array of FilterSummary structures
A list of returned filters.
- nextToken
-
- Type: string
A token for getting the next set of filters (if they exist).
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListRecipes
$result = $client->listRecipes([/* ... */]); $promise = $client->listRecipesAsync([/* ... */]);
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
Parameter Syntax
$result = $client->listRecipes([
'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
'maxResults' => <integer>,
'nextToken' => '<string>',
'recipeProvider' => 'SERVICE',
]);
Parameter Details
Members
- domain
-
- Type: string
Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.
- maxResults
-
- Type: int
The maximum number of recipes to return.
- nextToken
-
- Type: string
A token returned from the previous call to
ListRecipesfor getting the next set of recipes (if they exist). - recipeProvider
-
- Type: string
The default is
SERVICE.
Result Syntax
[
'nextToken' => '<string>',
'recipes' => [
[
'creationDateTime' => <DateTime>,
'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'recipeArn' => '<string>',
'status' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
A token for getting the next set of recipes.
- recipes
-
- Type: Array of RecipeSummary structures
The list of available recipes.
Errors
-
The token is not valid.
-
Provide a valid value for the field or parameter.
ListRecommenders
$result = $client->listRecommenders([/* ... */]); $promise = $client->listRecommendersAsync([/* ... */]);
Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
Parameter Syntax
$result = $client->listRecommenders([
'datasetGroupArn' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
- maxResults
-
- Type: int
The maximum number of recommenders to return.
- nextToken
-
- Type: string
A token returned from the previous call to
ListRecommendersfor getting the next set of recommenders (if they exist).
Result Syntax
[
'nextToken' => '<string>',
'recommenders' => [
[
'creationDateTime' => <DateTime>,
'datasetGroupArn' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'recipeArn' => '<string>',
'recommenderArn' => '<string>',
'recommenderConfig' => [
'itemExplorationConfig' => ['<string>', ...],
'minRecommendationRequestsPerSecond' => <integer>,
],
'status' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
A token for getting the next set of recommenders (if they exist).
- recommenders
-
- Type: Array of RecommenderSummary structures
A list of the recommenders.
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListSchemas
$result = $client->listSchemas([/* ... */]); $promise = $client->listSchemasAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listSchemas([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'schemas' => [
[
'creationDateTime' => <DateTime>,
'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'schemaArn' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
A token used to get the next set of schemas (if they exist).
- schemas
-
- Type: Array of DatasetSchemaSummary structures
A list of schemas.
Errors
-
The token is not valid.
ListSolutionVersions
$result = $client->listSolutionVersions([/* ... */]); $promise = $client->listSolutionVersionsAsync([/* ... */]);
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).
Parameter Syntax
$result = $client->listSolutionVersions([
'maxResults' => <integer>,
'nextToken' => '<string>',
'solutionArn' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'solutionVersions' => [
[
'creationDateTime' => <DateTime>,
'failureReason' => '<string>',
'lastUpdatedDateTime' => <DateTime>,
'solutionVersionArn' => '<string>',
'status' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
A token for getting the next set of solution versions (if they exist).
- solutionVersions
-
- Type: Array of SolutionVersionSummary structures
A list of solution versions describing the version properties.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The token is not valid.
ListSolutions
$result = $client->listSolutions([/* ... */]); $promise = $client->listSolutionsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listSolutions([
'datasetGroupArn' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'solutions' => [
[
'creationDateTime' => <DateTime>,
'lastUpdatedDateTime' => <DateTime>,
'name' => '<string>',
'solutionArn' => '<string>',
'status' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
A token for getting the next set of solutions (if they exist).
- solutions
-
- Type: Array of SolutionSummary structures
A list of the current solutions.
Errors
-
Provide a valid value for the field or parameter.
-
The token is not valid.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Get a list of tags attached to a resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'tags' => [
[
'tagKey' => '<string>',
'tagValue' => '<string>',
],
// ...
],
]
Result Details
Members
- tags
-
- Type: Array of Tag structures
The resource's tags.
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
StartRecommender
$result = $client->startRecommender([/* ... */]); $promise = $client->startRecommenderAsync([/* ... */]);
Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
Parameter Syntax
$result = $client->startRecommender([
'recommenderArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'recommenderArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
StopRecommender
$result = $client->stopRecommender([/* ... */]); $promise = $client->stopRecommenderAsync([/* ... */]);
Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
Parameter Syntax
$result = $client->stopRecommender([
'recommenderArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'recommenderArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
StopSolutionVersionCreation
$result = $client->stopSolutionVersionCreation([/* ... */]); $promise = $client->stopSolutionVersionCreationAsync([/* ... */]);
Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
Depending on the current state of the solution version, the solution version state changes as follows:
-
CREATE_PENDING > CREATE_STOPPED
or
-
CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED
You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.
Parameter Syntax
$result = $client->stopSolutionVersionCreation([
'solutionVersionArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Add a list of tags to a resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => [ // REQUIRED
[
'tagKey' => '<string>', // REQUIRED
'tagValue' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The resource's Amazon Resource Name (ARN).
- tags
-
- Required: Yes
- Type: Array of Tag structures
Tags to apply to the resource. For more information see Tagging Personalize resources.
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
You have exceeded the maximum number of tags you can apply to this resource.
-
The specified resource is in use.
-
The limit on the number of requests per second has been exceeded.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Remove tags that are attached to a resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
-
The specified resource is in use.
UpdateCampaign
$result = $client->updateCampaign([/* ... */]); $promise = $client->updateCampaignAsync([/* ... */]);
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 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 on campaigns, see CreateCampaign.
Parameter Syntax
$result = $client->updateCampaign([
'campaignArn' => '<string>', // REQUIRED
'campaignConfig' => [
'itemExplorationConfig' => ['<string>', ...],
],
'minProvisionedTPS' => <integer>,
'solutionVersionArn' => '<string>',
]);
Parameter Details
Members
- campaignArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the campaign.
- campaignConfig
-
- Type: CampaignConfig structure
The configuration details of a campaign.
- minProvisionedTPS
-
- Type: int
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
- solutionVersionArn
-
- Type: string
The ARN of a new solution version to deploy.
Result Syntax
[
'campaignArn' => '<string>',
]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
UpdateRecommender
$result = $client->updateRecommender([/* ... */]); $promise = $client->updateRecommenderAsync([/* ... */]);
Updates the recommender to modify the recommender configuration.
Parameter Syntax
$result = $client->updateRecommender([
'recommenderArn' => '<string>', // REQUIRED
'recommenderConfig' => [ // REQUIRED
'itemExplorationConfig' => ['<string>', ...],
'minRecommendationRequestsPerSecond' => <integer>,
],
]);
Parameter Details
Members
- recommenderArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the recommender to modify.
- recommenderConfig
-
- Required: Yes
- Type: RecommenderConfig structure
The configuration details of the recommender.
Result Syntax
[
'recommenderArn' => '<string>',
]
Result Details
Members
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
Shapes
Algorithm
Description
Describes a custom algorithm.
Members
- algorithmArn
-
- Type: string
The Amazon Resource Name (ARN) of the algorithm.
- algorithmImage
-
- Type: AlgorithmImage structure
The URI of the Docker container for the algorithm image.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the algorithm was created.
- defaultHyperParameterRanges
-
- Type: DefaultHyperParameterRanges structure
Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
- defaultHyperParameters
-
- Type: Associative array of custom strings keys (ParameterName) to strings
Specifies the default hyperparameters.
- defaultResourceConfig
-
- Type: Associative array of custom strings keys (ParameterName) to strings
Specifies the default maximum number of training jobs and parallel training jobs.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the algorithm was last updated.
- name
-
- Type: string
The name of the algorithm.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role.
- trainingInputMode
-
- Type: string
The training input mode.
AlgorithmImage
Description
Describes an algorithm image.
Members
AutoMLConfig
Description
When the solution performs AutoML (performAutoML is true in CreateSolution), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution.
Members
AutoMLResult
Description
When the solution performs AutoML (performAutoML is true in CreateSolution), specifies the recipe that best optimized the specified metric.
Members
BatchInferenceJob
Description
Contains information on a batch inference job.
Members
- batchInferenceJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the batch inference job.
- batchInferenceJobConfig
-
- Type: BatchInferenceJobConfig structure
A string to string map of the configuration details of a batch inference job.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the batch inference job was created.
- failureReason
-
- Type: string
If the batch inference job failed, the reason for the failure.
- filterArn
-
- Type: string
The ARN of the filter used on the batch inference job.
- jobInput
-
- Type: BatchInferenceJobInput structure
The Amazon S3 path that leads to the input data used to generate the batch inference job.
- jobName
-
- Type: string
The name of the batch inference job.
- jobOutput
-
- Type: BatchInferenceJobOutput structure
The Amazon S3 bucket that contains the output data generated by the batch inference job.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the batch inference job was last updated.
- numResults
-
- Type: int
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
- roleArn
-
- Type: string
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
- solutionVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
- status
-
- Type: string
The status of the batch inference job. The status is one of the following values:
-
PENDING
-
IN PROGRESS
-
ACTIVE
-
CREATE FAILED
BatchInferenceJobConfig
Description
The configuration details of a batch inference job.
Members
- itemExplorationConfig
-
- Type: Associative array of custom strings keys (ParameterName) to strings
A string to string map specifying the exploration configuration hyperparameters, including
explorationWeightandexplorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.
BatchInferenceJobInput
Description
The input configuration of a batch inference job.
Members
- s3DataSource
-
- Required: Yes
- Type: S3DataConfig structure
The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.
BatchInferenceJobOutput
Description
The output configuration parameters of a batch inference job.
Members
- s3DataDestination
-
- Required: Yes
- Type: S3DataConfig structure
Information on the Amazon S3 bucket in which the batch inference job's output is stored.
BatchInferenceJobSummary
Description
A truncated version of the BatchInferenceJob. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.
Members
- batchInferenceJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the batch inference job.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the batch inference job was created.
- failureReason
-
- Type: string
If the batch inference job failed, the reason for the failure.
- jobName
-
- Type: string
The name of the batch inference job.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the batch inference job was last updated.
- solutionVersionArn
-
- Type: string
The ARN of the solution version used by the batch inference job.
- status
-
- Type: string
The status of the batch inference job. The status is one of the following values:
-
PENDING
-
IN PROGRESS
-
ACTIVE
-
CREATE FAILED
BatchSegmentJob
Description
Contains information on a batch segment job.
Members
- batchSegmentJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the batch segment job.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the batch segment job was created.
- failureReason
-
- Type: string
If the batch segment job failed, the reason for the failure.
- filterArn
-
- Type: string
The ARN of the filter used on the batch segment job.
- jobInput
-
- Type: BatchSegmentJobInput structure
The Amazon S3 path that leads to the input data used to generate the batch segment job.
- jobName
-
- Type: string
The name of the batch segment job.
- jobOutput
-
- Type: BatchSegmentJobOutput structure
The Amazon S3 bucket that contains the output data generated by the batch segment job.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the batch segment job last updated.
- numResults
-
- Type: int
The number of predicted users generated by the batch segment job for each line of input data.
- roleArn
-
- Type: string
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
- solutionVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
- status
-
- Type: string
The status of the batch segment job. The status is one of the following values:
-
PENDING
-
IN PROGRESS
-
ACTIVE
-
CREATE FAILED
BatchSegmentJobInput
Description
The input configuration of a batch segment job.
Members
- s3DataSource
-
- Required: Yes
- Type: S3DataConfig structure
The configuration details of an Amazon S3 input or output bucket.
BatchSegmentJobOutput
Description
The output configuration parameters of a batch segment job.
Members
- s3DataDestination
-
- Required: Yes
- Type: S3DataConfig structure
The configuration details of an Amazon S3 input or output bucket.
BatchSegmentJobSummary
Description
A truncated version of the BatchSegmentJob datatype. ListBatchSegmentJobs operation returns a list of batch segment job summaries.
Members
- batchSegmentJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the batch segment job.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the batch segment job was created.
- failureReason
-
- Type: string
If the batch segment job failed, the reason for the failure.
- jobName
-
- Type: string
The name of the batch segment job.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the batch segment job was last updated.
- solutionVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
- status
-
- Type: string
The status of the batch segment job. The status is one of the following values:
-
PENDING
-
IN PROGRESS
-
ACTIVE
-
CREATE FAILED
Campaign
Description
An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.
Members
- campaignArn
-
- Type: string
The Amazon Resource Name (ARN) of the campaign.
- campaignConfig
-
- Type: CampaignConfig structure
The configuration details of a campaign.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the campaign was created.
- failureReason
-
- Type: string
If a campaign fails, the reason behind the failure.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the campaign was last updated.
- latestCampaignUpdate
-
- Type: CampaignUpdateSummary structure
Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.
- minProvisionedTPS
-
- Type: int
Specifies the requested minimum provisioned transactions (recommendations) per second.
- name
-
- Type: string
The name of the campaign.
- solutionVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of a specific version of the solution.
- status
-
- Type: string
The status of the campaign.
A campaign can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
CampaignConfig
Description
The configuration details of a campaign.
Members
- itemExplorationConfig
-
- Type: Associative array of custom strings keys (ParameterName) to strings
Specifies the exploration configuration hyperparameters, including
explorationWeightandexplorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. ProvideitemExplorationConfigdata only if your solution uses the User-Personalization recipe.
CampaignSummary
Description
Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.
Members
- campaignArn
-
- Type: string
The Amazon Resource Name (ARN) of the campaign.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the campaign was created.
- failureReason
-
- Type: string
If a campaign fails, the reason behind the failure.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the campaign was last updated.
- name
-
- Type: string
The name of the campaign.
- status
-
- Type: string
The status of the campaign.
A campaign can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
CampaignUpdateSummary
Description
Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.
Members
- campaignConfig
-
- Type: CampaignConfig structure
The configuration details of a campaign.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the campaign update was created.
- failureReason
-
- Type: string
If a campaign update fails, the reason behind the failure.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the campaign update was last updated.
- minProvisionedTPS
-
- Type: int
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
- solutionVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of the deployed solution version.
- status
-
- Type: string
The status of the campaign update.
A campaign update can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
CategoricalHyperParameterRange
Description
Provides the name and range of a categorical hyperparameter.
Members
ContinuousHyperParameterRange
Description
Provides the name and range of a continuous hyperparameter.
Members
DataSource
Description
Describes the data source that contains the data to upload to a dataset.
Members
Dataset
Description
Provides metadata for a dataset.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time (in Unix time) of the dataset.
- datasetArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset that you want metadata for.
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset group.
- datasetType
-
- Type: string
One of the following values:
-
Interactions
-
Items
-
Users
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A time stamp that shows when the dataset was updated.
- name
-
- Type: string
The name of the dataset.
- schemaArn
-
- Type: string
The ARN of the associated schema.
- status
-
- Type: string
The status of the dataset.
A dataset can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
DatasetExportJob
Description
Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.
A dataset export job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time (in Unix time) of the dataset export job.
- datasetArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset to export.
- datasetExportJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset export job.
- failureReason
-
- Type: string
If a dataset export job fails, provides the reason why.
- ingestionMode
-
- Type: string
The data to export, based on how you imported the data. You can choose to export
BULKdata that you imported using a dataset import job,PUTdata that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), orALLfor both types. The default value isPUT. - jobName
-
- Type: string
The name of the export job.
- jobOutput
-
- Type: DatasetExportJobOutput structure
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/ - lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) the status of the dataset export job was last updated.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
- status
-
- Type: string
The status of the dataset export job.
A dataset export job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DatasetExportJobOutput
Description
The output configuration parameters of a dataset export job.
Members
- s3DataDestination
-
- Required: Yes
- Type: S3DataConfig structure
The configuration details of an Amazon S3 input or output bucket.
DatasetExportJobSummary
Description
Provides a summary of the properties of a dataset export job. For a complete listing, call the DescribeDatasetExportJob API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the dataset export job was created.
- datasetExportJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset export job.
- failureReason
-
- Type: string
If a dataset export job fails, the reason behind the failure.
- jobName
-
- Type: string
The name of the dataset export job.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the dataset export job status was last updated.
- status
-
- Type: string
The status of the dataset export job.
A dataset export job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DatasetGroup
Description
A dataset group is a collection of related datasets (Interactions, User, and Item). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time (in Unix time) of the dataset group.
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset group.
- domain
-
- Type: string
The domain of a Domain dataset group.
- failureReason
-
- Type: string
If creating a dataset group fails, provides the reason why.
- kmsKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last update date and time (in Unix time) of the dataset group.
- name
-
- Type: string
The name of the dataset group.
- roleArn
-
- Type: string
The ARN of the IAM role that has permissions to create the dataset group.
- status
-
- Type: string
The current status of the dataset group.
A dataset group can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING
DatasetGroupSummary
Description
Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the dataset group was created.
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset group.
- domain
-
- Type: string
The domain of a Domain dataset group.
- failureReason
-
- Type: string
If creating a dataset group fails, the reason behind the failure.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the dataset group was last updated.
- name
-
- Type: string
The name of the dataset group.
- status
-
- Type: string
The status of the dataset group.
A dataset group can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING
DatasetImportJob
Description
Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.
A dataset import job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time (in Unix time) of the dataset import job.
- dataSource
-
- Type: DataSource structure
The Amazon S3 bucket that contains the training data to import.
- datasetArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset that receives the imported data.
- datasetImportJobArn
-
- Type: string
The ARN of the dataset import job.
- failureReason
-
- Type: string
If a dataset import job fails, provides the reason why.
- jobName
-
- Type: string
The name of the import job.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) the dataset was last updated.
- roleArn
-
- Type: string
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
- status
-
- Type: string
The status of the dataset import job.
A dataset import job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DatasetImportJobSummary
Description
Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the dataset import job was created.
- datasetImportJobArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset import job.
- failureReason
-
- Type: string
If a dataset import job fails, the reason behind the failure.
- jobName
-
- Type: string
The name of the dataset import job.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the dataset import job status was last updated.
- status
-
- Type: string
The status of the dataset import job.
A dataset import job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DatasetSchema
Description
Describes the schema for a dataset. For more information on schemas, see CreateSchema.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the schema was created.
- domain
-
- Type: string
The domain of a schema that you created for a dataset in a Domain dataset group.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the schema was last updated.
- name
-
- Type: string
The name of the schema.
- schema
-
- Type: string
The schema.
- schemaArn
-
- Type: string
The Amazon Resource Name (ARN) of the schema.
DatasetSchemaSummary
Description
Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the schema was created.
- domain
-
- Type: string
The domain of a schema that you created for a dataset in a Domain dataset group.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the schema was last updated.
- name
-
- Type: string
The name of the schema.
- schemaArn
-
- Type: string
The Amazon Resource Name (ARN) of the schema.
DatasetSummary
Description
Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the dataset was created.
- datasetArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset.
- datasetType
-
- Type: string
The dataset type. One of the following values:
-
Interactions
-
Items
-
Users
-
Event-Interactions
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the dataset was last updated.
- name
-
- Type: string
The name of the dataset.
- status
-
- Type: string
The status of the dataset.
A dataset can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
DefaultCategoricalHyperParameterRange
Description
Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
Members
DefaultContinuousHyperParameterRange
Description
Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
Members
DefaultHyperParameterRanges
Description
Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.
Members
- categoricalHyperParameterRanges
-
- Type: Array of DefaultCategoricalHyperParameterRange structures
The categorical hyperparameters and their default ranges.
- continuousHyperParameterRanges
-
- Type: Array of DefaultContinuousHyperParameterRange structures
The continuous hyperparameters and their default ranges.
- integerHyperParameterRanges
-
- Type: Array of DefaultIntegerHyperParameterRange structures
The integer-valued hyperparameters and their default ranges.
DefaultIntegerHyperParameterRange
Description
Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
Members
EventTracker
Description
Provides information about an event tracker.
Members
- accountId
-
- Type: string
The Amazon Web Services account that owns the event tracker.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the event tracker was created.
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset group that receives the event data.
- eventTrackerArn
-
- Type: string
The ARN of the event tracker.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the event tracker was last updated.
- name
-
- Type: string
The name of the event tracker.
- status
-
- Type: string
The status of the event tracker.
An event tracker can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
- trackingId
-
- Type: string
The ID of the event tracker. Include this ID in requests to the PutEvents API.
EventTrackerSummary
Description
Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the event tracker was created.
- eventTrackerArn
-
- Type: string
The Amazon Resource Name (ARN) of the event tracker.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the event tracker was last updated.
- name
-
- Type: string
The name of the event tracker.
- status
-
- Type: string
The status of the event tracker.
An event tracker can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
FeatureTransformation
Description
Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time (in Unix time) of the feature transformation.
- defaultParameters
-
- Type: Associative array of custom strings keys (ParameterName) to strings
Provides the default parameters for feature transformation.
- featureTransformationArn
-
- Type: string
The Amazon Resource Name (ARN) of the FeatureTransformation object.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last update date and time (in Unix time) of the feature transformation.
- name
-
- Type: string
The name of the feature transformation.
- status
-
- Type: string
The status of the feature transformation.
A feature transformation can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
Filter
Description
Contains information on a recommendation filter, including its ARN, status, and filter expression.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the filter was created.
- datasetGroupArn
-
- Type: string
The ARN of the dataset group to which the filter belongs.
- failureReason
-
- Type: string
If the filter failed, the reason for its failure.
- filterArn
-
- Type: string
The ARN of the filter.
- filterExpression
-
- Type: string
Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the filter was last updated.
- name
-
- Type: string
The name of the filter.
- status
-
- Type: string
The status of the filter.
FilterSummary
Description
A short summary of a filter's attributes.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the filter was created.
- datasetGroupArn
-
- Type: string
The ARN of the dataset group to which the filter belongs.
- failureReason
-
- Type: string
If the filter failed, the reason for the failure.
- filterArn
-
- Type: string
The ARN of the filter.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the filter was last updated.
- name
-
- Type: string
The name of the filter.
- status
-
- Type: string
The status of the filter.
HPOConfig
Description
Describes the properties for hyperparameter optimization (HPO).
Members
- algorithmHyperParameterRanges
-
- Type: HyperParameterRanges structure
The hyperparameters and their allowable ranges.
- hpoObjective
-
- Type: HPOObjective structure
The metric to optimize during HPO.
Amazon Personalize doesn't support configuring the
hpoObjectiveat this time. - hpoResourceConfig
-
- Type: HPOResourceConfig structure
Describes the resource configuration for HPO.
HPOObjective
Description
The metric to optimize during hyperparameter optimization (HPO).
Amazon Personalize doesn't support configuring the hpoObjective at this time.
Members
HPOResourceConfig
Description
Describes the resource configuration for hyperparameter optimization (HPO).
Members
- maxNumberOfTrainingJobs
-
- Type: string
The maximum number of training jobs when you create a solution version. The maximum value for
maxNumberOfTrainingJobsis40. - maxParallelTrainingJobs
-
- Type: string
The maximum number of parallel training jobs when you create a solution version. The maximum value for
maxParallelTrainingJobsis10.
HyperParameterRanges
Description
Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.
Members
- categoricalHyperParameterRanges
-
- Type: Array of CategoricalHyperParameterRange structures
The categorical hyperparameters and their ranges.
- continuousHyperParameterRanges
-
- Type: Array of ContinuousHyperParameterRange structures
The continuous hyperparameters and their ranges.
- integerHyperParameterRanges
-
- Type: Array of IntegerHyperParameterRange structures
The integer-valued hyperparameters and their ranges.
IntegerHyperParameterRange
Description
Provides the name and range of an integer-valued hyperparameter.
Members
InvalidInputException
InvalidNextTokenException
LimitExceededException
Description
The limit on the number of requests per second has been exceeded.
Members
OptimizationObjective
Description
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
Members
- itemAttribute
-
- Type: string
The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).
- objectiveSensitivity
-
- Type: string
Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.
Recipe
Description
Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution operation.
Members
- algorithmArn
-
- Type: string
The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the recipe was created.
- description
-
- Type: string
The description of the recipe.
- featureTransformationArn
-
- Type: string
The ARN of the FeatureTransformation object.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the recipe was last updated.
- name
-
- Type: string
The name of the recipe.
- recipeArn
-
- Type: string
The Amazon Resource Name (ARN) of the recipe.
- recipeType
-
- Type: string
One of the following values:
-
PERSONALIZED_RANKING
-
RELATED_ITEMS
-
USER_PERSONALIZATION
- status
-
- Type: string
The status of the recipe.
RecipeSummary
Description
Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the recipe was created.
- domain
-
- Type: string
The domain of the recipe (if the recipe is a Domain dataset group use case).
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the recipe was last updated.
- name
-
- Type: string
The name of the recipe.
- recipeArn
-
- Type: string
The Amazon Resource Name (ARN) of the recipe.
- status
-
- Type: string
The status of the recipe.
Recommender
Description
Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the recommender was created.
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
- failureReason
-
- Type: string
If a recommender fails, the reason behind the failure.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the recommender was last updated.
- latestRecommenderUpdate
-
- Type: RecommenderUpdateSummary structure
Provides a summary of the latest updates to the recommender.
- modelMetrics
-
- Type: Associative array of custom strings keys (MetricName) to doubles
Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
- name
-
- Type: string
The name of the recommender.
- recipeArn
-
- Type: string
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
- recommenderArn
-
- Type: string
The Amazon Resource Name (ARN) of the recommender.
- recommenderConfig
-
- Type: RecommenderConfig structure
The configuration details of the recommender.
- status
-
- Type: string
The status of the recommender.
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
RecommenderConfig
Description
The configuration details of the recommender.
Members
- itemExplorationConfig
-
- Type: Associative array of custom strings keys (ParameterName) to strings
Specifies the exploration configuration hyperparameters, including
explorationWeightandexplorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. ProvideitemExplorationConfigdata only if your recommenders generate personalized recommendations for a user (not popular items or similar items). - minRecommendationRequestsPerSecond
-
- Type: int
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
RecommenderSummary
Description
Provides a summary of the properties of the recommender.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the recommender was created.
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the recommender was last updated.
- name
-
- Type: string
The name of the recommender.
- recipeArn
-
- Type: string
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
- recommenderArn
-
- Type: string
The Amazon Resource Name (ARN) of the recommender.
- recommenderConfig
-
- Type: RecommenderConfig structure
The configuration details of the recommender.
- status
-
- Type: string
The status of the recommender. A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
RecommenderUpdateSummary
Description
Provides a summary of the properties of a recommender update. For a complete listing, call the DescribeRecommender API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix format) that the recommender update was created.
- failureReason
-
- Type: string
If a recommender update fails, the reason behind the failure.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the recommender update was last updated.
- recommenderConfig
-
- Type: RecommenderConfig structure
The configuration details of the recommender update.
- status
-
- Type: string
The status of the recommender update.
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
ResourceAlreadyExistsException
ResourceInUseException
ResourceNotFoundException
S3DataConfig
Description
The configuration details of an Amazon S3 input or output bucket.
Members
Solution
Description
An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.
Members
- autoMLResult
-
- Type: AutoMLResult structure
When
performAutoMLis true, specifies the best recipe found. - creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time (in Unix time) of the solution.
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
- eventType
-
- Type: string
The event type (for example, 'click' or 'like') that is used for training the model. If no
eventTypeis provided, Amazon Personalize uses all interactions for training with equal weight regardless of type. - lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the solution was last updated.
- latestSolutionVersion
-
- Type: SolutionVersionSummary structure
Describes the latest version of the solution, including the status and the ARN.
- name
-
- Type: string
The name of the solution.
- performAutoML
-
- Type: boolean
When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (
recipeArnmust not be specified). When false (the default), Amazon Personalize usesrecipeArnfor training. - performHPO
-
- Type: boolean
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is
false. - recipeArn
-
- Type: string
The ARN of the recipe used to create the solution.
- solutionArn
-
- Type: string
The ARN of the solution.
- solutionConfig
-
- Type: SolutionConfig structure
Describes the configuration properties for the solution.
- status
-
- Type: string
The status of the solution.
A solution can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
SolutionConfig
Description
Describes the configuration properties for the solution.
Members
- algorithmHyperParameters
-
- Type: Associative array of custom strings keys (ParameterName) to strings
Lists the hyperparameter names and ranges.
- autoMLConfig
-
- Type: AutoMLConfig structure
The AutoMLConfig object containing a list of recipes to search when AutoML is performed.
- eventValueThreshold
-
- Type: string
Only events with a value greater than or equal to this threshold are used for training a model.
- featureTransformationParameters
-
- Type: Associative array of custom strings keys (ParameterName) to strings
Lists the feature transformation parameters.
- hpoConfig
-
- Type: HPOConfig structure
Describes the properties for hyperparameter optimization (HPO).
- optimizationObjective
-
- Type: OptimizationObjective structure
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
SolutionSummary
Description
Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the solution was created.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the solution was last updated.
- name
-
- Type: string
The name of the solution.
- solutionArn
-
- Type: string
The Amazon Resource Name (ARN) of the solution.
- status
-
- Type: string
The status of the solution.
A solution can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
SolutionVersion
Description
An object that provides information about a specific version of a Solution in a Custom dataset group.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that this version of the solution was created.
- datasetGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset group providing the training data.
- eventType
-
- Type: string
The event type (for example, 'click' or 'like') that is used for training the model.
- failureReason
-
- Type: string
If training a solution version fails, the reason for the failure.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the solution was last updated.
- performAutoML
-
- Type: boolean
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses
recipeArn. - performHPO
-
- Type: boolean
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is
false. - recipeArn
-
- Type: string
The ARN of the recipe used in the solution.
- solutionArn
-
- Type: string
The ARN of the solution.
- solutionConfig
-
- Type: SolutionConfig structure
Describes the configuration properties for the solution.
- solutionVersionArn
-
- Type: string
The ARN of the solution version.
- status
-
- Type: string
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
-
CREATE STOPPING
-
CREATE STOPPED
- trainingHours
-
- Type: double
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.
- trainingMode
-
- Type: string
The scope of training to be performed when creating the solution version. The
FULLoption trains the solution version based on the entirety of the input solution's training data, while theUPDATEoption processes only the data that has changed in comparison to the input solution. ChooseUPDATEwhen you want to incrementally update your solution version instead of creating an entirely new one.The
UPDATEoption can only be used when you already have an active solution version created from the input solution using theFULLoption and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe. - tunedHPOParams
-
- Type: TunedHPOParams structure
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
SolutionVersionSummary
Description
Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that this version of a solution was created.
- failureReason
-
- Type: string
If a solution version fails, the reason behind the failure.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time (in Unix time) that the solution version was last updated.
- solutionVersionArn
-
- Type: string
The Amazon Resource Name (ARN) of the solution version.
- status
-
- Type: string
The status of the solution version.
A solution version can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
Tag
Description
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
Members
- tagKey
-
- Required: Yes
- Type: string
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
- tagValue
-
- Required: Yes
- Type: string
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
TooManyTagKeysException
Description
The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
Members
TooManyTagsException
Description
You have exceeded the maximum number of tags you can apply to this resource.
Members
TunedHPOParams
Description
If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.