aws-sdk-personalize 1.38.0 → 1.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-personalize/client.rb +623 -120
- data/lib/aws-sdk-personalize/client_api.rb +143 -0
- data/lib/aws-sdk-personalize/errors.rb +32 -0
- data/lib/aws-sdk-personalize/types.rb +582 -56
- data/lib/aws-sdk-personalize.rb +1 -1
- metadata +4 -4
|
@@ -27,6 +27,7 @@ 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'
|
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
@@ -75,6 +76,7 @@ module Aws::Personalize
|
|
|
75
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
76
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
77
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
|
78
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
|
79
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
|
80
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
|
@@ -361,7 +363,11 @@ module Aws::Personalize
|
|
|
361
363
|
|
|
362
364
|
# Creates a batch inference job. The operation can handle up to 50
|
|
363
365
|
# million records and the input file must be in JSON format. For more
|
|
364
|
-
# 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
|
|
365
371
|
#
|
|
366
372
|
# @option params [required, String] :job_name
|
|
367
373
|
# The name of the batch inference job to create.
|
|
@@ -372,15 +378,15 @@ module Aws::Personalize
|
|
|
372
378
|
#
|
|
373
379
|
# @option params [String] :filter_arn
|
|
374
380
|
# The ARN of the filter to apply to the batch inference job. For more
|
|
375
|
-
# information on using filters, see [Filtering
|
|
376
|
-
#
|
|
381
|
+
# information on using filters, see [Filtering batch
|
|
382
|
+
# recommendations][1].
|
|
377
383
|
#
|
|
378
384
|
#
|
|
379
385
|
#
|
|
380
386
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
|
|
381
387
|
#
|
|
382
388
|
# @option params [Integer] :num_results
|
|
383
|
-
# The number of recommendations to
|
|
389
|
+
# The number of recommendations to retrieve.
|
|
384
390
|
#
|
|
385
391
|
# @option params [required, Types::BatchInferenceJobInput] :job_input
|
|
386
392
|
# The Amazon S3 path that leads to the input file to base your
|
|
@@ -398,6 +404,13 @@ module Aws::Personalize
|
|
|
398
404
|
# @option params [Types::BatchInferenceJobConfig] :batch_inference_job_config
|
|
399
405
|
# The configuration details of a batch inference job.
|
|
400
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
|
+
#
|
|
401
414
|
# @return [Types::CreateBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
402
415
|
#
|
|
403
416
|
# * {Types::CreateBatchInferenceJobResponse#batch_inference_job_arn #batch_inference_job_arn} => String
|
|
@@ -427,6 +440,12 @@ module Aws::Personalize
|
|
|
427
440
|
# "ParameterName" => "ParameterValue",
|
|
428
441
|
# },
|
|
429
442
|
# },
|
|
443
|
+
# tags: [
|
|
444
|
+
# {
|
|
445
|
+
# tag_key: "TagKey", # required
|
|
446
|
+
# tag_value: "TagValue", # required
|
|
447
|
+
# },
|
|
448
|
+
# ],
|
|
430
449
|
# })
|
|
431
450
|
#
|
|
432
451
|
# @example Response structure
|
|
@@ -444,7 +463,11 @@ module Aws::Personalize
|
|
|
444
463
|
|
|
445
464
|
# Creates a batch segment job. The operation can handle up to 50 million
|
|
446
465
|
# records and the input file must be in JSON format. For more
|
|
447
|
-
# 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
|
|
448
471
|
#
|
|
449
472
|
# @option params [required, String] :job_name
|
|
450
473
|
# The name of the batch segment job to create.
|
|
@@ -455,7 +478,12 @@ module Aws::Personalize
|
|
|
455
478
|
#
|
|
456
479
|
# @option params [String] :filter_arn
|
|
457
480
|
# The ARN of the filter to apply to the batch segment job. For more
|
|
458
|
-
# 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
|
|
459
487
|
#
|
|
460
488
|
# @option params [Integer] :num_results
|
|
461
489
|
# The number of predicted users generated by the batch segment job for
|
|
@@ -474,6 +502,13 @@ module Aws::Personalize
|
|
|
474
502
|
# permissions to read and write to your input and output Amazon S3
|
|
475
503
|
# buckets respectively.
|
|
476
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
|
+
#
|
|
477
512
|
# @return [Types::CreateBatchSegmentJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
478
513
|
#
|
|
479
514
|
# * {Types::CreateBatchSegmentJobResponse#batch_segment_job_arn #batch_segment_job_arn} => String
|
|
@@ -498,6 +533,12 @@ module Aws::Personalize
|
|
|
498
533
|
# },
|
|
499
534
|
# },
|
|
500
535
|
# role_arn: "RoleArn", # required
|
|
536
|
+
# tags: [
|
|
537
|
+
# {
|
|
538
|
+
# tag_key: "TagKey", # required
|
|
539
|
+
# tag_value: "TagValue", # required
|
|
540
|
+
# },
|
|
541
|
+
# ],
|
|
501
542
|
# })
|
|
502
543
|
#
|
|
503
544
|
# @example Response structure
|
|
@@ -546,7 +587,7 @@ module Aws::Personalize
|
|
|
546
587
|
#
|
|
547
588
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
|
548
589
|
#
|
|
549
|
-
# To get the campaign status, call DescribeCampaign.
|
|
590
|
+
# To get the campaign status, call [DescribeCampaign][3].
|
|
550
591
|
#
|
|
551
592
|
# <note markdown="1"> Wait until the `status` of the campaign is `ACTIVE` before asking the
|
|
552
593
|
# campaign for recommendations.
|
|
@@ -555,18 +596,22 @@ module Aws::Personalize
|
|
|
555
596
|
#
|
|
556
597
|
# **Related APIs**
|
|
557
598
|
#
|
|
558
|
-
# * ListCampaigns
|
|
599
|
+
# * [ListCampaigns][4]
|
|
559
600
|
#
|
|
560
|
-
# * DescribeCampaign
|
|
601
|
+
# * [DescribeCampaign][3]
|
|
561
602
|
#
|
|
562
|
-
# * UpdateCampaign
|
|
603
|
+
# * [UpdateCampaign][5]
|
|
563
604
|
#
|
|
564
|
-
# * DeleteCampaign
|
|
605
|
+
# * [DeleteCampaign][6]
|
|
565
606
|
#
|
|
566
607
|
#
|
|
567
608
|
#
|
|
568
609
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
|
|
569
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
|
|
570
615
|
#
|
|
571
616
|
# @option params [required, String] :name
|
|
572
617
|
# A name for the new campaign. The campaign name must be unique within
|
|
@@ -582,6 +627,13 @@ module Aws::Personalize
|
|
|
582
627
|
# @option params [Types::CampaignConfig] :campaign_config
|
|
583
628
|
# The configuration details of a campaign.
|
|
584
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
|
+
#
|
|
585
637
|
# @return [Types::CreateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
586
638
|
#
|
|
587
639
|
# * {Types::CreateCampaignResponse#campaign_arn #campaign_arn} => String
|
|
@@ -597,6 +649,12 @@ module Aws::Personalize
|
|
|
597
649
|
# "ParameterName" => "ParameterValue",
|
|
598
650
|
# },
|
|
599
651
|
# },
|
|
652
|
+
# tags: [
|
|
653
|
+
# {
|
|
654
|
+
# tag_key: "TagKey", # required
|
|
655
|
+
# tag_value: "TagValue", # required
|
|
656
|
+
# },
|
|
657
|
+
# ],
|
|
600
658
|
# })
|
|
601
659
|
#
|
|
602
660
|
# @example Response structure
|
|
@@ -613,7 +671,8 @@ module Aws::Personalize
|
|
|
613
671
|
end
|
|
614
672
|
|
|
615
673
|
# Creates an empty dataset and adds it to the specified dataset group.
|
|
616
|
-
# Use CreateDatasetImportJob to import your training data to a
|
|
674
|
+
# Use [CreateDatasetImportJob][1] to import your training data to a
|
|
675
|
+
# dataset.
|
|
617
676
|
#
|
|
618
677
|
# There are three types of datasets:
|
|
619
678
|
#
|
|
@@ -634,17 +693,25 @@ module Aws::Personalize
|
|
|
634
693
|
#
|
|
635
694
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
|
636
695
|
#
|
|
637
|
-
# To get the status of the dataset, call DescribeDataset.
|
|
696
|
+
# To get the status of the dataset, call [DescribeDataset][2].
|
|
638
697
|
#
|
|
639
698
|
# **Related APIs**
|
|
640
699
|
#
|
|
641
|
-
# * CreateDatasetGroup
|
|
700
|
+
# * [CreateDatasetGroup][3]
|
|
701
|
+
#
|
|
702
|
+
# * [ListDatasets][4]
|
|
703
|
+
#
|
|
704
|
+
# * [DescribeDataset][2]
|
|
705
|
+
#
|
|
706
|
+
# * [DeleteDataset][5]
|
|
642
707
|
#
|
|
643
|
-
# * ListDatasets
|
|
644
708
|
#
|
|
645
|
-
# * DescribeDataset
|
|
646
709
|
#
|
|
647
|
-
#
|
|
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
|
|
648
715
|
#
|
|
649
716
|
# @option params [required, String] :name
|
|
650
717
|
# The name for the dataset.
|
|
@@ -668,6 +735,13 @@ module Aws::Personalize
|
|
|
668
735
|
#
|
|
669
736
|
# * Users
|
|
670
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
|
+
#
|
|
671
745
|
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
672
746
|
#
|
|
673
747
|
# * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
|
|
@@ -679,6 +753,12 @@ module Aws::Personalize
|
|
|
679
753
|
# schema_arn: "Arn", # required
|
|
680
754
|
# dataset_group_arn: "Arn", # required
|
|
681
755
|
# dataset_type: "DatasetType", # required
|
|
756
|
+
# tags: [
|
|
757
|
+
# {
|
|
758
|
+
# tag_key: "TagKey", # required
|
|
759
|
+
# tag_value: "TagValue", # required
|
|
760
|
+
# },
|
|
761
|
+
# ],
|
|
682
762
|
# })
|
|
683
763
|
#
|
|
684
764
|
# @example Response structure
|
|
@@ -710,15 +790,17 @@ module Aws::Personalize
|
|
|
710
790
|
#
|
|
711
791
|
# ^
|
|
712
792
|
#
|
|
713
|
-
# To get the status of the export job, call
|
|
714
|
-
# and specify the Amazon Resource Name
|
|
715
|
-
# The dataset export is complete when
|
|
716
|
-
# status shows as
|
|
717
|
-
# 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.
|
|
718
799
|
#
|
|
719
800
|
#
|
|
720
801
|
#
|
|
721
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
|
|
722
804
|
#
|
|
723
805
|
# @option params [required, String] :job_name
|
|
724
806
|
# The name for the dataset export job.
|
|
@@ -741,6 +823,13 @@ module Aws::Personalize
|
|
|
741
823
|
# @option params [required, Types::DatasetExportJobOutput] :job_output
|
|
742
824
|
# The path to the Amazon S3 bucket where the job's output is stored.
|
|
743
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
|
+
#
|
|
744
833
|
# @return [Types::CreateDatasetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
745
834
|
#
|
|
746
835
|
# * {Types::CreateDatasetExportJobResponse#dataset_export_job_arn #dataset_export_job_arn} => String
|
|
@@ -758,6 +847,12 @@ module Aws::Personalize
|
|
|
758
847
|
# kms_key_arn: "KmsKeyArn",
|
|
759
848
|
# },
|
|
760
849
|
# },
|
|
850
|
+
# tags: [
|
|
851
|
+
# {
|
|
852
|
+
# tag_key: "TagKey", # required
|
|
853
|
+
# tag_value: "TagValue", # required
|
|
854
|
+
# },
|
|
855
|
+
# ],
|
|
761
856
|
# })
|
|
762
857
|
#
|
|
763
858
|
# @example Response structure
|
|
@@ -798,9 +893,10 @@ module Aws::Personalize
|
|
|
798
893
|
#
|
|
799
894
|
# * DELETE PENDING
|
|
800
895
|
#
|
|
801
|
-
# To get the status of the dataset group, call
|
|
802
|
-
# the status shows as CREATE FAILED, the
|
|
803
|
-
# `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.
|
|
804
900
|
#
|
|
805
901
|
# <note markdown="1"> You must wait until the `status` of the dataset group is `ACTIVE`
|
|
806
902
|
# before adding a dataset to the group.
|
|
@@ -814,19 +910,28 @@ module Aws::Personalize
|
|
|
814
910
|
#
|
|
815
911
|
# **APIs that require a dataset group ARN in the request**
|
|
816
912
|
#
|
|
817
|
-
# * CreateDataset
|
|
913
|
+
# * [CreateDataset][2]
|
|
818
914
|
#
|
|
819
|
-
# * CreateEventTracker
|
|
915
|
+
# * [CreateEventTracker][3]
|
|
820
916
|
#
|
|
821
|
-
# * CreateSolution
|
|
917
|
+
# * [CreateSolution][4]
|
|
822
918
|
#
|
|
823
919
|
# **Related APIs**
|
|
824
920
|
#
|
|
825
|
-
# * ListDatasetGroups
|
|
921
|
+
# * [ListDatasetGroups][5]
|
|
922
|
+
#
|
|
923
|
+
# * [DescribeDatasetGroup][1]
|
|
924
|
+
#
|
|
925
|
+
# * [DeleteDatasetGroup][6]
|
|
826
926
|
#
|
|
827
|
-
# * DescribeDatasetGroup
|
|
828
927
|
#
|
|
829
|
-
#
|
|
928
|
+
#
|
|
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
|
|
830
935
|
#
|
|
831
936
|
# @option params [required, String] :name
|
|
832
937
|
# The name for the new dataset group.
|
|
@@ -847,6 +952,13 @@ module Aws::Personalize
|
|
|
847
952
|
# don't specify a domain, you create a Custom dataset group with
|
|
848
953
|
# solution versions that you deploy with a campaign.
|
|
849
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
|
+
#
|
|
850
962
|
# @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
851
963
|
#
|
|
852
964
|
# * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
|
|
@@ -859,6 +971,12 @@ module Aws::Personalize
|
|
|
859
971
|
# role_arn: "RoleArn",
|
|
860
972
|
# kms_key_arn: "KmsKeyArn",
|
|
861
973
|
# domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
|
|
974
|
+
# tags: [
|
|
975
|
+
# {
|
|
976
|
+
# tag_key: "TagKey", # required
|
|
977
|
+
# tag_value: "TagValue", # required
|
|
978
|
+
# },
|
|
979
|
+
# ],
|
|
862
980
|
# })
|
|
863
981
|
#
|
|
864
982
|
# @example Response structure
|
|
@@ -896,11 +1014,12 @@ module Aws::Personalize
|
|
|
896
1014
|
#
|
|
897
1015
|
# ^
|
|
898
1016
|
#
|
|
899
|
-
# To get the status of the import job, call
|
|
900
|
-
# providing the Amazon Resource Name
|
|
901
|
-
# The dataset import is complete when
|
|
902
|
-
# status shows as
|
|
903
|
-
# 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.
|
|
904
1023
|
#
|
|
905
1024
|
# <note markdown="1"> Importing takes time. You must wait until the status shows as ACTIVE
|
|
906
1025
|
# before training a model using the dataset.
|
|
@@ -909,13 +1028,15 @@ module Aws::Personalize
|
|
|
909
1028
|
#
|
|
910
1029
|
# **Related APIs**
|
|
911
1030
|
#
|
|
912
|
-
# * ListDatasetImportJobs
|
|
1031
|
+
# * [ListDatasetImportJobs][3]
|
|
913
1032
|
#
|
|
914
|
-
# * DescribeDatasetImportJob
|
|
1033
|
+
# * [DescribeDatasetImportJob][2]
|
|
915
1034
|
#
|
|
916
1035
|
#
|
|
917
1036
|
#
|
|
918
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
|
|
919
1040
|
#
|
|
920
1041
|
# @option params [required, String] :job_name
|
|
921
1042
|
# The name for the dataset import job.
|
|
@@ -930,6 +1051,13 @@ module Aws::Personalize
|
|
|
930
1051
|
# The ARN of the IAM role that has permissions to read from the Amazon
|
|
931
1052
|
# S3 data source.
|
|
932
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
|
+
#
|
|
933
1061
|
# @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
934
1062
|
#
|
|
935
1063
|
# * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
|
|
@@ -943,6 +1071,12 @@ module Aws::Personalize
|
|
|
943
1071
|
# data_location: "S3Location",
|
|
944
1072
|
# },
|
|
945
1073
|
# role_arn: "RoleArn", # required
|
|
1074
|
+
# tags: [
|
|
1075
|
+
# {
|
|
1076
|
+
# tag_key: "TagKey", # required
|
|
1077
|
+
# tag_value: "TagValue", # required
|
|
1078
|
+
# },
|
|
1079
|
+
# ],
|
|
946
1080
|
# })
|
|
947
1081
|
#
|
|
948
1082
|
# @example Response structure
|
|
@@ -980,7 +1114,8 @@ module Aws::Personalize
|
|
|
980
1114
|
#
|
|
981
1115
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
|
982
1116
|
#
|
|
983
|
-
# To get the status of the event tracker, call
|
|
1117
|
+
# To get the status of the event tracker, call
|
|
1118
|
+
# [DescribeEventTracker][2].
|
|
984
1119
|
#
|
|
985
1120
|
# <note markdown="1"> The event tracker must be in the ACTIVE state before using the
|
|
986
1121
|
# tracking ID.
|
|
@@ -989,15 +1124,18 @@ module Aws::Personalize
|
|
|
989
1124
|
#
|
|
990
1125
|
# **Related APIs**
|
|
991
1126
|
#
|
|
992
|
-
# * ListEventTrackers
|
|
1127
|
+
# * [ListEventTrackers][3]
|
|
993
1128
|
#
|
|
994
|
-
# * DescribeEventTracker
|
|
1129
|
+
# * [DescribeEventTracker][2]
|
|
995
1130
|
#
|
|
996
|
-
# * DeleteEventTracker
|
|
1131
|
+
# * [DeleteEventTracker][4]
|
|
997
1132
|
#
|
|
998
1133
|
#
|
|
999
1134
|
#
|
|
1000
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
|
|
1001
1139
|
#
|
|
1002
1140
|
# @option params [required, String] :name
|
|
1003
1141
|
# The name for the event tracker.
|
|
@@ -1006,6 +1144,13 @@ module Aws::Personalize
|
|
|
1006
1144
|
# The Amazon Resource Name (ARN) of the dataset group that receives the
|
|
1007
1145
|
# event data.
|
|
1008
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
|
+
#
|
|
1009
1154
|
# @return [Types::CreateEventTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1010
1155
|
#
|
|
1011
1156
|
# * {Types::CreateEventTrackerResponse#event_tracker_arn #event_tracker_arn} => String
|
|
@@ -1016,6 +1161,12 @@ module Aws::Personalize
|
|
|
1016
1161
|
# resp = client.create_event_tracker({
|
|
1017
1162
|
# name: "Name", # required
|
|
1018
1163
|
# dataset_group_arn: "Arn", # required
|
|
1164
|
+
# tags: [
|
|
1165
|
+
# {
|
|
1166
|
+
# tag_key: "TagKey", # required
|
|
1167
|
+
# tag_value: "TagValue", # required
|
|
1168
|
+
# },
|
|
1169
|
+
# ],
|
|
1019
1170
|
# })
|
|
1020
1171
|
#
|
|
1021
1172
|
# @example Response structure
|
|
@@ -1032,7 +1183,12 @@ module Aws::Personalize
|
|
|
1032
1183
|
req.send_request(options)
|
|
1033
1184
|
end
|
|
1034
1185
|
|
|
1035
|
-
# 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
|
|
1036
1192
|
#
|
|
1037
1193
|
# @option params [required, String] :name
|
|
1038
1194
|
# The name of the filter to create.
|
|
@@ -1044,7 +1200,18 @@ module Aws::Personalize
|
|
|
1044
1200
|
# The filter expression defines which items are included or excluded
|
|
1045
1201
|
# from recommendations. Filter expression must follow specific format
|
|
1046
1202
|
# rules. For information about filter expression structure and syntax,
|
|
1047
|
-
# 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
|
|
1048
1215
|
#
|
|
1049
1216
|
# @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1050
1217
|
#
|
|
@@ -1056,6 +1223,12 @@ module Aws::Personalize
|
|
|
1056
1223
|
# name: "Name", # required
|
|
1057
1224
|
# dataset_group_arn: "Arn", # required
|
|
1058
1225
|
# filter_expression: "FilterExpression", # required
|
|
1226
|
+
# tags: [
|
|
1227
|
+
# {
|
|
1228
|
+
# tag_key: "TagKey", # required
|
|
1229
|
+
# tag_value: "TagValue", # required
|
|
1230
|
+
# },
|
|
1231
|
+
# ],
|
|
1059
1232
|
# })
|
|
1060
1233
|
#
|
|
1061
1234
|
# @example Response structure
|
|
@@ -1111,7 +1284,7 @@ module Aws::Personalize
|
|
|
1111
1284
|
#
|
|
1112
1285
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
|
1113
1286
|
#
|
|
1114
|
-
# To get the recommender status, call DescribeRecommender.
|
|
1287
|
+
# To get the recommender status, call [DescribeRecommender][2].
|
|
1115
1288
|
#
|
|
1116
1289
|
# <note markdown="1"> Wait until the `status` of the recommender is `ACTIVE` before asking
|
|
1117
1290
|
# the recommender for recommendations.
|
|
@@ -1120,17 +1293,21 @@ module Aws::Personalize
|
|
|
1120
1293
|
#
|
|
1121
1294
|
# **Related APIs**
|
|
1122
1295
|
#
|
|
1123
|
-
# * ListRecommenders
|
|
1296
|
+
# * [ListRecommenders][3]
|
|
1124
1297
|
#
|
|
1125
|
-
# * DescribeRecommender
|
|
1298
|
+
# * [DescribeRecommender][2]
|
|
1126
1299
|
#
|
|
1127
|
-
# * UpdateRecommender
|
|
1300
|
+
# * [UpdateRecommender][4]
|
|
1128
1301
|
#
|
|
1129
|
-
# * DeleteRecommender
|
|
1302
|
+
# * [DeleteRecommender][5]
|
|
1130
1303
|
#
|
|
1131
1304
|
#
|
|
1132
1305
|
#
|
|
1133
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
|
|
1134
1311
|
#
|
|
1135
1312
|
# @option params [required, String] :name
|
|
1136
1313
|
# The name of the recommender.
|
|
@@ -1153,6 +1330,13 @@ module Aws::Personalize
|
|
|
1153
1330
|
# @option params [Types::RecommenderConfig] :recommender_config
|
|
1154
1331
|
# The configuration details of the recommender.
|
|
1155
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
|
+
#
|
|
1156
1340
|
# @return [Types::CreateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1157
1341
|
#
|
|
1158
1342
|
# * {Types::CreateRecommenderResponse#recommender_arn #recommender_arn} => String
|
|
@@ -1169,6 +1353,12 @@ module Aws::Personalize
|
|
|
1169
1353
|
# },
|
|
1170
1354
|
# min_recommendation_requests_per_second: 1,
|
|
1171
1355
|
# },
|
|
1356
|
+
# tags: [
|
|
1357
|
+
# {
|
|
1358
|
+
# tag_key: "TagKey", # required
|
|
1359
|
+
# tag_value: "TagValue", # required
|
|
1360
|
+
# },
|
|
1361
|
+
# ],
|
|
1172
1362
|
# })
|
|
1173
1363
|
#
|
|
1174
1364
|
# @example Response structure
|
|
@@ -1191,15 +1381,22 @@ module Aws::Personalize
|
|
|
1191
1381
|
# associated with a dataset type and has a set of required field and
|
|
1192
1382
|
# keywords. If you are creating a schema for a dataset in a Domain
|
|
1193
1383
|
# dataset group, you provide the domain of the Domain dataset group. You
|
|
1194
|
-
# specify a schema when you call CreateDataset.
|
|
1384
|
+
# specify a schema when you call [CreateDataset][1].
|
|
1195
1385
|
#
|
|
1196
1386
|
# **Related APIs**
|
|
1197
1387
|
#
|
|
1198
|
-
# * ListSchemas
|
|
1388
|
+
# * [ListSchemas][2]
|
|
1389
|
+
#
|
|
1390
|
+
# * [DescribeSchema][3]
|
|
1391
|
+
#
|
|
1392
|
+
# * [DeleteSchema][4]
|
|
1393
|
+
#
|
|
1199
1394
|
#
|
|
1200
|
-
# * DescribeSchema
|
|
1201
1395
|
#
|
|
1202
|
-
#
|
|
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
|
|
1203
1400
|
#
|
|
1204
1401
|
# @option params [required, String] :name
|
|
1205
1402
|
# The name for the schema.
|
|
@@ -1239,14 +1436,14 @@ module Aws::Personalize
|
|
|
1239
1436
|
|
|
1240
1437
|
# Creates the configuration for training a model. A trained model is
|
|
1241
1438
|
# known as a solution. After the configuration is created, you train the
|
|
1242
|
-
# model (create a solution) by calling the CreateSolutionVersion
|
|
1439
|
+
# model (create a solution) by calling the [CreateSolutionVersion][1]
|
|
1243
1440
|
# operation. Every time you call `CreateSolutionVersion`, a new version
|
|
1244
1441
|
# of the solution is created.
|
|
1245
1442
|
#
|
|
1246
1443
|
# After creating a solution version, you check its accuracy by calling
|
|
1247
|
-
# GetSolutionMetrics. When you are satisfied with the version, you
|
|
1248
|
-
# deploy it using CreateCampaign. The campaign provides
|
|
1249
|
-
# 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.
|
|
1250
1447
|
#
|
|
1251
1448
|
# To train a model, Amazon Personalize requires training data and a
|
|
1252
1449
|
# recipe. The training data comes from the dataset group that you
|
|
@@ -1270,27 +1467,36 @@ module Aws::Personalize
|
|
|
1270
1467
|
#
|
|
1271
1468
|
# * DELETE PENDING > DELETE IN\_PROGRESS
|
|
1272
1469
|
#
|
|
1273
|
-
# To get the status of the solution, call DescribeSolution. Wait
|
|
1274
|
-
# 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`.
|
|
1275
1473
|
#
|
|
1276
1474
|
# **Related APIs**
|
|
1277
1475
|
#
|
|
1278
|
-
# * ListSolutions
|
|
1476
|
+
# * [ListSolutions][6]
|
|
1279
1477
|
#
|
|
1280
|
-
# * CreateSolutionVersion
|
|
1478
|
+
# * [CreateSolutionVersion][1]
|
|
1281
1479
|
#
|
|
1282
|
-
# * DescribeSolution
|
|
1480
|
+
# * [DescribeSolution][5]
|
|
1283
1481
|
#
|
|
1284
|
-
# * DeleteSolution
|
|
1482
|
+
# * [DeleteSolution][7]
|
|
1285
1483
|
# ^
|
|
1286
1484
|
#
|
|
1287
|
-
# * ListSolutionVersions
|
|
1485
|
+
# * [ListSolutionVersions][8]
|
|
1288
1486
|
#
|
|
1289
|
-
# * DescribeSolutionVersion
|
|
1487
|
+
# * [DescribeSolutionVersion][9]
|
|
1290
1488
|
#
|
|
1291
1489
|
#
|
|
1292
1490
|
#
|
|
1293
|
-
# [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
|
|
1294
1500
|
#
|
|
1295
1501
|
# @option params [required, String] :name
|
|
1296
1502
|
# The name for the solution.
|
|
@@ -1339,6 +1545,13 @@ module Aws::Personalize
|
|
|
1339
1545
|
#
|
|
1340
1546
|
# </note>
|
|
1341
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
|
+
#
|
|
1342
1555
|
# @return [Types::CreateSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1343
1556
|
#
|
|
1344
1557
|
# * {Types::CreateSolutionResponse#solution_arn #solution_arn} => String
|
|
@@ -1402,6 +1615,12 @@ module Aws::Personalize
|
|
|
1402
1615
|
# objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
|
|
1403
1616
|
# },
|
|
1404
1617
|
# },
|
|
1618
|
+
# tags: [
|
|
1619
|
+
# {
|
|
1620
|
+
# tag_key: "TagKey", # required
|
|
1621
|
+
# tag_value: "TagValue", # required
|
|
1622
|
+
# },
|
|
1623
|
+
# ],
|
|
1405
1624
|
# })
|
|
1406
1625
|
#
|
|
1407
1626
|
# @example Response structure
|
|
@@ -1418,9 +1637,9 @@ module Aws::Personalize
|
|
|
1418
1637
|
end
|
|
1419
1638
|
|
|
1420
1639
|
# Trains or retrains an active solution in a Custom dataset group. A
|
|
1421
|
-
# solution is created using the CreateSolution operation and must
|
|
1422
|
-
# the ACTIVE state before calling `CreateSolutionVersion`. A new
|
|
1423
|
-
# 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.
|
|
1424
1643
|
#
|
|
1425
1644
|
# **Status**
|
|
1426
1645
|
#
|
|
@@ -1438,26 +1657,34 @@ module Aws::Personalize
|
|
|
1438
1657
|
#
|
|
1439
1658
|
# * CREATE STOPPED
|
|
1440
1659
|
#
|
|
1441
|
-
# To get the status of the version, call DescribeSolutionVersion.
|
|
1442
|
-
# 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`.
|
|
1443
1662
|
#
|
|
1444
1663
|
# If the status shows as CREATE FAILED, the response includes a
|
|
1445
1664
|
# `failureReason` key, which describes why the job failed.
|
|
1446
1665
|
#
|
|
1447
1666
|
# **Related APIs**
|
|
1448
1667
|
#
|
|
1449
|
-
# * ListSolutionVersions
|
|
1668
|
+
# * [ListSolutionVersions][3]
|
|
1450
1669
|
#
|
|
1451
|
-
# * DescribeSolutionVersion
|
|
1452
|
-
#
|
|
1670
|
+
# * [DescribeSolutionVersion][2]
|
|
1671
|
+
#
|
|
1672
|
+
# * [ListSolutions][4]
|
|
1453
1673
|
#
|
|
1454
|
-
# *
|
|
1674
|
+
# * [CreateSolution][1]
|
|
1455
1675
|
#
|
|
1456
|
-
# *
|
|
1676
|
+
# * [DescribeSolution][5]
|
|
1457
1677
|
#
|
|
1458
|
-
# *
|
|
1678
|
+
# * [DeleteSolution][6]
|
|
1459
1679
|
#
|
|
1460
|
-
#
|
|
1680
|
+
#
|
|
1681
|
+
#
|
|
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
|
|
1461
1688
|
#
|
|
1462
1689
|
# @option params [required, String] :solution_arn
|
|
1463
1690
|
# The Amazon Resource Name (ARN) of the solution containing the training
|
|
@@ -1481,6 +1708,13 @@ module Aws::Personalize
|
|
|
1481
1708
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
|
1482
1709
|
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
|
|
1483
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
|
+
#
|
|
1484
1718
|
# @return [Types::CreateSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1485
1719
|
#
|
|
1486
1720
|
# * {Types::CreateSolutionVersionResponse#solution_version_arn #solution_version_arn} => String
|
|
@@ -1490,6 +1724,12 @@ module Aws::Personalize
|
|
|
1490
1724
|
# resp = client.create_solution_version({
|
|
1491
1725
|
# solution_arn: "Arn", # required
|
|
1492
1726
|
# training_mode: "FULL", # accepts FULL, UPDATE
|
|
1727
|
+
# tags: [
|
|
1728
|
+
# {
|
|
1729
|
+
# tag_key: "TagKey", # required
|
|
1730
|
+
# tag_value: "TagValue", # required
|
|
1731
|
+
# },
|
|
1732
|
+
# ],
|
|
1493
1733
|
# })
|
|
1494
1734
|
#
|
|
1495
1735
|
# @example Response structure
|
|
@@ -1508,12 +1748,13 @@ module Aws::Personalize
|
|
|
1508
1748
|
# Removes a campaign by deleting the solution deployment. The solution
|
|
1509
1749
|
# that the campaign is based on is not deleted and can be redeployed
|
|
1510
1750
|
# when needed. A deleted campaign can no longer be specified in a
|
|
1511
|
-
# [GetRecommendations][1] request. For
|
|
1512
|
-
# see CreateCampaign.
|
|
1751
|
+
# [GetRecommendations][1] request. For information on creating
|
|
1752
|
+
# campaigns, see [CreateCampaign][2].
|
|
1513
1753
|
#
|
|
1514
1754
|
#
|
|
1515
1755
|
#
|
|
1516
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
|
|
1517
1758
|
#
|
|
1518
1759
|
# @option params [required, String] :campaign_arn
|
|
1519
1760
|
# The Amazon Resource Name (ARN) of the campaign to delete.
|
|
@@ -1537,7 +1778,12 @@ module Aws::Personalize
|
|
|
1537
1778
|
|
|
1538
1779
|
# Deletes a dataset. You can't delete a dataset if an associated
|
|
1539
1780
|
# `DatasetImportJob` or `SolutionVersion` is in the CREATE PENDING or IN
|
|
1540
|
-
# 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
|
|
1541
1787
|
#
|
|
1542
1788
|
# @option params [required, String] :dataset_arn
|
|
1543
1789
|
# The Amazon Resource Name (ARN) of the dataset to delete.
|
|
@@ -1590,7 +1836,11 @@ module Aws::Personalize
|
|
|
1590
1836
|
|
|
1591
1837
|
# Deletes the event tracker. Does not delete the event-interactions
|
|
1592
1838
|
# dataset from the associated dataset group. For more information on
|
|
1593
|
-
# 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
|
|
1594
1844
|
#
|
|
1595
1845
|
# @option params [required, String] :event_tracker_arn
|
|
1596
1846
|
# The Amazon Resource Name (ARN) of the event tracker to delete.
|
|
@@ -1663,7 +1913,11 @@ module Aws::Personalize
|
|
|
1663
1913
|
|
|
1664
1914
|
# Deletes a schema. Before deleting a schema, you must delete all
|
|
1665
1915
|
# datasets referencing the schema. For more information on schemas, see
|
|
1666
|
-
# CreateSchema.
|
|
1916
|
+
# [CreateSchema][1].
|
|
1917
|
+
#
|
|
1918
|
+
#
|
|
1919
|
+
#
|
|
1920
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html
|
|
1667
1921
|
#
|
|
1668
1922
|
# @option params [required, String] :schema_arn
|
|
1669
1923
|
# The Amazon Resource Name (ARN) of the schema to delete.
|
|
@@ -1688,10 +1942,15 @@ module Aws::Personalize
|
|
|
1688
1942
|
# Deletes all versions of a solution and the `Solution` object itself.
|
|
1689
1943
|
# Before deleting a solution, you must delete all campaigns based on the
|
|
1690
1944
|
# solution. To determine what campaigns are using the solution, call
|
|
1691
|
-
# ListCampaigns and supply the Amazon Resource Name (ARN) of the
|
|
1945
|
+
# [ListCampaigns][1] and supply the Amazon Resource Name (ARN) of the
|
|
1692
1946
|
# solution. You can't delete a solution if an associated
|
|
1693
1947
|
# `SolutionVersion` is in the CREATE PENDING or IN PROGRESS state. For
|
|
1694
|
-
# 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
|
|
1695
1954
|
#
|
|
1696
1955
|
# @option params [required, String] :solution_arn
|
|
1697
1956
|
# The ARN of the solution to delete.
|
|
@@ -1867,7 +2126,11 @@ module Aws::Personalize
|
|
|
1867
2126
|
# When the `status` is `CREATE FAILED`, the response includes the
|
|
1868
2127
|
# `failureReason` key, which describes why.
|
|
1869
2128
|
#
|
|
1870
|
-
# 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
|
|
1871
2134
|
#
|
|
1872
2135
|
# @option params [required, String] :campaign_arn
|
|
1873
2136
|
# The Amazon Resource Name (ARN) of the campaign.
|
|
@@ -1913,7 +2176,11 @@ module Aws::Personalize
|
|
|
1913
2176
|
end
|
|
1914
2177
|
|
|
1915
2178
|
# Describes the given dataset. For more information on datasets, see
|
|
1916
|
-
# CreateDataset.
|
|
2179
|
+
# [CreateDataset][1].
|
|
2180
|
+
#
|
|
2181
|
+
#
|
|
2182
|
+
#
|
|
2183
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
|
|
1917
2184
|
#
|
|
1918
2185
|
# @option params [required, String] :dataset_arn
|
|
1919
2186
|
# The Amazon Resource Name (ARN) of the dataset to describe.
|
|
@@ -1948,8 +2215,12 @@ module Aws::Personalize
|
|
|
1948
2215
|
req.send_request(options)
|
|
1949
2216
|
end
|
|
1950
2217
|
|
|
1951
|
-
# Describes the dataset export job created by
|
|
1952
|
-
# 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
|
|
1953
2224
|
#
|
|
1954
2225
|
# @option params [required, String] :dataset_export_job_arn
|
|
1955
2226
|
# The Amazon Resource Name (ARN) of the dataset export job to describe.
|
|
@@ -1988,7 +2259,11 @@ module Aws::Personalize
|
|
|
1988
2259
|
end
|
|
1989
2260
|
|
|
1990
2261
|
# Describes the given dataset group. For more information on dataset
|
|
1991
|
-
# groups, see CreateDatasetGroup.
|
|
2262
|
+
# groups, see [CreateDatasetGroup][1].
|
|
2263
|
+
#
|
|
2264
|
+
#
|
|
2265
|
+
#
|
|
2266
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html
|
|
1992
2267
|
#
|
|
1993
2268
|
# @option params [required, String] :dataset_group_arn
|
|
1994
2269
|
# The Amazon Resource Name (ARN) of the dataset group to describe.
|
|
@@ -2024,8 +2299,12 @@ module Aws::Personalize
|
|
|
2024
2299
|
req.send_request(options)
|
|
2025
2300
|
end
|
|
2026
2301
|
|
|
2027
|
-
# Describes the dataset import job created by
|
|
2028
|
-
# 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
|
|
2029
2308
|
#
|
|
2030
2309
|
# @option params [required, String] :dataset_import_job_arn
|
|
2031
2310
|
# The Amazon Resource Name (ARN) of the dataset import job to describe.
|
|
@@ -2063,7 +2342,11 @@ module Aws::Personalize
|
|
|
2063
2342
|
|
|
2064
2343
|
# Describes an event tracker. The response includes the `trackingId` and
|
|
2065
2344
|
# `status` of the event tracker. For more information on event trackers,
|
|
2066
|
-
# see CreateEventTracker.
|
|
2345
|
+
# see [CreateEventTracker][1].
|
|
2346
|
+
#
|
|
2347
|
+
#
|
|
2348
|
+
#
|
|
2349
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html
|
|
2067
2350
|
#
|
|
2068
2351
|
# @option params [required, String] :event_tracker_arn
|
|
2069
2352
|
# The Amazon Resource Name (ARN) of the event tracker to describe.
|
|
@@ -2180,15 +2463,16 @@ module Aws::Personalize
|
|
|
2180
2463
|
# before training.
|
|
2181
2464
|
#
|
|
2182
2465
|
# Amazon Personalize provides a set of predefined recipes. You specify a
|
|
2183
|
-
# recipe when you create a solution with the CreateSolution API.
|
|
2466
|
+
# recipe when you create a solution with the [CreateSolution][1] API.
|
|
2184
2467
|
# `CreateSolution` trains a model by using the algorithm in the
|
|
2185
2468
|
# specified recipe and a training dataset. The solution, when deployed
|
|
2186
2469
|
# as a campaign, can provide recommendations using the
|
|
2187
|
-
# [GetRecommendations][
|
|
2470
|
+
# [GetRecommendations][2] API.
|
|
2188
2471
|
#
|
|
2189
2472
|
#
|
|
2190
2473
|
#
|
|
2191
|
-
# [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
|
|
2192
2476
|
#
|
|
2193
2477
|
# @option params [required, String] :recipe_arn
|
|
2194
2478
|
# The Amazon Resource Name (ARN) of the recipe to describe.
|
|
@@ -2285,7 +2569,12 @@ module Aws::Personalize
|
|
|
2285
2569
|
req.send_request(options)
|
|
2286
2570
|
end
|
|
2287
2571
|
|
|
2288
|
-
# 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
|
|
2289
2578
|
#
|
|
2290
2579
|
# @option params [required, String] :schema_arn
|
|
2291
2580
|
# The Amazon Resource Name (ARN) of the schema to retrieve.
|
|
@@ -2319,7 +2608,11 @@ module Aws::Personalize
|
|
|
2319
2608
|
end
|
|
2320
2609
|
|
|
2321
2610
|
# Describes a solution. For more information on solutions, see
|
|
2322
|
-
# CreateSolution.
|
|
2611
|
+
# [CreateSolution][1].
|
|
2612
|
+
#
|
|
2613
|
+
#
|
|
2614
|
+
#
|
|
2615
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
|
2323
2616
|
#
|
|
2324
2617
|
# @option params [required, String] :solution_arn
|
|
2325
2618
|
# The Amazon Resource Name (ARN) of the solution to describe.
|
|
@@ -2390,7 +2683,11 @@ module Aws::Personalize
|
|
|
2390
2683
|
end
|
|
2391
2684
|
|
|
2392
2685
|
# Describes a specific version of a solution. For more information on
|
|
2393
|
-
# solutions, see CreateSolution
|
|
2686
|
+
# solutions, see [CreateSolution][1]
|
|
2687
|
+
#
|
|
2688
|
+
#
|
|
2689
|
+
#
|
|
2690
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html
|
|
2394
2691
|
#
|
|
2395
2692
|
# @option params [required, String] :solution_version_arn
|
|
2396
2693
|
# The Amazon Resource Name (ARN) of the solution version.
|
|
@@ -2595,7 +2892,11 @@ module Aws::Personalize
|
|
|
2595
2892
|
# solution is not specified, all the campaigns associated with the
|
|
2596
2893
|
# account are listed. The response provides the properties for each
|
|
2597
2894
|
# campaign, including the Amazon Resource Name (ARN). For more
|
|
2598
|
-
# 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
|
|
2599
2900
|
#
|
|
2600
2901
|
# @option params [String] :solution_arn
|
|
2601
2902
|
# The Amazon Resource Name (ARN) of the solution to list the campaigns
|
|
@@ -2603,8 +2904,12 @@ module Aws::Personalize
|
|
|
2603
2904
|
# with the account are listed.
|
|
2604
2905
|
#
|
|
2605
2906
|
# @option params [String] :next_token
|
|
2606
|
-
# A token returned from the previous call to
|
|
2607
|
-
# 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
|
|
2608
2913
|
#
|
|
2609
2914
|
# @option params [Integer] :max_results
|
|
2610
2915
|
# The maximum number of campaigns to return.
|
|
@@ -2648,8 +2953,14 @@ module Aws::Personalize
|
|
|
2648
2953
|
# a dataset is not specified, all the dataset export jobs associated
|
|
2649
2954
|
# with the account are listed. The response provides the properties for
|
|
2650
2955
|
# each dataset export job, including the Amazon Resource Name (ARN). For
|
|
2651
|
-
# more information on dataset export jobs, see
|
|
2652
|
-
# 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
|
|
2653
2964
|
#
|
|
2654
2965
|
# @option params [String] :dataset_arn
|
|
2655
2966
|
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
|
@@ -2699,7 +3010,11 @@ module Aws::Personalize
|
|
|
2699
3010
|
|
|
2700
3011
|
# Returns a list of dataset groups. The response provides the properties
|
|
2701
3012
|
# for each dataset group, including the Amazon Resource Name (ARN). For
|
|
2702
|
-
# 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
|
|
2703
3018
|
#
|
|
2704
3019
|
# @option params [String] :next_token
|
|
2705
3020
|
# A token returned from the previous call to `ListDatasetGroups` for
|
|
@@ -2747,8 +3062,14 @@ module Aws::Personalize
|
|
|
2747
3062
|
# a dataset is not specified, all the dataset import jobs associated
|
|
2748
3063
|
# with the account are listed. The response provides the properties for
|
|
2749
3064
|
# each dataset import job, including the Amazon Resource Name (ARN). For
|
|
2750
|
-
# more information on dataset import jobs, see
|
|
2751
|
-
# 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
|
|
2752
3073
|
#
|
|
2753
3074
|
# @option params [String] :dataset_arn
|
|
2754
3075
|
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
|
@@ -2799,7 +3120,11 @@ module Aws::Personalize
|
|
|
2799
3120
|
# Returns the list of datasets contained in the given dataset group. The
|
|
2800
3121
|
# response provides the properties for each dataset, including the
|
|
2801
3122
|
# Amazon Resource Name (ARN). For more information on datasets, see
|
|
2802
|
-
# CreateDataset.
|
|
3123
|
+
# [CreateDataset][1].
|
|
3124
|
+
#
|
|
3125
|
+
#
|
|
3126
|
+
#
|
|
3127
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
|
|
2803
3128
|
#
|
|
2804
3129
|
# @option params [String] :dataset_group_arn
|
|
2805
3130
|
# The Amazon Resource Name (ARN) of the dataset group that contains the
|
|
@@ -2850,7 +3175,11 @@ module Aws::Personalize
|
|
|
2850
3175
|
# Returns the list of event trackers associated with the account. The
|
|
2851
3176
|
# response provides the properties for each event tracker, including the
|
|
2852
3177
|
# Amazon Resource Name (ARN) and tracking ID. For more information on
|
|
2853
|
-
# 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
|
|
2854
3183
|
#
|
|
2855
3184
|
# @option params [String] :dataset_group_arn
|
|
2856
3185
|
# The ARN of a dataset group used to filter the response.
|
|
@@ -2961,8 +3290,8 @@ module Aws::Personalize
|
|
|
2961
3290
|
# @option params [String] :domain
|
|
2962
3291
|
# Filters returned recipes by domain for a Domain dataset group. Only
|
|
2963
3292
|
# recipes (Domain dataset group use cases) for this domain are included
|
|
2964
|
-
# in the response. If you don't specify a domain,
|
|
2965
|
-
#
|
|
3293
|
+
# in the response. If you don't specify a domain, all recipes are
|
|
3294
|
+
# returned.
|
|
2966
3295
|
#
|
|
2967
3296
|
# @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2968
3297
|
#
|
|
@@ -3063,7 +3392,11 @@ module Aws::Personalize
|
|
|
3063
3392
|
|
|
3064
3393
|
# Returns the list of schemas associated with the account. The response
|
|
3065
3394
|
# provides the properties for each schema, including the Amazon Resource
|
|
3066
|
-
# 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
|
|
3067
3400
|
#
|
|
3068
3401
|
# @option params [String] :next_token
|
|
3069
3402
|
# A token returned from the previous call to `ListSchemas` for getting
|
|
@@ -3108,8 +3441,7 @@ module Aws::Personalize
|
|
|
3108
3441
|
# Returns a list of solution versions for the given solution. When a
|
|
3109
3442
|
# solution is not specified, all the solution versions associated with
|
|
3110
3443
|
# the account are listed. The response provides the properties for each
|
|
3111
|
-
# solution version, including the Amazon Resource Name (ARN).
|
|
3112
|
-
# information on solutions, see CreateSolution.
|
|
3444
|
+
# solution version, including the Amazon Resource Name (ARN).
|
|
3113
3445
|
#
|
|
3114
3446
|
# @option params [String] :solution_arn
|
|
3115
3447
|
# The Amazon Resource Name (ARN) of the solution.
|
|
@@ -3159,7 +3491,11 @@ module Aws::Personalize
|
|
|
3159
3491
|
# dataset group is not specified, all the solutions associated with the
|
|
3160
3492
|
# account are listed. The response provides the properties for each
|
|
3161
3493
|
# solution, including the Amazon Resource Name (ARN). For more
|
|
3162
|
-
# 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
|
|
3163
3499
|
#
|
|
3164
3500
|
# @option params [String] :dataset_group_arn
|
|
3165
3501
|
# The Amazon Resource Name (ARN) of the dataset group.
|
|
@@ -3205,6 +3541,99 @@ module Aws::Personalize
|
|
|
3205
3541
|
req.send_request(options)
|
|
3206
3542
|
end
|
|
3207
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
|
+
|
|
3578
|
+
# Starts a recommender that is INACTIVE. Starting a recommender does not
|
|
3579
|
+
# create any new models, but resumes billing and automatic retraining
|
|
3580
|
+
# for the recommender.
|
|
3581
|
+
#
|
|
3582
|
+
# @option params [required, String] :recommender_arn
|
|
3583
|
+
# The Amazon Resource Name (ARN) of the recommender to start.
|
|
3584
|
+
#
|
|
3585
|
+
# @return [Types::StartRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3586
|
+
#
|
|
3587
|
+
# * {Types::StartRecommenderResponse#recommender_arn #recommender_arn} => String
|
|
3588
|
+
#
|
|
3589
|
+
# @example Request syntax with placeholder values
|
|
3590
|
+
#
|
|
3591
|
+
# resp = client.start_recommender({
|
|
3592
|
+
# recommender_arn: "Arn", # required
|
|
3593
|
+
# })
|
|
3594
|
+
#
|
|
3595
|
+
# @example Response structure
|
|
3596
|
+
#
|
|
3597
|
+
# resp.recommender_arn #=> String
|
|
3598
|
+
#
|
|
3599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StartRecommender AWS API Documentation
|
|
3600
|
+
#
|
|
3601
|
+
# @overload start_recommender(params = {})
|
|
3602
|
+
# @param [Hash] params ({})
|
|
3603
|
+
def start_recommender(params = {}, options = {})
|
|
3604
|
+
req = build_request(:start_recommender, params)
|
|
3605
|
+
req.send_request(options)
|
|
3606
|
+
end
|
|
3607
|
+
|
|
3608
|
+
# Stops a recommender that is ACTIVE. Stopping a recommender halts
|
|
3609
|
+
# billing and automatic retraining for the recommender.
|
|
3610
|
+
#
|
|
3611
|
+
# @option params [required, String] :recommender_arn
|
|
3612
|
+
# The Amazon Resource Name (ARN) of the recommender to stop.
|
|
3613
|
+
#
|
|
3614
|
+
# @return [Types::StopRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3615
|
+
#
|
|
3616
|
+
# * {Types::StopRecommenderResponse#recommender_arn #recommender_arn} => String
|
|
3617
|
+
#
|
|
3618
|
+
# @example Request syntax with placeholder values
|
|
3619
|
+
#
|
|
3620
|
+
# resp = client.stop_recommender({
|
|
3621
|
+
# recommender_arn: "Arn", # required
|
|
3622
|
+
# })
|
|
3623
|
+
#
|
|
3624
|
+
# @example Response structure
|
|
3625
|
+
#
|
|
3626
|
+
# resp.recommender_arn #=> String
|
|
3627
|
+
#
|
|
3628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StopRecommender AWS API Documentation
|
|
3629
|
+
#
|
|
3630
|
+
# @overload stop_recommender(params = {})
|
|
3631
|
+
# @param [Hash] params ({})
|
|
3632
|
+
def stop_recommender(params = {}, options = {})
|
|
3633
|
+
req = build_request(:stop_recommender, params)
|
|
3634
|
+
req.send_request(options)
|
|
3635
|
+
end
|
|
3636
|
+
|
|
3208
3637
|
# Stops creating a solution version that is in a state of
|
|
3209
3638
|
# CREATE\_PENDING or CREATE IN\_PROGRESS.
|
|
3210
3639
|
#
|
|
@@ -3242,18 +3671,92 @@ module Aws::Personalize
|
|
|
3242
3671
|
req.send_request(options)
|
|
3243
3672
|
end
|
|
3244
3673
|
|
|
3674
|
+
# Add a list of tags to a resource.
|
|
3675
|
+
#
|
|
3676
|
+
# @option params [required, String] :resource_arn
|
|
3677
|
+
# The resource's Amazon Resource Name (ARN).
|
|
3678
|
+
#
|
|
3679
|
+
# @option params [required, Array<Types::Tag>] :tags
|
|
3680
|
+
# Tags to apply to the resource. For more information see [Tagging
|
|
3681
|
+
# Personalize resources][1].
|
|
3682
|
+
#
|
|
3683
|
+
#
|
|
3684
|
+
#
|
|
3685
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
|
3686
|
+
#
|
|
3687
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3688
|
+
#
|
|
3689
|
+
# @example Request syntax with placeholder values
|
|
3690
|
+
#
|
|
3691
|
+
# resp = client.tag_resource({
|
|
3692
|
+
# resource_arn: "Arn", # required
|
|
3693
|
+
# tags: [ # required
|
|
3694
|
+
# {
|
|
3695
|
+
# tag_key: "TagKey", # required
|
|
3696
|
+
# tag_value: "TagValue", # required
|
|
3697
|
+
# },
|
|
3698
|
+
# ],
|
|
3699
|
+
# })
|
|
3700
|
+
#
|
|
3701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TagResource AWS API Documentation
|
|
3702
|
+
#
|
|
3703
|
+
# @overload tag_resource(params = {})
|
|
3704
|
+
# @param [Hash] params ({})
|
|
3705
|
+
def tag_resource(params = {}, options = {})
|
|
3706
|
+
req = build_request(:tag_resource, params)
|
|
3707
|
+
req.send_request(options)
|
|
3708
|
+
end
|
|
3709
|
+
|
|
3710
|
+
# Remove [tags][1] that are attached to a resource.
|
|
3711
|
+
#
|
|
3712
|
+
#
|
|
3713
|
+
#
|
|
3714
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html
|
|
3715
|
+
#
|
|
3716
|
+
# @option params [required, String] :resource_arn
|
|
3717
|
+
# The resource's Amazon Resource Name (ARN).
|
|
3718
|
+
#
|
|
3719
|
+
# @option params [required, Array<String>] :tag_keys
|
|
3720
|
+
# Keys to remove from the resource's tags.
|
|
3721
|
+
#
|
|
3722
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3723
|
+
#
|
|
3724
|
+
# @example Request syntax with placeholder values
|
|
3725
|
+
#
|
|
3726
|
+
# resp = client.untag_resource({
|
|
3727
|
+
# resource_arn: "Arn", # required
|
|
3728
|
+
# tag_keys: ["TagKey"], # required
|
|
3729
|
+
# })
|
|
3730
|
+
#
|
|
3731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UntagResource AWS API Documentation
|
|
3732
|
+
#
|
|
3733
|
+
# @overload untag_resource(params = {})
|
|
3734
|
+
# @param [Hash] params ({})
|
|
3735
|
+
def untag_resource(params = {}, options = {})
|
|
3736
|
+
req = build_request(:untag_resource, params)
|
|
3737
|
+
req.send_request(options)
|
|
3738
|
+
end
|
|
3739
|
+
|
|
3245
3740
|
# Updates a campaign by either deploying a new solution or changing the
|
|
3246
3741
|
# value of the campaign's `minProvisionedTPS` parameter.
|
|
3247
3742
|
#
|
|
3248
3743
|
# To update a campaign, the campaign status must be ACTIVE or CREATE
|
|
3249
|
-
# FAILED. Check the campaign status using the DescribeCampaign
|
|
3744
|
+
# FAILED. Check the campaign status using the [DescribeCampaign][1]
|
|
3745
|
+
# operation.
|
|
3250
3746
|
#
|
|
3251
|
-
# <note markdown="1"> You
|
|
3252
|
-
#
|
|
3747
|
+
# <note markdown="1"> You can still get recommendations from a campaign while an update is
|
|
3748
|
+
# in progress. The campaign will use the previous solution version and
|
|
3749
|
+
# campaign configuration to generate recommendations until the latest
|
|
3750
|
+
# campaign update status is `Active`.
|
|
3253
3751
|
#
|
|
3254
3752
|
# </note>
|
|
3255
3753
|
#
|
|
3256
|
-
# For more information on campaigns, see CreateCampaign.
|
|
3754
|
+
# For more information on campaigns, see [CreateCampaign][2].
|
|
3755
|
+
#
|
|
3756
|
+
#
|
|
3757
|
+
#
|
|
3758
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
|
|
3759
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
|
|
3257
3760
|
#
|
|
3258
3761
|
# @option params [required, String] :campaign_arn
|
|
3259
3762
|
# The Amazon Resource Name (ARN) of the campaign.
|
|
@@ -3348,7 +3851,7 @@ module Aws::Personalize
|
|
|
3348
3851
|
params: params,
|
|
3349
3852
|
config: config)
|
|
3350
3853
|
context[:gem_name] = 'aws-sdk-personalize'
|
|
3351
|
-
context[:gem_version] = '1.
|
|
3854
|
+
context[:gem_version] = '1.41.0'
|
|
3352
3855
|
Seahorse::Client::Request.new(handlers, context)
|
|
3353
3856
|
end
|
|
3354
3857
|
|