Table of Contents
Personalize.Client¶A low-level client representing Amazon Personalize
Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
import boto3
client = boto3.client('personalize')
These are the available methods:
can_paginate()close()create_batch_inference_job()create_batch_segment_job()create_campaign()create_dataset()create_dataset_export_job()create_dataset_group()create_dataset_import_job()create_event_tracker()create_filter()create_metric_attribution()create_recommender()create_schema()create_solution()create_solution_version()delete_campaign()delete_dataset()delete_dataset_group()delete_event_tracker()delete_filter()delete_metric_attribution()delete_recommender()delete_schema()delete_solution()describe_algorithm()describe_batch_inference_job()describe_batch_segment_job()describe_campaign()describe_dataset()describe_dataset_export_job()describe_dataset_group()describe_dataset_import_job()describe_event_tracker()describe_feature_transformation()describe_filter()describe_metric_attribution()describe_recipe()describe_recommender()describe_schema()describe_solution()describe_solution_version()get_paginator()get_solution_metrics()get_waiter()list_batch_inference_jobs()list_batch_segment_jobs()list_campaigns()list_dataset_export_jobs()list_dataset_groups()list_dataset_import_jobs()list_datasets()list_event_trackers()list_filters()list_metric_attribution_metrics()list_metric_attributions()list_recipes()list_recommenders()list_schemas()list_solution_versions()list_solutions()list_tags_for_resource()start_recommender()stop_recommender()stop_solution_version_creation()tag_resource()untag_resource()update_campaign()update_metric_attribution()update_recommender()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_batch_inference_job(**kwargs)¶Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Creating a batch inference job.
See also: AWS API Documentation
Request Syntax
response = client.create_batch_inference_job(
jobName='string',
solutionVersionArn='string',
filterArn='string',
numResults=123,
jobInput={
's3DataSource': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
jobOutput={
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
roleArn='string',
batchInferenceJobConfig={
'itemExplorationConfig': {
'string': 'string'
}
},
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The name of the batch inference job to create.
[REQUIRED]
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
[REQUIRED]
The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
[REQUIRED]
The path to the Amazon S3 bucket where the job's output will be stored.
Information on the Amazon S3 bucket in which the batch inference job's output is stored.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
[REQUIRED]
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.
The configuration details of a batch inference job.
A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.
A list of tags to apply to the batch inference job.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'batchInferenceJobArn': 'string'
}
Response Structure
(dict) --
batchInferenceJobArn (string) --
The ARN of the batch inference job.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_batch_segment_job(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_batch_segment_job(
jobName='string',
solutionVersionArn='string',
filterArn='string',
numResults=123,
jobInput={
's3DataSource': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
jobOutput={
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
roleArn='string',
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The name of the batch segment job to create.
[REQUIRED]
The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
[REQUIRED]
The Amazon S3 path for the input data used to generate the batch segment job.
The configuration details of an Amazon S3 input or output bucket.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
[REQUIRED]
The Amazon S3 path for the bucket where the job's output will be stored.
The configuration details of an Amazon S3 input or output bucket.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
[REQUIRED]
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.
A list of tags to apply to the batch segment job.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'batchSegmentJobArn': 'string'
}
Response Structure
(dict) --
batchSegmentJobArn (string) --
The ARN of the batch segment job.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_campaign(**kwargs)¶Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
Minimum Provisioned TPS and Auto-Scaling
A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS ( minProvisionedTPS ) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.
If your TPS increases beyond minProvisionedTPS , Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS . There's a short time delay while the capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS , track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.
Status
A campaign can be in one of the following states:
To get the campaign status, call DescribeCampaign.
Note
Wait until thestatusof the campaign isACTIVEbefore asking the campaign for recommendations.
Related APIs
See also: AWS API Documentation
Request Syntax
response = client.create_campaign(
name='string',
solutionVersionArn='string',
minProvisionedTPS=123,
campaignConfig={
'itemExplorationConfig': {
'string': 'string'
}
},
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
A name for the new campaign. The campaign name must be unique within your account.
[REQUIRED]
The Amazon Resource Name (ARN) of the solution version to deploy.
The configuration details of a campaign.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.
A list of tags to apply to the campaign.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'campaignArn': 'string'
}
Response Structure
(dict) --
campaignArn (string) --
The Amazon Resource Name (ARN) of the campaign.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_dataset(**kwargs)¶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:
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:
To get the status of the dataset, call DescribeDataset.
Related APIs
See also: AWS API Documentation
Request Syntax
response = client.create_dataset(
name='string',
schemaArn='string',
datasetGroupArn='string',
datasetType='string',
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The name for the dataset.
[REQUIRED]
The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
[REQUIRED]
The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
[REQUIRED]
The type of dataset.
One of the following (case insensitive) values:
A list of tags to apply to the dataset.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'datasetArn': 'string'
}
Response Structure
(dict) --
datasetArn (string) --
The ARN of the dataset.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_dataset_export_job(**kwargs)¶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:
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.
See also: AWS API Documentation
Request Syntax
response = client.create_dataset_export_job(
jobName='string',
datasetArn='string',
ingestionMode='BULK'|'PUT'|'ALL',
roleArn='string',
jobOutput={
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The name for the dataset export job.
[REQUIRED]
The Amazon Resource Name (ARN) of the dataset that contains the data to export.
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 .[REQUIRED]
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
[REQUIRED]
The path to the Amazon S3 bucket where the job's output is stored.
The configuration details of an Amazon S3 input or output bucket.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
A list of tags to apply to the dataset export job.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'datasetExportJobArn': 'string'
}
Response Structure
(dict) --
datasetExportJobArn (string) --
The Amazon Resource Name (ARN) of the dataset export job.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_dataset_group(**kwargs)¶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:
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:
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.
Note
You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
See also: AWS API Documentation
Request Syntax
response = client.create_dataset_group(
name='string',
roleArn='string',
kmsKeyArn='string',
domain='ECOMMERCE'|'VIDEO_ON_DEMAND',
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The name for the new dataset group.
A list of tags to apply to the dataset group.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'datasetGroupArn': 'string',
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
}
Response Structure
(dict) --
datasetGroupArn (string) --
The Amazon Resource Name (ARN) of the new dataset group.
domain (string) --
The domain for the new Domain dataset group.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_dataset_import_job(**kwargs)¶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.
Warning
By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.
Status
A dataset import job can be in one of the following states:
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.
Note
Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
Related APIs
See also: AWS API Documentation
Request Syntax
response = client.create_dataset_import_job(
jobName='string',
datasetArn='string',
dataSource={
'dataLocation': 'string'
},
roleArn='string',
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
],
importMode='FULL'|'INCREMENTAL',
publishAttributionMetricsToS3=True|False
)
[REQUIRED]
The name for the dataset import job.
[REQUIRED]
The ARN of the dataset that receives the imported data.
[REQUIRED]
The Amazon S3 bucket that contains the training data to import.
The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example:
s3://bucket-name/folder-name/
[REQUIRED]
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
A list of tags to apply to the dataset import job.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
Specify how to add the new records to an existing dataset. The default import mode is FULL . If you haven't imported bulk records into the dataset previously, you can only specify FULL .
FULL to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced.INCREMENTAL to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.dict
Response Syntax
{
'datasetImportJobArn': 'string'
}
Response Structure
(dict) --
datasetImportJobArn (string) --
The ARN of the dataset import job.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_event_tracker(**kwargs)¶Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
Note
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:
To get the status of the event tracker, call DescribeEventTracker.
Note
The event tracker must be in the ACTIVE state before using the tracking ID.
Related APIs
See also: AWS API Documentation
Request Syntax
response = client.create_event_tracker(
name='string',
datasetGroupArn='string',
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The name for the event tracker.
[REQUIRED]
The Amazon Resource Name (ARN) of the dataset group that receives the event data.
A list of tags to apply to the event tracker.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'eventTrackerArn': 'string',
'trackingId': 'string'
}
Response Structure
(dict) --
eventTrackerArn (string) --
The ARN of the event tracker.
trackingId (string) --
The ID of the event tracker. Include this ID in requests to the PutEvents API.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_filter(**kwargs)¶Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
See also: AWS API Documentation
Request Syntax
response = client.create_filter(
name='string',
datasetGroupArn='string',
filterExpression='string',
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The name of the filter to create.
[REQUIRED]
The ARN of the dataset group that the filter will belong to.
[REQUIRED]
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.
A list of tags to apply to the filter.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'filterArn': 'string'
}
Response Structure
(dict) --
filterArn (string) --
The ARN of the new filter.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_metric_attribution(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_metric_attribution(
name='string',
datasetGroupArn='string',
metrics=[
{
'eventType': 'string',
'metricName': 'string',
'expression': 'string'
},
],
metricsOutputConfig={
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
},
'roleArn': 'string'
}
)
[REQUIRED]
A name for the metric attribution.
[REQUIRED]
The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.
[REQUIRED]
A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT() . For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.
The metric's event type.
The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
The attribute's expression. Available functions are SUM() or SAMPLECOUNT() . For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
[REQUIRED]
The output configuration details for the metric attribution.
The configuration details of an Amazon S3 input or output bucket.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.
dict
Response Syntax
{
'metricAttributionArn': 'string'
}
Response Structure
(dict) --
metricAttributionArn (string) --
The Amazon Resource Name (ARN) for the new metric attribution.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.LimitExceededExceptioncreate_recommender(**kwargs)¶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:
To get the recommender status, call DescribeRecommender.
Note
Wait until thestatusof the recommender isACTIVEbefore asking the recommender for recommendations.
Related APIs
See also: AWS API Documentation
Request Syntax
response = client.create_recommender(
name='string',
datasetGroupArn='string',
recipeArn='string',
recommenderConfig={
'itemExplorationConfig': {
'string': 'string'
},
'minRecommendationRequestsPerSecond': 123
},
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The name of the recommender.
[REQUIRED]
The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
[REQUIRED]
The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.
The configuration details of the recommender.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
A list of tags to apply to the recommender.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'recommenderArn': 'string'
}
Response Structure
(dict) --
recommenderArn (string) --
The Amazon Resource Name (ARN) of the recommender.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_schema(**kwargs)¶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
See also: AWS API Documentation
Request Syntax
response = client.create_schema(
name='string',
schema='string',
domain='ECOMMERCE'|'VIDEO_ON_DEMAND'
)
[REQUIRED]
The name for the schema.
[REQUIRED]
A schema in Avro JSON format.
dict
Response Syntax
{
'schemaArn': 'string'
}
Response Structure
(dict) --
schemaArn (string) --
The Amazon Resource Name (ARN) of the created schema.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.LimitExceededExceptioncreate_solution(**kwargs)¶Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion , a new version of the solution is created.
After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.
Note
Amazon Personalize doesn't support configuring thehpoObjectivefor solution hyperparameter optimization at this time.
Status
A solution can be in one of the following states:
To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion .
Related APIs
See also: AWS API Documentation
Request Syntax
response = client.create_solution(
name='string',
performHPO=True|False,
performAutoML=True|False,
recipeArn='string',
datasetGroupArn='string',
eventType='string',
solutionConfig={
'eventValueThreshold': 'string',
'hpoConfig': {
'hpoObjective': {
'type': 'string',
'metricName': 'string',
'metricRegex': 'string'
},
'hpoResourceConfig': {
'maxNumberOfTrainingJobs': 'string',
'maxParallelTrainingJobs': 'string'
},
'algorithmHyperParameterRanges': {
'integerHyperParameterRanges': [
{
'name': 'string',
'minValue': 123,
'maxValue': 123
},
],
'continuousHyperParameterRanges': [
{
'name': 'string',
'minValue': 123.0,
'maxValue': 123.0
},
],
'categoricalHyperParameterRanges': [
{
'name': 'string',
'values': [
'string',
]
},
]
}
},
'algorithmHyperParameters': {
'string': 'string'
},
'featureTransformationParameters': {
'string': 'string'
},
'autoMLConfig': {
'metricName': 'string',
'recipeList': [
'string',
]
},
'optimizationObjective': {
'itemAttribute': 'string',
'objectiveSensitivity': 'LOW'|'MEDIUM'|'HIGH'|'OFF'
}
},
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The name for the solution.
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 .
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.
performAutoML is false.[REQUIRED]
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
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.
The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.
Note
Amazon Personalize doesn't support configuring the hpoObjective at this time.
Only events with a value greater than or equal to this threshold are used for training a model.
Describes the properties for hyperparameter optimization (HPO).
The metric to optimize during HPO.
Note
Amazon Personalize doesn't support configuring the hpoObjective at this time.
The type of the metric. Valid values are Maximize and Minimize .
The name of the metric.
A regular expression for finding the metric in the training job logs.
Describes the resource configuration for HPO.
The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40 .
The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10 .
The hyperparameters and their allowable ranges.
The integer-valued hyperparameters and their ranges.
Provides the name and range of an integer-valued hyperparameter.
The name of the hyperparameter.
The minimum allowable value for the hyperparameter.
The maximum allowable value for the hyperparameter.
The continuous hyperparameters and their ranges.
Provides the name and range of a continuous hyperparameter.
The name of the hyperparameter.
The minimum allowable value for the hyperparameter.
The maximum allowable value for the hyperparameter.
The categorical hyperparameters and their ranges.
Provides the name and range of a categorical hyperparameter.
The name of the hyperparameter.
A list of the categories for the hyperparameter.
Lists the hyperparameter names and ranges.
Lists the feature transformation parameters.
The AutoMLConfig object containing a list of recipes to search when AutoML is performed.
The metric to optimize.
The list of candidate recipes.
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).
Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.
A list of tags to apply to the solution.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'solutionArn': 'string'
}
Response Structure
(dict) --
solutionArn (string) --
The ARN of the solution.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptioncreate_solution_version(**kwargs)¶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:
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
See also: AWS API Documentation
Request Syntax
response = client.create_solution_version(
name='string',
solutionArn='string',
trainingMode='FULL'|'UPDATE',
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the solution containing the training configuration information.
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.
Warning
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.
A list of tags to apply to the solution version.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'solutionVersionArn': 'string'
}
Response Structure
(dict) --
solutionVersionArn (string) --
The ARN of the new solution version.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.LimitExceededExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.TooManyTagsExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptiondelete_campaign(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_campaign(
campaignArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the campaign to delete.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiondelete_dataset(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_dataset(
datasetArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the dataset to delete.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiondelete_dataset_group(**kwargs)¶Deletes a dataset group. Before you delete a dataset group, you must delete the following:
See also: AWS API Documentation
Request Syntax
response = client.delete_dataset_group(
datasetGroupArn='string'
)
[REQUIRED]
The ARN of the dataset group to delete.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiondelete_event_tracker(**kwargs)¶Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_tracker(
eventTrackerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the event tracker to delete.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiondelete_filter(**kwargs)¶Deletes a filter.
See also: AWS API Documentation
Request Syntax
response = client.delete_filter(
filterArn='string'
)
[REQUIRED]
The ARN of the filter to delete.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiondelete_metric_attribution(**kwargs)¶Deletes a metric attribution.
See also: AWS API Documentation
Request Syntax
response = client.delete_metric_attribution(
metricAttributionArn='string'
)
[REQUIRED]
The metric attribution's Amazon Resource Name (ARN).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiondelete_recommender(**kwargs)¶Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
See also: AWS API Documentation
Request Syntax
response = client.delete_recommender(
recommenderArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the recommender to delete.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiondelete_schema(**kwargs)¶Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
See also: AWS API Documentation
Request Syntax
response = client.delete_schema(
schemaArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the schema to delete.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiondelete_solution(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_solution(
solutionArn='string'
)
[REQUIRED]
The ARN of the solution to delete.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiondescribe_algorithm(**kwargs)¶Describes the given algorithm.
See also: AWS API Documentation
Request Syntax
response = client.describe_algorithm(
algorithmArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the algorithm to describe.
{
'algorithm': {
'name': 'string',
'algorithmArn': 'string',
'algorithmImage': {
'name': 'string',
'dockerURI': 'string'
},
'defaultHyperParameters': {
'string': 'string'
},
'defaultHyperParameterRanges': {
'integerHyperParameterRanges': [
{
'name': 'string',
'minValue': 123,
'maxValue': 123,
'isTunable': True|False
},
],
'continuousHyperParameterRanges': [
{
'name': 'string',
'minValue': 123.0,
'maxValue': 123.0,
'isTunable': True|False
},
],
'categoricalHyperParameterRanges': [
{
'name': 'string',
'values': [
'string',
],
'isTunable': True|False
},
]
},
'defaultResourceConfig': {
'string': 'string'
},
'trainingInputMode': 'string',
'roleArn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
}
Response Structure
A listing of the properties of the algorithm.
The name of the algorithm.
The Amazon Resource Name (ARN) of the algorithm.
The URI of the Docker container for the algorithm image.
The name of the algorithm image.
The URI of the Docker container for the algorithm image.
Specifies the default hyperparameters.
Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
The integer-valued hyperparameters and their default ranges.
Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
The name of the hyperparameter.
The minimum allowable value for the hyperparameter.
The maximum allowable value for the hyperparameter.
Indicates whether the hyperparameter is tunable.
The continuous hyperparameters and their default ranges.
Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
The name of the hyperparameter.
The minimum allowable value for the hyperparameter.
The maximum allowable value for the hyperparameter.
Whether the hyperparameter is tunable.
The categorical hyperparameters and their default ranges.
Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
The name of the hyperparameter.
A list of the categories for the hyperparameter.
Whether the hyperparameter is tunable.
Specifies the default maximum number of training jobs and parallel training jobs.
The training input mode.
The Amazon Resource Name (ARN) of the role.
The date and time (in Unix time) that the algorithm was created.
The date and time (in Unix time) that the algorithm was last updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_batch_inference_job(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_batch_inference_job(
batchInferenceJobArn='string'
)
[REQUIRED]
The ARN of the batch inference job to describe.
{
'batchInferenceJob': {
'jobName': 'string',
'batchInferenceJobArn': 'string',
'filterArn': 'string',
'failureReason': 'string',
'solutionVersionArn': 'string',
'numResults': 123,
'jobInput': {
's3DataSource': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
'jobOutput': {
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
'batchInferenceJobConfig': {
'itemExplorationConfig': {
'string': 'string'
}
},
'roleArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
}
Response Structure
Information on the specified batch inference job.
The name of the batch inference job.
The Amazon Resource Name (ARN) of the batch inference job.
The ARN of the filter used on the batch inference job.
If the batch inference job failed, the reason for the failure.
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
The Amazon S3 path that leads to the input data used to generate the batch inference job.
The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
The Amazon S3 bucket that contains the output data generated by the batch inference job.
Information on the Amazon S3 bucket in which the batch inference job's output is stored.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
A string to string map of the configuration details of a batch inference job.
A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
The status of the batch inference job. The status is one of the following values:
The time at which the batch inference job was created.
The time at which the batch inference job was last updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_batch_segment_job(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_batch_segment_job(
batchSegmentJobArn='string'
)
[REQUIRED]
The ARN of the batch segment job to describe.
{
'batchSegmentJob': {
'jobName': 'string',
'batchSegmentJobArn': 'string',
'filterArn': 'string',
'failureReason': 'string',
'solutionVersionArn': 'string',
'numResults': 123,
'jobInput': {
's3DataSource': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
'jobOutput': {
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
'roleArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
}
Response Structure
Information on the specified batch segment job.
The name of the batch segment job.
The Amazon Resource Name (ARN) of the batch segment job.
The ARN of the filter used on the batch segment job.
If the batch segment job failed, the reason for the failure.
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
The number of predicted users generated by the batch segment job for each line of input data.
The Amazon S3 path that leads to the input data used to generate the batch segment job.
The configuration details of an Amazon S3 input or output bucket.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
The Amazon S3 bucket that contains the output data generated by the batch segment job.
The configuration details of an Amazon S3 input or output bucket.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
The status of the batch segment job. The status is one of the following values:
The time at which the batch segment job was created.
The time at which the batch segment job last updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_campaign(**kwargs)¶Describes the given campaign, including its status.
A campaign can be in one of the following states:
When the status is CREATE FAILED , the response includes the failureReason key, which describes why.
For more information on campaigns, see CreateCampaign.
See also: AWS API Documentation
Request Syntax
response = client.describe_campaign(
campaignArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the campaign.
{
'campaign': {
'name': 'string',
'campaignArn': 'string',
'solutionVersionArn': 'string',
'minProvisionedTPS': 123,
'campaignConfig': {
'itemExplorationConfig': {
'string': 'string'
}
},
'status': 'string',
'failureReason': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'latestCampaignUpdate': {
'solutionVersionArn': 'string',
'minProvisionedTPS': 123,
'campaignConfig': {
'itemExplorationConfig': {
'string': 'string'
}
},
'status': 'string',
'failureReason': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
}
}
Response Structure
The properties of the campaign.
The name of the campaign.
The Amazon Resource Name (ARN) of the campaign.
The Amazon Resource Name (ARN) of a specific version of the solution.
Specifies the requested minimum provisioned transactions (recommendations) per second.
The configuration details of a campaign.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.
The status of the campaign.
A campaign can be in one of the following states:
If a campaign fails, the reason behind the failure.
The date and time (in Unix format) that the campaign was created.
The date and time (in Unix format) that the campaign was last updated.
Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.
The Amazon Resource Name (ARN) of the deployed solution version.
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
The configuration details of a campaign.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.
The status of the campaign update.
A campaign update can be in one of the following states:
If a campaign update fails, the reason behind the failure.
The date and time (in Unix time) that the campaign update was created.
The date and time (in Unix time) that the campaign update was last updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_dataset(**kwargs)¶Describes the given dataset. For more information on datasets, see CreateDataset.
See also: AWS API Documentation
Request Syntax
response = client.describe_dataset(
datasetArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the dataset to describe.
{
'dataset': {
'name': 'string',
'datasetArn': 'string',
'datasetGroupArn': 'string',
'datasetType': 'string',
'schemaArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
}
Response Structure
A listing of the dataset's properties.
The name of the dataset.
The Amazon Resource Name (ARN) of the dataset that you want metadata for.
The Amazon Resource Name (ARN) of the dataset group.
One of the following values:
The ARN of the associated schema.
The status of the dataset.
A dataset can be in one of the following states:
The creation date and time (in Unix time) of the dataset.
A time stamp that shows when the dataset was updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_dataset_export_job(**kwargs)¶Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
See also: AWS API Documentation
Request Syntax
response = client.describe_dataset_export_job(
datasetExportJobArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the dataset export job to describe.
{
'datasetExportJob': {
'jobName': 'string',
'datasetExportJobArn': 'string',
'datasetArn': 'string',
'ingestionMode': 'BULK'|'PUT'|'ALL',
'roleArn': 'string',
'status': 'string',
'jobOutput': {
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
}
}
Response Structure
Information about the dataset export job, including the status.
The status is one of the following values:
The name of the export job.
The Amazon Resource Name (ARN) of the dataset export job.
The Amazon Resource Name (ARN) of the dataset to export.
The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT .
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
The status of the dataset export job.
A dataset export job can be in one of the following states:
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
The configuration details of an Amazon S3 input or output bucket.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
The creation date and time (in Unix time) of the dataset export job.
The date and time (in Unix time) the status of the dataset export job was last updated.
If a dataset export job fails, provides the reason why.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_dataset_group(**kwargs)¶Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
See also: AWS API Documentation
Request Syntax
response = client.describe_dataset_group(
datasetGroupArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the dataset group to describe.
{
'datasetGroup': {
'name': 'string',
'datasetGroupArn': 'string',
'status': 'string',
'roleArn': 'string',
'kmsKeyArn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
}
}
Response Structure
A listing of the dataset group's properties.
The name of the dataset group.
The Amazon Resource Name (ARN) of the dataset group.
The current status of the dataset group.
A dataset group can be in one of the following states:
The ARN of the IAM role that has permissions to create the dataset group.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.
The creation date and time (in Unix time) of the dataset group.
The last update date and time (in Unix time) of the dataset group.
If creating a dataset group fails, provides the reason why.
The domain of a Domain dataset group.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_dataset_import_job(**kwargs)¶Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
See also: AWS API Documentation
Request Syntax
response = client.describe_dataset_import_job(
datasetImportJobArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the dataset import job to describe.
{
'datasetImportJob': {
'jobName': 'string',
'datasetImportJobArn': 'string',
'datasetArn': 'string',
'dataSource': {
'dataLocation': 'string'
},
'roleArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'importMode': 'FULL'|'INCREMENTAL',
'publishAttributionMetricsToS3': True|False
}
}
Response Structure
Information about the dataset import job, including the status.
The status is one of the following values:
The name of the import job.
The ARN of the dataset import job.
The Amazon Resource Name (ARN) of the dataset that receives the imported data.
The Amazon S3 bucket that contains the training data to import.
The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example:
s3://bucket-name/folder-name/
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
The status of the dataset import job.
A dataset import job can be in one of the following states:
The creation date and time (in Unix time) of the dataset import job.
The date and time (in Unix time) the dataset was last updated.
If a dataset import job fails, provides the reason why.
The import mode used by the dataset import job to import new records.
Whether the job publishes metrics to Amazon S3 for a metric attribution.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_event_tracker(**kwargs)¶Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_tracker(
eventTrackerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the event tracker to describe.
{
'eventTracker': {
'name': 'string',
'eventTrackerArn': 'string',
'accountId': 'string',
'trackingId': 'string',
'datasetGroupArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
}
Response Structure
An object that describes the event tracker.
The name of the event tracker.
The ARN of the event tracker.
The Amazon Web Services account that owns the event tracker.
The ID of the event tracker. Include this ID in requests to the PutEvents API.
The Amazon Resource Name (ARN) of the dataset group that receives the event data.
The status of the event tracker.
An event tracker can be in one of the following states:
The date and time (in Unix format) that the event tracker was created.
The date and time (in Unix time) that the event tracker was last updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_feature_transformation(**kwargs)¶Describes the given feature transformation.
See also: AWS API Documentation
Request Syntax
response = client.describe_feature_transformation(
featureTransformationArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the feature transformation to describe.
{
'featureTransformation': {
'name': 'string',
'featureTransformationArn': 'string',
'defaultParameters': {
'string': 'string'
},
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'status': 'string'
}
}
Response Structure
A listing of the FeatureTransformation properties.
The name of the feature transformation.
The Amazon Resource Name (ARN) of the FeatureTransformation object.
Provides the default parameters for feature transformation.
The creation date and time (in Unix time) of the feature transformation.
The last update date and time (in Unix time) of the feature transformation.
The status of the feature transformation.
A feature transformation can be in one of the following states:
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_filter(**kwargs)¶Describes a filter's properties.
See also: AWS API Documentation
Request Syntax
response = client.describe_filter(
filterArn='string'
)
[REQUIRED]
The ARN of the filter to describe.
{
'filter': {
'name': 'string',
'filterArn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'datasetGroupArn': 'string',
'failureReason': 'string',
'filterExpression': 'string',
'status': 'string'
}
}
Response Structure
The filter's details.
The name of the filter.
The ARN of the filter.
The time at which the filter was created.
The time at which the filter was last updated.
The ARN of the dataset group to which the filter belongs.
If the filter failed, the reason for its failure.
Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.
The status of the filter.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_metric_attribution(**kwargs)¶Describes a metric attribution.
See also: AWS API Documentation
Request Syntax
response = client.describe_metric_attribution(
metricAttributionArn='string'
)
[REQUIRED]
The metric attribution's Amazon Resource Name (ARN).
{
'metricAttribution': {
'name': 'string',
'metricAttributionArn': 'string',
'datasetGroupArn': 'string',
'metricsOutputConfig': {
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
},
'roleArn': 'string'
},
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
}
}
Response Structure
The details of the metric attribution.
The metric attribution's name.
The metric attribution's Amazon Resource Name (ARN).
The metric attribution's dataset group Amazon Resource Name (ARN).
The metric attribution's output configuration.
The configuration details of an Amazon S3 input or output bucket.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.
The metric attribution's status.
The metric attribution's creation date time.
The metric attribution's last updated date time.
The metric attribution's failure reason.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_recipe(**kwargs)¶Describes a recipe.
A recipe contains three items:
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_recipe(
recipeArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the recipe to describe.
{
'recipe': {
'name': 'string',
'recipeArn': 'string',
'algorithmArn': 'string',
'featureTransformationArn': 'string',
'status': 'string',
'description': 'string',
'creationDateTime': datetime(2015, 1, 1),
'recipeType': 'string',
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
}
Response Structure
An object that describes the recipe.
The name of the recipe.
The Amazon Resource Name (ARN) of the recipe.
The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
The ARN of the FeatureTransformation object.
The status of the recipe.
The description of the recipe.
The date and time (in Unix format) that the recipe was created.
One of the following values:
The date and time (in Unix format) that the recipe was last updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_recommender(**kwargs)¶Describes the given recommender, including its status.
A recommender can be in one of the following states:
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_recommender(
recommenderArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the recommender to describe.
{
'recommender': {
'recommenderArn': 'string',
'datasetGroupArn': 'string',
'name': 'string',
'recipeArn': 'string',
'recommenderConfig': {
'itemExplorationConfig': {
'string': 'string'
},
'minRecommendationRequestsPerSecond': 123
},
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'status': 'string',
'failureReason': 'string',
'latestRecommenderUpdate': {
'recommenderConfig': {
'itemExplorationConfig': {
'string': 'string'
},
'minRecommendationRequestsPerSecond': 123
},
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'status': 'string',
'failureReason': 'string'
},
'modelMetrics': {
'string': 123.0
}
}
}
Response Structure
The properties of the recommender.
The Amazon Resource Name (ARN) of the recommender.
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
The name of the recommender.
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
The configuration details of the recommender.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
The date and time (in Unix format) that the recommender was created.
The date and time (in Unix format) that the recommender was last updated.
The status of the recommender.
A recommender can be in one of the following states:
If a recommender fails, the reason behind the failure.
Provides a summary of the latest updates to the recommender.
The configuration details of the recommender update.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
The date and time (in Unix format) that the recommender update was created.
The date and time (in Unix time) that the recommender update was last updated.
The status of the recommender update.
A recommender can be in one of the following states:
If a recommender update fails, the reason behind the failure.
Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_schema(**kwargs)¶Describes a schema. For more information on schemas, see CreateSchema.
See also: AWS API Documentation
Request Syntax
response = client.describe_schema(
schemaArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the schema to retrieve.
{
'schema': {
'name': 'string',
'schemaArn': 'string',
'schema': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
}
}
Response Structure
The requested schema.
The name of the schema.
The Amazon Resource Name (ARN) of the schema.
The schema.
The date and time (in Unix time) that the schema was created.
The date and time (in Unix time) that the schema was last updated.
The domain of a schema that you created for a dataset in a Domain dataset group.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_solution(**kwargs)¶Describes a solution. For more information on solutions, see CreateSolution.
See also: AWS API Documentation
Request Syntax
response = client.describe_solution(
solutionArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the solution to describe.
{
'solution': {
'name': 'string',
'solutionArn': 'string',
'performHPO': True|False,
'performAutoML': True|False,
'recipeArn': 'string',
'datasetGroupArn': 'string',
'eventType': 'string',
'solutionConfig': {
'eventValueThreshold': 'string',
'hpoConfig': {
'hpoObjective': {
'type': 'string',
'metricName': 'string',
'metricRegex': 'string'
},
'hpoResourceConfig': {
'maxNumberOfTrainingJobs': 'string',
'maxParallelTrainingJobs': 'string'
},
'algorithmHyperParameterRanges': {
'integerHyperParameterRanges': [
{
'name': 'string',
'minValue': 123,
'maxValue': 123
},
],
'continuousHyperParameterRanges': [
{
'name': 'string',
'minValue': 123.0,
'maxValue': 123.0
},
],
'categoricalHyperParameterRanges': [
{
'name': 'string',
'values': [
'string',
]
},
]
}
},
'algorithmHyperParameters': {
'string': 'string'
},
'featureTransformationParameters': {
'string': 'string'
},
'autoMLConfig': {
'metricName': 'string',
'recipeList': [
'string',
]
},
'optimizationObjective': {
'itemAttribute': 'string',
'objectiveSensitivity': 'LOW'|'MEDIUM'|'HIGH'|'OFF'
}
},
'autoMLResult': {
'bestRecipeArn': 'string'
},
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'latestSolutionVersion': {
'solutionVersionArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
}
}
}
Response Structure
An object that describes the solution.
The name of the solution.
The ARN of the solution.
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false .
When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration ( recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.
The ARN of the recipe used to create the solution.
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
The event type (for example, 'click' or 'like') that is used for training the model. If no eventType is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.
Describes the configuration properties for the solution.
Only events with a value greater than or equal to this threshold are used for training a model.
Describes the properties for hyperparameter optimization (HPO).
The metric to optimize during HPO.
Note
Amazon Personalize doesn't support configuring the hpoObjective at this time.
The type of the metric. Valid values are Maximize and Minimize .
The name of the metric.
A regular expression for finding the metric in the training job logs.
Describes the resource configuration for HPO.
The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40 .
The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10 .
The hyperparameters and their allowable ranges.
The integer-valued hyperparameters and their ranges.
Provides the name and range of an integer-valued hyperparameter.
The name of the hyperparameter.
The minimum allowable value for the hyperparameter.
The maximum allowable value for the hyperparameter.
The continuous hyperparameters and their ranges.
Provides the name and range of a continuous hyperparameter.
The name of the hyperparameter.
The minimum allowable value for the hyperparameter.
The maximum allowable value for the hyperparameter.
The categorical hyperparameters and their ranges.
Provides the name and range of a categorical hyperparameter.
The name of the hyperparameter.
A list of the categories for the hyperparameter.
Lists the hyperparameter names and ranges.
Lists the feature transformation parameters.
The AutoMLConfig object containing a list of recipes to search when AutoML is performed.
The metric to optimize.
The list of candidate recipes.
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).
Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.
When performAutoML is true, specifies the best recipe found.
The Amazon Resource Name (ARN) of the best recipe.
The status of the solution.
A solution can be in one of the following states:
The creation date and time (in Unix time) of the solution.
The date and time (in Unix time) that the solution was last updated.
Describes the latest version of the solution, including the status and the ARN.
The Amazon Resource Name (ARN) of the solution version.
The status of the solution version.
A solution version can be in one of the following states:
The date and time (in Unix time) that this version of a solution was created.
The date and time (in Unix time) that the solution version was last updated.
If a solution version fails, the reason behind the failure.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptiondescribe_solution_version(**kwargs)¶Describes a specific version of a solution. For more information on solutions, see CreateSolution
See also: AWS API Documentation
Request Syntax
response = client.describe_solution_version(
solutionVersionArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the solution version.
{
'solutionVersion': {
'name': 'string',
'solutionVersionArn': 'string',
'solutionArn': 'string',
'performHPO': True|False,
'performAutoML': True|False,
'recipeArn': 'string',
'eventType': 'string',
'datasetGroupArn': 'string',
'solutionConfig': {
'eventValueThreshold': 'string',
'hpoConfig': {
'hpoObjective': {
'type': 'string',
'metricName': 'string',
'metricRegex': 'string'
},
'hpoResourceConfig': {
'maxNumberOfTrainingJobs': 'string',
'maxParallelTrainingJobs': 'string'
},
'algorithmHyperParameterRanges': {
'integerHyperParameterRanges': [
{
'name': 'string',
'minValue': 123,
'maxValue': 123
},
],
'continuousHyperParameterRanges': [
{
'name': 'string',
'minValue': 123.0,
'maxValue': 123.0
},
],
'categoricalHyperParameterRanges': [
{
'name': 'string',
'values': [
'string',
]
},
]
}
},
'algorithmHyperParameters': {
'string': 'string'
},
'featureTransformationParameters': {
'string': 'string'
},
'autoMLConfig': {
'metricName': 'string',
'recipeList': [
'string',
]
},
'optimizationObjective': {
'itemAttribute': 'string',
'objectiveSensitivity': 'LOW'|'MEDIUM'|'HIGH'|'OFF'
}
},
'trainingHours': 123.0,
'trainingMode': 'FULL'|'UPDATE',
'tunedHPOParams': {
'algorithmHyperParameters': {
'string': 'string'
}
},
'status': 'string',
'failureReason': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
}
Response Structure
The solution version.
The name of the solution version.
The ARN of the solution version.
The ARN of the solution.
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false .
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn .
The ARN of the recipe used in the solution.
The event type (for example, 'click' or 'like') that is used for training the model.
The Amazon Resource Name (ARN) of the dataset group providing the training data.
Describes the configuration properties for the solution.
Only events with a value greater than or equal to this threshold are used for training a model.
Describes the properties for hyperparameter optimization (HPO).
The metric to optimize during HPO.
Note
Amazon Personalize doesn't support configuring the hpoObjective at this time.
The type of the metric. Valid values are Maximize and Minimize .
The name of the metric.
A regular expression for finding the metric in the training job logs.
Describes the resource configuration for HPO.
The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40 .
The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10 .
The hyperparameters and their allowable ranges.
The integer-valued hyperparameters and their ranges.
Provides the name and range of an integer-valued hyperparameter.
The name of the hyperparameter.
The minimum allowable value for the hyperparameter.
The maximum allowable value for the hyperparameter.
The continuous hyperparameters and their ranges.
Provides the name and range of a continuous hyperparameter.
The name of the hyperparameter.
The minimum allowable value for the hyperparameter.
The maximum allowable value for the hyperparameter.
The categorical hyperparameters and their ranges.
Provides the name and range of a categorical hyperparameter.
The name of the hyperparameter.
A list of the categories for the hyperparameter.
Lists the hyperparameter names and ranges.
Lists the feature transformation parameters.
The AutoMLConfig object containing a list of recipes to search when AutoML is performed.
The metric to optimize.
The list of candidate recipes.
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).
Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.
The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
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.
Warning
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.
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
A list of the hyperparameter values of the best performing model.
The status of the solution version.
A solution version can be in one of the following states:
If training a solution version fails, the reason for the failure.
The date and time (in Unix time) that this version of the solution was created.
The date and time (in Unix time) that the solution was last updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_solution_metrics(**kwargs)¶Gets the metrics for the specified solution version.
See also: AWS API Documentation
Request Syntax
response = client.get_solution_metrics(
solutionVersionArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the solution version for which to get metrics.
{
'solutionVersionArn': 'string',
'metrics': {
'string': 123.0
}
}
Response Structure
The same solution version ARN as specified in the request.
The metrics for the solution version. For more information, see Evaluating a solution version with metrics.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_batch_inference_jobs(**kwargs)¶Gets a list of the batch inference jobs that have been performed off of a solution version.
See also: AWS API Documentation
Request Syntax
response = client.list_batch_inference_jobs(
solutionVersionArn='string',
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'batchInferenceJobs': [
{
'batchInferenceJobArn': 'string',
'jobName': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'solutionVersionArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
batchInferenceJobs (list) --
A list containing information on each job that is returned.
(dict) --
A truncated version of the BatchInferenceJob. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.
batchInferenceJobArn (string) --
The Amazon Resource Name (ARN) of the batch inference job.
jobName (string) --
The name of the batch inference job.
status (string) --
The status of the batch inference job. The status is one of the following values:
creationDateTime (datetime) --
The time at which the batch inference job was created.
lastUpdatedDateTime (datetime) --
The time at which the batch inference job was last updated.
failureReason (string) --
If the batch inference job failed, the reason for the failure.
solutionVersionArn (string) --
The ARN of the solution version used by the batch inference job.
nextToken (string) --
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_batch_segment_jobs(**kwargs)¶Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
See also: AWS API Documentation
Request Syntax
response = client.list_batch_segment_jobs(
solutionVersionArn='string',
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'batchSegmentJobs': [
{
'batchSegmentJobArn': 'string',
'jobName': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'solutionVersionArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
batchSegmentJobs (list) --
A list containing information on each job that is returned.
(dict) --
A truncated version of the BatchSegmentJob datatype. ListBatchSegmentJobs operation returns a list of batch segment job summaries.
batchSegmentJobArn (string) --
The Amazon Resource Name (ARN) of the batch segment job.
jobName (string) --
The name of the batch segment job.
status (string) --
The status of the batch segment job. The status is one of the following values:
creationDateTime (datetime) --
The time at which the batch segment job was created.
lastUpdatedDateTime (datetime) --
The time at which the batch segment job was last updated.
failureReason (string) --
If the batch segment job failed, the reason for the failure.
solutionVersionArn (string) --
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
nextToken (string) --
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_campaigns(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_campaigns(
solutionArn='string',
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'campaigns': [
{
'name': 'string',
'campaignArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
campaigns (list) --
A list of the campaigns.
(dict) --
Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.
name (string) --
The name of the campaign.
campaignArn (string) --
The Amazon Resource Name (ARN) of the campaign.
status (string) --
The status of the campaign.
A campaign can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the campaign was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the campaign was last updated.
failureReason (string) --
If a campaign fails, the reason behind the failure.
nextToken (string) --
A token for getting the next set of campaigns (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_dataset_export_jobs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_dataset_export_jobs(
datasetArn='string',
nextToken='string',
maxResults=123
)
ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).dict
Response Syntax
{
'datasetExportJobs': [
{
'datasetExportJobArn': 'string',
'jobName': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
datasetExportJobs (list) --
The list of dataset export jobs.
(dict) --
Provides a summary of the properties of a dataset export job. For a complete listing, call the DescribeDatasetExportJob API.
datasetExportJobArn (string) --
The Amazon Resource Name (ARN) of the dataset export job.
jobName (string) --
The name of the dataset export job.
status (string) --
The status of the dataset export job.
A dataset export job can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the dataset export job was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the dataset export job status was last updated.
failureReason (string) --
If a dataset export job fails, the reason behind the failure.
nextToken (string) --
A token for getting the next set of dataset export jobs (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_dataset_groups(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_dataset_groups(
nextToken='string',
maxResults=123
)
ListDatasetGroups for getting the next set of dataset groups (if they exist).dict
Response Syntax
{
'datasetGroups': [
{
'name': 'string',
'datasetGroupArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
datasetGroups (list) --
The list of your dataset groups.
(dict) --
Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.
name (string) --
The name of the dataset group.
datasetGroupArn (string) --
The Amazon Resource Name (ARN) of the dataset group.
status (string) --
The status of the dataset group.
A dataset group can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the dataset group was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the dataset group was last updated.
failureReason (string) --
If creating a dataset group fails, the reason behind the failure.
domain (string) --
The domain of a Domain dataset group.
nextToken (string) --
A token for getting the next set of dataset groups (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidNextTokenExceptionlist_dataset_import_jobs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_dataset_import_jobs(
datasetArn='string',
nextToken='string',
maxResults=123
)
ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).dict
Response Syntax
{
'datasetImportJobs': [
{
'datasetImportJobArn': 'string',
'jobName': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'importMode': 'FULL'|'INCREMENTAL'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
datasetImportJobs (list) --
The list of dataset import jobs.
(dict) --
Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.
datasetImportJobArn (string) --
The Amazon Resource Name (ARN) of the dataset import job.
jobName (string) --
The name of the dataset import job.
status (string) --
The status of the dataset import job.
A dataset import job can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the dataset import job was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the dataset import job status was last updated.
failureReason (string) --
If a dataset import job fails, the reason behind the failure.
importMode (string) --
The import mode the dataset import job used to update the data in the dataset. For more information see Updating existing bulk data.
nextToken (string) --
A token for getting the next set of dataset import jobs (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_datasets(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_datasets(
datasetGroupArn='string',
nextToken='string',
maxResults=123
)
ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).dict
Response Syntax
{
'datasets': [
{
'name': 'string',
'datasetArn': 'string',
'datasetType': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
datasets (list) --
An array of Dataset objects. Each object provides metadata information.
(dict) --
Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.
name (string) --
The name of the dataset.
datasetArn (string) --
The Amazon Resource Name (ARN) of the dataset.
datasetType (string) --
The dataset type. One of the following values:
status (string) --
The status of the dataset.
A dataset can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the dataset was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the dataset was last updated.
nextToken (string) --
A token for getting the next set of datasets (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_event_trackers(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_event_trackers(
datasetGroupArn='string',
nextToken='string',
maxResults=123
)
ListEventTrackers for getting the next set of event trackers (if they exist).dict
Response Syntax
{
'eventTrackers': [
{
'name': 'string',
'eventTrackerArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
eventTrackers (list) --
A list of event trackers.
(dict) --
Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.
name (string) --
The name of the event tracker.
eventTrackerArn (string) --
The Amazon Resource Name (ARN) of the event tracker.
status (string) --
The status of the event tracker.
An event tracker can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the event tracker was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the event tracker was last updated.
nextToken (string) --
A token for getting the next set of event trackers (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_filters(**kwargs)¶Lists all filters that belong to a given dataset group.
See also: AWS API Documentation
Request Syntax
response = client.list_filters(
datasetGroupArn='string',
nextToken='string',
maxResults=123
)
ListFilters for getting the next set of filters (if they exist).dict
Response Syntax
{
'Filters': [
{
'name': 'string',
'filterArn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'datasetGroupArn': 'string',
'failureReason': 'string',
'status': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Filters (list) --
A list of returned filters.
(dict) --
A short summary of a filter's attributes.
name (string) --
The name of the filter.
filterArn (string) --
The ARN of the filter.
creationDateTime (datetime) --
The time at which the filter was created.
lastUpdatedDateTime (datetime) --
The time at which the filter was last updated.
datasetGroupArn (string) --
The ARN of the dataset group to which the filter belongs.
failureReason (string) --
If the filter failed, the reason for the failure.
status (string) --
The status of the filter.
nextToken (string) --
A token for getting the next set of filters (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_metric_attribution_metrics(**kwargs)¶Lists the metrics for the metric attribution.
See also: AWS API Documentation
Request Syntax
response = client.list_metric_attribution_metrics(
metricAttributionArn='string',
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'metrics': [
{
'eventType': 'string',
'metricName': 'string',
'expression': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
metrics (list) --
The metrics for the specified metric attribution.
(dict) --
Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.
eventType (string) --
The metric's event type.
metricName (string) --
The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
expression (string) --
The attribute's expression. Available functions are SUM() or SAMPLECOUNT() . For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
nextToken (string) --
Specify the pagination token from a previous ListMetricAttributionMetricsResponse request to retrieve the next page of results.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_metric_attributions(**kwargs)¶Lists metric attributions.
See also: AWS API Documentation
Request Syntax
response = client.list_metric_attributions(
datasetGroupArn='string',
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'metricAttributions': [
{
'name': 'string',
'metricAttributionArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
metricAttributions (list) --
The list of metric attributions.
(dict) --
Provides a summary of the properties of a metric attribution. For a complete listing, call the DescribeMetricAttribution.
name (string) --
The name of the metric attribution.
metricAttributionArn (string) --
The metric attribution's Amazon Resource Name (ARN).
status (string) --
The metric attribution's status.
creationDateTime (datetime) --
The metric attribution's creation date time.
lastUpdatedDateTime (datetime) --
The metric attribution's last updated date time.
failureReason (string) --
The metric attribution's failure reason.
nextToken (string) --
Specify the pagination token from a previous request to retrieve the next page of results.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_recipes(**kwargs)¶Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
response = client.list_recipes(
recipeProvider='SERVICE',
nextToken='string',
maxResults=123,
domain='ECOMMERCE'|'VIDEO_ON_DEMAND'
)
SERVICE .ListRecipes for getting the next set of recipes (if they exist).dict
Response Syntax
{
'recipes': [
{
'name': 'string',
'recipeArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
recipes (list) --
The list of available recipes.
(dict) --
Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.
name (string) --
The name of the recipe.
recipeArn (string) --
The Amazon Resource Name (ARN) of the recipe.
status (string) --
The status of the recipe.
creationDateTime (datetime) --
The date and time (in Unix time) that the recipe was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the recipe was last updated.
domain (string) --
The domain of the recipe (if the recipe is a Domain dataset group use case).
nextToken (string) --
A token for getting the next set of recipes.
Exceptions
Personalize.Client.exceptions.InvalidNextTokenExceptionPersonalize.Client.exceptions.InvalidInputExceptionlist_recommenders(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_recommenders(
datasetGroupArn='string',
nextToken='string',
maxResults=123
)
ListRecommenders for getting the next set of recommenders (if they exist).dict
Response Syntax
{
'recommenders': [
{
'name': 'string',
'recommenderArn': 'string',
'datasetGroupArn': 'string',
'recipeArn': 'string',
'recommenderConfig': {
'itemExplorationConfig': {
'string': 'string'
},
'minRecommendationRequestsPerSecond': 123
},
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
recommenders (list) --
A list of the recommenders.
(dict) --
Provides a summary of the properties of the recommender.
name (string) --
The name of the recommender.
recommenderArn (string) --
The Amazon Resource Name (ARN) of the recommender.
datasetGroupArn (string) --
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
recipeArn (string) --
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
recommenderConfig (dict) --
The configuration details of the recommender.
itemExplorationConfig (dict) --
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
minRecommendationRequestsPerSecond (integer) --
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
status (string) --
The status of the recommender. A recommender can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix format) that the recommender was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix format) that the recommender was last updated.
nextToken (string) --
A token for getting the next set of recommenders (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_schemas(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_schemas(
nextToken='string',
maxResults=123
)
ListSchemas for getting the next set of schemas (if they exist).dict
Response Syntax
{
'schemas': [
{
'name': 'string',
'schemaArn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
schemas (list) --
A list of schemas.
(dict) --
Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.
name (string) --
The name of the schema.
schemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
creationDateTime (datetime) --
The date and time (in Unix time) that the schema was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the schema was last updated.
domain (string) --
The domain of a schema that you created for a dataset in a Domain dataset group.
nextToken (string) --
A token used to get the next set of schemas (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidNextTokenExceptionlist_solution_versions(**kwargs)¶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).
See also: AWS API Documentation
Request Syntax
response = client.list_solution_versions(
solutionArn='string',
nextToken='string',
maxResults=123
)
ListSolutionVersions for getting the next set of solution versions (if they exist).dict
Response Syntax
{
'solutionVersions': [
{
'solutionVersionArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
solutionVersions (list) --
A list of solution versions describing the version properties.
(dict) --
Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.
solutionVersionArn (string) --
The Amazon Resource Name (ARN) of the solution version.
status (string) --
The status of the solution version.
A solution version can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that this version of a solution was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the solution version was last updated.
failureReason (string) --
If a solution version fails, the reason behind the failure.
nextToken (string) --
A token for getting the next set of solution versions (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionlist_solutions(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_solutions(
datasetGroupArn='string',
nextToken='string',
maxResults=123
)
ListSolutions for getting the next set of solutions (if they exist).dict
Response Syntax
{
'solutions': [
{
'name': 'string',
'solutionArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'recipeArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
solutions (list) --
A list of the current solutions.
(dict) --
Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.
name (string) --
The name of the solution.
solutionArn (string) --
The Amazon Resource Name (ARN) of the solution.
status (string) --
The status of the solution.
A solution can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the solution was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the solution was last updated.
recipeArn (string) --
The Amazon Resource Name (ARN) of the recipe used by the solution.
nextToken (string) --
A token for getting the next set of solutions (if they exist).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.InvalidNextTokenExceptionGet a list of tags attached to a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The resource's Amazon Resource Name.
{
'tags': [
{
'tagKey': 'string',
'tagValue': 'string'
},
]
}
Response Structure
The resource's tags.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptionstart_recommender(**kwargs)¶Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
See also: AWS API Documentation
Request Syntax
response = client.start_recommender(
recommenderArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the recommender to start.
{
'recommenderArn': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the recommender you started.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptionstop_recommender(**kwargs)¶Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
See also: AWS API Documentation
Request Syntax
response = client.stop_recommender(
recommenderArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the recommender to stop.
{
'recommenderArn': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the recommender you stopped.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptionstop_solution_version_creation(**kwargs)¶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:
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.
See also: AWS API Documentation
Request Syntax
response = client.stop_solution_version_creation(
solutionVersionArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the solution version you want to stop creating.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptiontag_resource(**kwargs)¶Add a list of tags to a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'tagKey': 'string',
'tagValue': 'string'
},
]
)
[REQUIRED]
The resource's Amazon Resource Name (ARN).
[REQUIRED]
Tags to apply to the resource. For more information see Tagging Personalize resources.
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Personalize resources.
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{}
Response Structure
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.TooManyTagsExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.LimitExceededExceptionuntag_resource(**kwargs)¶Remove tags that are attached to a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The resource's Amazon Resource Name (ARN).
[REQUIRED]
Keys to remove from the resource's tags.
dict
Response Syntax
{}
Response Structure
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.TooManyTagKeysExceptionPersonalize.Client.exceptions.ResourceInUseExceptionupdate_campaign(**kwargs)¶Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
Note
You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active .
For more information on campaigns, see CreateCampaign.
See also: AWS API Documentation
Request Syntax
response = client.update_campaign(
campaignArn='string',
solutionVersionArn='string',
minProvisionedTPS=123,
campaignConfig={
'itemExplorationConfig': {
'string': 'string'
}
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the campaign.
The configuration details of a campaign.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.
dict
Response Syntax
{
'campaignArn': 'string'
}
Response Structure
(dict) --
campaignArn (string) --
The same campaign ARN as given in the request.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptionupdate_metric_attribution(**kwargs)¶Updates a metric attribution.
See also: AWS API Documentation
Request Syntax
response = client.update_metric_attribution(
addMetrics=[
{
'eventType': 'string',
'metricName': 'string',
'expression': 'string'
},
],
removeMetrics=[
'string',
],
metricsOutputConfig={
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
},
'roleArn': 'string'
},
metricAttributionArn='string'
)
Add new metric attributes to the metric attribution.
Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.
The metric's event type.
The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
The attribute's expression. Available functions are SUM() or SAMPLECOUNT() . For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
Remove metric attributes from the metric attribution.
An output config for the metric attribution.
The configuration details of an Amazon S3 input or output bucket.
The file path of the Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.
dict
Response Syntax
{
'metricAttributionArn': 'string'
}
Response Structure
(dict) --
metricAttributionArn (string) --
The Amazon Resource Name (ARN) for the metric attribution that you updated.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptionPersonalize.Client.exceptions.ResourceAlreadyExistsExceptionupdate_recommender(**kwargs)¶Updates the recommender to modify the recommender configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_recommender(
recommenderArn='string',
recommenderConfig={
'itemExplorationConfig': {
'string': 'string'
},
'minRecommendationRequestsPerSecond': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the recommender to modify.
[REQUIRED]
The configuration details of the recommender.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
dict
Response Syntax
{
'recommenderArn': 'string'
}
Response Structure
(dict) --
recommenderArn (string) --
The same recommender Amazon Resource Name (ARN) as given in the request.
Exceptions
Personalize.Client.exceptions.InvalidInputExceptionPersonalize.Client.exceptions.ResourceNotFoundExceptionPersonalize.Client.exceptions.ResourceInUseExceptionThe available paginators are:
Personalize.Paginator.ListBatchInferenceJobsPersonalize.Paginator.ListBatchSegmentJobsPersonalize.Paginator.ListCampaignsPersonalize.Paginator.ListDatasetExportJobsPersonalize.Paginator.ListDatasetGroupsPersonalize.Paginator.ListDatasetImportJobsPersonalize.Paginator.ListDatasetsPersonalize.Paginator.ListEventTrackersPersonalize.Paginator.ListFiltersPersonalize.Paginator.ListMetricAttributionMetricsPersonalize.Paginator.ListMetricAttributionsPersonalize.Paginator.ListRecipesPersonalize.Paginator.ListRecommendersPersonalize.Paginator.ListSchemasPersonalize.Paginator.ListSolutionVersionsPersonalize.Paginator.ListSolutionsPersonalize.Paginator.ListBatchInferenceJobs¶paginator = client.get_paginator('list_batch_inference_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_batch_inference_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
solutionVersionArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'batchInferenceJobs': [
{
'batchInferenceJobArn': 'string',
'jobName': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'solutionVersionArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
batchInferenceJobs (list) --
A list containing information on each job that is returned.
(dict) --
A truncated version of the BatchInferenceJob. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.
batchInferenceJobArn (string) --
The Amazon Resource Name (ARN) of the batch inference job.
jobName (string) --
The name of the batch inference job.
status (string) --
The status of the batch inference job. The status is one of the following values:
creationDateTime (datetime) --
The time at which the batch inference job was created.
lastUpdatedDateTime (datetime) --
The time at which the batch inference job was last updated.
failureReason (string) --
If the batch inference job failed, the reason for the failure.
solutionVersionArn (string) --
The ARN of the solution version used by the batch inference job.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListBatchSegmentJobs¶paginator = client.get_paginator('list_batch_segment_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_batch_segment_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
solutionVersionArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'batchSegmentJobs': [
{
'batchSegmentJobArn': 'string',
'jobName': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'solutionVersionArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
batchSegmentJobs (list) --
A list containing information on each job that is returned.
(dict) --
A truncated version of the BatchSegmentJob datatype. ListBatchSegmentJobs operation returns a list of batch segment job summaries.
batchSegmentJobArn (string) --
The Amazon Resource Name (ARN) of the batch segment job.
jobName (string) --
The name of the batch segment job.
status (string) --
The status of the batch segment job. The status is one of the following values:
creationDateTime (datetime) --
The time at which the batch segment job was created.
lastUpdatedDateTime (datetime) --
The time at which the batch segment job was last updated.
failureReason (string) --
If the batch segment job failed, the reason for the failure.
solutionVersionArn (string) --
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListCampaigns¶paginator = client.get_paginator('list_campaigns')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_campaigns().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
solutionArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'campaigns': [
{
'name': 'string',
'campaignArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
campaigns (list) --
A list of the campaigns.
(dict) --
Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.
name (string) --
The name of the campaign.
campaignArn (string) --
The Amazon Resource Name (ARN) of the campaign.
status (string) --
The status of the campaign.
A campaign can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the campaign was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the campaign was last updated.
failureReason (string) --
If a campaign fails, the reason behind the failure.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListDatasetExportJobs¶paginator = client.get_paginator('list_dataset_export_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_dataset_export_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'datasetExportJobs': [
{
'datasetExportJobArn': 'string',
'jobName': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
datasetExportJobs (list) --
The list of dataset export jobs.
(dict) --
Provides a summary of the properties of a dataset export job. For a complete listing, call the DescribeDatasetExportJob API.
datasetExportJobArn (string) --
The Amazon Resource Name (ARN) of the dataset export job.
jobName (string) --
The name of the dataset export job.
status (string) --
The status of the dataset export job.
A dataset export job can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the dataset export job was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the dataset export job status was last updated.
failureReason (string) --
If a dataset export job fails, the reason behind the failure.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListDatasetGroups¶paginator = client.get_paginator('list_dataset_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_dataset_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'datasetGroups': [
{
'name': 'string',
'datasetGroupArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
},
],
'NextToken': 'string'
}
Response Structure
The list of your dataset groups.
Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.
The name of the dataset group.
The Amazon Resource Name (ARN) of the dataset group.
The status of the dataset group.
A dataset group can be in one of the following states:
The date and time (in Unix time) that the dataset group was created.
The date and time (in Unix time) that the dataset group was last updated.
If creating a dataset group fails, the reason behind the failure.
The domain of a Domain dataset group.
A token to resume pagination.
Personalize.Paginator.ListDatasetImportJobs¶paginator = client.get_paginator('list_dataset_import_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_dataset_import_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'datasetImportJobs': [
{
'datasetImportJobArn': 'string',
'jobName': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'importMode': 'FULL'|'INCREMENTAL'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
datasetImportJobs (list) --
The list of dataset import jobs.
(dict) --
Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.
datasetImportJobArn (string) --
The Amazon Resource Name (ARN) of the dataset import job.
jobName (string) --
The name of the dataset import job.
status (string) --
The status of the dataset import job.
A dataset import job can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the dataset import job was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the dataset import job status was last updated.
failureReason (string) --
If a dataset import job fails, the reason behind the failure.
importMode (string) --
The import mode the dataset import job used to update the data in the dataset. For more information see Updating existing bulk data.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListDatasets¶paginator = client.get_paginator('list_datasets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_datasets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetGroupArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'datasets': [
{
'name': 'string',
'datasetArn': 'string',
'datasetType': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
datasets (list) --
An array of Dataset objects. Each object provides metadata information.
(dict) --
Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.
name (string) --
The name of the dataset.
datasetArn (string) --
The Amazon Resource Name (ARN) of the dataset.
datasetType (string) --
The dataset type. One of the following values:
status (string) --
The status of the dataset.
A dataset can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the dataset was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the dataset was last updated.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListEventTrackers¶paginator = client.get_paginator('list_event_trackers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_event_trackers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetGroupArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'eventTrackers': [
{
'name': 'string',
'eventTrackerArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
eventTrackers (list) --
A list of event trackers.
(dict) --
Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.
name (string) --
The name of the event tracker.
eventTrackerArn (string) --
The Amazon Resource Name (ARN) of the event tracker.
status (string) --
The status of the event tracker.
An event tracker can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the event tracker was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the event tracker was last updated.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListFilters¶paginator = client.get_paginator('list_filters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_filters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetGroupArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Filters': [
{
'name': 'string',
'filterArn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'datasetGroupArn': 'string',
'failureReason': 'string',
'status': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Filters (list) --
A list of returned filters.
(dict) --
A short summary of a filter's attributes.
name (string) --
The name of the filter.
filterArn (string) --
The ARN of the filter.
creationDateTime (datetime) --
The time at which the filter was created.
lastUpdatedDateTime (datetime) --
The time at which the filter was last updated.
datasetGroupArn (string) --
The ARN of the dataset group to which the filter belongs.
failureReason (string) --
If the filter failed, the reason for the failure.
status (string) --
The status of the filter.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListMetricAttributionMetrics¶paginator = client.get_paginator('list_metric_attribution_metrics')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_metric_attribution_metrics().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
metricAttributionArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'metrics': [
{
'eventType': 'string',
'metricName': 'string',
'expression': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
metrics (list) --
The metrics for the specified metric attribution.
(dict) --
Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.
eventType (string) --
The metric's event type.
metricName (string) --
The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
expression (string) --
The attribute's expression. Available functions are SUM() or SAMPLECOUNT() . For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListMetricAttributions¶paginator = client.get_paginator('list_metric_attributions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_metric_attributions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetGroupArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'metricAttributions': [
{
'name': 'string',
'metricAttributionArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
metricAttributions (list) --
The list of metric attributions.
(dict) --
Provides a summary of the properties of a metric attribution. For a complete listing, call the DescribeMetricAttribution.
name (string) --
The name of the metric attribution.
metricAttributionArn (string) --
The metric attribution's Amazon Resource Name (ARN).
status (string) --
The metric attribution's status.
creationDateTime (datetime) --
The metric attribution's creation date time.
lastUpdatedDateTime (datetime) --
The metric attribution's last updated date time.
failureReason (string) --
The metric attribution's failure reason.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListRecipes¶paginator = client.get_paginator('list_recipes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_recipes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
recipeProvider='SERVICE',
domain='ECOMMERCE'|'VIDEO_ON_DEMAND',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
SERVICE .A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'recipes': [
{
'name': 'string',
'recipeArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
recipes (list) --
The list of available recipes.
(dict) --
Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.
name (string) --
The name of the recipe.
recipeArn (string) --
The Amazon Resource Name (ARN) of the recipe.
status (string) --
The status of the recipe.
creationDateTime (datetime) --
The date and time (in Unix time) that the recipe was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the recipe was last updated.
domain (string) --
The domain of the recipe (if the recipe is a Domain dataset group use case).
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListRecommenders¶paginator = client.get_paginator('list_recommenders')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_recommenders().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetGroupArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'recommenders': [
{
'name': 'string',
'recommenderArn': 'string',
'datasetGroupArn': 'string',
'recipeArn': 'string',
'recommenderConfig': {
'itemExplorationConfig': {
'string': 'string'
},
'minRecommendationRequestsPerSecond': 123
},
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
recommenders (list) --
A list of the recommenders.
(dict) --
Provides a summary of the properties of the recommender.
name (string) --
The name of the recommender.
recommenderArn (string) --
The Amazon Resource Name (ARN) of the recommender.
datasetGroupArn (string) --
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
recipeArn (string) --
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
recommenderConfig (dict) --
The configuration details of the recommender.
itemExplorationConfig (dict) --
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
minRecommendationRequestsPerSecond (integer) --
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
status (string) --
The status of the recommender. A recommender can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix format) that the recommender was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix format) that the recommender was last updated.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListSchemas¶paginator = client.get_paginator('list_schemas')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_schemas().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'schemas': [
{
'name': 'string',
'schemaArn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
},
],
'NextToken': 'string'
}
Response Structure
A list of schemas.
Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.
The name of the schema.
The Amazon Resource Name (ARN) of the schema.
The date and time (in Unix time) that the schema was created.
The date and time (in Unix time) that the schema was last updated.
The domain of a schema that you created for a dataset in a Domain dataset group.
A token to resume pagination.
Personalize.Paginator.ListSolutionVersions¶paginator = client.get_paginator('list_solution_versions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_solution_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
solutionArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'solutionVersions': [
{
'solutionVersionArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
solutionVersions (list) --
A list of solution versions describing the version properties.
(dict) --
Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.
solutionVersionArn (string) --
The Amazon Resource Name (ARN) of the solution version.
status (string) --
The status of the solution version.
A solution version can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that this version of a solution was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the solution version was last updated.
failureReason (string) --
If a solution version fails, the reason behind the failure.
NextToken (string) --
A token to resume pagination.
Personalize.Paginator.ListSolutions¶paginator = client.get_paginator('list_solutions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Personalize.Client.list_solutions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetGroupArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'solutions': [
{
'name': 'string',
'solutionArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'recipeArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
solutions (list) --
A list of the current solutions.
(dict) --
Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.
name (string) --
The name of the solution.
solutionArn (string) --
The Amazon Resource Name (ARN) of the solution.
status (string) --
The status of the solution.
A solution can be in one of the following states:
creationDateTime (datetime) --
The date and time (in Unix time) that the solution was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the solution was last updated.
recipeArn (string) --
The Amazon Resource Name (ARN) of the recipe used by the solution.
NextToken (string) --
A token to resume pagination.