aws-sdk-personalize 1.37.0 → 1.40.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-personalize/client.rb +562 -118
- data/lib/aws-sdk-personalize/client_api.rb +105 -0
- data/lib/aws-sdk-personalize/errors.rb +32 -0
- data/lib/aws-sdk-personalize/types.rb +520 -56
- data/lib/aws-sdk-personalize.rb +1 -1
- metadata +4 -4
@@ -27,7 +27,9 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
31
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
32
34
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
33
35
|
|
@@ -74,7 +76,9 @@ module Aws::Personalize
|
|
74
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
75
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
76
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
77
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
78
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
79
83
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
80
84
|
|
@@ -359,7 +363,11 @@ module Aws::Personalize
|
|
359
363
|
|
360
364
|
# Creates a batch inference job. The operation can handle up to 50
|
361
365
|
# million records and the input file must be in JSON format. For more
|
362
|
-
# information, see
|
366
|
+
# information, see [Creating a batch inference job][1].
|
367
|
+
#
|
368
|
+
#
|
369
|
+
#
|
370
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html
|
363
371
|
#
|
364
372
|
# @option params [required, String] :job_name
|
365
373
|
# The name of the batch inference job to create.
|
@@ -370,15 +378,15 @@ module Aws::Personalize
|
|
370
378
|
#
|
371
379
|
# @option params [String] :filter_arn
|
372
380
|
# The ARN of the filter to apply to the batch inference job. For more
|
373
|
-
# information on using filters, see [Filtering
|
374
|
-
#
|
381
|
+
# information on using filters, see [Filtering batch
|
382
|
+
# recommendations][1].
|
375
383
|
#
|
376
384
|
#
|
377
385
|
#
|
378
386
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
|
379
387
|
#
|
380
388
|
# @option params [Integer] :num_results
|
381
|
-
# The number of recommendations to
|
389
|
+
# The number of recommendations to retrieve.
|
382
390
|
#
|
383
391
|
# @option params [required, Types::BatchInferenceJobInput] :job_input
|
384
392
|
# The Amazon S3 path that leads to the input file to base your
|
@@ -396,6 +404,13 @@ module Aws::Personalize
|
|
396
404
|
# @option params [Types::BatchInferenceJobConfig] :batch_inference_job_config
|
397
405
|
# The configuration details of a batch inference job.
|
398
406
|
#
|
407
|
+
# @option params [Array<Types::Tag>] :tags
|
408
|
+
# A list of [tags][1] to apply to the batch inference job.
|
409
|
+
#
|
410
|
+
#
|
411
|
+
#
|
412
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
413
|
+
#
|
399
414
|
# @return [Types::CreateBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
400
415
|
#
|
401
416
|
# * {Types::CreateBatchInferenceJobResponse#batch_inference_job_arn #batch_inference_job_arn} => String
|
@@ -425,6 +440,12 @@ module Aws::Personalize
|
|
425
440
|
# "ParameterName" => "ParameterValue",
|
426
441
|
# },
|
427
442
|
# },
|
443
|
+
# tags: [
|
444
|
+
# {
|
445
|
+
# tag_key: "TagKey", # required
|
446
|
+
# tag_value: "TagValue", # required
|
447
|
+
# },
|
448
|
+
# ],
|
428
449
|
# })
|
429
450
|
#
|
430
451
|
# @example Response structure
|
@@ -442,7 +463,11 @@ module Aws::Personalize
|
|
442
463
|
|
443
464
|
# Creates a batch segment job. The operation can handle up to 50 million
|
444
465
|
# records and the input file must be in JSON format. For more
|
445
|
-
# information, see recommendations
|
466
|
+
# information, see [Getting batch recommendations and user segments][1].
|
467
|
+
#
|
468
|
+
#
|
469
|
+
#
|
470
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html
|
446
471
|
#
|
447
472
|
# @option params [required, String] :job_name
|
448
473
|
# The name of the batch segment job to create.
|
@@ -453,7 +478,12 @@ module Aws::Personalize
|
|
453
478
|
#
|
454
479
|
# @option params [String] :filter_arn
|
455
480
|
# The ARN of the filter to apply to the batch segment job. For more
|
456
|
-
# information on using filters, see
|
481
|
+
# information on using filters, see [Filtering batch
|
482
|
+
# recommendations][1].
|
483
|
+
#
|
484
|
+
#
|
485
|
+
#
|
486
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
|
457
487
|
#
|
458
488
|
# @option params [Integer] :num_results
|
459
489
|
# The number of predicted users generated by the batch segment job for
|
@@ -472,6 +502,13 @@ module Aws::Personalize
|
|
472
502
|
# permissions to read and write to your input and output Amazon S3
|
473
503
|
# buckets respectively.
|
474
504
|
#
|
505
|
+
# @option params [Array<Types::Tag>] :tags
|
506
|
+
# A list of [tags][1] to apply to the batch segment job.
|
507
|
+
#
|
508
|
+
#
|
509
|
+
#
|
510
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
511
|
+
#
|
475
512
|
# @return [Types::CreateBatchSegmentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
476
513
|
#
|
477
514
|
# * {Types::CreateBatchSegmentJobResponse#batch_segment_job_arn #batch_segment_job_arn} => String
|
@@ -496,6 +533,12 @@ module Aws::Personalize
|
|
496
533
|
# },
|
497
534
|
# },
|
498
535
|
# role_arn: "RoleArn", # required
|
536
|
+
# tags: [
|
537
|
+
# {
|
538
|
+
# tag_key: "TagKey", # required
|
539
|
+
# tag_value: "TagValue", # required
|
540
|
+
# },
|
541
|
+
# ],
|
499
542
|
# })
|
500
543
|
#
|
501
544
|
# @example Response structure
|
@@ -544,7 +587,7 @@ module Aws::Personalize
|
|
544
587
|
#
|
545
588
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
546
589
|
#
|
547
|
-
# To get the campaign status, call DescribeCampaign.
|
590
|
+
# To get the campaign status, call [DescribeCampaign][3].
|
548
591
|
#
|
549
592
|
# <note markdown="1"> Wait until the `status` of the campaign is `ACTIVE` before asking the
|
550
593
|
# campaign for recommendations.
|
@@ -553,18 +596,22 @@ module Aws::Personalize
|
|
553
596
|
#
|
554
597
|
# **Related APIs**
|
555
598
|
#
|
556
|
-
# * ListCampaigns
|
599
|
+
# * [ListCampaigns][4]
|
557
600
|
#
|
558
|
-
# * DescribeCampaign
|
601
|
+
# * [DescribeCampaign][3]
|
559
602
|
#
|
560
|
-
# * UpdateCampaign
|
603
|
+
# * [UpdateCampaign][5]
|
561
604
|
#
|
562
|
-
# * DeleteCampaign
|
605
|
+
# * [DeleteCampaign][6]
|
563
606
|
#
|
564
607
|
#
|
565
608
|
#
|
566
609
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
567
610
|
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html
|
611
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
|
612
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
|
613
|
+
# [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html
|
614
|
+
# [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html
|
568
615
|
#
|
569
616
|
# @option params [required, String] :name
|
570
617
|
# A name for the new campaign. The campaign name must be unique within
|
@@ -580,6 +627,13 @@ module Aws::Personalize
|
|
580
627
|
# @option params [Types::CampaignConfig] :campaign_config
|
581
628
|
# The configuration details of a campaign.
|
582
629
|
#
|
630
|
+
# @option params [Array<Types::Tag>] :tags
|
631
|
+
# A list of [tags][1] to apply to the campaign.
|
632
|
+
#
|
633
|
+
#
|
634
|
+
#
|
635
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
636
|
+
#
|
583
637
|
# @return [Types::CreateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
584
638
|
#
|
585
639
|
# * {Types::CreateCampaignResponse#campaign_arn #campaign_arn} => String
|
@@ -595,6 +649,12 @@ module Aws::Personalize
|
|
595
649
|
# "ParameterName" => "ParameterValue",
|
596
650
|
# },
|
597
651
|
# },
|
652
|
+
# tags: [
|
653
|
+
# {
|
654
|
+
# tag_key: "TagKey", # required
|
655
|
+
# tag_value: "TagValue", # required
|
656
|
+
# },
|
657
|
+
# ],
|
598
658
|
# })
|
599
659
|
#
|
600
660
|
# @example Response structure
|
@@ -611,7 +671,8 @@ module Aws::Personalize
|
|
611
671
|
end
|
612
672
|
|
613
673
|
# Creates an empty dataset and adds it to the specified dataset group.
|
614
|
-
# Use CreateDatasetImportJob to import your training data to a
|
674
|
+
# Use [CreateDatasetImportJob][1] to import your training data to a
|
675
|
+
# dataset.
|
615
676
|
#
|
616
677
|
# There are three types of datasets:
|
617
678
|
#
|
@@ -632,17 +693,25 @@ module Aws::Personalize
|
|
632
693
|
#
|
633
694
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
634
695
|
#
|
635
|
-
# To get the status of the dataset, call DescribeDataset.
|
696
|
+
# To get the status of the dataset, call [DescribeDataset][2].
|
636
697
|
#
|
637
698
|
# **Related APIs**
|
638
699
|
#
|
639
|
-
# * CreateDatasetGroup
|
700
|
+
# * [CreateDatasetGroup][3]
|
701
|
+
#
|
702
|
+
# * [ListDatasets][4]
|
703
|
+
#
|
704
|
+
# * [DescribeDataset][2]
|
640
705
|
#
|
641
|
-
# *
|
706
|
+
# * [DeleteDataset][5]
|
642
707
|
#
|
643
|
-
# * DescribeDataset
|
644
708
|
#
|
645
|
-
#
|
709
|
+
#
|
710
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html
|
711
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html
|
712
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html
|
713
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html
|
714
|
+
# [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html
|
646
715
|
#
|
647
716
|
# @option params [required, String] :name
|
648
717
|
# The name for the dataset.
|
@@ -666,6 +735,13 @@ module Aws::Personalize
|
|
666
735
|
#
|
667
736
|
# * Users
|
668
737
|
#
|
738
|
+
# @option params [Array<Types::Tag>] :tags
|
739
|
+
# A list of [tags][1] to apply to the dataset.
|
740
|
+
#
|
741
|
+
#
|
742
|
+
#
|
743
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
744
|
+
#
|
669
745
|
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
670
746
|
#
|
671
747
|
# * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
|
@@ -677,6 +753,12 @@ module Aws::Personalize
|
|
677
753
|
# schema_arn: "Arn", # required
|
678
754
|
# dataset_group_arn: "Arn", # required
|
679
755
|
# dataset_type: "DatasetType", # required
|
756
|
+
# tags: [
|
757
|
+
# {
|
758
|
+
# tag_key: "TagKey", # required
|
759
|
+
# tag_value: "TagValue", # required
|
760
|
+
# },
|
761
|
+
# ],
|
680
762
|
# })
|
681
763
|
#
|
682
764
|
# @example Response structure
|
@@ -708,15 +790,17 @@ module Aws::Personalize
|
|
708
790
|
#
|
709
791
|
# ^
|
710
792
|
#
|
711
|
-
# To get the status of the export job, call
|
712
|
-
# and specify the Amazon Resource Name
|
713
|
-
# The dataset export is complete when
|
714
|
-
# status shows as
|
715
|
-
# key, which describes why the job
|
793
|
+
# To get the status of the export job, call
|
794
|
+
# [DescribeDatasetExportJob][2], and specify the Amazon Resource Name
|
795
|
+
# (ARN) of the dataset export job. The dataset export is complete when
|
796
|
+
# the status shows as ACTIVE. If the status shows as CREATE FAILED, the
|
797
|
+
# response includes a `failureReason` key, which describes why the job
|
798
|
+
# failed.
|
716
799
|
#
|
717
800
|
#
|
718
801
|
#
|
719
802
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/export-data.html
|
803
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html
|
720
804
|
#
|
721
805
|
# @option params [required, String] :job_name
|
722
806
|
# The name for the dataset export job.
|
@@ -739,6 +823,13 @@ module Aws::Personalize
|
|
739
823
|
# @option params [required, Types::DatasetExportJobOutput] :job_output
|
740
824
|
# The path to the Amazon S3 bucket where the job's output is stored.
|
741
825
|
#
|
826
|
+
# @option params [Array<Types::Tag>] :tags
|
827
|
+
# A list of [tags][1] to apply to the dataset export job.
|
828
|
+
#
|
829
|
+
#
|
830
|
+
#
|
831
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
832
|
+
#
|
742
833
|
# @return [Types::CreateDatasetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
743
834
|
#
|
744
835
|
# * {Types::CreateDatasetExportJobResponse#dataset_export_job_arn #dataset_export_job_arn} => String
|
@@ -756,6 +847,12 @@ module Aws::Personalize
|
|
756
847
|
# kms_key_arn: "KmsKeyArn",
|
757
848
|
# },
|
758
849
|
# },
|
850
|
+
# tags: [
|
851
|
+
# {
|
852
|
+
# tag_key: "TagKey", # required
|
853
|
+
# tag_value: "TagValue", # required
|
854
|
+
# },
|
855
|
+
# ],
|
759
856
|
# })
|
760
857
|
#
|
761
858
|
# @example Response structure
|
@@ -796,9 +893,10 @@ module Aws::Personalize
|
|
796
893
|
#
|
797
894
|
# * DELETE PENDING
|
798
895
|
#
|
799
|
-
# To get the status of the dataset group, call
|
800
|
-
# the status shows as CREATE FAILED, the
|
801
|
-
# `failureReason` key, which describes why the
|
896
|
+
# To get the status of the dataset group, call
|
897
|
+
# [DescribeDatasetGroup][1]. If the status shows as CREATE FAILED, the
|
898
|
+
# response includes a `failureReason` key, which describes why the
|
899
|
+
# creation failed.
|
802
900
|
#
|
803
901
|
# <note markdown="1"> You must wait until the `status` of the dataset group is `ACTIVE`
|
804
902
|
# before adding a dataset to the group.
|
@@ -812,19 +910,28 @@ module Aws::Personalize
|
|
812
910
|
#
|
813
911
|
# **APIs that require a dataset group ARN in the request**
|
814
912
|
#
|
815
|
-
# * CreateDataset
|
913
|
+
# * [CreateDataset][2]
|
816
914
|
#
|
817
|
-
# * CreateEventTracker
|
915
|
+
# * [CreateEventTracker][3]
|
818
916
|
#
|
819
|
-
# * CreateSolution
|
917
|
+
# * [CreateSolution][4]
|
820
918
|
#
|
821
919
|
# **Related APIs**
|
822
920
|
#
|
823
|
-
# * ListDatasetGroups
|
921
|
+
# * [ListDatasetGroups][5]
|
922
|
+
#
|
923
|
+
# * [DescribeDatasetGroup][1]
|
924
|
+
#
|
925
|
+
# * [DeleteDatasetGroup][6]
|
926
|
+
#
|
824
927
|
#
|
825
|
-
# * DescribeDatasetGroup
|
826
928
|
#
|
827
|
-
#
|
929
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html
|
930
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
|
931
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html
|
932
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
933
|
+
# [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html
|
934
|
+
# [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html
|
828
935
|
#
|
829
936
|
# @option params [required, String] :name
|
830
937
|
# The name for the new dataset group.
|
@@ -845,6 +952,13 @@ module Aws::Personalize
|
|
845
952
|
# don't specify a domain, you create a Custom dataset group with
|
846
953
|
# solution versions that you deploy with a campaign.
|
847
954
|
#
|
955
|
+
# @option params [Array<Types::Tag>] :tags
|
956
|
+
# A list of [tags][1] to apply to the dataset group.
|
957
|
+
#
|
958
|
+
#
|
959
|
+
#
|
960
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
961
|
+
#
|
848
962
|
# @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
849
963
|
#
|
850
964
|
# * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
|
@@ -857,6 +971,12 @@ module Aws::Personalize
|
|
857
971
|
# role_arn: "RoleArn",
|
858
972
|
# kms_key_arn: "KmsKeyArn",
|
859
973
|
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
974
|
+
# tags: [
|
975
|
+
# {
|
976
|
+
# tag_key: "TagKey", # required
|
977
|
+
# tag_value: "TagValue", # required
|
978
|
+
# },
|
979
|
+
# ],
|
860
980
|
# })
|
861
981
|
#
|
862
982
|
# @example Response structure
|
@@ -894,11 +1014,12 @@ module Aws::Personalize
|
|
894
1014
|
#
|
895
1015
|
# ^
|
896
1016
|
#
|
897
|
-
# To get the status of the import job, call
|
898
|
-
# providing the Amazon Resource Name
|
899
|
-
# The dataset import is complete when
|
900
|
-
# status shows as
|
901
|
-
# key, which describes why the job
|
1017
|
+
# To get the status of the import job, call
|
1018
|
+
# [DescribeDatasetImportJob][2], providing the Amazon Resource Name
|
1019
|
+
# (ARN) of the dataset import job. The dataset import is complete when
|
1020
|
+
# the status shows as ACTIVE. If the status shows as CREATE FAILED, the
|
1021
|
+
# response includes a `failureReason` key, which describes why the job
|
1022
|
+
# failed.
|
902
1023
|
#
|
903
1024
|
# <note markdown="1"> Importing takes time. You must wait until the status shows as ACTIVE
|
904
1025
|
# before training a model using the dataset.
|
@@ -907,13 +1028,15 @@ module Aws::Personalize
|
|
907
1028
|
#
|
908
1029
|
# **Related APIs**
|
909
1030
|
#
|
910
|
-
# * ListDatasetImportJobs
|
1031
|
+
# * [ListDatasetImportJobs][3]
|
911
1032
|
#
|
912
|
-
# * DescribeDatasetImportJob
|
1033
|
+
# * [DescribeDatasetImportJob][2]
|
913
1034
|
#
|
914
1035
|
#
|
915
1036
|
#
|
916
1037
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html
|
1038
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html
|
1039
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html
|
917
1040
|
#
|
918
1041
|
# @option params [required, String] :job_name
|
919
1042
|
# The name for the dataset import job.
|
@@ -928,6 +1051,13 @@ module Aws::Personalize
|
|
928
1051
|
# The ARN of the IAM role that has permissions to read from the Amazon
|
929
1052
|
# S3 data source.
|
930
1053
|
#
|
1054
|
+
# @option params [Array<Types::Tag>] :tags
|
1055
|
+
# A list of [tags][1] to apply to the dataset import job.
|
1056
|
+
#
|
1057
|
+
#
|
1058
|
+
#
|
1059
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
1060
|
+
#
|
931
1061
|
# @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
932
1062
|
#
|
933
1063
|
# * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
|
@@ -941,6 +1071,12 @@ module Aws::Personalize
|
|
941
1071
|
# data_location: "S3Location",
|
942
1072
|
# },
|
943
1073
|
# role_arn: "RoleArn", # required
|
1074
|
+
# tags: [
|
1075
|
+
# {
|
1076
|
+
# tag_key: "TagKey", # required
|
1077
|
+
# tag_value: "TagValue", # required
|
1078
|
+
# },
|
1079
|
+
# ],
|
944
1080
|
# })
|
945
1081
|
#
|
946
1082
|
# @example Response structure
|
@@ -978,7 +1114,8 @@ module Aws::Personalize
|
|
978
1114
|
#
|
979
1115
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
980
1116
|
#
|
981
|
-
# To get the status of the event tracker, call
|
1117
|
+
# To get the status of the event tracker, call
|
1118
|
+
# [DescribeEventTracker][2].
|
982
1119
|
#
|
983
1120
|
# <note markdown="1"> The event tracker must be in the ACTIVE state before using the
|
984
1121
|
# tracking ID.
|
@@ -987,15 +1124,18 @@ module Aws::Personalize
|
|
987
1124
|
#
|
988
1125
|
# **Related APIs**
|
989
1126
|
#
|
990
|
-
# * ListEventTrackers
|
1127
|
+
# * [ListEventTrackers][3]
|
991
1128
|
#
|
992
|
-
# * DescribeEventTracker
|
1129
|
+
# * [DescribeEventTracker][2]
|
993
1130
|
#
|
994
|
-
# * DeleteEventTracker
|
1131
|
+
# * [DeleteEventTracker][4]
|
995
1132
|
#
|
996
1133
|
#
|
997
1134
|
#
|
998
1135
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html
|
1136
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html
|
1137
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html
|
1138
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html
|
999
1139
|
#
|
1000
1140
|
# @option params [required, String] :name
|
1001
1141
|
# The name for the event tracker.
|
@@ -1004,6 +1144,13 @@ module Aws::Personalize
|
|
1004
1144
|
# The Amazon Resource Name (ARN) of the dataset group that receives the
|
1005
1145
|
# event data.
|
1006
1146
|
#
|
1147
|
+
# @option params [Array<Types::Tag>] :tags
|
1148
|
+
# A list of [tags][1] to apply to the event tracker.
|
1149
|
+
#
|
1150
|
+
#
|
1151
|
+
#
|
1152
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
1153
|
+
#
|
1007
1154
|
# @return [Types::CreateEventTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1008
1155
|
#
|
1009
1156
|
# * {Types::CreateEventTrackerResponse#event_tracker_arn #event_tracker_arn} => String
|
@@ -1014,6 +1161,12 @@ module Aws::Personalize
|
|
1014
1161
|
# resp = client.create_event_tracker({
|
1015
1162
|
# name: "Name", # required
|
1016
1163
|
# dataset_group_arn: "Arn", # required
|
1164
|
+
# tags: [
|
1165
|
+
# {
|
1166
|
+
# tag_key: "TagKey", # required
|
1167
|
+
# tag_value: "TagValue", # required
|
1168
|
+
# },
|
1169
|
+
# ],
|
1017
1170
|
# })
|
1018
1171
|
#
|
1019
1172
|
# @example Response structure
|
@@ -1030,7 +1183,12 @@ module Aws::Personalize
|
|
1030
1183
|
req.send_request(options)
|
1031
1184
|
end
|
1032
1185
|
|
1033
|
-
# Creates a recommendation filter. For more information, see
|
1186
|
+
# Creates a recommendation filter. For more information, see [Filtering
|
1187
|
+
# recommendations and user segments][1].
|
1188
|
+
#
|
1189
|
+
#
|
1190
|
+
#
|
1191
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
|
1034
1192
|
#
|
1035
1193
|
# @option params [required, String] :name
|
1036
1194
|
# The name of the filter to create.
|
@@ -1042,7 +1200,18 @@ module Aws::Personalize
|
|
1042
1200
|
# The filter expression defines which items are included or excluded
|
1043
1201
|
# from recommendations. Filter expression must follow specific format
|
1044
1202
|
# rules. For information about filter expression structure and syntax,
|
1045
|
-
# see
|
1203
|
+
# see [Filter expressions][1].
|
1204
|
+
#
|
1205
|
+
#
|
1206
|
+
#
|
1207
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html
|
1208
|
+
#
|
1209
|
+
# @option params [Array<Types::Tag>] :tags
|
1210
|
+
# A list of [tags][1] to apply to the filter.
|
1211
|
+
#
|
1212
|
+
#
|
1213
|
+
#
|
1214
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
1046
1215
|
#
|
1047
1216
|
# @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1048
1217
|
#
|
@@ -1054,6 +1223,12 @@ module Aws::Personalize
|
|
1054
1223
|
# name: "Name", # required
|
1055
1224
|
# dataset_group_arn: "Arn", # required
|
1056
1225
|
# filter_expression: "FilterExpression", # required
|
1226
|
+
# tags: [
|
1227
|
+
# {
|
1228
|
+
# tag_key: "TagKey", # required
|
1229
|
+
# tag_value: "TagValue", # required
|
1230
|
+
# },
|
1231
|
+
# ],
|
1057
1232
|
# })
|
1058
1233
|
#
|
1059
1234
|
# @example Response structure
|
@@ -1109,7 +1284,7 @@ module Aws::Personalize
|
|
1109
1284
|
#
|
1110
1285
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
1111
1286
|
#
|
1112
|
-
# To get the recommender status, call DescribeRecommender.
|
1287
|
+
# To get the recommender status, call [DescribeRecommender][2].
|
1113
1288
|
#
|
1114
1289
|
# <note markdown="1"> Wait until the `status` of the recommender is `ACTIVE` before asking
|
1115
1290
|
# the recommender for recommendations.
|
@@ -1118,17 +1293,21 @@ module Aws::Personalize
|
|
1118
1293
|
#
|
1119
1294
|
# **Related APIs**
|
1120
1295
|
#
|
1121
|
-
# * ListRecommenders
|
1296
|
+
# * [ListRecommenders][3]
|
1122
1297
|
#
|
1123
|
-
# * DescribeRecommender
|
1298
|
+
# * [DescribeRecommender][2]
|
1124
1299
|
#
|
1125
|
-
# * UpdateRecommender
|
1300
|
+
# * [UpdateRecommender][4]
|
1126
1301
|
#
|
1127
|
-
# * DeleteRecommender
|
1302
|
+
# * [DeleteRecommender][5]
|
1128
1303
|
#
|
1129
1304
|
#
|
1130
1305
|
#
|
1131
1306
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
1307
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html
|
1308
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html
|
1309
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html
|
1310
|
+
# [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html
|
1132
1311
|
#
|
1133
1312
|
# @option params [required, String] :name
|
1134
1313
|
# The name of the recommender.
|
@@ -1151,6 +1330,13 @@ module Aws::Personalize
|
|
1151
1330
|
# @option params [Types::RecommenderConfig] :recommender_config
|
1152
1331
|
# The configuration details of the recommender.
|
1153
1332
|
#
|
1333
|
+
# @option params [Array<Types::Tag>] :tags
|
1334
|
+
# A list of [tags][1] to apply to the recommender.
|
1335
|
+
#
|
1336
|
+
#
|
1337
|
+
#
|
1338
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
1339
|
+
#
|
1154
1340
|
# @return [Types::CreateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1155
1341
|
#
|
1156
1342
|
# * {Types::CreateRecommenderResponse#recommender_arn #recommender_arn} => String
|
@@ -1167,6 +1353,12 @@ module Aws::Personalize
|
|
1167
1353
|
# },
|
1168
1354
|
# min_recommendation_requests_per_second: 1,
|
1169
1355
|
# },
|
1356
|
+
# tags: [
|
1357
|
+
# {
|
1358
|
+
# tag_key: "TagKey", # required
|
1359
|
+
# tag_value: "TagValue", # required
|
1360
|
+
# },
|
1361
|
+
# ],
|
1170
1362
|
# })
|
1171
1363
|
#
|
1172
1364
|
# @example Response structure
|
@@ -1189,15 +1381,22 @@ module Aws::Personalize
|
|
1189
1381
|
# associated with a dataset type and has a set of required field and
|
1190
1382
|
# keywords. If you are creating a schema for a dataset in a Domain
|
1191
1383
|
# dataset group, you provide the domain of the Domain dataset group. You
|
1192
|
-
# specify a schema when you call CreateDataset.
|
1384
|
+
# specify a schema when you call [CreateDataset][1].
|
1193
1385
|
#
|
1194
1386
|
# **Related APIs**
|
1195
1387
|
#
|
1196
|
-
# * ListSchemas
|
1388
|
+
# * [ListSchemas][2]
|
1389
|
+
#
|
1390
|
+
# * [DescribeSchema][3]
|
1391
|
+
#
|
1392
|
+
# * [DeleteSchema][4]
|
1393
|
+
#
|
1197
1394
|
#
|
1198
|
-
# * DescribeSchema
|
1199
1395
|
#
|
1200
|
-
#
|
1396
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
|
1397
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html
|
1398
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html
|
1399
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html
|
1201
1400
|
#
|
1202
1401
|
# @option params [required, String] :name
|
1203
1402
|
# The name for the schema.
|
@@ -1237,14 +1436,14 @@ module Aws::Personalize
|
|
1237
1436
|
|
1238
1437
|
# Creates the configuration for training a model. A trained model is
|
1239
1438
|
# known as a solution. After the configuration is created, you train the
|
1240
|
-
# model (create a solution) by calling the CreateSolutionVersion
|
1439
|
+
# model (create a solution) by calling the [CreateSolutionVersion][1]
|
1241
1440
|
# operation. Every time you call `CreateSolutionVersion`, a new version
|
1242
1441
|
# of the solution is created.
|
1243
1442
|
#
|
1244
1443
|
# After creating a solution version, you check its accuracy by calling
|
1245
|
-
# GetSolutionMetrics. When you are satisfied with the version, you
|
1246
|
-
# deploy it using CreateCampaign. The campaign provides
|
1247
|
-
# to a client through the [GetRecommendations][
|
1444
|
+
# [GetSolutionMetrics][2]. When you are satisfied with the version, you
|
1445
|
+
# deploy it using [CreateCampaign][3]. The campaign provides
|
1446
|
+
# recommendations to a client through the [GetRecommendations][4] API.
|
1248
1447
|
#
|
1249
1448
|
# To train a model, Amazon Personalize requires training data and a
|
1250
1449
|
# recipe. The training data comes from the dataset group that you
|
@@ -1268,27 +1467,36 @@ module Aws::Personalize
|
|
1268
1467
|
#
|
1269
1468
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
1270
1469
|
#
|
1271
|
-
# To get the status of the solution, call DescribeSolution. Wait
|
1272
|
-
# the status shows as ACTIVE before calling
|
1470
|
+
# To get the status of the solution, call [DescribeSolution][5]. Wait
|
1471
|
+
# until the status shows as ACTIVE before calling
|
1472
|
+
# `CreateSolutionVersion`.
|
1273
1473
|
#
|
1274
1474
|
# **Related APIs**
|
1275
1475
|
#
|
1276
|
-
# * ListSolutions
|
1476
|
+
# * [ListSolutions][6]
|
1277
1477
|
#
|
1278
|
-
# * CreateSolutionVersion
|
1478
|
+
# * [CreateSolutionVersion][1]
|
1279
1479
|
#
|
1280
|
-
# * DescribeSolution
|
1480
|
+
# * [DescribeSolution][5]
|
1281
1481
|
#
|
1282
|
-
# * DeleteSolution
|
1482
|
+
# * [DeleteSolution][7]
|
1283
1483
|
# ^
|
1284
1484
|
#
|
1285
|
-
# * ListSolutionVersions
|
1485
|
+
# * [ListSolutionVersions][8]
|
1286
1486
|
#
|
1287
|
-
# * DescribeSolutionVersion
|
1487
|
+
# * [DescribeSolutionVersion][9]
|
1288
1488
|
#
|
1289
1489
|
#
|
1290
1490
|
#
|
1291
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/
|
1491
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html
|
1492
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html
|
1493
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
|
1494
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
1495
|
+
# [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html
|
1496
|
+
# [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html
|
1497
|
+
# [7]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html
|
1498
|
+
# [8]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html
|
1499
|
+
# [9]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html
|
1292
1500
|
#
|
1293
1501
|
# @option params [required, String] :name
|
1294
1502
|
# The name for the solution.
|
@@ -1337,6 +1545,13 @@ module Aws::Personalize
|
|
1337
1545
|
#
|
1338
1546
|
# </note>
|
1339
1547
|
#
|
1548
|
+
# @option params [Array<Types::Tag>] :tags
|
1549
|
+
# A list of [tags][1] to apply to the solution.
|
1550
|
+
#
|
1551
|
+
#
|
1552
|
+
#
|
1553
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
1554
|
+
#
|
1340
1555
|
# @return [Types::CreateSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1341
1556
|
#
|
1342
1557
|
# * {Types::CreateSolutionResponse#solution_arn #solution_arn} => String
|
@@ -1400,6 +1615,12 @@ module Aws::Personalize
|
|
1400
1615
|
# objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
|
1401
1616
|
# },
|
1402
1617
|
# },
|
1618
|
+
# tags: [
|
1619
|
+
# {
|
1620
|
+
# tag_key: "TagKey", # required
|
1621
|
+
# tag_value: "TagValue", # required
|
1622
|
+
# },
|
1623
|
+
# ],
|
1403
1624
|
# })
|
1404
1625
|
#
|
1405
1626
|
# @example Response structure
|
@@ -1416,9 +1637,9 @@ module Aws::Personalize
|
|
1416
1637
|
end
|
1417
1638
|
|
1418
1639
|
# Trains or retrains an active solution in a Custom dataset group. A
|
1419
|
-
# solution is created using the CreateSolution operation and must
|
1420
|
-
# the ACTIVE state before calling `CreateSolutionVersion`. A new
|
1421
|
-
# of the solution is created every time you call this operation.
|
1640
|
+
# solution is created using the [CreateSolution][1] operation and must
|
1641
|
+
# be in the ACTIVE state before calling `CreateSolutionVersion`. A new
|
1642
|
+
# version of the solution is created every time you call this operation.
|
1422
1643
|
#
|
1423
1644
|
# **Status**
|
1424
1645
|
#
|
@@ -1436,26 +1657,34 @@ module Aws::Personalize
|
|
1436
1657
|
#
|
1437
1658
|
# * CREATE STOPPED
|
1438
1659
|
#
|
1439
|
-
# To get the status of the version, call DescribeSolutionVersion.
|
1440
|
-
# until the status shows as ACTIVE before calling `CreateCampaign`.
|
1660
|
+
# To get the status of the version, call [DescribeSolutionVersion][2].
|
1661
|
+
# Wait until the status shows as ACTIVE before calling `CreateCampaign`.
|
1441
1662
|
#
|
1442
1663
|
# If the status shows as CREATE FAILED, the response includes a
|
1443
1664
|
# `failureReason` key, which describes why the job failed.
|
1444
1665
|
#
|
1445
1666
|
# **Related APIs**
|
1446
1667
|
#
|
1447
|
-
# * ListSolutionVersions
|
1668
|
+
# * [ListSolutionVersions][3]
|
1448
1669
|
#
|
1449
|
-
# * DescribeSolutionVersion
|
1450
|
-
#
|
1670
|
+
# * [DescribeSolutionVersion][2]
|
1671
|
+
#
|
1672
|
+
# * [ListSolutions][4]
|
1673
|
+
#
|
1674
|
+
# * [CreateSolution][1]
|
1675
|
+
#
|
1676
|
+
# * [DescribeSolution][5]
|
1451
1677
|
#
|
1452
|
-
# *
|
1678
|
+
# * [DeleteSolution][6]
|
1453
1679
|
#
|
1454
|
-
# * CreateSolution
|
1455
1680
|
#
|
1456
|
-
# * DescribeSolution
|
1457
1681
|
#
|
1458
|
-
#
|
1682
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
1683
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html
|
1684
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html
|
1685
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html
|
1686
|
+
# [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html
|
1687
|
+
# [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html
|
1459
1688
|
#
|
1460
1689
|
# @option params [required, String] :solution_arn
|
1461
1690
|
# The Amazon Resource Name (ARN) of the solution containing the training
|
@@ -1479,6 +1708,13 @@ module Aws::Personalize
|
|
1479
1708
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
1480
1709
|
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
|
1481
1710
|
#
|
1711
|
+
# @option params [Array<Types::Tag>] :tags
|
1712
|
+
# A list of [tags][1] to apply to the solution version.
|
1713
|
+
#
|
1714
|
+
#
|
1715
|
+
#
|
1716
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
1717
|
+
#
|
1482
1718
|
# @return [Types::CreateSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1483
1719
|
#
|
1484
1720
|
# * {Types::CreateSolutionVersionResponse#solution_version_arn #solution_version_arn} => String
|
@@ -1488,6 +1724,12 @@ module Aws::Personalize
|
|
1488
1724
|
# resp = client.create_solution_version({
|
1489
1725
|
# solution_arn: "Arn", # required
|
1490
1726
|
# training_mode: "FULL", # accepts FULL, UPDATE
|
1727
|
+
# tags: [
|
1728
|
+
# {
|
1729
|
+
# tag_key: "TagKey", # required
|
1730
|
+
# tag_value: "TagValue", # required
|
1731
|
+
# },
|
1732
|
+
# ],
|
1491
1733
|
# })
|
1492
1734
|
#
|
1493
1735
|
# @example Response structure
|
@@ -1506,12 +1748,13 @@ module Aws::Personalize
|
|
1506
1748
|
# Removes a campaign by deleting the solution deployment. The solution
|
1507
1749
|
# that the campaign is based on is not deleted and can be redeployed
|
1508
1750
|
# when needed. A deleted campaign can no longer be specified in a
|
1509
|
-
# [GetRecommendations][1] request. For
|
1510
|
-
# see CreateCampaign.
|
1751
|
+
# [GetRecommendations][1] request. For information on creating
|
1752
|
+
# campaigns, see [CreateCampaign][2].
|
1511
1753
|
#
|
1512
1754
|
#
|
1513
1755
|
#
|
1514
1756
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
1757
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
|
1515
1758
|
#
|
1516
1759
|
# @option params [required, String] :campaign_arn
|
1517
1760
|
# The Amazon Resource Name (ARN) of the campaign to delete.
|
@@ -1535,7 +1778,12 @@ module Aws::Personalize
|
|
1535
1778
|
|
1536
1779
|
# Deletes a dataset. You can't delete a dataset if an associated
|
1537
1780
|
# `DatasetImportJob` or `SolutionVersion` is in the CREATE PENDING or IN
|
1538
|
-
# PROGRESS state. For more information on datasets, see
|
1781
|
+
# PROGRESS state. For more information on datasets, see
|
1782
|
+
# [CreateDataset][1].
|
1783
|
+
#
|
1784
|
+
#
|
1785
|
+
#
|
1786
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
|
1539
1787
|
#
|
1540
1788
|
# @option params [required, String] :dataset_arn
|
1541
1789
|
# The Amazon Resource Name (ARN) of the dataset to delete.
|
@@ -1588,7 +1836,11 @@ module Aws::Personalize
|
|
1588
1836
|
|
1589
1837
|
# Deletes the event tracker. Does not delete the event-interactions
|
1590
1838
|
# dataset from the associated dataset group. For more information on
|
1591
|
-
# event trackers, see CreateEventTracker.
|
1839
|
+
# event trackers, see [CreateEventTracker][1].
|
1840
|
+
#
|
1841
|
+
#
|
1842
|
+
#
|
1843
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html
|
1592
1844
|
#
|
1593
1845
|
# @option params [required, String] :event_tracker_arn
|
1594
1846
|
# The Amazon Resource Name (ARN) of the event tracker to delete.
|
@@ -1661,7 +1913,11 @@ module Aws::Personalize
|
|
1661
1913
|
|
1662
1914
|
# Deletes a schema. Before deleting a schema, you must delete all
|
1663
1915
|
# datasets referencing the schema. For more information on schemas, see
|
1664
|
-
# CreateSchema.
|
1916
|
+
# [CreateSchema][1].
|
1917
|
+
#
|
1918
|
+
#
|
1919
|
+
#
|
1920
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html
|
1665
1921
|
#
|
1666
1922
|
# @option params [required, String] :schema_arn
|
1667
1923
|
# The Amazon Resource Name (ARN) of the schema to delete.
|
@@ -1686,10 +1942,15 @@ module Aws::Personalize
|
|
1686
1942
|
# Deletes all versions of a solution and the `Solution` object itself.
|
1687
1943
|
# Before deleting a solution, you must delete all campaigns based on the
|
1688
1944
|
# solution. To determine what campaigns are using the solution, call
|
1689
|
-
# ListCampaigns and supply the Amazon Resource Name (ARN) of the
|
1945
|
+
# [ListCampaigns][1] and supply the Amazon Resource Name (ARN) of the
|
1690
1946
|
# solution. You can't delete a solution if an associated
|
1691
1947
|
# `SolutionVersion` is in the CREATE PENDING or IN PROGRESS state. For
|
1692
|
-
# more information on solutions, see CreateSolution.
|
1948
|
+
# more information on solutions, see [CreateSolution][2].
|
1949
|
+
#
|
1950
|
+
#
|
1951
|
+
#
|
1952
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
|
1953
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
1693
1954
|
#
|
1694
1955
|
# @option params [required, String] :solution_arn
|
1695
1956
|
# The ARN of the solution to delete.
|
@@ -1865,7 +2126,11 @@ module Aws::Personalize
|
|
1865
2126
|
# When the `status` is `CREATE FAILED`, the response includes the
|
1866
2127
|
# `failureReason` key, which describes why.
|
1867
2128
|
#
|
1868
|
-
# For more information on campaigns, see CreateCampaign.
|
2129
|
+
# For more information on campaigns, see [CreateCampaign][1].
|
2130
|
+
#
|
2131
|
+
#
|
2132
|
+
#
|
2133
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
|
1869
2134
|
#
|
1870
2135
|
# @option params [required, String] :campaign_arn
|
1871
2136
|
# The Amazon Resource Name (ARN) of the campaign.
|
@@ -1911,7 +2176,11 @@ module Aws::Personalize
|
|
1911
2176
|
end
|
1912
2177
|
|
1913
2178
|
# Describes the given dataset. For more information on datasets, see
|
1914
|
-
# CreateDataset.
|
2179
|
+
# [CreateDataset][1].
|
2180
|
+
#
|
2181
|
+
#
|
2182
|
+
#
|
2183
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
|
1915
2184
|
#
|
1916
2185
|
# @option params [required, String] :dataset_arn
|
1917
2186
|
# The Amazon Resource Name (ARN) of the dataset to describe.
|
@@ -1946,8 +2215,12 @@ module Aws::Personalize
|
|
1946
2215
|
req.send_request(options)
|
1947
2216
|
end
|
1948
2217
|
|
1949
|
-
# Describes the dataset export job created by
|
1950
|
-
# including the export job status.
|
2218
|
+
# Describes the dataset export job created by
|
2219
|
+
# [CreateDatasetExportJob][1], including the export job status.
|
2220
|
+
#
|
2221
|
+
#
|
2222
|
+
#
|
2223
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html
|
1951
2224
|
#
|
1952
2225
|
# @option params [required, String] :dataset_export_job_arn
|
1953
2226
|
# The Amazon Resource Name (ARN) of the dataset export job to describe.
|
@@ -1986,7 +2259,11 @@ module Aws::Personalize
|
|
1986
2259
|
end
|
1987
2260
|
|
1988
2261
|
# Describes the given dataset group. For more information on dataset
|
1989
|
-
# groups, see CreateDatasetGroup.
|
2262
|
+
# groups, see [CreateDatasetGroup][1].
|
2263
|
+
#
|
2264
|
+
#
|
2265
|
+
#
|
2266
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html
|
1990
2267
|
#
|
1991
2268
|
# @option params [required, String] :dataset_group_arn
|
1992
2269
|
# The Amazon Resource Name (ARN) of the dataset group to describe.
|
@@ -2022,8 +2299,12 @@ module Aws::Personalize
|
|
2022
2299
|
req.send_request(options)
|
2023
2300
|
end
|
2024
2301
|
|
2025
|
-
# Describes the dataset import job created by
|
2026
|
-
# including the import job status.
|
2302
|
+
# Describes the dataset import job created by
|
2303
|
+
# [CreateDatasetImportJob][1], including the import job status.
|
2304
|
+
#
|
2305
|
+
#
|
2306
|
+
#
|
2307
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html
|
2027
2308
|
#
|
2028
2309
|
# @option params [required, String] :dataset_import_job_arn
|
2029
2310
|
# The Amazon Resource Name (ARN) of the dataset import job to describe.
|
@@ -2061,7 +2342,11 @@ module Aws::Personalize
|
|
2061
2342
|
|
2062
2343
|
# Describes an event tracker. The response includes the `trackingId` and
|
2063
2344
|
# `status` of the event tracker. For more information on event trackers,
|
2064
|
-
# see CreateEventTracker.
|
2345
|
+
# see [CreateEventTracker][1].
|
2346
|
+
#
|
2347
|
+
#
|
2348
|
+
#
|
2349
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html
|
2065
2350
|
#
|
2066
2351
|
# @option params [required, String] :event_tracker_arn
|
2067
2352
|
# The Amazon Resource Name (ARN) of the event tracker to describe.
|
@@ -2178,15 +2463,16 @@ module Aws::Personalize
|
|
2178
2463
|
# before training.
|
2179
2464
|
#
|
2180
2465
|
# Amazon Personalize provides a set of predefined recipes. You specify a
|
2181
|
-
# recipe when you create a solution with the CreateSolution API.
|
2466
|
+
# recipe when you create a solution with the [CreateSolution][1] API.
|
2182
2467
|
# `CreateSolution` trains a model by using the algorithm in the
|
2183
2468
|
# specified recipe and a training dataset. The solution, when deployed
|
2184
2469
|
# as a campaign, can provide recommendations using the
|
2185
|
-
# [GetRecommendations][
|
2470
|
+
# [GetRecommendations][2] API.
|
2186
2471
|
#
|
2187
2472
|
#
|
2188
2473
|
#
|
2189
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/
|
2474
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
2475
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
2190
2476
|
#
|
2191
2477
|
# @option params [required, String] :recipe_arn
|
2192
2478
|
# The Amazon Resource Name (ARN) of the recipe to describe.
|
@@ -2283,7 +2569,12 @@ module Aws::Personalize
|
|
2283
2569
|
req.send_request(options)
|
2284
2570
|
end
|
2285
2571
|
|
2286
|
-
# Describes a schema. For more information on schemas, see
|
2572
|
+
# Describes a schema. For more information on schemas, see
|
2573
|
+
# [CreateSchema][1].
|
2574
|
+
#
|
2575
|
+
#
|
2576
|
+
#
|
2577
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html
|
2287
2578
|
#
|
2288
2579
|
# @option params [required, String] :schema_arn
|
2289
2580
|
# The Amazon Resource Name (ARN) of the schema to retrieve.
|
@@ -2317,7 +2608,11 @@ module Aws::Personalize
|
|
2317
2608
|
end
|
2318
2609
|
|
2319
2610
|
# Describes a solution. For more information on solutions, see
|
2320
|
-
# CreateSolution.
|
2611
|
+
# [CreateSolution][1].
|
2612
|
+
#
|
2613
|
+
#
|
2614
|
+
#
|
2615
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
2321
2616
|
#
|
2322
2617
|
# @option params [required, String] :solution_arn
|
2323
2618
|
# The Amazon Resource Name (ARN) of the solution to describe.
|
@@ -2388,7 +2683,11 @@ module Aws::Personalize
|
|
2388
2683
|
end
|
2389
2684
|
|
2390
2685
|
# Describes a specific version of a solution. For more information on
|
2391
|
-
# solutions, see CreateSolution
|
2686
|
+
# solutions, see [CreateSolution][1]
|
2687
|
+
#
|
2688
|
+
#
|
2689
|
+
#
|
2690
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
2392
2691
|
#
|
2393
2692
|
# @option params [required, String] :solution_version_arn
|
2394
2693
|
# The Amazon Resource Name (ARN) of the solution version.
|
@@ -2593,7 +2892,11 @@ module Aws::Personalize
|
|
2593
2892
|
# solution is not specified, all the campaigns associated with the
|
2594
2893
|
# account are listed. The response provides the properties for each
|
2595
2894
|
# campaign, including the Amazon Resource Name (ARN). For more
|
2596
|
-
# information on campaigns, see CreateCampaign.
|
2895
|
+
# information on campaigns, see [CreateCampaign][1].
|
2896
|
+
#
|
2897
|
+
#
|
2898
|
+
#
|
2899
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
|
2597
2900
|
#
|
2598
2901
|
# @option params [String] :solution_arn
|
2599
2902
|
# The Amazon Resource Name (ARN) of the solution to list the campaigns
|
@@ -2601,8 +2904,12 @@ module Aws::Personalize
|
|
2601
2904
|
# with the account are listed.
|
2602
2905
|
#
|
2603
2906
|
# @option params [String] :next_token
|
2604
|
-
# A token returned from the previous call to
|
2605
|
-
# the next set of campaigns (if they exist).
|
2907
|
+
# A token returned from the previous call to [ListCampaigns][1] for
|
2908
|
+
# getting the next set of campaigns (if they exist).
|
2909
|
+
#
|
2910
|
+
#
|
2911
|
+
#
|
2912
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
|
2606
2913
|
#
|
2607
2914
|
# @option params [Integer] :max_results
|
2608
2915
|
# The maximum number of campaigns to return.
|
@@ -2646,8 +2953,14 @@ module Aws::Personalize
|
|
2646
2953
|
# a dataset is not specified, all the dataset export jobs associated
|
2647
2954
|
# with the account are listed. The response provides the properties for
|
2648
2955
|
# each dataset export job, including the Amazon Resource Name (ARN). For
|
2649
|
-
# more information on dataset export jobs, see
|
2650
|
-
# For more information on datasets, see
|
2956
|
+
# more information on dataset export jobs, see
|
2957
|
+
# [CreateDatasetExportJob][1]. For more information on datasets, see
|
2958
|
+
# [CreateDataset][2].
|
2959
|
+
#
|
2960
|
+
#
|
2961
|
+
#
|
2962
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html
|
2963
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
|
2651
2964
|
#
|
2652
2965
|
# @option params [String] :dataset_arn
|
2653
2966
|
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
@@ -2697,7 +3010,11 @@ module Aws::Personalize
|
|
2697
3010
|
|
2698
3011
|
# Returns a list of dataset groups. The response provides the properties
|
2699
3012
|
# for each dataset group, including the Amazon Resource Name (ARN). For
|
2700
|
-
# more information on dataset groups, see CreateDatasetGroup.
|
3013
|
+
# more information on dataset groups, see [CreateDatasetGroup][1].
|
3014
|
+
#
|
3015
|
+
#
|
3016
|
+
#
|
3017
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html
|
2701
3018
|
#
|
2702
3019
|
# @option params [String] :next_token
|
2703
3020
|
# A token returned from the previous call to `ListDatasetGroups` for
|
@@ -2745,8 +3062,14 @@ module Aws::Personalize
|
|
2745
3062
|
# a dataset is not specified, all the dataset import jobs associated
|
2746
3063
|
# with the account are listed. The response provides the properties for
|
2747
3064
|
# each dataset import job, including the Amazon Resource Name (ARN). For
|
2748
|
-
# more information on dataset import jobs, see
|
2749
|
-
# For more information on datasets, see
|
3065
|
+
# more information on dataset import jobs, see
|
3066
|
+
# [CreateDatasetImportJob][1]. For more information on datasets, see
|
3067
|
+
# [CreateDataset][2].
|
3068
|
+
#
|
3069
|
+
#
|
3070
|
+
#
|
3071
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html
|
3072
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
|
2750
3073
|
#
|
2751
3074
|
# @option params [String] :dataset_arn
|
2752
3075
|
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
@@ -2797,7 +3120,11 @@ module Aws::Personalize
|
|
2797
3120
|
# Returns the list of datasets contained in the given dataset group. The
|
2798
3121
|
# response provides the properties for each dataset, including the
|
2799
3122
|
# Amazon Resource Name (ARN). For more information on datasets, see
|
2800
|
-
# CreateDataset.
|
3123
|
+
# [CreateDataset][1].
|
3124
|
+
#
|
3125
|
+
#
|
3126
|
+
#
|
3127
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
|
2801
3128
|
#
|
2802
3129
|
# @option params [String] :dataset_group_arn
|
2803
3130
|
# The Amazon Resource Name (ARN) of the dataset group that contains the
|
@@ -2848,7 +3175,11 @@ module Aws::Personalize
|
|
2848
3175
|
# Returns the list of event trackers associated with the account. The
|
2849
3176
|
# response provides the properties for each event tracker, including the
|
2850
3177
|
# Amazon Resource Name (ARN) and tracking ID. For more information on
|
2851
|
-
# event trackers, see CreateEventTracker.
|
3178
|
+
# event trackers, see [CreateEventTracker][1].
|
3179
|
+
#
|
3180
|
+
#
|
3181
|
+
#
|
3182
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html
|
2852
3183
|
#
|
2853
3184
|
# @option params [String] :dataset_group_arn
|
2854
3185
|
# The ARN of a dataset group used to filter the response.
|
@@ -2959,8 +3290,8 @@ module Aws::Personalize
|
|
2959
3290
|
# @option params [String] :domain
|
2960
3291
|
# Filters returned recipes by domain for a Domain dataset group. Only
|
2961
3292
|
# recipes (Domain dataset group use cases) for this domain are included
|
2962
|
-
# in the response. If you don't specify a domain,
|
2963
|
-
#
|
3293
|
+
# in the response. If you don't specify a domain, all recipes are
|
3294
|
+
# returned.
|
2964
3295
|
#
|
2965
3296
|
# @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2966
3297
|
#
|
@@ -3061,7 +3392,11 @@ module Aws::Personalize
|
|
3061
3392
|
|
3062
3393
|
# Returns the list of schemas associated with the account. The response
|
3063
3394
|
# provides the properties for each schema, including the Amazon Resource
|
3064
|
-
# Name (ARN). For more information on schemas, see CreateSchema.
|
3395
|
+
# Name (ARN). For more information on schemas, see [CreateSchema][1].
|
3396
|
+
#
|
3397
|
+
#
|
3398
|
+
#
|
3399
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html
|
3065
3400
|
#
|
3066
3401
|
# @option params [String] :next_token
|
3067
3402
|
# A token returned from the previous call to `ListSchemas` for getting
|
@@ -3106,8 +3441,7 @@ module Aws::Personalize
|
|
3106
3441
|
# Returns a list of solution versions for the given solution. When a
|
3107
3442
|
# solution is not specified, all the solution versions associated with
|
3108
3443
|
# the account are listed. The response provides the properties for each
|
3109
|
-
# solution version, including the Amazon Resource Name (ARN).
|
3110
|
-
# information on solutions, see CreateSolution.
|
3444
|
+
# solution version, including the Amazon Resource Name (ARN).
|
3111
3445
|
#
|
3112
3446
|
# @option params [String] :solution_arn
|
3113
3447
|
# The Amazon Resource Name (ARN) of the solution.
|
@@ -3157,7 +3491,11 @@ module Aws::Personalize
|
|
3157
3491
|
# dataset group is not specified, all the solutions associated with the
|
3158
3492
|
# account are listed. The response provides the properties for each
|
3159
3493
|
# solution, including the Amazon Resource Name (ARN). For more
|
3160
|
-
# information on solutions, see CreateSolution.
|
3494
|
+
# information on solutions, see [CreateSolution][1].
|
3495
|
+
#
|
3496
|
+
#
|
3497
|
+
#
|
3498
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
3161
3499
|
#
|
3162
3500
|
# @option params [String] :dataset_group_arn
|
3163
3501
|
# The Amazon Resource Name (ARN) of the dataset group.
|
@@ -3203,6 +3541,40 @@ module Aws::Personalize
|
|
3203
3541
|
req.send_request(options)
|
3204
3542
|
end
|
3205
3543
|
|
3544
|
+
# Get a list of [tags][1] attached to a resource.
|
3545
|
+
#
|
3546
|
+
#
|
3547
|
+
#
|
3548
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
3549
|
+
#
|
3550
|
+
# @option params [required, String] :resource_arn
|
3551
|
+
# The resource's Amazon Resource Name.
|
3552
|
+
#
|
3553
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3554
|
+
#
|
3555
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
3556
|
+
#
|
3557
|
+
# @example Request syntax with placeholder values
|
3558
|
+
#
|
3559
|
+
# resp = client.list_tags_for_resource({
|
3560
|
+
# resource_arn: "Arn", # required
|
3561
|
+
# })
|
3562
|
+
#
|
3563
|
+
# @example Response structure
|
3564
|
+
#
|
3565
|
+
# resp.tags #=> Array
|
3566
|
+
# resp.tags[0].tag_key #=> String
|
3567
|
+
# resp.tags[0].tag_value #=> String
|
3568
|
+
#
|
3569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListTagsForResource AWS API Documentation
|
3570
|
+
#
|
3571
|
+
# @overload list_tags_for_resource(params = {})
|
3572
|
+
# @param [Hash] params ({})
|
3573
|
+
def list_tags_for_resource(params = {}, options = {})
|
3574
|
+
req = build_request(:list_tags_for_resource, params)
|
3575
|
+
req.send_request(options)
|
3576
|
+
end
|
3577
|
+
|
3206
3578
|
# Stops creating a solution version that is in a state of
|
3207
3579
|
# CREATE\_PENDING or CREATE IN\_PROGRESS.
|
3208
3580
|
#
|
@@ -3240,18 +3612,90 @@ module Aws::Personalize
|
|
3240
3612
|
req.send_request(options)
|
3241
3613
|
end
|
3242
3614
|
|
3615
|
+
# Add a list of tags to a resource.
|
3616
|
+
#
|
3617
|
+
# @option params [required, String] :resource_arn
|
3618
|
+
# The resource's Amazon Resource Name (ARN).
|
3619
|
+
#
|
3620
|
+
# @option params [required, Array<Types::Tag>] :tags
|
3621
|
+
# Tags to apply to the resource. For more information see [Tagging
|
3622
|
+
# Personalize resources][1].
|
3623
|
+
#
|
3624
|
+
#
|
3625
|
+
#
|
3626
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
3627
|
+
#
|
3628
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3629
|
+
#
|
3630
|
+
# @example Request syntax with placeholder values
|
3631
|
+
#
|
3632
|
+
# resp = client.tag_resource({
|
3633
|
+
# resource_arn: "Arn", # required
|
3634
|
+
# tags: [ # required
|
3635
|
+
# {
|
3636
|
+
# tag_key: "TagKey", # required
|
3637
|
+
# tag_value: "TagValue", # required
|
3638
|
+
# },
|
3639
|
+
# ],
|
3640
|
+
# })
|
3641
|
+
#
|
3642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TagResource AWS API Documentation
|
3643
|
+
#
|
3644
|
+
# @overload tag_resource(params = {})
|
3645
|
+
# @param [Hash] params ({})
|
3646
|
+
def tag_resource(params = {}, options = {})
|
3647
|
+
req = build_request(:tag_resource, params)
|
3648
|
+
req.send_request(options)
|
3649
|
+
end
|
3650
|
+
|
3651
|
+
# Remove [tags][1] that are attached to a resource.
|
3652
|
+
#
|
3653
|
+
#
|
3654
|
+
#
|
3655
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
3656
|
+
#
|
3657
|
+
# @option params [required, String] :resource_arn
|
3658
|
+
# The resource's Amazon Resource Name (ARN).
|
3659
|
+
#
|
3660
|
+
# @option params [required, Array<String>] :tag_keys
|
3661
|
+
# Keys to remove from the resource's tags.
|
3662
|
+
#
|
3663
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3664
|
+
#
|
3665
|
+
# @example Request syntax with placeholder values
|
3666
|
+
#
|
3667
|
+
# resp = client.untag_resource({
|
3668
|
+
# resource_arn: "Arn", # required
|
3669
|
+
# tag_keys: ["TagKey"], # required
|
3670
|
+
# })
|
3671
|
+
#
|
3672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UntagResource AWS API Documentation
|
3673
|
+
#
|
3674
|
+
# @overload untag_resource(params = {})
|
3675
|
+
# @param [Hash] params ({})
|
3676
|
+
def untag_resource(params = {}, options = {})
|
3677
|
+
req = build_request(:untag_resource, params)
|
3678
|
+
req.send_request(options)
|
3679
|
+
end
|
3680
|
+
|
3243
3681
|
# Updates a campaign by either deploying a new solution or changing the
|
3244
3682
|
# value of the campaign's `minProvisionedTPS` parameter.
|
3245
3683
|
#
|
3246
3684
|
# To update a campaign, the campaign status must be ACTIVE or CREATE
|
3247
|
-
# FAILED. Check the campaign status using the DescribeCampaign
|
3685
|
+
# FAILED. Check the campaign status using the [DescribeCampaign][1]
|
3686
|
+
# operation.
|
3248
3687
|
#
|
3249
3688
|
# <note markdown="1"> You must wait until the `status` of the updated campaign is `ACTIVE`
|
3250
3689
|
# before asking the campaign for recommendations.
|
3251
3690
|
#
|
3252
3691
|
# </note>
|
3253
3692
|
#
|
3254
|
-
# For more information on campaigns, see CreateCampaign.
|
3693
|
+
# For more information on campaigns, see [CreateCampaign][2].
|
3694
|
+
#
|
3695
|
+
#
|
3696
|
+
#
|
3697
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
|
3698
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
|
3255
3699
|
#
|
3256
3700
|
# @option params [required, String] :campaign_arn
|
3257
3701
|
# The Amazon Resource Name (ARN) of the campaign.
|
@@ -3346,7 +3790,7 @@ module Aws::Personalize
|
|
3346
3790
|
params: params,
|
3347
3791
|
config: config)
|
3348
3792
|
context[:gem_name] = 'aws-sdk-personalize'
|
3349
|
-
context[:gem_version] = '1.
|
3793
|
+
context[:gem_version] = '1.40.0'
|
3350
3794
|
Seahorse::Client::Request.new(handlers, context)
|
3351
3795
|
end
|
3352
3796
|
|