aws-sdk-personalize 1.22.0 → 1.27.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 57ca84f91ae09dcd33f95e24bc2bfaa4009361097dc0c55b18144433660b91e4
4
- data.tar.gz: 348c41901d08afccb8f9efbbc776b1c465639432fcc2582b25be3287ec4d8dd3
3
+ metadata.gz: 1b9bf1983c2caf05d03bf27910e127dbf08ef2c57729bd945f1342ef9fc91e46
4
+ data.tar.gz: e667272e15bbbd36286c6bc4170979d107eb8d9f8c11369afa88893468fa260c
5
5
  SHA512:
6
- metadata.gz: b5804afc266f9b92fe0b6830753a27dddb2b3765e2ef9a5bb5d5a0bd4963c5a15699fed8cb675b6e3ef7adca4750c6787d32e7451ac1c8a0681cfb41d46bd701
7
- data.tar.gz: 2eea08fb47af054c148aa86743583545dddd71937b44894babd870e36608d6c77b467cb6195eb0463141cee5e74d1575f4f14c5ee7e2f73ed089fea386ff6b72
6
+ metadata.gz: 9b3aaa180e5deb69bbdc185bbfc0fa55d01aeb671fa1b6c7ff1dee1d44503f005036807584839fdc7d00597c5686ce1d0a82827f0d0687b76f732fd808505993
7
+ data.tar.gz: e77af966cbc01a03dc68781edb8a6c0f80c49140e7b2ee38ad88c97505c125b2439a78dc03384618641a7f73ef565d63e0b8238e5897a0cdb65cddcbbb7eaf35
data/CHANGELOG.md CHANGED
@@ -1,6 +1,31 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.27.0 (2021-06-07)
5
+ ------------------
6
+
7
+ * Feature - Update regex validation in kmsKeyArn and s3 path API parameters for AWS Personalize APIs
8
+
9
+ 1.26.0 (2021-05-20)
10
+ ------------------
11
+
12
+ * Feature - Added new API to stop a solution version creation that is pending or in progress for Amazon Personalize
13
+
14
+ 1.25.0 (2021-05-18)
15
+ ------------------
16
+
17
+ * Feature - Amazon Personalize now supports the ability to optimize a solution for a custom objective in addition to maximizing relevance.
18
+
19
+ 1.24.0 (2021-04-30)
20
+ ------------------
21
+
22
+ * Feature - Update URL for dataset export job documentation.
23
+
24
+ 1.23.0 (2021-04-26)
25
+ ------------------
26
+
27
+ * Feature - Added support for exporting data imported into an Amazon Personalize dataset to a specified data source (Amazon S3 bucket).
28
+
4
29
  1.22.0 (2021-03-10)
5
30
  ------------------
6
31
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.22.0
1
+ 1.27.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-personalize/customizations'
48
48
  # @!group service
49
49
  module Aws::Personalize
50
50
 
51
- GEM_VERSION = '1.22.0'
51
+ GEM_VERSION = '1.27.0'
52
52
 
53
53
  end
@@ -350,8 +350,12 @@ module Aws::Personalize
350
350
  #
351
351
  # @option params [String] :filter_arn
352
352
  # The ARN of the filter to apply to the batch inference job. For more
353
- # information on using filters, see Using Filters with Amazon
354
- # Personalize.
353
+ # information on using filters, see [Filtering Batch
354
+ # Recommendations][1]..
355
+ #
356
+ #
357
+ #
358
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
355
359
  #
356
360
  # @option params [Integer] :num_results
357
361
  # The number of recommendations to retreive.
@@ -366,8 +370,8 @@ module Aws::Personalize
366
370
  #
367
371
  # @option params [required, String] :role_arn
368
372
  # The ARN of the Amazon Identity and Access Management role that has
369
- # permissions to read and write to your input and out Amazon S3 buckets
370
- # respectively.
373
+ # permissions to read and write to your input and output Amazon S3
374
+ # buckets respectively.
371
375
  #
372
376
  # @option params [Types::BatchInferenceJobConfig] :batch_inference_job_config
373
377
  # The configuration details of a batch inference job.
@@ -597,6 +601,86 @@ module Aws::Personalize
597
601
  req.send_request(options)
598
602
  end
599
603
 
604
+ # Creates a job that exports data from your dataset to an Amazon S3
605
+ # bucket. To allow Amazon Personalize to export the training data, you
606
+ # must specify an service-linked AWS Identity and Access Management
607
+ # (IAM) role that gives Amazon Personalize `PutObject` permissions for
608
+ # your Amazon S3 bucket. For information, see [Exporting a dataset][1]
609
+ # in the Amazon Personalize developer guide.
610
+ #
611
+ # **Status**
612
+ #
613
+ # A dataset export job can be in one of the following states:
614
+ #
615
+ # * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
616
+ # FAILED
617
+ #
618
+ # ^
619
+ #
620
+ # To get the status of the export job, call DescribeDatasetExportJob,
621
+ # and specify the Amazon Resource Name (ARN) of the dataset export job.
622
+ # The dataset export is complete when the status shows as ACTIVE. If the
623
+ # status shows as CREATE FAILED, the response includes a `failureReason`
624
+ # key, which describes why the job failed.
625
+ #
626
+ #
627
+ #
628
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/export-data.html
629
+ #
630
+ # @option params [required, String] :job_name
631
+ # The name for the dataset export job.
632
+ #
633
+ # @option params [required, String] :dataset_arn
634
+ # The Amazon Resource Name (ARN) of the dataset that contains the data
635
+ # to export.
636
+ #
637
+ # @option params [String] :ingestion_mode
638
+ # The data to export, based on how you imported the data. You can choose
639
+ # to export only `BULK` data that you imported using a dataset import
640
+ # job, only `PUT` data that you imported incrementally (using the
641
+ # console, PutEvents, PutUsers and PutItems operations), or `ALL` for
642
+ # both types. The default value is `PUT`.
643
+ #
644
+ # @option params [required, String] :role_arn
645
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
646
+ # Management service role that has permissions to add data to your
647
+ # output Amazon S3 bucket.
648
+ #
649
+ # @option params [required, Types::DatasetExportJobOutput] :job_output
650
+ # The path to the Amazon S3 bucket where the job's output is stored.
651
+ #
652
+ # @return [Types::CreateDatasetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
653
+ #
654
+ # * {Types::CreateDatasetExportJobResponse#dataset_export_job_arn #dataset_export_job_arn} => String
655
+ #
656
+ # @example Request syntax with placeholder values
657
+ #
658
+ # resp = client.create_dataset_export_job({
659
+ # job_name: "Name", # required
660
+ # dataset_arn: "Arn", # required
661
+ # ingestion_mode: "BULK", # accepts BULK, PUT, ALL
662
+ # role_arn: "RoleArn", # required
663
+ # job_output: { # required
664
+ # s3_data_destination: { # required
665
+ # path: "S3Location", # required
666
+ # kms_key_arn: "KmsKeyArn",
667
+ # },
668
+ # },
669
+ # })
670
+ #
671
+ # @example Response structure
672
+ #
673
+ # resp.dataset_export_job_arn #=> String
674
+ #
675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetExportJob AWS API Documentation
676
+ #
677
+ # @overload create_dataset_export_job(params = {})
678
+ # @param [Hash] params ({})
679
+ def create_dataset_export_job(params = {}, options = {})
680
+ req = build_request(:create_dataset_export_job, params)
681
+ req.send_request(options)
682
+ end
683
+
600
684
  # Creates an empty dataset group. A dataset group contains related
601
685
  # datasets that supply data for training a model. A dataset group can
602
686
  # contain at most three datasets, one for each type of dataset:
@@ -687,9 +771,11 @@ module Aws::Personalize
687
771
  # Creates a job that imports training data from your data source (an
688
772
  # Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon
689
773
  # Personalize to import the training data, you must specify an AWS
690
- # Identity and Access Management (IAM) role that has permission to read
691
- # from the data source, as Amazon Personalize makes a copy of your data
692
- # and processes it in an internal AWS system.
774
+ # Identity and Access Management (IAM) service role that has permission
775
+ # to read from the data source, as Amazon Personalize makes a copy of
776
+ # your data and processes it in an internal AWS system. For information
777
+ # on granting access to your Amazon S3 bucket, see [Giving Amazon
778
+ # Personalize Access to Amazon S3 Resources][1].
693
779
  #
694
780
  # The dataset import job replaces any existing data in the dataset that
695
781
  # you imported in bulk.
@@ -720,6 +806,10 @@ module Aws::Personalize
720
806
  #
721
807
  # * DescribeDatasetImportJob
722
808
  #
809
+ #
810
+ #
811
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html
812
+ #
723
813
  # @option params [required, String] :job_name
724
814
  # The name for the dataset import job.
725
815
  #
@@ -1079,6 +1169,10 @@ module Aws::Personalize
1079
1169
  # metric_name: "MetricName",
1080
1170
  # recipe_list: ["Arn"],
1081
1171
  # },
1172
+ # optimization_objective: {
1173
+ # item_attribute: "ItemAttribute",
1174
+ # objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
1175
+ # },
1082
1176
  # },
1083
1177
  # })
1084
1178
  #
@@ -1104,10 +1198,17 @@ module Aws::Personalize
1104
1198
  #
1105
1199
  # A solution version can be in one of the following states:
1106
1200
  #
1107
- # * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
1108
- # FAILED
1201
+ # * CREATE PENDING
1109
1202
  #
1110
- # ^
1203
+ # * CREATE IN\_PROGRESS
1204
+ #
1205
+ # * ACTIVE
1206
+ #
1207
+ # * CREATE FAILED
1208
+ #
1209
+ # * CREATE STOPPING
1210
+ #
1211
+ # * CREATE STOPPED
1111
1212
  #
1112
1213
  # To get the status of the version, call DescribeSolutionVersion. Wait
1113
1214
  # until the status shows as ACTIVE before calling `CreateCampaign`.
@@ -1549,6 +1650,45 @@ module Aws::Personalize
1549
1650
  req.send_request(options)
1550
1651
  end
1551
1652
 
1653
+ # Describes the dataset export job created by CreateDatasetExportJob,
1654
+ # including the export job status.
1655
+ #
1656
+ # @option params [required, String] :dataset_export_job_arn
1657
+ # The Amazon Resource Name (ARN) of the dataset export job to describe.
1658
+ #
1659
+ # @return [Types::DescribeDatasetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1660
+ #
1661
+ # * {Types::DescribeDatasetExportJobResponse#dataset_export_job #dataset_export_job} => Types::DatasetExportJob
1662
+ #
1663
+ # @example Request syntax with placeholder values
1664
+ #
1665
+ # resp = client.describe_dataset_export_job({
1666
+ # dataset_export_job_arn: "Arn", # required
1667
+ # })
1668
+ #
1669
+ # @example Response structure
1670
+ #
1671
+ # resp.dataset_export_job.job_name #=> String
1672
+ # resp.dataset_export_job.dataset_export_job_arn #=> String
1673
+ # resp.dataset_export_job.dataset_arn #=> String
1674
+ # resp.dataset_export_job.ingestion_mode #=> String, one of "BULK", "PUT", "ALL"
1675
+ # resp.dataset_export_job.role_arn #=> String
1676
+ # resp.dataset_export_job.status #=> String
1677
+ # resp.dataset_export_job.job_output.s3_data_destination.path #=> String
1678
+ # resp.dataset_export_job.job_output.s3_data_destination.kms_key_arn #=> String
1679
+ # resp.dataset_export_job.creation_date_time #=> Time
1680
+ # resp.dataset_export_job.last_updated_date_time #=> Time
1681
+ # resp.dataset_export_job.failure_reason #=> String
1682
+ #
1683
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetExportJob AWS API Documentation
1684
+ #
1685
+ # @overload describe_dataset_export_job(params = {})
1686
+ # @param [Hash] params ({})
1687
+ def describe_dataset_export_job(params = {}, options = {})
1688
+ req = build_request(:describe_dataset_export_job, params)
1689
+ req.send_request(options)
1690
+ end
1691
+
1552
1692
  # Describes the given dataset group. For more information on dataset
1553
1693
  # groups, see CreateDatasetGroup.
1554
1694
  #
@@ -1867,6 +2007,8 @@ module Aws::Personalize
1867
2007
  # resp.solution.solution_config.auto_ml_config.metric_name #=> String
1868
2008
  # resp.solution.solution_config.auto_ml_config.recipe_list #=> Array
1869
2009
  # resp.solution.solution_config.auto_ml_config.recipe_list[0] #=> String
2010
+ # resp.solution.solution_config.optimization_objective.item_attribute #=> String
2011
+ # resp.solution.solution_config.optimization_objective.objective_sensitivity #=> String, one of "LOW", "MEDIUM", "HIGH", "OFF"
1870
2012
  # resp.solution.auto_ml_result.best_recipe_arn #=> String
1871
2013
  # resp.solution.status #=> String
1872
2014
  # resp.solution.creation_date_time #=> Time
@@ -1936,6 +2078,8 @@ module Aws::Personalize
1936
2078
  # resp.solution_version.solution_config.auto_ml_config.metric_name #=> String
1937
2079
  # resp.solution_version.solution_config.auto_ml_config.recipe_list #=> Array
1938
2080
  # resp.solution_version.solution_config.auto_ml_config.recipe_list[0] #=> String
2081
+ # resp.solution_version.solution_config.optimization_objective.item_attribute #=> String
2082
+ # resp.solution_version.solution_config.optimization_objective.objective_sensitivity #=> String, one of "LOW", "MEDIUM", "HIGH", "OFF"
1939
2083
  # resp.solution_version.training_hours #=> Float
1940
2084
  # resp.solution_version.training_mode #=> String, one of "FULL", "UPDATE"
1941
2085
  # resp.solution_version.tuned_hpo_params.algorithm_hyper_parameters #=> Hash
@@ -2089,6 +2233,59 @@ module Aws::Personalize
2089
2233
  req.send_request(options)
2090
2234
  end
2091
2235
 
2236
+ # Returns a list of dataset export jobs that use the given dataset. When
2237
+ # a dataset is not specified, all the dataset export jobs associated
2238
+ # with the account are listed. The response provides the properties for
2239
+ # each dataset export job, including the Amazon Resource Name (ARN). For
2240
+ # more information on dataset export jobs, see CreateDatasetExportJob.
2241
+ # For more information on datasets, see CreateDataset.
2242
+ #
2243
+ # @option params [String] :dataset_arn
2244
+ # The Amazon Resource Name (ARN) of the dataset to list the dataset
2245
+ # export jobs for.
2246
+ #
2247
+ # @option params [String] :next_token
2248
+ # A token returned from the previous call to `ListDatasetExportJobs` for
2249
+ # getting the next set of dataset export jobs (if they exist).
2250
+ #
2251
+ # @option params [Integer] :max_results
2252
+ # The maximum number of dataset export jobs to return.
2253
+ #
2254
+ # @return [Types::ListDatasetExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2255
+ #
2256
+ # * {Types::ListDatasetExportJobsResponse#dataset_export_jobs #dataset_export_jobs} => Array<Types::DatasetExportJobSummary>
2257
+ # * {Types::ListDatasetExportJobsResponse#next_token #next_token} => String
2258
+ #
2259
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2260
+ #
2261
+ # @example Request syntax with placeholder values
2262
+ #
2263
+ # resp = client.list_dataset_export_jobs({
2264
+ # dataset_arn: "Arn",
2265
+ # next_token: "NextToken",
2266
+ # max_results: 1,
2267
+ # })
2268
+ #
2269
+ # @example Response structure
2270
+ #
2271
+ # resp.dataset_export_jobs #=> Array
2272
+ # resp.dataset_export_jobs[0].dataset_export_job_arn #=> String
2273
+ # resp.dataset_export_jobs[0].job_name #=> String
2274
+ # resp.dataset_export_jobs[0].status #=> String
2275
+ # resp.dataset_export_jobs[0].creation_date_time #=> Time
2276
+ # resp.dataset_export_jobs[0].last_updated_date_time #=> Time
2277
+ # resp.dataset_export_jobs[0].failure_reason #=> String
2278
+ # resp.next_token #=> String
2279
+ #
2280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobs AWS API Documentation
2281
+ #
2282
+ # @overload list_dataset_export_jobs(params = {})
2283
+ # @param [Hash] params ({})
2284
+ def list_dataset_export_jobs(params = {}, options = {})
2285
+ req = build_request(:list_dataset_export_jobs, params)
2286
+ req.send_request(options)
2287
+ end
2288
+
2092
2289
  # Returns a list of dataset groups. The response provides the properties
2093
2290
  # for each dataset group, including the Amazon Resource Name (ARN). For
2094
2291
  # more information on dataset groups, see CreateDatasetGroup.
@@ -2304,6 +2501,8 @@ module Aws::Personalize
2304
2501
  # * {Types::ListFiltersResponse#filters #filters} => Array<Types::FilterSummary>
2305
2502
  # * {Types::ListFiltersResponse#next_token #next_token} => String
2306
2503
  #
2504
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2505
+ #
2307
2506
  # @example Request syntax with placeholder values
2308
2507
  #
2309
2508
  # resp = client.list_filters({
@@ -2524,6 +2723,43 @@ module Aws::Personalize
2524
2723
  req.send_request(options)
2525
2724
  end
2526
2725
 
2726
+ # Stops creating a solution version that is in a state of
2727
+ # CREATE\_PENDING or CREATE IN\_PROGRESS.
2728
+ #
2729
+ # Depending on the current state of the solution version, the solution
2730
+ # version state changes as follows:
2731
+ #
2732
+ # * CREATE\_PENDING > CREATE\_STOPPED
2733
+ #
2734
+ # or
2735
+ #
2736
+ # * CREATE\_IN\_PROGRESS > CREATE\_STOPPING > CREATE\_STOPPED
2737
+ #
2738
+ # You are billed for all of the training completed up until you stop the
2739
+ # solution version creation. You cannot resume creating a solution
2740
+ # version once it has been stopped.
2741
+ #
2742
+ # @option params [required, String] :solution_version_arn
2743
+ # The Amazon Resource Name (ARN) of the solution version you want to
2744
+ # stop creating.
2745
+ #
2746
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2747
+ #
2748
+ # @example Request syntax with placeholder values
2749
+ #
2750
+ # resp = client.stop_solution_version_creation({
2751
+ # solution_version_arn: "Arn", # required
2752
+ # })
2753
+ #
2754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StopSolutionVersionCreation AWS API Documentation
2755
+ #
2756
+ # @overload stop_solution_version_creation(params = {})
2757
+ # @param [Hash] params ({})
2758
+ def stop_solution_version_creation(params = {}, options = {})
2759
+ req = build_request(:stop_solution_version_creation, params)
2760
+ req.send_request(options)
2761
+ end
2762
+
2527
2763
  # Updates a campaign by either deploying a new solution or changing the
2528
2764
  # value of the campaign's `minProvisionedTPS` parameter.
2529
2765
  #
@@ -2593,7 +2829,7 @@ module Aws::Personalize
2593
2829
  params: params,
2594
2830
  config: config)
2595
2831
  context[:gem_name] = 'aws-sdk-personalize'
2596
- context[:gem_version] = '1.22.0'
2832
+ context[:gem_version] = '1.27.0'
2597
2833
  Seahorse::Client::Request.new(handlers, context)
2598
2834
  end
2599
2835
 
@@ -45,6 +45,8 @@ module Aws::Personalize
45
45
  CreateBatchInferenceJobResponse = Shapes::StructureShape.new(name: 'CreateBatchInferenceJobResponse')
46
46
  CreateCampaignRequest = Shapes::StructureShape.new(name: 'CreateCampaignRequest')
47
47
  CreateCampaignResponse = Shapes::StructureShape.new(name: 'CreateCampaignResponse')
48
+ CreateDatasetExportJobRequest = Shapes::StructureShape.new(name: 'CreateDatasetExportJobRequest')
49
+ CreateDatasetExportJobResponse = Shapes::StructureShape.new(name: 'CreateDatasetExportJobResponse')
48
50
  CreateDatasetGroupRequest = Shapes::StructureShape.new(name: 'CreateDatasetGroupRequest')
49
51
  CreateDatasetGroupResponse = Shapes::StructureShape.new(name: 'CreateDatasetGroupResponse')
50
52
  CreateDatasetImportJobRequest = Shapes::StructureShape.new(name: 'CreateDatasetImportJobRequest')
@@ -63,6 +65,10 @@ module Aws::Personalize
63
65
  CreateSolutionVersionResponse = Shapes::StructureShape.new(name: 'CreateSolutionVersionResponse')
64
66
  DataSource = Shapes::StructureShape.new(name: 'DataSource')
65
67
  Dataset = Shapes::StructureShape.new(name: 'Dataset')
68
+ DatasetExportJob = Shapes::StructureShape.new(name: 'DatasetExportJob')
69
+ DatasetExportJobOutput = Shapes::StructureShape.new(name: 'DatasetExportJobOutput')
70
+ DatasetExportJobSummary = Shapes::StructureShape.new(name: 'DatasetExportJobSummary')
71
+ DatasetExportJobs = Shapes::ListShape.new(name: 'DatasetExportJobs')
66
72
  DatasetGroup = Shapes::StructureShape.new(name: 'DatasetGroup')
67
73
  DatasetGroupSummary = Shapes::StructureShape.new(name: 'DatasetGroupSummary')
68
74
  DatasetGroups = Shapes::ListShape.new(name: 'DatasetGroups')
@@ -95,6 +101,8 @@ module Aws::Personalize
95
101
  DescribeBatchInferenceJobResponse = Shapes::StructureShape.new(name: 'DescribeBatchInferenceJobResponse')
96
102
  DescribeCampaignRequest = Shapes::StructureShape.new(name: 'DescribeCampaignRequest')
97
103
  DescribeCampaignResponse = Shapes::StructureShape.new(name: 'DescribeCampaignResponse')
104
+ DescribeDatasetExportJobRequest = Shapes::StructureShape.new(name: 'DescribeDatasetExportJobRequest')
105
+ DescribeDatasetExportJobResponse = Shapes::StructureShape.new(name: 'DescribeDatasetExportJobResponse')
98
106
  DescribeDatasetGroupRequest = Shapes::StructureShape.new(name: 'DescribeDatasetGroupRequest')
99
107
  DescribeDatasetGroupResponse = Shapes::StructureShape.new(name: 'DescribeDatasetGroupResponse')
100
108
  DescribeDatasetImportJobRequest = Shapes::StructureShape.new(name: 'DescribeDatasetImportJobRequest')
@@ -140,18 +148,22 @@ module Aws::Personalize
140
148
  HPOResourceConfig = Shapes::StructureShape.new(name: 'HPOResourceConfig')
141
149
  HyperParameterRanges = Shapes::StructureShape.new(name: 'HyperParameterRanges')
142
150
  HyperParameters = Shapes::MapShape.new(name: 'HyperParameters')
151
+ IngestionMode = Shapes::StringShape.new(name: 'IngestionMode')
143
152
  IntegerHyperParameterRange = Shapes::StructureShape.new(name: 'IntegerHyperParameterRange')
144
153
  IntegerHyperParameterRanges = Shapes::ListShape.new(name: 'IntegerHyperParameterRanges')
145
154
  IntegerMaxValue = Shapes::IntegerShape.new(name: 'IntegerMaxValue')
146
155
  IntegerMinValue = Shapes::IntegerShape.new(name: 'IntegerMinValue')
147
156
  InvalidInputException = Shapes::StructureShape.new(name: 'InvalidInputException')
148
157
  InvalidNextTokenException = Shapes::StructureShape.new(name: 'InvalidNextTokenException')
158
+ ItemAttribute = Shapes::StringShape.new(name: 'ItemAttribute')
149
159
  KmsKeyArn = Shapes::StringShape.new(name: 'KmsKeyArn')
150
160
  LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
151
161
  ListBatchInferenceJobsRequest = Shapes::StructureShape.new(name: 'ListBatchInferenceJobsRequest')
152
162
  ListBatchInferenceJobsResponse = Shapes::StructureShape.new(name: 'ListBatchInferenceJobsResponse')
153
163
  ListCampaignsRequest = Shapes::StructureShape.new(name: 'ListCampaignsRequest')
154
164
  ListCampaignsResponse = Shapes::StructureShape.new(name: 'ListCampaignsResponse')
165
+ ListDatasetExportJobsRequest = Shapes::StructureShape.new(name: 'ListDatasetExportJobsRequest')
166
+ ListDatasetExportJobsResponse = Shapes::StructureShape.new(name: 'ListDatasetExportJobsResponse')
155
167
  ListDatasetGroupsRequest = Shapes::StructureShape.new(name: 'ListDatasetGroupsRequest')
156
168
  ListDatasetGroupsResponse = Shapes::StructureShape.new(name: 'ListDatasetGroupsResponse')
157
169
  ListDatasetImportJobsRequest = Shapes::StructureShape.new(name: 'ListDatasetImportJobsRequest')
@@ -178,6 +190,8 @@ module Aws::Personalize
178
190
  Name = Shapes::StringShape.new(name: 'Name')
179
191
  NextToken = Shapes::StringShape.new(name: 'NextToken')
180
192
  NumBatchResults = Shapes::IntegerShape.new(name: 'NumBatchResults')
193
+ ObjectiveSensitivity = Shapes::StringShape.new(name: 'ObjectiveSensitivity')
194
+ OptimizationObjective = Shapes::StructureShape.new(name: 'OptimizationObjective')
181
195
  ParameterName = Shapes::StringShape.new(name: 'ParameterName')
182
196
  ParameterValue = Shapes::StringShape.new(name: 'ParameterValue')
183
197
  PerformAutoML = Shapes::BooleanShape.new(name: 'PerformAutoML')
@@ -203,6 +217,7 @@ module Aws::Personalize
203
217
  SolutionVersions = Shapes::ListShape.new(name: 'SolutionVersions')
204
218
  Solutions = Shapes::ListShape.new(name: 'Solutions')
205
219
  Status = Shapes::StringShape.new(name: 'Status')
220
+ StopSolutionVersionCreationRequest = Shapes::StructureShape.new(name: 'StopSolutionVersionCreationRequest')
206
221
  TrackingId = Shapes::StringShape.new(name: 'TrackingId')
207
222
  TrainingHours = Shapes::FloatShape.new(name: 'TrainingHours')
208
223
  TrainingInputMode = Shapes::StringShape.new(name: 'TrainingInputMode')
@@ -344,6 +359,16 @@ module Aws::Personalize
344
359
  CreateCampaignResponse.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
345
360
  CreateCampaignResponse.struct_class = Types::CreateCampaignResponse
346
361
 
362
+ CreateDatasetExportJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
363
+ CreateDatasetExportJobRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetArn"))
364
+ CreateDatasetExportJobRequest.add_member(:ingestion_mode, Shapes::ShapeRef.new(shape: IngestionMode, location_name: "ingestionMode"))
365
+ CreateDatasetExportJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
366
+ CreateDatasetExportJobRequest.add_member(:job_output, Shapes::ShapeRef.new(shape: DatasetExportJobOutput, required: true, location_name: "jobOutput"))
367
+ CreateDatasetExportJobRequest.struct_class = Types::CreateDatasetExportJobRequest
368
+
369
+ CreateDatasetExportJobResponse.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetExportJobArn"))
370
+ CreateDatasetExportJobResponse.struct_class = Types::CreateDatasetExportJobResponse
371
+
347
372
  CreateDatasetGroupRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
348
373
  CreateDatasetGroupRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
349
374
  CreateDatasetGroupRequest.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn"))
@@ -425,6 +450,31 @@ module Aws::Personalize
425
450
  Dataset.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
426
451
  Dataset.struct_class = Types::Dataset
427
452
 
453
+ DatasetExportJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
454
+ DatasetExportJob.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetExportJobArn"))
455
+ DatasetExportJob.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetArn"))
456
+ DatasetExportJob.add_member(:ingestion_mode, Shapes::ShapeRef.new(shape: IngestionMode, location_name: "ingestionMode"))
457
+ DatasetExportJob.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "roleArn"))
458
+ DatasetExportJob.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
459
+ DatasetExportJob.add_member(:job_output, Shapes::ShapeRef.new(shape: DatasetExportJobOutput, location_name: "jobOutput"))
460
+ DatasetExportJob.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
461
+ DatasetExportJob.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
462
+ DatasetExportJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
463
+ DatasetExportJob.struct_class = Types::DatasetExportJob
464
+
465
+ DatasetExportJobOutput.add_member(:s3_data_destination, Shapes::ShapeRef.new(shape: S3DataConfig, required: true, location_name: "s3DataDestination"))
466
+ DatasetExportJobOutput.struct_class = Types::DatasetExportJobOutput
467
+
468
+ DatasetExportJobSummary.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetExportJobArn"))
469
+ DatasetExportJobSummary.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
470
+ DatasetExportJobSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
471
+ DatasetExportJobSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
472
+ DatasetExportJobSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
473
+ DatasetExportJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
474
+ DatasetExportJobSummary.struct_class = Types::DatasetExportJobSummary
475
+
476
+ DatasetExportJobs.member = Shapes::ShapeRef.new(shape: DatasetExportJobSummary)
477
+
428
478
  DatasetGroup.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
429
479
  DatasetGroup.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
430
480
  DatasetGroup.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
@@ -556,6 +606,12 @@ module Aws::Personalize
556
606
  DescribeCampaignResponse.add_member(:campaign, Shapes::ShapeRef.new(shape: Campaign, location_name: "campaign"))
557
607
  DescribeCampaignResponse.struct_class = Types::DescribeCampaignResponse
558
608
 
609
+ DescribeDatasetExportJobRequest.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetExportJobArn"))
610
+ DescribeDatasetExportJobRequest.struct_class = Types::DescribeDatasetExportJobRequest
611
+
612
+ DescribeDatasetExportJobResponse.add_member(:dataset_export_job, Shapes::ShapeRef.new(shape: DatasetExportJob, location_name: "datasetExportJob"))
613
+ DescribeDatasetExportJobResponse.struct_class = Types::DescribeDatasetExportJobResponse
614
+
559
615
  DescribeDatasetGroupRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetGroupArn"))
560
616
  DescribeDatasetGroupRequest.struct_class = Types::DescribeDatasetGroupRequest
561
617
 
@@ -733,6 +789,15 @@ module Aws::Personalize
733
789
  ListCampaignsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
734
790
  ListCampaignsResponse.struct_class = Types::ListCampaignsResponse
735
791
 
792
+ ListDatasetExportJobsRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetArn"))
793
+ ListDatasetExportJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
794
+ ListDatasetExportJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
795
+ ListDatasetExportJobsRequest.struct_class = Types::ListDatasetExportJobsRequest
796
+
797
+ ListDatasetExportJobsResponse.add_member(:dataset_export_jobs, Shapes::ShapeRef.new(shape: DatasetExportJobs, location_name: "datasetExportJobs"))
798
+ ListDatasetExportJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
799
+ ListDatasetExportJobsResponse.struct_class = Types::ListDatasetExportJobsResponse
800
+
736
801
  ListDatasetGroupsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
737
802
  ListDatasetGroupsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
738
803
  ListDatasetGroupsRequest.struct_class = Types::ListDatasetGroupsRequest
@@ -815,6 +880,10 @@ module Aws::Personalize
815
880
  Metrics.key = Shapes::ShapeRef.new(shape: MetricName)
816
881
  Metrics.value = Shapes::ShapeRef.new(shape: MetricValue)
817
882
 
883
+ OptimizationObjective.add_member(:item_attribute, Shapes::ShapeRef.new(shape: ItemAttribute, location_name: "itemAttribute"))
884
+ OptimizationObjective.add_member(:objective_sensitivity, Shapes::ShapeRef.new(shape: ObjectiveSensitivity, location_name: "objectiveSensitivity"))
885
+ OptimizationObjective.struct_class = Types::OptimizationObjective
886
+
818
887
  Recipe.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
819
888
  Recipe.add_member(:recipe_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "recipeArn"))
820
889
  Recipe.add_member(:algorithm_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "algorithmArn"))
@@ -873,6 +942,7 @@ module Aws::Personalize
873
942
  SolutionConfig.add_member(:algorithm_hyper_parameters, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "algorithmHyperParameters"))
874
943
  SolutionConfig.add_member(:feature_transformation_parameters, Shapes::ShapeRef.new(shape: FeatureTransformationParameters, location_name: "featureTransformationParameters"))
875
944
  SolutionConfig.add_member(:auto_ml_config, Shapes::ShapeRef.new(shape: AutoMLConfig, location_name: "autoMLConfig"))
945
+ SolutionConfig.add_member(:optimization_objective, Shapes::ShapeRef.new(shape: OptimizationObjective, location_name: "optimizationObjective"))
876
946
  SolutionConfig.struct_class = Types::SolutionConfig
877
947
 
878
948
  SolutionSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -910,6 +980,9 @@ module Aws::Personalize
910
980
 
911
981
  Solutions.member = Shapes::ShapeRef.new(shape: SolutionSummary)
912
982
 
983
+ StopSolutionVersionCreationRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
984
+ StopSolutionVersionCreationRequest.struct_class = Types::StopSolutionVersionCreationRequest
985
+
913
986
  TunedHPOParams.add_member(:algorithm_hyper_parameters, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "algorithmHyperParameters"))
914
987
  TunedHPOParams.struct_class = Types::TunedHPOParams
915
988
 
@@ -980,6 +1053,19 @@ module Aws::Personalize
980
1053
  o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
981
1054
  end)
982
1055
 
1056
+ api.add_operation(:create_dataset_export_job, Seahorse::Model::Operation.new.tap do |o|
1057
+ o.name = "CreateDatasetExportJob"
1058
+ o.http_method = "POST"
1059
+ o.http_request_uri = "/"
1060
+ o.input = Shapes::ShapeRef.new(shape: CreateDatasetExportJobRequest)
1061
+ o.output = Shapes::ShapeRef.new(shape: CreateDatasetExportJobResponse)
1062
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1063
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1064
+ o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
1065
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
1066
+ o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
1067
+ end)
1068
+
983
1069
  api.add_operation(:create_dataset_group, Seahorse::Model::Operation.new.tap do |o|
984
1070
  o.name = "CreateDatasetGroup"
985
1071
  o.http_method = "POST"
@@ -1182,6 +1268,16 @@ module Aws::Personalize
1182
1268
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1183
1269
  end)
1184
1270
 
1271
+ api.add_operation(:describe_dataset_export_job, Seahorse::Model::Operation.new.tap do |o|
1272
+ o.name = "DescribeDatasetExportJob"
1273
+ o.http_method = "POST"
1274
+ o.http_request_uri = "/"
1275
+ o.input = Shapes::ShapeRef.new(shape: DescribeDatasetExportJobRequest)
1276
+ o.output = Shapes::ShapeRef.new(shape: DescribeDatasetExportJobResponse)
1277
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1278
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1279
+ end)
1280
+
1185
1281
  api.add_operation(:describe_dataset_group, Seahorse::Model::Operation.new.tap do |o|
1186
1282
  o.name = "DescribeDatasetGroup"
1187
1283
  o.http_method = "POST"
@@ -1315,6 +1411,22 @@ module Aws::Personalize
1315
1411
  )
1316
1412
  end)
1317
1413
 
1414
+ api.add_operation(:list_dataset_export_jobs, Seahorse::Model::Operation.new.tap do |o|
1415
+ o.name = "ListDatasetExportJobs"
1416
+ o.http_method = "POST"
1417
+ o.http_request_uri = "/"
1418
+ o.input = Shapes::ShapeRef.new(shape: ListDatasetExportJobsRequest)
1419
+ o.output = Shapes::ShapeRef.new(shape: ListDatasetExportJobsResponse)
1420
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1421
+ o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
1422
+ o[:pager] = Aws::Pager.new(
1423
+ limit_key: "max_results",
1424
+ tokens: {
1425
+ "next_token" => "next_token"
1426
+ }
1427
+ )
1428
+ end)
1429
+
1318
1430
  api.add_operation(:list_dataset_groups, Seahorse::Model::Operation.new.tap do |o|
1319
1431
  o.name = "ListDatasetGroups"
1320
1432
  o.http_method = "POST"
@@ -1386,6 +1498,12 @@ module Aws::Personalize
1386
1498
  o.output = Shapes::ShapeRef.new(shape: ListFiltersResponse)
1387
1499
  o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1388
1500
  o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
1501
+ o[:pager] = Aws::Pager.new(
1502
+ limit_key: "max_results",
1503
+ tokens: {
1504
+ "next_token" => "next_token"
1505
+ }
1506
+ )
1389
1507
  end)
1390
1508
 
1391
1509
  api.add_operation(:list_recipes, Seahorse::Model::Operation.new.tap do |o|
@@ -1451,6 +1569,17 @@ module Aws::Personalize
1451
1569
  )
1452
1570
  end)
1453
1571
 
1572
+ api.add_operation(:stop_solution_version_creation, Seahorse::Model::Operation.new.tap do |o|
1573
+ o.name = "StopSolutionVersionCreation"
1574
+ o.http_method = "POST"
1575
+ o.http_request_uri = "/"
1576
+ o.input = Shapes::ShapeRef.new(shape: StopSolutionVersionCreationRequest)
1577
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
1578
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1579
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1580
+ o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
1581
+ end)
1582
+
1454
1583
  api.add_operation(:update_campaign, Seahorse::Model::Operation.new.tap do |o|
1455
1584
  o.name = "UpdateCampaign"
1456
1585
  o.http_method = "POST"
@@ -244,7 +244,11 @@ module Aws::Personalize
244
244
  # hyperparameters, including `explorationWeight` and
245
245
  # `explorationItemAgeCutOff`, you want to use to configure the amount
246
246
  # of item exploration Amazon Personalize uses when recommending items.
247
- # See native-recipe-new-item-USER\_PERSONALIZATION.
247
+ # See [User-Personalization][1].
248
+ #
249
+ #
250
+ #
251
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
248
252
  # @return [Hash<String,String>]
249
253
  #
250
254
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobConfig AWS API Documentation
@@ -665,8 +669,12 @@ module Aws::Personalize
665
669
  #
666
670
  # @!attribute [rw] filter_arn
667
671
  # The ARN of the filter to apply to the batch inference job. For more
668
- # information on using filters, see Using Filters with Amazon
669
- # Personalize.
672
+ # information on using filters, see [Filtering Batch
673
+ # Recommendations][1]..
674
+ #
675
+ #
676
+ #
677
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
670
678
  # @return [String]
671
679
  #
672
680
  # @!attribute [rw] num_results
@@ -685,7 +693,7 @@ module Aws::Personalize
685
693
  #
686
694
  # @!attribute [rw] role_arn
687
695
  # The ARN of the Amazon Identity and Access Management role that has
688
- # permissions to read and write to your input and out Amazon S3
696
+ # permissions to read and write to your input and output Amazon S3
689
697
  # buckets respectively.
690
698
  # @return [String]
691
699
  #
@@ -775,6 +783,73 @@ module Aws::Personalize
775
783
  include Aws::Structure
776
784
  end
777
785
 
786
+ # @note When making an API call, you may pass CreateDatasetExportJobRequest
787
+ # data as a hash:
788
+ #
789
+ # {
790
+ # job_name: "Name", # required
791
+ # dataset_arn: "Arn", # required
792
+ # ingestion_mode: "BULK", # accepts BULK, PUT, ALL
793
+ # role_arn: "RoleArn", # required
794
+ # job_output: { # required
795
+ # s3_data_destination: { # required
796
+ # path: "S3Location", # required
797
+ # kms_key_arn: "KmsKeyArn",
798
+ # },
799
+ # },
800
+ # }
801
+ #
802
+ # @!attribute [rw] job_name
803
+ # The name for the dataset export job.
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] dataset_arn
807
+ # The Amazon Resource Name (ARN) of the dataset that contains the data
808
+ # to export.
809
+ # @return [String]
810
+ #
811
+ # @!attribute [rw] ingestion_mode
812
+ # The data to export, based on how you imported the data. You can
813
+ # choose to export only `BULK` data that you imported using a dataset
814
+ # import job, only `PUT` data that you imported incrementally (using
815
+ # the console, PutEvents, PutUsers and PutItems operations), or `ALL`
816
+ # for both types. The default value is `PUT`.
817
+ # @return [String]
818
+ #
819
+ # @!attribute [rw] role_arn
820
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
821
+ # Management service role that has permissions to add data to your
822
+ # output Amazon S3 bucket.
823
+ # @return [String]
824
+ #
825
+ # @!attribute [rw] job_output
826
+ # The path to the Amazon S3 bucket where the job's output is stored.
827
+ # @return [Types::DatasetExportJobOutput]
828
+ #
829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetExportJobRequest AWS API Documentation
830
+ #
831
+ class CreateDatasetExportJobRequest < Struct.new(
832
+ :job_name,
833
+ :dataset_arn,
834
+ :ingestion_mode,
835
+ :role_arn,
836
+ :job_output)
837
+ SENSITIVE = []
838
+ include Aws::Structure
839
+ end
840
+
841
+ # @!attribute [rw] dataset_export_job_arn
842
+ # The Amazon Resource Name (ARN) of the dataset export job.
843
+ # @return [String]
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetExportJobResponse AWS API Documentation
846
+ #
847
+ class CreateDatasetExportJobResponse < Struct.new(
848
+ :dataset_export_job_arn)
849
+ SENSITIVE = []
850
+ include Aws::Structure
851
+ end
852
+
778
853
  # @note When making an API call, you may pass CreateDatasetGroupRequest
779
854
  # data as a hash:
780
855
  #
@@ -1117,6 +1192,10 @@ module Aws::Personalize
1117
1192
  # metric_name: "MetricName",
1118
1193
  # recipe_list: ["Arn"],
1119
1194
  # },
1195
+ # optimization_objective: {
1196
+ # item_attribute: "ItemAttribute",
1197
+ # objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
1198
+ # },
1120
1199
  # },
1121
1200
  # }
1122
1201
  #
@@ -1268,7 +1347,7 @@ module Aws::Personalize
1268
1347
  # The path to the Amazon S3 bucket where the data that you want to
1269
1348
  # upload to your dataset is stored. For example:
1270
1349
  #
1271
- # `s3://bucket-name/training-data.csv`
1350
+ # `s3://bucket-name/folder-name/`
1272
1351
  # @return [String]
1273
1352
  #
1274
1353
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DataSource AWS API Documentation
@@ -1342,6 +1421,163 @@ module Aws::Personalize
1342
1421
  include Aws::Structure
1343
1422
  end
1344
1423
 
1424
+ # Describes a job that exports a dataset to an Amazon S3 bucket. For
1425
+ # more information, see CreateDatasetExportJob.
1426
+ #
1427
+ # A dataset export job can be in one of the following states:
1428
+ #
1429
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1430
+ # FAILED
1431
+ #
1432
+ # ^
1433
+ #
1434
+ # @!attribute [rw] job_name
1435
+ # The name of the export job.
1436
+ # @return [String]
1437
+ #
1438
+ # @!attribute [rw] dataset_export_job_arn
1439
+ # The Amazon Resource Name (ARN) of the dataset export job.
1440
+ # @return [String]
1441
+ #
1442
+ # @!attribute [rw] dataset_arn
1443
+ # The Amazon Resource Name (ARN) of the dataset to export.
1444
+ # @return [String]
1445
+ #
1446
+ # @!attribute [rw] ingestion_mode
1447
+ # The data to export, based on how you imported the data. You can
1448
+ # choose to export `BULK` data that you imported using a dataset
1449
+ # import job, `PUT` data that you imported incrementally (using the
1450
+ # console, PutEvents, PutUsers and PutItems operations), or `ALL` for
1451
+ # both types. The default value is `PUT`.
1452
+ # @return [String]
1453
+ #
1454
+ # @!attribute [rw] role_arn
1455
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1456
+ # Management service role that has permissions to add data to your
1457
+ # output Amazon S3 bucket.
1458
+ # @return [String]
1459
+ #
1460
+ # @!attribute [rw] status
1461
+ # The status of the dataset export job.
1462
+ #
1463
+ # A dataset export job can be in one of the following states:
1464
+ #
1465
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1466
+ # FAILED
1467
+ #
1468
+ # ^
1469
+ # @return [String]
1470
+ #
1471
+ # @!attribute [rw] job_output
1472
+ # The path to the Amazon S3 bucket where the job's output is stored.
1473
+ # For example:
1474
+ #
1475
+ # `s3://bucket-name/folder-name/`
1476
+ # @return [Types::DatasetExportJobOutput]
1477
+ #
1478
+ # @!attribute [rw] creation_date_time
1479
+ # The creation date and time (in Unix time) of the dataset export job.
1480
+ # @return [Time]
1481
+ #
1482
+ # @!attribute [rw] last_updated_date_time
1483
+ # The date and time (in Unix time) the status of the dataset export
1484
+ # job was last updated.
1485
+ # @return [Time]
1486
+ #
1487
+ # @!attribute [rw] failure_reason
1488
+ # If a dataset export job fails, provides the reason why.
1489
+ # @return [String]
1490
+ #
1491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetExportJob AWS API Documentation
1492
+ #
1493
+ class DatasetExportJob < Struct.new(
1494
+ :job_name,
1495
+ :dataset_export_job_arn,
1496
+ :dataset_arn,
1497
+ :ingestion_mode,
1498
+ :role_arn,
1499
+ :status,
1500
+ :job_output,
1501
+ :creation_date_time,
1502
+ :last_updated_date_time,
1503
+ :failure_reason)
1504
+ SENSITIVE = []
1505
+ include Aws::Structure
1506
+ end
1507
+
1508
+ # The output configuration parameters of a dataset export job.
1509
+ #
1510
+ # @note When making an API call, you may pass DatasetExportJobOutput
1511
+ # data as a hash:
1512
+ #
1513
+ # {
1514
+ # s3_data_destination: { # required
1515
+ # path: "S3Location", # required
1516
+ # kms_key_arn: "KmsKeyArn",
1517
+ # },
1518
+ # }
1519
+ #
1520
+ # @!attribute [rw] s3_data_destination
1521
+ # The configuration details of an Amazon S3 input or output bucket.
1522
+ # @return [Types::S3DataConfig]
1523
+ #
1524
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetExportJobOutput AWS API Documentation
1525
+ #
1526
+ class DatasetExportJobOutput < Struct.new(
1527
+ :s3_data_destination)
1528
+ SENSITIVE = []
1529
+ include Aws::Structure
1530
+ end
1531
+
1532
+ # Provides a summary of the properties of a dataset export job. For a
1533
+ # complete listing, call the DescribeDatasetExportJob API.
1534
+ #
1535
+ # @!attribute [rw] dataset_export_job_arn
1536
+ # The Amazon Resource Name (ARN) of the dataset export job.
1537
+ # @return [String]
1538
+ #
1539
+ # @!attribute [rw] job_name
1540
+ # The name of the dataset export job.
1541
+ # @return [String]
1542
+ #
1543
+ # @!attribute [rw] status
1544
+ # The status of the dataset export job.
1545
+ #
1546
+ # A dataset export job can be in one of the following states:
1547
+ #
1548
+ # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
1549
+ # FAILED
1550
+ #
1551
+ # ^
1552
+ # @return [String]
1553
+ #
1554
+ # @!attribute [rw] creation_date_time
1555
+ # The date and time (in Unix time) that the dataset export job was
1556
+ # created.
1557
+ # @return [Time]
1558
+ #
1559
+ # @!attribute [rw] last_updated_date_time
1560
+ # The date and time (in Unix time) that the dataset export job status
1561
+ # was last updated.
1562
+ # @return [Time]
1563
+ #
1564
+ # @!attribute [rw] failure_reason
1565
+ # If a dataset export job fails, the reason behind the failure.
1566
+ # @return [String]
1567
+ #
1568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetExportJobSummary AWS API Documentation
1569
+ #
1570
+ class DatasetExportJobSummary < Struct.new(
1571
+ :dataset_export_job_arn,
1572
+ :job_name,
1573
+ :status,
1574
+ :creation_date_time,
1575
+ :last_updated_date_time,
1576
+ :failure_reason)
1577
+ SENSITIVE = []
1578
+ include Aws::Structure
1579
+ end
1580
+
1345
1581
  # A dataset group is a collection of related datasets (Interactions,
1346
1582
  # User, and Item). You create a dataset group by calling
1347
1583
  # CreateDatasetGroup. You then create a dataset and add it to a dataset
@@ -1556,7 +1792,8 @@ module Aws::Personalize
1556
1792
  # @return [Time]
1557
1793
  #
1558
1794
  # @!attribute [rw] last_updated_date_time
1559
- # The date and time (in Unix time) that the dataset was last updated.
1795
+ # The date and time (in Unix time) that the dataset import job status
1796
+ # was last updated.
1560
1797
  # @return [Time]
1561
1798
  #
1562
1799
  # @!attribute [rw] failure_reason
@@ -2037,6 +2274,48 @@ module Aws::Personalize
2037
2274
  include Aws::Structure
2038
2275
  end
2039
2276
 
2277
+ # @note When making an API call, you may pass DescribeDatasetExportJobRequest
2278
+ # data as a hash:
2279
+ #
2280
+ # {
2281
+ # dataset_export_job_arn: "Arn", # required
2282
+ # }
2283
+ #
2284
+ # @!attribute [rw] dataset_export_job_arn
2285
+ # The Amazon Resource Name (ARN) of the dataset export job to
2286
+ # describe.
2287
+ # @return [String]
2288
+ #
2289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetExportJobRequest AWS API Documentation
2290
+ #
2291
+ class DescribeDatasetExportJobRequest < Struct.new(
2292
+ :dataset_export_job_arn)
2293
+ SENSITIVE = []
2294
+ include Aws::Structure
2295
+ end
2296
+
2297
+ # @!attribute [rw] dataset_export_job
2298
+ # Information about the dataset export job, including the status.
2299
+ #
2300
+ # The status is one of the following values:
2301
+ #
2302
+ # * CREATE PENDING
2303
+ #
2304
+ # * CREATE IN\_PROGRESS
2305
+ #
2306
+ # * ACTIVE
2307
+ #
2308
+ # * CREATE FAILED
2309
+ # @return [Types::DatasetExportJob]
2310
+ #
2311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetExportJobResponse AWS API Documentation
2312
+ #
2313
+ class DescribeDatasetExportJobResponse < Struct.new(
2314
+ :dataset_export_job)
2315
+ SENSITIVE = []
2316
+ include Aws::Structure
2317
+ end
2318
+
2040
2319
  # @note When making an API call, you may pass DescribeDatasetGroupRequest
2041
2320
  # data as a hash:
2042
2321
  #
@@ -2947,7 +3226,7 @@ module Aws::Personalize
2947
3226
  # @return [Array<Types::BatchInferenceJobSummary>]
2948
3227
  #
2949
3228
  # @!attribute [rw] next_token
2950
- # The token to use to retreive the next page of results. The value is
3229
+ # The token to use to retrieve the next page of results. The value is
2951
3230
  # `null` when there are no more results to return.
2952
3231
  # @return [String]
2953
3232
  #
@@ -3011,6 +3290,57 @@ module Aws::Personalize
3011
3290
  include Aws::Structure
3012
3291
  end
3013
3292
 
3293
+ # @note When making an API call, you may pass ListDatasetExportJobsRequest
3294
+ # data as a hash:
3295
+ #
3296
+ # {
3297
+ # dataset_arn: "Arn",
3298
+ # next_token: "NextToken",
3299
+ # max_results: 1,
3300
+ # }
3301
+ #
3302
+ # @!attribute [rw] dataset_arn
3303
+ # The Amazon Resource Name (ARN) of the dataset to list the dataset
3304
+ # export jobs for.
3305
+ # @return [String]
3306
+ #
3307
+ # @!attribute [rw] next_token
3308
+ # A token returned from the previous call to `ListDatasetExportJobs`
3309
+ # for getting the next set of dataset export jobs (if they exist).
3310
+ # @return [String]
3311
+ #
3312
+ # @!attribute [rw] max_results
3313
+ # The maximum number of dataset export jobs to return.
3314
+ # @return [Integer]
3315
+ #
3316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobsRequest AWS API Documentation
3317
+ #
3318
+ class ListDatasetExportJobsRequest < Struct.new(
3319
+ :dataset_arn,
3320
+ :next_token,
3321
+ :max_results)
3322
+ SENSITIVE = []
3323
+ include Aws::Structure
3324
+ end
3325
+
3326
+ # @!attribute [rw] dataset_export_jobs
3327
+ # The list of dataset export jobs.
3328
+ # @return [Array<Types::DatasetExportJobSummary>]
3329
+ #
3330
+ # @!attribute [rw] next_token
3331
+ # A token for getting the next set of dataset export jobs (if they
3332
+ # exist).
3333
+ # @return [String]
3334
+ #
3335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobsResponse AWS API Documentation
3336
+ #
3337
+ class ListDatasetExportJobsResponse < Struct.new(
3338
+ :dataset_export_jobs,
3339
+ :next_token)
3340
+ SENSITIVE = []
3341
+ include Aws::Structure
3342
+ end
3343
+
3014
3344
  # @note When making an API call, you may pass ListDatasetGroupsRequest
3015
3345
  # data as a hash:
3016
3346
  #
@@ -3445,6 +3775,42 @@ module Aws::Personalize
3445
3775
  include Aws::Structure
3446
3776
  end
3447
3777
 
3778
+ # Describes the additional objective for the solution, such as
3779
+ # maximizing streaming minutes or increasing revenue. For more
3780
+ # information see [Optimizing a solution][1].
3781
+ #
3782
+ #
3783
+ #
3784
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html
3785
+ #
3786
+ # @note When making an API call, you may pass OptimizationObjective
3787
+ # data as a hash:
3788
+ #
3789
+ # {
3790
+ # item_attribute: "ItemAttribute",
3791
+ # objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
3792
+ # }
3793
+ #
3794
+ # @!attribute [rw] item_attribute
3795
+ # The numerical metadata column in an Items dataset related to the
3796
+ # optimization objective. For example, VIDEO\_LENGTH (to maximize
3797
+ # streaming minutes), or PRICE (to maximize revenue).
3798
+ # @return [String]
3799
+ #
3800
+ # @!attribute [rw] objective_sensitivity
3801
+ # Specifies how Amazon Personalize balances the importance of your
3802
+ # optimization objective versus relevance.
3803
+ # @return [String]
3804
+ #
3805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/OptimizationObjective AWS API Documentation
3806
+ #
3807
+ class OptimizationObjective < Struct.new(
3808
+ :item_attribute,
3809
+ :objective_sensitivity)
3810
+ SENSITIVE = []
3811
+ include Aws::Structure
3812
+ end
3813
+
3448
3814
  # Provides information about a recipe. Each recipe provides an algorithm
3449
3815
  # that Amazon Personalize uses in model training when you use the
3450
3816
  # CreateSolution operation.
@@ -3752,6 +4118,10 @@ module Aws::Personalize
3752
4118
  # metric_name: "MetricName",
3753
4119
  # recipe_list: ["Arn"],
3754
4120
  # },
4121
+ # optimization_objective: {
4122
+ # item_attribute: "ItemAttribute",
4123
+ # objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
4124
+ # },
3755
4125
  # }
3756
4126
  #
3757
4127
  # @!attribute [rw] event_value_threshold
@@ -3776,6 +4146,16 @@ module Aws::Personalize
3776
4146
  # AutoML is performed.
3777
4147
  # @return [Types::AutoMLConfig]
3778
4148
  #
4149
+ # @!attribute [rw] optimization_objective
4150
+ # Describes the additional objective for the solution, such as
4151
+ # maximizing streaming minutes or increasing revenue. For more
4152
+ # information see [Optimizing a solution][1].
4153
+ #
4154
+ #
4155
+ #
4156
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html
4157
+ # @return [Types::OptimizationObjective]
4158
+ #
3779
4159
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionConfig AWS API Documentation
3780
4160
  #
3781
4161
  class SolutionConfig < Struct.new(
@@ -3783,7 +4163,8 @@ module Aws::Personalize
3783
4163
  :hpo_config,
3784
4164
  :algorithm_hyper_parameters,
3785
4165
  :feature_transformation_parameters,
3786
- :auto_ml_config)
4166
+ :auto_ml_config,
4167
+ :optimization_objective)
3787
4168
  SENSITIVE = []
3788
4169
  include Aws::Structure
3789
4170
  end
@@ -3913,6 +4294,10 @@ module Aws::Personalize
3913
4294
  # * ACTIVE
3914
4295
  #
3915
4296
  # * CREATE FAILED
4297
+ #
4298
+ # * CREATE STOPPING
4299
+ #
4300
+ # * CREATE STOPPED
3916
4301
  # @return [String]
3917
4302
  #
3918
4303
  # @!attribute [rw] failure_reason
@@ -3994,6 +4379,26 @@ module Aws::Personalize
3994
4379
  include Aws::Structure
3995
4380
  end
3996
4381
 
4382
+ # @note When making an API call, you may pass StopSolutionVersionCreationRequest
4383
+ # data as a hash:
4384
+ #
4385
+ # {
4386
+ # solution_version_arn: "Arn", # required
4387
+ # }
4388
+ #
4389
+ # @!attribute [rw] solution_version_arn
4390
+ # The Amazon Resource Name (ARN) of the solution version you want to
4391
+ # stop creating.
4392
+ # @return [String]
4393
+ #
4394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StopSolutionVersionCreationRequest AWS API Documentation
4395
+ #
4396
+ class StopSolutionVersionCreationRequest < Struct.new(
4397
+ :solution_version_arn)
4398
+ SENSITIVE = []
4399
+ include Aws::Structure
4400
+ end
4401
+
3997
4402
  # If hyperparameter optimization (HPO) was performed, contains the
3998
4403
  # hyperparameter values of the best performing model.
3999
4404
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-personalize
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.22.0
4
+ version: 1.27.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-10 00:00:00.000000000 Z
11
+ date: 2021-06-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -66,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
66
66
  licenses:
67
67
  - Apache-2.0
68
68
  metadata:
69
- source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-personalize
70
- changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-personalize/CHANGELOG.md
69
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-personalize
70
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-personalize/CHANGELOG.md
71
71
  post_install_message:
72
72
  rdoc_options: []
73
73
  require_paths:
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
83
83
  - !ruby/object:Gem::Version
84
84
  version: '0'
85
85
  requirements: []
86
- rubyforge_project:
87
- rubygems_version: 2.7.6.2
86
+ rubygems_version: 3.1.6
88
87
  signing_key:
89
88
  specification_version: 4
90
89
  summary: AWS SDK for Ruby - Amazon Personalize