aws-sdk-personalize 1.57.0 → 1.59.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-personalize/client.rb +44 -31
- data/lib/aws-sdk-personalize/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-personalize/types.rb +22 -10
- data/lib/aws-sdk-personalize.rb +1 -1
- data/sig/client.rbs +1020 -0
- data/sig/errors.rbs +40 -0
- data/sig/resource.rbs +80 -0
- data/sig/types.rbs +1420 -0
- data/sig/waiters.rbs +13 -0
- metadata +13 -8
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1bbf9f9dfaa6c21ec60de92115714cf616ed34a13314feee44adda460b367b32
|
4
|
+
data.tar.gz: e87dcd0cfb2a597c90352605368508874c53764348eb25b04dad8209f579a1fe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 45a8d39268c544f6f2b8c6006aa722ee2e9239eb8ea8d4ce02f52a83ed10ec4f42a4cab3cc7c30acd291ee6547c73b605a609d5a88cc92443dfcd432ea6e5c58
|
7
|
+
data.tar.gz: 60a9bb3ca25d87016682be7d0d05e60c29ea348e2d5844b350e973df8fe967c3b599787d104c656bf609397815fac1af3dc1cea6dd97cf1b67f389e447a18728
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.59.0 (2024-01-26)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.58.0 (2024-01-16)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Documentation updates for Amazon Personalize.
|
13
|
+
|
4
14
|
1.57.0 (2023-11-28)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.59.0
|
@@ -644,28 +644,34 @@ module Aws::Personalize
|
|
644
644
|
#
|
645
645
|
# **Minimum Provisioned TPS and Auto-Scaling**
|
646
646
|
#
|
647
|
-
# A high `minProvisionedTPS` will increase your
|
647
|
+
# A high `minProvisionedTPS` will increase your cost. We recommend
|
648
648
|
# starting with 1 for `minProvisionedTPS` (the default). Track your
|
649
649
|
# usage using Amazon CloudWatch metrics, and increase the
|
650
650
|
# `minProvisionedTPS` as necessary.
|
651
651
|
#
|
652
|
-
#
|
653
|
-
#
|
654
|
-
#
|
655
|
-
# provisioned
|
656
|
-
#
|
657
|
-
#
|
658
|
-
#
|
659
|
-
#
|
660
|
-
#
|
661
|
-
#
|
662
|
-
#
|
652
|
+
# When you create an Amazon Personalize campaign, you can specify the
|
653
|
+
# minimum provisioned transactions per second (`minProvisionedTPS`) for
|
654
|
+
# the campaign. This is the baseline transaction throughput for the
|
655
|
+
# campaign provisioned by Amazon Personalize. It sets the minimum
|
656
|
+
# billing charge for the campaign while it is active. A transaction is a
|
657
|
+
# single `GetRecommendations` or `GetPersonalizedRanking` request. The
|
658
|
+
# default `minProvisionedTPS` is 1.
|
659
|
+
#
|
660
|
+
# If your TPS increases beyond the `minProvisionedTPS`, Amazon
|
661
|
+
# Personalize auto-scales the provisioned capacity up and down, but
|
662
|
+
# never below `minProvisionedTPS`. There's a short time delay while the
|
663
|
+
# capacity is increased that might cause loss of transactions. When your
|
664
|
+
# traffic reduces, capacity returns to the `minProvisionedTPS`.
|
665
|
+
#
|
666
|
+
# You are charged for the the minimum provisioned TPS or, if your
|
667
|
+
# requests exceed the `minProvisionedTPS`, the actual TPS. The actual
|
668
|
+
# TPS is the total number of recommendation requests you make. We
|
669
|
+
# recommend starting with a low `minProvisionedTPS`, track your usage
|
670
|
+
# using Amazon CloudWatch metrics, and then increase the
|
671
|
+
# `minProvisionedTPS` as necessary.
|
663
672
|
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
# provisioned TPS or the actual TPS. We recommend starting with a low
|
667
|
-
# `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics,
|
668
|
-
# and then increase the `minProvisionedTPS` as necessary.
|
673
|
+
# For more information about campaign costs, see [Amazon Personalize
|
674
|
+
# pricing][3].
|
669
675
|
#
|
670
676
|
# **Status**
|
671
677
|
#
|
@@ -676,7 +682,7 @@ module Aws::Personalize
|
|
676
682
|
#
|
677
683
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
678
684
|
#
|
679
|
-
# To get the campaign status, call [DescribeCampaign][
|
685
|
+
# To get the campaign status, call [DescribeCampaign][4].
|
680
686
|
#
|
681
687
|
# <note markdown="1"> Wait until the `status` of the campaign is `ACTIVE` before asking the
|
682
688
|
# campaign for recommendations.
|
@@ -685,22 +691,23 @@ module Aws::Personalize
|
|
685
691
|
#
|
686
692
|
# **Related APIs**
|
687
693
|
#
|
688
|
-
# * [ListCampaigns][
|
694
|
+
# * [ListCampaigns][5]
|
689
695
|
#
|
690
|
-
# * [DescribeCampaign][
|
696
|
+
# * [DescribeCampaign][4]
|
691
697
|
#
|
692
|
-
# * [UpdateCampaign][
|
698
|
+
# * [UpdateCampaign][6]
|
693
699
|
#
|
694
|
-
# * [DeleteCampaign][
|
700
|
+
# * [DeleteCampaign][7]
|
695
701
|
#
|
696
702
|
#
|
697
703
|
#
|
698
704
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
699
705
|
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html
|
700
|
-
# [3]: https://
|
701
|
-
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/
|
702
|
-
# [5]: https://docs.aws.amazon.com/personalize/latest/dg/
|
703
|
-
# [6]: https://docs.aws.amazon.com/personalize/latest/dg/
|
706
|
+
# [3]: https://aws.amazon.com/personalize/pricing/
|
707
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
|
708
|
+
# [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
|
709
|
+
# [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html
|
710
|
+
# [7]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html
|
704
711
|
#
|
705
712
|
# @option params [required, String] :name
|
706
713
|
# A name for the new campaign. The campaign name must be unique within
|
@@ -1721,7 +1728,7 @@ module Aws::Personalize
|
|
1721
1728
|
# @option params [Boolean] :perform_auto_ml
|
1722
1729
|
# We don't recommend enabling automated machine learning. Instead,
|
1723
1730
|
# match your use case to the available Amazon Personalize recipes. For
|
1724
|
-
# more information, see [
|
1731
|
+
# more information, see [Choosing a recipe][1].
|
1725
1732
|
#
|
1726
1733
|
# Whether to perform automated machine learning (AutoML). The default is
|
1727
1734
|
# `false`. For this case, you must specify `recipeArn`.
|
@@ -1735,11 +1742,17 @@ module Aws::Personalize
|
|
1735
1742
|
#
|
1736
1743
|
#
|
1737
1744
|
#
|
1738
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/
|
1745
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
|
1739
1746
|
#
|
1740
1747
|
# @option params [String] :recipe_arn
|
1741
|
-
# The ARN of the recipe to use for model
|
1742
|
-
# `performAutoML` is false.
|
1748
|
+
# The Amazon Resource Name (ARN) of the recipe to use for model
|
1749
|
+
# training. This is required when `performAutoML` is false. For
|
1750
|
+
# information about different Amazon Personalize recipes and their ARNs,
|
1751
|
+
# see [Choosing a recipe][1].
|
1752
|
+
#
|
1753
|
+
#
|
1754
|
+
#
|
1755
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
|
1743
1756
|
#
|
1744
1757
|
# @option params [required, String] :dataset_group_arn
|
1745
1758
|
# The Amazon Resource Name (ARN) of the dataset group that provides the
|
@@ -4397,7 +4410,7 @@ module Aws::Personalize
|
|
4397
4410
|
params: params,
|
4398
4411
|
config: config)
|
4399
4412
|
context[:gem_name] = 'aws-sdk-personalize'
|
4400
|
-
context[:gem_version] = '1.
|
4413
|
+
context[:gem_version] = '1.59.0'
|
4401
4414
|
Seahorse::Client::Request.new(handlers, context)
|
4402
4415
|
end
|
4403
4416
|
|
@@ -14,6 +14,7 @@ module Aws::Personalize
|
|
14
14
|
option(
|
15
15
|
:endpoint_provider,
|
16
16
|
doc_type: 'Aws::Personalize::EndpointProvider',
|
17
|
+
rbs_type: 'untyped',
|
17
18
|
docstring: 'The endpoint provider used to resolve endpoints. Any '\
|
18
19
|
'object that responds to `#resolve_endpoint(parameters)` '\
|
19
20
|
'where `parameters` is a Struct similar to '\
|
@@ -630,14 +630,17 @@ module Aws::Personalize
|
|
630
630
|
# Whether metadata with recommendations is enabled for the campaign.
|
631
631
|
# If enabled, you can specify the columns from your Items dataset in
|
632
632
|
# your request for recommendations. Amazon Personalize returns this
|
633
|
-
# data for each item in the recommendation response.
|
633
|
+
# data for each item in the recommendation response. For information
|
634
|
+
# about enabling metadata for a campaign, see [Enabling metadata in
|
635
|
+
# recommendations for a campaign][1].
|
634
636
|
#
|
635
637
|
# If you enable metadata in recommendations, you will incur additional
|
636
|
-
# costs. For more information, see [Amazon Personalize pricing][
|
638
|
+
# costs. For more information, see [Amazon Personalize pricing][2].
|
637
639
|
#
|
638
640
|
#
|
639
641
|
#
|
640
|
-
# [1]: https://aws.amazon.com/personalize/
|
642
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata
|
643
|
+
# [2]: https://aws.amazon.com/personalize/pricing/
|
641
644
|
# @return [Boolean]
|
642
645
|
#
|
643
646
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
|
@@ -1534,7 +1537,7 @@ module Aws::Personalize
|
|
1534
1537
|
# @!attribute [rw] perform_auto_ml
|
1535
1538
|
# We don't recommend enabling automated machine learning. Instead,
|
1536
1539
|
# match your use case to the available Amazon Personalize recipes. For
|
1537
|
-
# more information, see [
|
1540
|
+
# more information, see [Choosing a recipe][1].
|
1538
1541
|
#
|
1539
1542
|
# Whether to perform automated machine learning (AutoML). The default
|
1540
1543
|
# is `false`. For this case, you must specify `recipeArn`.
|
@@ -1548,12 +1551,18 @@ module Aws::Personalize
|
|
1548
1551
|
#
|
1549
1552
|
#
|
1550
1553
|
#
|
1551
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/
|
1554
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
|
1552
1555
|
# @return [Boolean]
|
1553
1556
|
#
|
1554
1557
|
# @!attribute [rw] recipe_arn
|
1555
|
-
# The ARN of the recipe to use for model
|
1556
|
-
# when `performAutoML` is false.
|
1558
|
+
# The Amazon Resource Name (ARN) of the recipe to use for model
|
1559
|
+
# training. This is required when `performAutoML` is false. For
|
1560
|
+
# information about different Amazon Personalize recipes and their
|
1561
|
+
# ARNs, see [Choosing a recipe][1].
|
1562
|
+
#
|
1563
|
+
#
|
1564
|
+
#
|
1565
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
|
1557
1566
|
# @return [String]
|
1558
1567
|
#
|
1559
1568
|
# @!attribute [rw] dataset_group_arn
|
@@ -4645,14 +4654,17 @@ module Aws::Personalize
|
|
4645
4654
|
# Whether metadata with recommendations is enabled for the
|
4646
4655
|
# recommender. If enabled, you can specify the columns from your Items
|
4647
4656
|
# dataset in your request for recommendations. Amazon Personalize
|
4648
|
-
# returns this data for each item in the recommendation response.
|
4657
|
+
# returns this data for each item in the recommendation response. For
|
4658
|
+
# information about enabling metadata for a recommender, see [Enabling
|
4659
|
+
# metadata in recommendations for a recommender][1].
|
4649
4660
|
#
|
4650
4661
|
# If you enable metadata in recommendations, you will incur additional
|
4651
|
-
# costs. For more information, see [Amazon Personalize pricing][
|
4662
|
+
# costs. For more information, see [Amazon Personalize pricing][2].
|
4652
4663
|
#
|
4653
4664
|
#
|
4654
4665
|
#
|
4655
|
-
# [1]: https://aws.amazon.com/personalize/
|
4666
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata
|
4667
|
+
# [2]: https://aws.amazon.com/personalize/pricing/
|
4656
4668
|
# @return [Boolean]
|
4657
4669
|
#
|
4658
4670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderConfig AWS API Documentation
|