CreateBatchInferenceJob

$result = $client->createBatchInferenceJob([/* ... */]);
$promise = $client->createBatchInferenceJobAsync([/* ... */]);

Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.

To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.

For more information, see Creating a batch inference job .

If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data.

For more information about generating themes, see Batch recommendations with themes from Content Generator .

You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.

Parameter Syntax

$result = $client->createBatchInferenceJob([
    'batchInferenceJobConfig' => [
        'itemExplorationConfig' => ['<string>', ...],
    ],
    'batchInferenceJobMode' => 'BATCH_INFERENCE|THEME_GENERATION',
    '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
        ],
        // ...
    ],
    'themeGenerationConfig' => [
        'fieldsForThemeGeneration' => [ // REQUIRED
            'itemName' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'batchInferenceJobArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

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

Result Syntax

[
    'batchSegmentJobArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

You have exceeded the maximum number of tags you can apply to this resource.

CreateCampaign

$result = $client->createCampaign([/* ... */]);
$promise = $client->createCampaignAsync([/* ... */]);

You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing.

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

When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1.

If your TPS increases beyond the 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. When your traffic reduces, capacity returns to the minProvisionedTPS.

You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

For more information about campaign costs, see Amazon Personalize pricing.

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.

Related APIs

• ListCampaigns

• DescribeCampaign

• UpdateCampaign

• DeleteCampaign

Parameter Syntax

$result = $client->createCampaign([
    'campaignConfig' => [
        'enableMetadataWithRecommendations' => true || false,
        'itemExplorationConfig' => ['<string>', ...],
        'syncWithLatestSolutionVersion' => true || false,
    ],
    'minProvisionedTPS' => <integer>,
    'name' => '<string>', // REQUIRED
    'solutionVersionArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'tagKey' => '<string>', // REQUIRED
            'tagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'campaignArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

You have exceeded the maximum number of tags you can apply to this resource.

CreateDataDeletionJob

$result = $client->createDataDeletionJob([/* ... */]);
$promise = $client->createDataDeletionJobAsync([/* ... */]);

Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users.

• Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information about preparing the CSV file, see Preparing your data deletion file and uploading it to Amazon S3.

• To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs GetObject and ListBucket permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments.

Status

A data deletion job can have one of the following statuses:

• PENDING > IN_PROGRESS > COMPLETED -or- FAILED

To get the status of the data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

• ListDataDeletionJobs

• DescribeDataDeletionJob

Parameter Syntax

$result = $client->createDataDeletionJob([
    'dataSource' => [ // REQUIRED
        'dataLocation' => '<string>',
    ],
    'datasetGroupArn' => '<string>', // REQUIRED
    'jobName' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'tagKey' => '<string>', // REQUIRED
            'tagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'dataDeletionJobArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

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 5 types of datasets:

• Item interactions

• Items

• Users

• Action interactions

• Actions

Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

• CreateDatasetGroup

• ListDatasets

• DescribeDataset

• DeleteDataset

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

Result Syntax

[
    'datasetArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

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

Result Syntax

[
    'datasetExportJobArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

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:

• Item interactions

• Items

• Users

• Actions

• Action interactions

A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.

A dataset group can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

• CreateDataset

• CreateEventTracker

• CreateSolution

Related APIs

• ListDatasetGroups

• DescribeDatasetGroup

• DeleteDatasetGroup

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

Result Syntax

[
    'datasetGroupArn' => '<string>',
    'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

TooManyTagsException:

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.

If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.

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.

Related APIs

• ListDatasetImportJobs

• DescribeDatasetImportJob

Parameter Syntax

$result = $client->createDatasetImportJob([
    'dataSource' => [ // REQUIRED
        'dataLocation' => '<string>',
    ],
    'datasetArn' => '<string>', // REQUIRED
    'importMode' => 'FULL|INCREMENTAL',
    'jobName' => '<string>', // REQUIRED
    'publishAttributionMetricsToS3' => true || false,
    'roleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'tagKey' => '<string>', // REQUIRED
            'tagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'datasetImportJobArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

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.

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.

The event tracker can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

To get the status of the event tracker, call DescribeEventTracker.

Related APIs

• ListEventTrackers

• DescribeEventTracker

• DeleteEventTracker

Parameter Syntax

$result = $client->createEventTracker([
    'datasetGroupArn' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'tagKey' => '<string>', // REQUIRED
            'tagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'eventTrackerArn' => '<string>',
    'trackingId' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

Could not find the specified resource.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

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

Result Syntax

[
    'filterArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

Could not find the specified resource.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

TooManyTagsException:

You have exceeded the maximum number of tags you can apply to this resource.

CreateMetricAttribution

$result = $client->createMetricAttribution([/* ... */]);
$promise = $client->createMetricAttributionAsync([/* ... */]);

Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

Parameter Syntax

$result = $client->createMetricAttribution([
    'datasetGroupArn' => '<string>', // REQUIRED
    'metrics' => [ // REQUIRED
        [
            'eventType' => '<string>', // REQUIRED
            'expression' => '<string>', // REQUIRED
            'metricName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'metricsOutputConfig' => [ // REQUIRED
        'roleArn' => '<string>', // REQUIRED
        's3DataDestination' => [
            'kmsKeyArn' => '<string>',
            'path' => '<string>', // REQUIRED
        ],
    ],
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'metricAttributionArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceInUseException:

The specified resource is in use.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

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.

Related APIs

• ListRecommenders

• DescribeRecommender

• UpdateRecommender

• DeleteRecommender

Parameter Syntax

$result = $client->createRecommender([
    'datasetGroupArn' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'recipeArn' => '<string>', // REQUIRED
    'recommenderConfig' => [
        'enableMetadataWithRecommendations' => true || false,
        'itemExplorationConfig' => ['<string>', ...],
        'minRecommendationRequestsPerSecond' => <integer>,
        'trainingDataConfig' => [
            'excludedDatasetColumns' => [
                '<DatasetType>' => ['<string>', ...],
                // ...
            ],
        ],
    ],
    'tags' => [
        [
            'tagKey' => '<string>', // REQUIRED
            'tagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'recommenderArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

Could not find the specified resource.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

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

• ListSchemas

• DescribeSchema

• DeleteSchema

Parameter Syntax

$result = $client->createSchema([
    'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
    'name' => '<string>', // REQUIRED
    'schema' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'schemaArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

CreateSolution

$result = $client->createSolution([/* ... */]);
$promise = $client->createSolutionAsync([/* ... */]);

By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing.

Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.

By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training.

To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation.

After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

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. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion.

Related APIs

• UpdateSolution

• ListSolutions

• CreateSolutionVersion

• DescribeSolution

• DeleteSolution

• ListSolutionVersions

• DescribeSolutionVersion

Parameter Syntax

$result = $client->createSolution([
    'datasetGroupArn' => '<string>', // REQUIRED
    'eventType' => '<string>',
    'name' => '<string>', // REQUIRED
    'performAutoML' => true || false,
    'performAutoTraining' => true || false,
    'performHPO' => true || false,
    'recipeArn' => '<string>',
    'solutionConfig' => [
        'algorithmHyperParameters' => ['<string>', ...],
        'autoMLConfig' => [
            'metricName' => '<string>',
            'recipeList' => ['<string>', ...],
        ],
        'autoTrainingConfig' => [
            'schedulingExpression' => '<string>',
        ],
        'eventValueThreshold' => '<string>',
        'eventsConfig' => [
            'eventParametersList' => [
                [
                    'eventType' => '<string>',
                    'eventValueThreshold' => <float>,
                    'weight' => <float>,
                ],
                // ...
            ],
        ],
        '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',
        ],
        'trainingDataConfig' => [
            'excludedDatasetColumns' => [
                '<DatasetType>' => ['<string>', ...],
                // ...
            ],
        ],
    ],
    'tags' => [
        [
            'tagKey' => '<string>', // REQUIRED
            'tagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'solutionArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

Could not find the specified resource.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

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

• ListSolutionVersions

• DescribeSolutionVersion

• ListSolutions

• CreateSolution

• DescribeSolution

• DeleteSolution

Parameter Syntax

$result = $client->createSolutionVersion([
    'name' => '<string>',
    'solutionArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'tagKey' => '<string>', // REQUIRED
            'tagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'trainingMode' => 'FULL|UPDATE|AUTOTRAIN',
]);

Parameter Details

Result Syntax

[
    'solutionVersionArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.

TooManyTagsException:

You have exceeded the maximum number of tags you can apply to this resource.

ResourceAlreadyExistsException:

The specified resource already exists.

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

Result Syntax

[]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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 about deleting datasets, see Deleting a dataset.

Parameter Syntax

$result = $client->deleteDataset([
    'datasetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

The specified resource is in use.

DeleteEventTracker

$result = $client->deleteEventTracker([/* ... */]);
$promise = $client->deleteEventTrackerAsync([/* ... */]);

Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.

Parameter Syntax

$result = $client->deleteEventTracker([
    'eventTrackerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

The specified resource is in use.

DeleteMetricAttribution

$result = $client->deleteMetricAttribution([/* ... */]);
$promise = $client->deleteMetricAttributionAsync([/* ... */]);

Deletes a metric attribution.

Parameter Syntax

$result = $client->deleteMetricAttribution([
    'metricAttributionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

Result Syntax

[]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

Result Syntax

[]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

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

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'batchInferenceJob' => [
        'batchInferenceJobArn' => '<string>',
        'batchInferenceJobConfig' => [
            'itemExplorationConfig' => ['<string>', ...],
        ],
        'batchInferenceJobMode' => 'BATCH_INFERENCE|THEME_GENERATION',
        '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>',
        'themeGenerationConfig' => [
            'fieldsForThemeGeneration' => [
                'itemName' => '<string>',
            ],
        ],
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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' => [
            'enableMetadataWithRecommendations' => true || false,
            'itemExplorationConfig' => ['<string>', ...],
            'syncWithLatestSolutionVersion' => true || false,
        ],
        'creationDateTime' => <DateTime>,
        'failureReason' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'latestCampaignUpdate' => [
            'campaignConfig' => [
                'enableMetadataWithRecommendations' => true || false,
                'itemExplorationConfig' => ['<string>', ...],
                'syncWithLatestSolutionVersion' => true || false,
            ],
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'minProvisionedTPS' => <integer>,
            'solutionVersionArn' => '<string>',
            'status' => '<string>',
        ],
        'minProvisionedTPS' => <integer>,
        'name' => '<string>',
        'solutionVersionArn' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

DescribeDataDeletionJob

$result = $client->describeDataDeletionJob([/* ... */]);
$promise = $client->describeDataDeletionJobAsync([/* ... */]);

Describes the data deletion job created by CreateDataDeletionJob, including the job status.

Parameter Syntax

$result = $client->describeDataDeletionJob([
    'dataDeletionJobArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dataDeletionJob' => [
        'creationDateTime' => <DateTime>,
        'dataDeletionJobArn' => '<string>',
        'dataSource' => [
            'dataLocation' => '<string>',
        ],
        'datasetGroupArn' => '<string>',
        'failureReason' => '<string>',
        'jobName' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'numDeleted' => <integer>,
        'roleArn' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'dataset' => [
        'creationDateTime' => <DateTime>,
        'datasetArn' => '<string>',
        'datasetGroupArn' => '<string>',
        'datasetType' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'latestDatasetUpdate' => [
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'schemaArn' => '<string>',
            'status' => '<string>',
        ],
        'name' => '<string>',
        'schemaArn' => '<string>',
        'status' => '<string>',
        'trackingId' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

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

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

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

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'datasetImportJob' => [
        'creationDateTime' => <DateTime>,
        'dataSource' => [
            'dataLocation' => '<string>',
        ],
        'datasetArn' => '<string>',
        'datasetImportJobArn' => '<string>',
        'failureReason' => '<string>',
        'importMode' => 'FULL|INCREMENTAL',
        'jobName' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'publishAttributionMetricsToS3' => true || false,
        'roleArn' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'eventTracker' => [
        'accountId' => '<string>',
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'eventTrackerArn' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'status' => '<string>',
        'trackingId' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'featureTransformation' => [
        'creationDateTime' => <DateTime>,
        'defaultParameters' => ['<string>', ...],
        'featureTransformationArn' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

DescribeMetricAttribution

$result = $client->describeMetricAttribution([/* ... */]);
$promise = $client->describeMetricAttributionAsync([/* ... */]);

Describes a metric attribution.

Parameter Syntax

$result = $client->describeMetricAttribution([
    'metricAttributionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'metricAttribution' => [
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'failureReason' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'metricAttributionArn' => '<string>',
        'metricsOutputConfig' => [
            'roleArn' => '<string>',
            's3DataDestination' => [
                'kmsKeyArn' => '<string>',
                'path' => '<string>',
            ],
        ],
        'name' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'recipe' => [
        'algorithmArn' => '<string>',
        'creationDateTime' => <DateTime>,
        'description' => '<string>',
        'featureTransformationArn' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'recipeArn' => '<string>',
        'recipeType' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'recommender' => [
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'failureReason' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'latestRecommenderUpdate' => [
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'recommenderConfig' => [
                'enableMetadataWithRecommendations' => true || false,
                'itemExplorationConfig' => ['<string>', ...],
                'minRecommendationRequestsPerSecond' => <integer>,
                'trainingDataConfig' => [
                    'excludedDatasetColumns' => [
                        '<DatasetType>' => ['<string>', ...],
                        // ...
                    ],
                ],
            ],
            'status' => '<string>',
        ],
        'modelMetrics' => [<float>, ...],
        'name' => '<string>',
        'recipeArn' => '<string>',
        'recommenderArn' => '<string>',
        'recommenderConfig' => [
            'enableMetadataWithRecommendations' => true || false,
            'itemExplorationConfig' => ['<string>', ...],
            'minRecommendationRequestsPerSecond' => <integer>,
            'trainingDataConfig' => [
                'excludedDatasetColumns' => [
                    '<DatasetType>' => ['<string>', ...],
                    // ...
                ],
            ],
        ],
        'status' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'schema' => [
        'creationDateTime' => <DateTime>,
        'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'schema' => '<string>',
        'schemaArn' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'solution' => [
        'autoMLResult' => [
            'bestRecipeArn' => '<string>',
        ],
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'eventType' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'latestSolutionUpdate' => [
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'performAutoTraining' => true || false,
            'solutionUpdateConfig' => [
                'autoTrainingConfig' => [
                    'schedulingExpression' => '<string>',
                ],
                'eventsConfig' => [
                    'eventParametersList' => [
                        [
                            'eventType' => '<string>',
                            'eventValueThreshold' => <float>,
                            'weight' => <float>,
                        ],
                        // ...
                    ],
                ],
            ],
            'status' => '<string>',
        ],
        'latestSolutionVersion' => [
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'solutionVersionArn' => '<string>',
            'status' => '<string>',
            'trainingMode' => 'FULL|UPDATE|AUTOTRAIN',
            'trainingType' => 'AUTOMATIC|MANUAL',
        ],
        'name' => '<string>',
        'performAutoML' => true || false,
        'performAutoTraining' => true || false,
        'performHPO' => true || false,
        'recipeArn' => '<string>',
        'solutionArn' => '<string>',
        'solutionConfig' => [
            'algorithmHyperParameters' => ['<string>', ...],
            'autoMLConfig' => [
                'metricName' => '<string>',
                'recipeList' => ['<string>', ...],
            ],
            'autoTrainingConfig' => [
                'schedulingExpression' => '<string>',
            ],
            'eventValueThreshold' => '<string>',
            'eventsConfig' => [
                'eventParametersList' => [
                    [
                        'eventType' => '<string>',
                        'eventValueThreshold' => <float>,
                        'weight' => <float>,
                    ],
                    // ...
                ],
            ],
            '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',
            ],
            'trainingDataConfig' => [
                'excludedDatasetColumns' => [
                    '<DatasetType>' => ['<string>', ...],
                    // ...
                ],
            ],
        ],
        'status' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'solutionVersion' => [
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'eventType' => '<string>',
        'failureReason' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'performAutoML' => true || false,
        'performHPO' => true || false,
        'recipeArn' => '<string>',
        'solutionArn' => '<string>',
        'solutionConfig' => [
            'algorithmHyperParameters' => ['<string>', ...],
            'autoMLConfig' => [
                'metricName' => '<string>',
                'recipeList' => ['<string>', ...],
            ],
            'autoTrainingConfig' => [
                'schedulingExpression' => '<string>',
            ],
            'eventValueThreshold' => '<string>',
            'eventsConfig' => [
                'eventParametersList' => [
                    [
                        'eventType' => '<string>',
                        'eventValueThreshold' => <float>,
                        'weight' => <float>,
                    ],
                    // ...
                ],
            ],
            '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',
            ],
            'trainingDataConfig' => [
                'excludedDatasetColumns' => [
                    '<DatasetType>' => ['<string>', ...],
                    // ...
                ],
            ],
        ],
        'solutionVersionArn' => '<string>',
        'status' => '<string>',
        'trainingHours' => <float>,
        'trainingMode' => 'FULL|UPDATE|AUTOTRAIN',
        'trainingType' => 'AUTOMATIC|MANUAL',
        'tunedHPOParams' => [
            'algorithmHyperParameters' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

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

Result Syntax

[
    'metrics' => [<float>, ...],
    'solutionVersionArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

Result Syntax

[
    'batchInferenceJobs' => [
        [
            'batchInferenceJobArn' => '<string>',
            'batchInferenceJobMode' => 'BATCH_INFERENCE|THEME_GENERATION',
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'jobName' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'solutionVersionArn' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Result Syntax

[
    'batchSegmentJobs' => [
        [
            'batchSegmentJobArn' => '<string>',
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'jobName' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'solutionVersionArn' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Result Syntax

[
    'campaigns' => [
        [
            'campaignArn' => '<string>',
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

The token is not valid.

ListDataDeletionJobs

$result = $client->listDataDeletionJobs([/* ... */]);
$promise = $client->listDataDeletionJobsAsync([/* ... */]);

Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.

Parameter Syntax

$result = $client->listDataDeletionJobs([
    'datasetGroupArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'dataDeletionJobs' => [
        [
            'creationDateTime' => <DateTime>,
            'dataDeletionJobArn' => '<string>',
            'datasetGroupArn' => '<string>',
            'failureReason' => '<string>',
            'jobName' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Result Syntax

[
    'datasetExportJobs' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetExportJobArn' => '<string>',
            'failureReason' => '<string>',
            'jobName' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Result Syntax

[
    'datasetGroups' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetGroupArn' => '<string>',
            'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidNextTokenException:

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

Result Syntax

[
    'datasetImportJobs' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetImportJobArn' => '<string>',
            'failureReason' => '<string>',
            'importMode' => 'FULL|INCREMENTAL',
            'jobName' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Result Syntax

[
    'datasets' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetArn' => '<string>',
            'datasetType' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Result Syntax

[
    'eventTrackers' => [
        [
            'creationDateTime' => <DateTime>,
            'eventTrackerArn' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Result Syntax

[
    'Filters' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetGroupArn' => '<string>',
            'failureReason' => '<string>',
            'filterArn' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

The token is not valid.

ListMetricAttributionMetrics

$result = $client->listMetricAttributionMetrics([/* ... */]);
$promise = $client->listMetricAttributionMetricsAsync([/* ... */]);

Lists the metrics for the metric attribution.

Parameter Syntax

$result = $client->listMetricAttributionMetrics([
    'maxResults' => <integer>,
    'metricAttributionArn' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'metrics' => [
        [
            'eventType' => '<string>',
            'expression' => '<string>',
            'metricName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

The token is not valid.

ListMetricAttributions

$result = $client->listMetricAttributions([/* ... */]);
$promise = $client->listMetricAttributionsAsync([/* ... */]);

Lists metric attributions.

Parameter Syntax

$result = $client->listMetricAttributions([
    'datasetGroupArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'metricAttributions' => [
        [
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'metricAttributionArn' => '<string>',
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'recipes' => [
        [
            'creationDateTime' => <DateTime>,
            'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'recipeArn' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidNextTokenException:

The token is not valid.

InvalidInputException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'recommenders' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetGroupArn' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'recipeArn' => '<string>',
            'recommenderArn' => '<string>',
            'recommenderConfig' => [
                'enableMetadataWithRecommendations' => true || false,
                'itemExplorationConfig' => ['<string>', ...],
                'minRecommendationRequestsPerSecond' => <integer>,
                'trainingDataConfig' => [
                    'excludedDatasetColumns' => [
                        '<DatasetType>' => ['<string>', ...],
                        // ...
                    ],
                ],
            ],
            'status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'schemas' => [
        [
            'creationDateTime' => <DateTime>,
            'domain' => 'ECOMMERCE|VIDEO_ON_DEMAND',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'schemaArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidNextTokenException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'solutionVersions' => [
        [
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'solutionVersionArn' => '<string>',
            'status' => '<string>',
            'trainingMode' => 'FULL|UPDATE|AUTOTRAIN',
            'trainingType' => 'AUTOMATIC|MANUAL',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

InvalidNextTokenException:

The token is not valid.

ListSolutions

$result = $client->listSolutions([/* ... */]);
$promise = $client->listSolutionsAsync([/* ... */]);

Returns a list of solutions in a 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

Result Syntax

[
    'nextToken' => '<string>',
    'solutions' => [
        [
            'creationDateTime' => <DateTime>,
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'recipeArn' => '<string>',
            'solutionArn' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

InvalidNextTokenException:

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

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

Result Syntax

[
    'recommenderArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

Result Syntax

[
    'recommenderArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

Result Syntax

[]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

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

Result Syntax

[]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

TooManyTagsException:

You have exceeded the maximum number of tags you can apply to this resource.

ResourceInUseException:

The specified resource is in use.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

TooManyTagKeysException:

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

ResourceInUseException:

The specified resource is in use.

UpdateCampaign

$result = $client->updateCampaign([/* ... */]);
$promise = $client->updateCampaignAsync([/* ... */]);

Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.

To update a campaign to start automatically using the latest solution version, specify the following:

• For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in SolutionArn/$LATEST format.

• In the campaignConfig, set syncWithLatestSolutionVersion to true.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.

For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.

Parameter Syntax

$result = $client->updateCampaign([
    'campaignArn' => '<string>', // REQUIRED
    'campaignConfig' => [
        'enableMetadataWithRecommendations' => true || false,
        'itemExplorationConfig' => ['<string>', ...],
        'syncWithLatestSolutionVersion' => true || false,
    ],
    'minProvisionedTPS' => <integer>,
    'solutionVersionArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'campaignArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

The specified resource is in use.

UpdateDataset

$result = $client->updateDataset([/* ... */]);
$promise = $client->updateDatasetAsync([/* ... */]);

Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.

Parameter Syntax

$result = $client->updateDataset([
    'datasetArn' => '<string>', // REQUIRED
    'schemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'datasetArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

The specified resource is in use.

UpdateMetricAttribution

$result = $client->updateMetricAttribution([/* ... */]);
$promise = $client->updateMetricAttributionAsync([/* ... */]);

Updates a metric attribution.

Parameter Syntax

$result = $client->updateMetricAttribution([
    'addMetrics' => [
        [
            'eventType' => '<string>', // REQUIRED
            'expression' => '<string>', // REQUIRED
            'metricName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'metricAttributionArn' => '<string>',
    'metricsOutputConfig' => [
        'roleArn' => '<string>', // REQUIRED
        's3DataDestination' => [
            'kmsKeyArn' => '<string>',
            'path' => '<string>', // REQUIRED
        ],
    ],
    'removeMetrics' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'metricAttributionArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

The specified resource is in use.

ResourceAlreadyExistsException:

The specified resource already exists.

UpdateRecommender

$result = $client->updateRecommender([/* ... */]);
$promise = $client->updateRecommenderAsync([/* ... */]);

Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.

Parameter Syntax

$result = $client->updateRecommender([
    'recommenderArn' => '<string>', // REQUIRED
    'recommenderConfig' => [ // REQUIRED
        'enableMetadataWithRecommendations' => true || false,
        'itemExplorationConfig' => ['<string>', ...],
        'minRecommendationRequestsPerSecond' => <integer>,
        'trainingDataConfig' => [
            'excludedDatasetColumns' => [
                '<DatasetType>' => ['<string>', ...],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'recommenderArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

The specified resource is in use.

UpdateSolution

$result = $client->updateSolution([/* ... */]);
$promise = $client->updateSolutionAsync([/* ... */]);

Updates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution uses automatic training, and you can change the training frequency. For more information about updating a solution, see Updating a solution.

A solution update can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of a solution update, call the DescribeSolution API operation and find the status in the latestSolutionUpdate.

Parameter Syntax

$result = $client->updateSolution([
    'performAutoTraining' => true || false,
    'solutionArn' => '<string>', // REQUIRED
    'solutionUpdateConfig' => [
        'autoTrainingConfig' => [
            'schedulingExpression' => '<string>',
        ],
        'eventsConfig' => [
            'eventParametersList' => [
                [
                    'eventType' => '<string>',
                    'eventValueThreshold' => <float>,
                    'weight' => <float>,
                ],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'solutionArn' => '<string>',
]

Result Details

Errors

InvalidInputException:

Provide a valid value for the field or parameter.

ResourceNotFoundException:

Could not find the specified resource.

ResourceInUseException:

The specified resource is in use.

LimitExceededException:

The limit on the number of requests per second has been exceeded.

ResourceInUseException:

The specified resource is in use.