Personalize

create_batch_inference_job(job_input, job_name, job_output, role_arn, solution_version_arn)
create_batch_inference_job(job_input, job_name, job_output, role_arn, solution_version_arn, params::Dict{String,<:Any})

Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.

Arguments

• job_input: The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
• job_name: The name of the batch inference job to create.
• job_output: The path to the Amazon S3 bucket where the job's output will be stored.
• role_arn: The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
• solution_version_arn: The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "batchInferenceJobConfig": The configuration details of a batch inference job.
• "filterArn": The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering Batch Recommendations..
• "numResults": The number of recommendations to retreive.

create_campaign(min_provisioned_tps, name, solution_version_arn)
create_campaign(min_provisioned_tps, name, solution_version_arn, params::Dict{String,<:Any})

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request. Minimum Provisioned TPS and Auto-Scaling A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions. The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary. Status A campaign can be in one of the following states: CREATE PENDING > CREATE INPROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE INPROGRESS To get the campaign status, call DescribeCampaign. Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations. Related APIs ListCampaigns DescribeCampaign UpdateCampaign DeleteCampaign

Arguments

• min_provisioned_tps: Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
• name: A name for the new campaign. The campaign name must be unique within your account.
• solution_version_arn: The Amazon Resource Name (ARN) of the solution version to deploy.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "campaignConfig": The configuration details of a campaign.

create_dataset(dataset_group_arn, dataset_type, name, schema_arn)
create_dataset(dataset_group_arn, dataset_type, name, schema_arn, params::Dict{String,<:Any})

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are three types of datasets: Interactions Items Users Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution). A dataset can be in one of the following states: CREATE PENDING > CREATE INPROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE INPROGRESS To get the status of the dataset, call DescribeDataset. Related APIs CreateDatasetGroup ListDatasets DescribeDataset DeleteDataset

Arguments

• dataset_group_arn: The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
• dataset_type: The type of dataset. One of the following (case insensitive) values: Interactions Items Users
• name: The name for the dataset.
• schema_arn: The ARN of the schema to associate with the dataset. The schema defines the dataset fields.

create_dataset_export_job(dataset_arn, job_name, job_output, role_arn)
create_dataset_export_job(dataset_arn, job_name, job_output, role_arn, params::Dict{String,<:Any})

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 AWS Identity and Access Management (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.

Arguments

• dataset_arn: The Amazon Resource Name (ARN) of the dataset that contains the data to export.
• job_name: The name for the dataset export job.
• job_output: The path to the Amazon S3 bucket where the job's output is stored.
• role_arn: The Amazon Resource Name (ARN) of the AWS Identity and Access Management service role that has permissions to add data to your output Amazon S3 bucket.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ingestionMode": The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

create_dataset_group(name)
create_dataset_group(name, params::Dict{String,<:Any})

Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup

Arguments

• name: The name for the new dataset group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "kmsKeyArn": The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.
• "roleArn": The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM role is only valid when also specifying a KMS key.

create_dataset_import_job(data_source, dataset_arn, job_name, role_arn)
create_dataset_import_job(data_source, dataset_arn, job_name, role_arn, params::Dict{String,<:Any})

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. The dataset import job replaces any existing data in the dataset that you imported in bulk. Status A dataset import job can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob

Arguments

• data_source: The Amazon S3 bucket that contains the training data to import.
• dataset_arn: The ARN of the dataset that receives the imported data.
• job_name: The name for the dataset import job.
• role_arn: The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

create_event_tracker(dataset_group_arn, name)
create_event_tracker(dataset_group_arn, name, params::Dict{String,<:Any})

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker. When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker. The event tracker can be in one of the following states: CREATE PENDING > CREATE INPROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE INPROGRESS To get the status of the event tracker, call DescribeEventTracker. The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs ListEventTrackers DescribeEventTracker DeleteEventTracker

Arguments

• dataset_group_arn: The Amazon Resource Name (ARN) of the dataset group that receives the event data.
• name: The name for the event tracker.

create_filter(dataset_group_arn, filter_expression, name)
create_filter(dataset_group_arn, filter_expression, name, params::Dict{String,<:Any})

Creates a recommendation filter. For more information, see filter.

Arguments

• dataset_group_arn: The ARN of the dataset group that the filter will belong to.
• filter_expression: The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.
• name: The name of the filter to create.

create_schema(name, schema)
create_schema(name, schema, params::Dict{String,<:Any})

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset. Related APIs ListSchemas DescribeSchema DeleteSchema

Arguments

• name: The name for the schema.
• schema: A schema in Avro JSON format.

create_solution(dataset_group_arn, name)
create_solution(dataset_group_arn, name, params::Dict{String,<:Any})

Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created. After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API. To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USERPERSONALIZATION recipe for you. Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time. Status A solution can be in one of the following states: CREATE PENDING > CREATE INPROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE IN_PROGRESS To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion. Related APIs ListSolutions CreateSolutionVersion DescribeSolution DeleteSolution ListSolutionVersions DescribeSolutionVersion

Arguments

• dataset_group_arn: The Amazon Resource Name (ARN) of the dataset group that provides the training data.
• name: The name for the solution.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "eventType": When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model. If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.
• "performAutoML": Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn. When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
• "performHPO": Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false.
• "recipeArn": The ARN of the recipe to use for model training. Only specified when performAutoML is false.
• "solutionConfig": The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration. Amazon Personalize doesn't support configuring the hpoObjective at this time.

create_solution_version(solution_arn)
create_solution_version(solution_arn, params::Dict{String,<:Any})

Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation. Status A solution version can be in one of the following states: CREATE PENDING 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

Arguments

• solution_arn: The Amazon Resource Name (ARN) of the solution containing the training configuration information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "trainingMode": The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one. The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

delete_campaign(campaign_arn)
delete_campaign(campaign_arn, params::Dict{String,<:Any})

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.

Arguments

• campaign_arn: The Amazon Resource Name (ARN) of the campaign to delete.

delete_dataset(dataset_arn)
delete_dataset(dataset_arn, params::Dict{String,<:Any})

Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

Arguments

• dataset_arn: The Amazon Resource Name (ARN) of the dataset to delete.

delete_dataset_group(dataset_group_arn)
delete_dataset_group(dataset_group_arn, params::Dict{String,<:Any})

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.

Arguments

• dataset_group_arn: The ARN of the dataset group to delete.

delete_event_tracker(event_tracker_arn)
delete_event_tracker(event_tracker_arn, params::Dict{String,<:Any})

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

Arguments

• event_tracker_arn: The Amazon Resource Name (ARN) of the event tracker to delete.

delete_filter(filter_arn)
delete_filter(filter_arn, params::Dict{String,<:Any})

Deletes a filter.

Arguments

• filter_arn: The ARN of the filter to delete.

delete_schema(schema_arn)
delete_schema(schema_arn, params::Dict{String,<:Any})

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

Arguments

• schema_arn: The Amazon Resource Name (ARN) of the schema to delete.

delete_solution(solution_arn)
delete_solution(solution_arn, params::Dict{String,<:Any})

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.

Arguments

• solution_arn: The ARN of the solution to delete.

describe_algorithm(algorithm_arn)
describe_algorithm(algorithm_arn, params::Dict{String,<:Any})

Describes the given algorithm.

Arguments

• algorithm_arn: The Amazon Resource Name (ARN) of the algorithm to describe.

describe_batch_inference_job(batch_inference_job_arn)
describe_batch_inference_job(batch_inference_job_arn, params::Dict{String,<:Any})

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.

Arguments

• batch_inference_job_arn: The ARN of the batch inference job to describe.

describe_campaign(campaign_arn)
describe_campaign(campaign_arn, params::Dict{String,<:Any})

Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING > CREATE INPROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING > DELETE INPROGRESS When the status is CREATE FAILED, the response includes the failureReason key, which describes why. For more information on campaigns, see CreateCampaign.

Arguments

• campaign_arn: The Amazon Resource Name (ARN) of the campaign.

describe_dataset(dataset_arn)
describe_dataset(dataset_arn, params::Dict{String,<:Any})

Describes the given dataset. For more information on datasets, see CreateDataset.

Arguments

• dataset_arn: The Amazon Resource Name (ARN) of the dataset to describe.

describe_dataset_export_job(dataset_export_job_arn)
describe_dataset_export_job(dataset_export_job_arn, params::Dict{String,<:Any})

Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

Arguments

• dataset_export_job_arn: The Amazon Resource Name (ARN) of the dataset export job to describe.

describe_dataset_group(dataset_group_arn)
describe_dataset_group(dataset_group_arn, params::Dict{String,<:Any})

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

Arguments

• dataset_group_arn: The Amazon Resource Name (ARN) of the dataset group to describe.

describe_dataset_import_job(dataset_import_job_arn)
describe_dataset_import_job(dataset_import_job_arn, params::Dict{String,<:Any})

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

Arguments

• dataset_import_job_arn: The Amazon Resource Name (ARN) of the dataset import job to describe.

describe_event_tracker(event_tracker_arn)
describe_event_tracker(event_tracker_arn, params::Dict{String,<:Any})

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

Arguments

• event_tracker_arn: The Amazon Resource Name (ARN) of the event tracker to describe.

describe_feature_transformation(feature_transformation_arn)
describe_feature_transformation(feature_transformation_arn, params::Dict{String,<:Any})

Describes the given feature transformation.

Arguments

• feature_transformation_arn: The Amazon Resource Name (ARN) of the feature transformation to describe.

describe_filter(filter_arn)
describe_filter(filter_arn, params::Dict{String,<:Any})

Describes a filter's properties.

Arguments

• filter_arn: The ARN of the filter to describe.

describe_recipe(recipe_arn)
describe_recipe(recipe_arn, params::Dict{String,<:Any})

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.

Arguments

• recipe_arn: The Amazon Resource Name (ARN) of the recipe to describe.

describe_schema(schema_arn)
describe_schema(schema_arn, params::Dict{String,<:Any})

Describes a schema. For more information on schemas, see CreateSchema.

Arguments

• schema_arn: The Amazon Resource Name (ARN) of the schema to retrieve.

describe_solution(solution_arn)
describe_solution(solution_arn, params::Dict{String,<:Any})

Describes a solution. For more information on solutions, see CreateSolution.

Arguments

• solution_arn: The Amazon Resource Name (ARN) of the solution to describe.

describe_solution_version(solution_version_arn)
describe_solution_version(solution_version_arn, params::Dict{String,<:Any})

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

Arguments

• solution_version_arn: The Amazon Resource Name (ARN) of the solution version.

get_solution_metrics(solution_version_arn)
get_solution_metrics(solution_version_arn, params::Dict{String,<:Any})

Gets the metrics for the specified solution version.

Arguments

• solution_version_arn: The Amazon Resource Name (ARN) of the solution version for which to get metrics.

list_batch_inference_jobs()
list_batch_inference_jobs(params::Dict{String,<:Any})

Gets a list of the batch inference jobs that have been performed off of a solution version.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of batch inference job results to return in each page. The default value is 100.
• "nextToken": The token to request the next page of results.
• "solutionVersionArn": The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.

list_campaigns()
list_campaigns(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of campaigns to return.
• "nextToken": A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
• "solutionArn": The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.

list_dataset_export_jobs()
list_dataset_export_jobs(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "datasetArn": The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.
• "maxResults": The maximum number of dataset export jobs to return.
• "nextToken": A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).

list_dataset_groups()
list_dataset_groups(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of dataset groups to return.
• "nextToken": A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).

list_dataset_import_jobs()
list_dataset_import_jobs(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "datasetArn": The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.
• "maxResults": The maximum number of dataset import jobs to return.
• "nextToken": A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

list_datasets()
list_datasets(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "datasetGroupArn": The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
• "maxResults": The maximum number of datasets to return.
• "nextToken": A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

list_event_trackers()
list_event_trackers(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "datasetGroupArn": The ARN of a dataset group used to filter the response.
• "maxResults": The maximum number of event trackers to return.
• "nextToken": A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).

list_filters()
list_filters(params::Dict{String,<:Any})

Lists all filters that belong to a given dataset group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "datasetGroupArn": The ARN of the dataset group that contains the filters.
• "maxResults": The maximum number of filters to return.
• "nextToken": A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).

list_recipes()
list_recipes(params::Dict{String,<:Any})

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of recipes to return.
• "nextToken": A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
• "recipeProvider": The default is SERVICE.

list_schemas()
list_schemas(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of schemas to return.
• "nextToken": A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).

list_solution_versions()
list_solution_versions(params::Dict{String,<:Any})

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of solution versions to return.
• "nextToken": A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).
• "solutionArn": The Amazon Resource Name (ARN) of the solution.

list_solutions()
list_solutions(params::Dict{String,<:Any})

Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "datasetGroupArn": The Amazon Resource Name (ARN) of the dataset group.
• "maxResults": The maximum number of solutions to return.
• "nextToken": A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).

stop_solution_version_creation(solution_version_arn)
stop_solution_version_creation(solution_version_arn, params::Dict{String,<:Any})

Stops creating a solution version that is in a state of CREATEPENDING or CREATE INPROGRESS. Depending on the current state of the solution version, the solution version state changes as follows: CREATEPENDING > CREATESTOPPED or CREATEINPROGRESS > CREATESTOPPING > CREATESTOPPED 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.

Arguments

• solution_version_arn: The Amazon Resource Name (ARN) of the solution version you want to stop creating.

update_campaign(campaign_arn)
update_campaign(campaign_arn, params::Dict{String,<:Any})

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter. To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API. You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations. For more information on campaigns, see CreateCampaign.

Arguments

• campaign_arn: The Amazon Resource Name (ARN) of the campaign.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "campaignConfig": The configuration details of a campaign.
• "minProvisionedTPS": Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
• "solutionVersionArn": The ARN of a new solution version to deploy.