aws-sdk-personalize 1.22.0 → 1.23.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-personalize.rb +1 -1
- data/lib/aws-sdk-personalize/client.rb +193 -8
- data/lib/aws-sdk-personalize/client_api.rb +106 -0
- data/lib/aws-sdk-personalize/types.rb +333 -7
- metadata +5 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 21861151f0e79d08f061f15dad8a66437420dd0bf285c22b5ba20e2fdec125a7
|
4
|
+
data.tar.gz: 762f5ed0df85e77554b273a07d0f2dd7c00e9172a80e4bd640b585d224148298
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e39a706304565fb03c6a41def1616592282bf21d3a958bd042ae34a58c19489b41710c536a1c30b36df13f76fd71394e9f486c459d0e330ec5fe54a11a8fa36a
|
7
|
+
data.tar.gz: 7f411d1b37dd27f65c5de49ea6ae15cd51d332f8996927584a8a1ea3535983aaf01ac1c989d844b8a5bb1fb98153296f60f18c5287bab023b531c29ae52e4a4c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.23.0 (2021-04-26)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added support for exporting data imported into an Amazon Personalize dataset to a specified data source (Amazon S3 bucket).
|
8
|
+
|
4
9
|
1.22.0 (2021-03-10)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.23.0
|
data/lib/aws-sdk-personalize.rb
CHANGED
@@ -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
|
354
|
-
#
|
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
|
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,87 @@ 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 [Dataset export job
|
609
|
+
# permissions requirements][1] in the Amazon Personalize developer
|
610
|
+
# guide.
|
611
|
+
#
|
612
|
+
# **Status**
|
613
|
+
#
|
614
|
+
# A dataset export job can be in one of the following states:
|
615
|
+
#
|
616
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
617
|
+
# FAILED
|
618
|
+
#
|
619
|
+
# ^
|
620
|
+
#
|
621
|
+
# To get the status of the export job, call DescribeDatasetExportJob,
|
622
|
+
# and specify the Amazon Resource Name (ARN) of the dataset export job.
|
623
|
+
# The dataset export is complete when the status shows as ACTIVE. If the
|
624
|
+
# status shows as CREATE FAILED, the response includes a `failureReason`
|
625
|
+
# key, which describes why the job failed.
|
626
|
+
#
|
627
|
+
#
|
628
|
+
#
|
629
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/export-permissions.html
|
630
|
+
#
|
631
|
+
# @option params [required, String] :job_name
|
632
|
+
# The name for the dataset export job.
|
633
|
+
#
|
634
|
+
# @option params [required, String] :dataset_arn
|
635
|
+
# The Amazon Resource Name (ARN) of the dataset that contains the data
|
636
|
+
# to export.
|
637
|
+
#
|
638
|
+
# @option params [String] :ingestion_mode
|
639
|
+
# The data to export, based on how you imported the data. You can choose
|
640
|
+
# to export only `BULK` data that you imported using a dataset import
|
641
|
+
# job, only `PUT` data that you imported incrementally (using the
|
642
|
+
# console, PutEvents, PutUsers and PutItems operations), or `ALL` for
|
643
|
+
# both types. The default value is `PUT`.
|
644
|
+
#
|
645
|
+
# @option params [required, String] :role_arn
|
646
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
647
|
+
# Management service role that has permissions to add data to your
|
648
|
+
# output Amazon S3 bucket.
|
649
|
+
#
|
650
|
+
# @option params [required, Types::DatasetExportJobOutput] :job_output
|
651
|
+
# The path to the Amazon S3 bucket where the job's output is stored.
|
652
|
+
#
|
653
|
+
# @return [Types::CreateDatasetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
654
|
+
#
|
655
|
+
# * {Types::CreateDatasetExportJobResponse#dataset_export_job_arn #dataset_export_job_arn} => String
|
656
|
+
#
|
657
|
+
# @example Request syntax with placeholder values
|
658
|
+
#
|
659
|
+
# resp = client.create_dataset_export_job({
|
660
|
+
# job_name: "Name", # required
|
661
|
+
# dataset_arn: "Arn", # required
|
662
|
+
# ingestion_mode: "BULK", # accepts BULK, PUT, ALL
|
663
|
+
# role_arn: "RoleArn", # required
|
664
|
+
# job_output: { # required
|
665
|
+
# s3_data_destination: { # required
|
666
|
+
# path: "S3Location", # required
|
667
|
+
# kms_key_arn: "KmsKeyArn",
|
668
|
+
# },
|
669
|
+
# },
|
670
|
+
# })
|
671
|
+
#
|
672
|
+
# @example Response structure
|
673
|
+
#
|
674
|
+
# resp.dataset_export_job_arn #=> String
|
675
|
+
#
|
676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetExportJob AWS API Documentation
|
677
|
+
#
|
678
|
+
# @overload create_dataset_export_job(params = {})
|
679
|
+
# @param [Hash] params ({})
|
680
|
+
def create_dataset_export_job(params = {}, options = {})
|
681
|
+
req = build_request(:create_dataset_export_job, params)
|
682
|
+
req.send_request(options)
|
683
|
+
end
|
684
|
+
|
600
685
|
# Creates an empty dataset group. A dataset group contains related
|
601
686
|
# datasets that supply data for training a model. A dataset group can
|
602
687
|
# contain at most three datasets, one for each type of dataset:
|
@@ -687,9 +772,11 @@ module Aws::Personalize
|
|
687
772
|
# Creates a job that imports training data from your data source (an
|
688
773
|
# Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon
|
689
774
|
# Personalize to import the training data, you must specify an AWS
|
690
|
-
# Identity and Access Management (IAM) role that has permission
|
691
|
-
# from the data source, as Amazon Personalize makes a copy of
|
692
|
-
# and processes it in an internal AWS system.
|
775
|
+
# Identity and Access Management (IAM) service role that has permission
|
776
|
+
# to read from the data source, as Amazon Personalize makes a copy of
|
777
|
+
# your data and processes it in an internal AWS system. For information
|
778
|
+
# on granting access to your Amazon S3 bucket, see [Giving Amazon
|
779
|
+
# Personalize Access to Amazon S3 Resources][1].
|
693
780
|
#
|
694
781
|
# The dataset import job replaces any existing data in the dataset that
|
695
782
|
# you imported in bulk.
|
@@ -720,6 +807,10 @@ module Aws::Personalize
|
|
720
807
|
#
|
721
808
|
# * DescribeDatasetImportJob
|
722
809
|
#
|
810
|
+
#
|
811
|
+
#
|
812
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html
|
813
|
+
#
|
723
814
|
# @option params [required, String] :job_name
|
724
815
|
# The name for the dataset import job.
|
725
816
|
#
|
@@ -1549,6 +1640,45 @@ module Aws::Personalize
|
|
1549
1640
|
req.send_request(options)
|
1550
1641
|
end
|
1551
1642
|
|
1643
|
+
# Describes the dataset export job created by CreateDatasetExportJob,
|
1644
|
+
# including the export job status.
|
1645
|
+
#
|
1646
|
+
# @option params [required, String] :dataset_export_job_arn
|
1647
|
+
# The Amazon Resource Name (ARN) of the dataset export job to describe.
|
1648
|
+
#
|
1649
|
+
# @return [Types::DescribeDatasetExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1650
|
+
#
|
1651
|
+
# * {Types::DescribeDatasetExportJobResponse#dataset_export_job #dataset_export_job} => Types::DatasetExportJob
|
1652
|
+
#
|
1653
|
+
# @example Request syntax with placeholder values
|
1654
|
+
#
|
1655
|
+
# resp = client.describe_dataset_export_job({
|
1656
|
+
# dataset_export_job_arn: "Arn", # required
|
1657
|
+
# })
|
1658
|
+
#
|
1659
|
+
# @example Response structure
|
1660
|
+
#
|
1661
|
+
# resp.dataset_export_job.job_name #=> String
|
1662
|
+
# resp.dataset_export_job.dataset_export_job_arn #=> String
|
1663
|
+
# resp.dataset_export_job.dataset_arn #=> String
|
1664
|
+
# resp.dataset_export_job.ingestion_mode #=> String, one of "BULK", "PUT", "ALL"
|
1665
|
+
# resp.dataset_export_job.role_arn #=> String
|
1666
|
+
# resp.dataset_export_job.status #=> String
|
1667
|
+
# resp.dataset_export_job.job_output.s3_data_destination.path #=> String
|
1668
|
+
# resp.dataset_export_job.job_output.s3_data_destination.kms_key_arn #=> String
|
1669
|
+
# resp.dataset_export_job.creation_date_time #=> Time
|
1670
|
+
# resp.dataset_export_job.last_updated_date_time #=> Time
|
1671
|
+
# resp.dataset_export_job.failure_reason #=> String
|
1672
|
+
#
|
1673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetExportJob AWS API Documentation
|
1674
|
+
#
|
1675
|
+
# @overload describe_dataset_export_job(params = {})
|
1676
|
+
# @param [Hash] params ({})
|
1677
|
+
def describe_dataset_export_job(params = {}, options = {})
|
1678
|
+
req = build_request(:describe_dataset_export_job, params)
|
1679
|
+
req.send_request(options)
|
1680
|
+
end
|
1681
|
+
|
1552
1682
|
# Describes the given dataset group. For more information on dataset
|
1553
1683
|
# groups, see CreateDatasetGroup.
|
1554
1684
|
#
|
@@ -2089,6 +2219,59 @@ module Aws::Personalize
|
|
2089
2219
|
req.send_request(options)
|
2090
2220
|
end
|
2091
2221
|
|
2222
|
+
# Returns a list of dataset export jobs that use the given dataset. When
|
2223
|
+
# a dataset is not specified, all the dataset export jobs associated
|
2224
|
+
# with the account are listed. The response provides the properties for
|
2225
|
+
# each dataset export job, including the Amazon Resource Name (ARN). For
|
2226
|
+
# more information on dataset export jobs, see CreateDatasetExportJob.
|
2227
|
+
# For more information on datasets, see CreateDataset.
|
2228
|
+
#
|
2229
|
+
# @option params [String] :dataset_arn
|
2230
|
+
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
2231
|
+
# export jobs for.
|
2232
|
+
#
|
2233
|
+
# @option params [String] :next_token
|
2234
|
+
# A token returned from the previous call to `ListDatasetExportJobs` for
|
2235
|
+
# getting the next set of dataset export jobs (if they exist).
|
2236
|
+
#
|
2237
|
+
# @option params [Integer] :max_results
|
2238
|
+
# The maximum number of dataset export jobs to return.
|
2239
|
+
#
|
2240
|
+
# @return [Types::ListDatasetExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2241
|
+
#
|
2242
|
+
# * {Types::ListDatasetExportJobsResponse#dataset_export_jobs #dataset_export_jobs} => Array<Types::DatasetExportJobSummary>
|
2243
|
+
# * {Types::ListDatasetExportJobsResponse#next_token #next_token} => String
|
2244
|
+
#
|
2245
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2246
|
+
#
|
2247
|
+
# @example Request syntax with placeholder values
|
2248
|
+
#
|
2249
|
+
# resp = client.list_dataset_export_jobs({
|
2250
|
+
# dataset_arn: "Arn",
|
2251
|
+
# next_token: "NextToken",
|
2252
|
+
# max_results: 1,
|
2253
|
+
# })
|
2254
|
+
#
|
2255
|
+
# @example Response structure
|
2256
|
+
#
|
2257
|
+
# resp.dataset_export_jobs #=> Array
|
2258
|
+
# resp.dataset_export_jobs[0].dataset_export_job_arn #=> String
|
2259
|
+
# resp.dataset_export_jobs[0].job_name #=> String
|
2260
|
+
# resp.dataset_export_jobs[0].status #=> String
|
2261
|
+
# resp.dataset_export_jobs[0].creation_date_time #=> Time
|
2262
|
+
# resp.dataset_export_jobs[0].last_updated_date_time #=> Time
|
2263
|
+
# resp.dataset_export_jobs[0].failure_reason #=> String
|
2264
|
+
# resp.next_token #=> String
|
2265
|
+
#
|
2266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobs AWS API Documentation
|
2267
|
+
#
|
2268
|
+
# @overload list_dataset_export_jobs(params = {})
|
2269
|
+
# @param [Hash] params ({})
|
2270
|
+
def list_dataset_export_jobs(params = {}, options = {})
|
2271
|
+
req = build_request(:list_dataset_export_jobs, params)
|
2272
|
+
req.send_request(options)
|
2273
|
+
end
|
2274
|
+
|
2092
2275
|
# Returns a list of dataset groups. The response provides the properties
|
2093
2276
|
# for each dataset group, including the Amazon Resource Name (ARN). For
|
2094
2277
|
# more information on dataset groups, see CreateDatasetGroup.
|
@@ -2304,6 +2487,8 @@ module Aws::Personalize
|
|
2304
2487
|
# * {Types::ListFiltersResponse#filters #filters} => Array<Types::FilterSummary>
|
2305
2488
|
# * {Types::ListFiltersResponse#next_token #next_token} => String
|
2306
2489
|
#
|
2490
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2491
|
+
#
|
2307
2492
|
# @example Request syntax with placeholder values
|
2308
2493
|
#
|
2309
2494
|
# resp = client.list_filters({
|
@@ -2593,7 +2778,7 @@ module Aws::Personalize
|
|
2593
2778
|
params: params,
|
2594
2779
|
config: config)
|
2595
2780
|
context[:gem_name] = 'aws-sdk-personalize'
|
2596
|
-
context[:gem_version] = '1.
|
2781
|
+
context[:gem_version] = '1.23.0'
|
2597
2782
|
Seahorse::Client::Request.new(handlers, context)
|
2598
2783
|
end
|
2599
2784
|
|
@@ -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,6 +148,7 @@ 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')
|
@@ -152,6 +161,8 @@ module Aws::Personalize
|
|
152
161
|
ListBatchInferenceJobsResponse = Shapes::StructureShape.new(name: 'ListBatchInferenceJobsResponse')
|
153
162
|
ListCampaignsRequest = Shapes::StructureShape.new(name: 'ListCampaignsRequest')
|
154
163
|
ListCampaignsResponse = Shapes::StructureShape.new(name: 'ListCampaignsResponse')
|
164
|
+
ListDatasetExportJobsRequest = Shapes::StructureShape.new(name: 'ListDatasetExportJobsRequest')
|
165
|
+
ListDatasetExportJobsResponse = Shapes::StructureShape.new(name: 'ListDatasetExportJobsResponse')
|
155
166
|
ListDatasetGroupsRequest = Shapes::StructureShape.new(name: 'ListDatasetGroupsRequest')
|
156
167
|
ListDatasetGroupsResponse = Shapes::StructureShape.new(name: 'ListDatasetGroupsResponse')
|
157
168
|
ListDatasetImportJobsRequest = Shapes::StructureShape.new(name: 'ListDatasetImportJobsRequest')
|
@@ -344,6 +355,16 @@ module Aws::Personalize
|
|
344
355
|
CreateCampaignResponse.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
|
345
356
|
CreateCampaignResponse.struct_class = Types::CreateCampaignResponse
|
346
357
|
|
358
|
+
CreateDatasetExportJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
|
359
|
+
CreateDatasetExportJobRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetArn"))
|
360
|
+
CreateDatasetExportJobRequest.add_member(:ingestion_mode, Shapes::ShapeRef.new(shape: IngestionMode, location_name: "ingestionMode"))
|
361
|
+
CreateDatasetExportJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
|
362
|
+
CreateDatasetExportJobRequest.add_member(:job_output, Shapes::ShapeRef.new(shape: DatasetExportJobOutput, required: true, location_name: "jobOutput"))
|
363
|
+
CreateDatasetExportJobRequest.struct_class = Types::CreateDatasetExportJobRequest
|
364
|
+
|
365
|
+
CreateDatasetExportJobResponse.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetExportJobArn"))
|
366
|
+
CreateDatasetExportJobResponse.struct_class = Types::CreateDatasetExportJobResponse
|
367
|
+
|
347
368
|
CreateDatasetGroupRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
|
348
369
|
CreateDatasetGroupRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
|
349
370
|
CreateDatasetGroupRequest.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn"))
|
@@ -425,6 +446,31 @@ module Aws::Personalize
|
|
425
446
|
Dataset.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
|
426
447
|
Dataset.struct_class = Types::Dataset
|
427
448
|
|
449
|
+
DatasetExportJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
|
450
|
+
DatasetExportJob.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetExportJobArn"))
|
451
|
+
DatasetExportJob.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetArn"))
|
452
|
+
DatasetExportJob.add_member(:ingestion_mode, Shapes::ShapeRef.new(shape: IngestionMode, location_name: "ingestionMode"))
|
453
|
+
DatasetExportJob.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "roleArn"))
|
454
|
+
DatasetExportJob.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
|
455
|
+
DatasetExportJob.add_member(:job_output, Shapes::ShapeRef.new(shape: DatasetExportJobOutput, location_name: "jobOutput"))
|
456
|
+
DatasetExportJob.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
|
457
|
+
DatasetExportJob.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
|
458
|
+
DatasetExportJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
|
459
|
+
DatasetExportJob.struct_class = Types::DatasetExportJob
|
460
|
+
|
461
|
+
DatasetExportJobOutput.add_member(:s3_data_destination, Shapes::ShapeRef.new(shape: S3DataConfig, required: true, location_name: "s3DataDestination"))
|
462
|
+
DatasetExportJobOutput.struct_class = Types::DatasetExportJobOutput
|
463
|
+
|
464
|
+
DatasetExportJobSummary.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetExportJobArn"))
|
465
|
+
DatasetExportJobSummary.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
|
466
|
+
DatasetExportJobSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
|
467
|
+
DatasetExportJobSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
|
468
|
+
DatasetExportJobSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
|
469
|
+
DatasetExportJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
|
470
|
+
DatasetExportJobSummary.struct_class = Types::DatasetExportJobSummary
|
471
|
+
|
472
|
+
DatasetExportJobs.member = Shapes::ShapeRef.new(shape: DatasetExportJobSummary)
|
473
|
+
|
428
474
|
DatasetGroup.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
|
429
475
|
DatasetGroup.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
|
430
476
|
DatasetGroup.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
|
@@ -556,6 +602,12 @@ module Aws::Personalize
|
|
556
602
|
DescribeCampaignResponse.add_member(:campaign, Shapes::ShapeRef.new(shape: Campaign, location_name: "campaign"))
|
557
603
|
DescribeCampaignResponse.struct_class = Types::DescribeCampaignResponse
|
558
604
|
|
605
|
+
DescribeDatasetExportJobRequest.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetExportJobArn"))
|
606
|
+
DescribeDatasetExportJobRequest.struct_class = Types::DescribeDatasetExportJobRequest
|
607
|
+
|
608
|
+
DescribeDatasetExportJobResponse.add_member(:dataset_export_job, Shapes::ShapeRef.new(shape: DatasetExportJob, location_name: "datasetExportJob"))
|
609
|
+
DescribeDatasetExportJobResponse.struct_class = Types::DescribeDatasetExportJobResponse
|
610
|
+
|
559
611
|
DescribeDatasetGroupRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetGroupArn"))
|
560
612
|
DescribeDatasetGroupRequest.struct_class = Types::DescribeDatasetGroupRequest
|
561
613
|
|
@@ -733,6 +785,15 @@ module Aws::Personalize
|
|
733
785
|
ListCampaignsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
734
786
|
ListCampaignsResponse.struct_class = Types::ListCampaignsResponse
|
735
787
|
|
788
|
+
ListDatasetExportJobsRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetArn"))
|
789
|
+
ListDatasetExportJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
790
|
+
ListDatasetExportJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
|
791
|
+
ListDatasetExportJobsRequest.struct_class = Types::ListDatasetExportJobsRequest
|
792
|
+
|
793
|
+
ListDatasetExportJobsResponse.add_member(:dataset_export_jobs, Shapes::ShapeRef.new(shape: DatasetExportJobs, location_name: "datasetExportJobs"))
|
794
|
+
ListDatasetExportJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
795
|
+
ListDatasetExportJobsResponse.struct_class = Types::ListDatasetExportJobsResponse
|
796
|
+
|
736
797
|
ListDatasetGroupsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
737
798
|
ListDatasetGroupsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
|
738
799
|
ListDatasetGroupsRequest.struct_class = Types::ListDatasetGroupsRequest
|
@@ -980,6 +1041,19 @@ module Aws::Personalize
|
|
980
1041
|
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
981
1042
|
end)
|
982
1043
|
|
1044
|
+
api.add_operation(:create_dataset_export_job, Seahorse::Model::Operation.new.tap do |o|
|
1045
|
+
o.name = "CreateDatasetExportJob"
|
1046
|
+
o.http_method = "POST"
|
1047
|
+
o.http_request_uri = "/"
|
1048
|
+
o.input = Shapes::ShapeRef.new(shape: CreateDatasetExportJobRequest)
|
1049
|
+
o.output = Shapes::ShapeRef.new(shape: CreateDatasetExportJobResponse)
|
1050
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1051
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1052
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
|
1053
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1054
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
1055
|
+
end)
|
1056
|
+
|
983
1057
|
api.add_operation(:create_dataset_group, Seahorse::Model::Operation.new.tap do |o|
|
984
1058
|
o.name = "CreateDatasetGroup"
|
985
1059
|
o.http_method = "POST"
|
@@ -1182,6 +1256,16 @@ module Aws::Personalize
|
|
1182
1256
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1183
1257
|
end)
|
1184
1258
|
|
1259
|
+
api.add_operation(:describe_dataset_export_job, Seahorse::Model::Operation.new.tap do |o|
|
1260
|
+
o.name = "DescribeDatasetExportJob"
|
1261
|
+
o.http_method = "POST"
|
1262
|
+
o.http_request_uri = "/"
|
1263
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeDatasetExportJobRequest)
|
1264
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeDatasetExportJobResponse)
|
1265
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1266
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1267
|
+
end)
|
1268
|
+
|
1185
1269
|
api.add_operation(:describe_dataset_group, Seahorse::Model::Operation.new.tap do |o|
|
1186
1270
|
o.name = "DescribeDatasetGroup"
|
1187
1271
|
o.http_method = "POST"
|
@@ -1315,6 +1399,22 @@ module Aws::Personalize
|
|
1315
1399
|
)
|
1316
1400
|
end)
|
1317
1401
|
|
1402
|
+
api.add_operation(:list_dataset_export_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1403
|
+
o.name = "ListDatasetExportJobs"
|
1404
|
+
o.http_method = "POST"
|
1405
|
+
o.http_request_uri = "/"
|
1406
|
+
o.input = Shapes::ShapeRef.new(shape: ListDatasetExportJobsRequest)
|
1407
|
+
o.output = Shapes::ShapeRef.new(shape: ListDatasetExportJobsResponse)
|
1408
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1409
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
|
1410
|
+
o[:pager] = Aws::Pager.new(
|
1411
|
+
limit_key: "max_results",
|
1412
|
+
tokens: {
|
1413
|
+
"next_token" => "next_token"
|
1414
|
+
}
|
1415
|
+
)
|
1416
|
+
end)
|
1417
|
+
|
1318
1418
|
api.add_operation(:list_dataset_groups, Seahorse::Model::Operation.new.tap do |o|
|
1319
1419
|
o.name = "ListDatasetGroups"
|
1320
1420
|
o.http_method = "POST"
|
@@ -1386,6 +1486,12 @@ module Aws::Personalize
|
|
1386
1486
|
o.output = Shapes::ShapeRef.new(shape: ListFiltersResponse)
|
1387
1487
|
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1388
1488
|
o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
|
1489
|
+
o[:pager] = Aws::Pager.new(
|
1490
|
+
limit_key: "max_results",
|
1491
|
+
tokens: {
|
1492
|
+
"next_token" => "next_token"
|
1493
|
+
}
|
1494
|
+
)
|
1389
1495
|
end)
|
1390
1496
|
|
1391
1497
|
api.add_operation(:list_recipes, Seahorse::Model::Operation.new.tap do |o|
|
@@ -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
|
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
|
669
|
-
#
|
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
|
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
|
#
|
@@ -1268,7 +1343,7 @@ module Aws::Personalize
|
|
1268
1343
|
# The path to the Amazon S3 bucket where the data that you want to
|
1269
1344
|
# upload to your dataset is stored. For example:
|
1270
1345
|
#
|
1271
|
-
# `s3://bucket-name/
|
1346
|
+
# `s3://bucket-name/folder-name/`
|
1272
1347
|
# @return [String]
|
1273
1348
|
#
|
1274
1349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DataSource AWS API Documentation
|
@@ -1342,6 +1417,163 @@ module Aws::Personalize
|
|
1342
1417
|
include Aws::Structure
|
1343
1418
|
end
|
1344
1419
|
|
1420
|
+
# Describes a job that exports a dataset to an Amazon S3 bucket. For
|
1421
|
+
# more information, see CreateDatasetExportJob.
|
1422
|
+
#
|
1423
|
+
# A dataset export job can be in one of the following states:
|
1424
|
+
#
|
1425
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
1426
|
+
# FAILED
|
1427
|
+
#
|
1428
|
+
# ^
|
1429
|
+
#
|
1430
|
+
# @!attribute [rw] job_name
|
1431
|
+
# The name of the export job.
|
1432
|
+
# @return [String]
|
1433
|
+
#
|
1434
|
+
# @!attribute [rw] dataset_export_job_arn
|
1435
|
+
# The Amazon Resource Name (ARN) of the dataset export job.
|
1436
|
+
# @return [String]
|
1437
|
+
#
|
1438
|
+
# @!attribute [rw] dataset_arn
|
1439
|
+
# The Amazon Resource Name (ARN) of the dataset to export.
|
1440
|
+
# @return [String]
|
1441
|
+
#
|
1442
|
+
# @!attribute [rw] ingestion_mode
|
1443
|
+
# The data to export, based on how you imported the data. You can
|
1444
|
+
# choose to export `BULK` data that you imported using a dataset
|
1445
|
+
# import job, `PUT` data that you imported incrementally (using the
|
1446
|
+
# console, PutEvents, PutUsers and PutItems operations), or `ALL` for
|
1447
|
+
# both types. The default value is `PUT`.
|
1448
|
+
# @return [String]
|
1449
|
+
#
|
1450
|
+
# @!attribute [rw] role_arn
|
1451
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1452
|
+
# Management service role that has permissions to add data to your
|
1453
|
+
# output Amazon S3 bucket.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] status
|
1457
|
+
# The status of the dataset export job.
|
1458
|
+
#
|
1459
|
+
# A dataset export job can be in one of the following states:
|
1460
|
+
#
|
1461
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
1462
|
+
# FAILED
|
1463
|
+
#
|
1464
|
+
# ^
|
1465
|
+
# @return [String]
|
1466
|
+
#
|
1467
|
+
# @!attribute [rw] job_output
|
1468
|
+
# The path to the Amazon S3 bucket where the job's output is stored.
|
1469
|
+
# For example:
|
1470
|
+
#
|
1471
|
+
# `s3://bucket-name/folder-name/`
|
1472
|
+
# @return [Types::DatasetExportJobOutput]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] creation_date_time
|
1475
|
+
# The creation date and time (in Unix time) of the dataset export job.
|
1476
|
+
# @return [Time]
|
1477
|
+
#
|
1478
|
+
# @!attribute [rw] last_updated_date_time
|
1479
|
+
# The date and time (in Unix time) the status of the dataset export
|
1480
|
+
# job was last updated.
|
1481
|
+
# @return [Time]
|
1482
|
+
#
|
1483
|
+
# @!attribute [rw] failure_reason
|
1484
|
+
# If a dataset export job fails, provides the reason why.
|
1485
|
+
# @return [String]
|
1486
|
+
#
|
1487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetExportJob AWS API Documentation
|
1488
|
+
#
|
1489
|
+
class DatasetExportJob < Struct.new(
|
1490
|
+
:job_name,
|
1491
|
+
:dataset_export_job_arn,
|
1492
|
+
:dataset_arn,
|
1493
|
+
:ingestion_mode,
|
1494
|
+
:role_arn,
|
1495
|
+
:status,
|
1496
|
+
:job_output,
|
1497
|
+
:creation_date_time,
|
1498
|
+
:last_updated_date_time,
|
1499
|
+
:failure_reason)
|
1500
|
+
SENSITIVE = []
|
1501
|
+
include Aws::Structure
|
1502
|
+
end
|
1503
|
+
|
1504
|
+
# The output configuration parameters of a dataset export job.
|
1505
|
+
#
|
1506
|
+
# @note When making an API call, you may pass DatasetExportJobOutput
|
1507
|
+
# data as a hash:
|
1508
|
+
#
|
1509
|
+
# {
|
1510
|
+
# s3_data_destination: { # required
|
1511
|
+
# path: "S3Location", # required
|
1512
|
+
# kms_key_arn: "KmsKeyArn",
|
1513
|
+
# },
|
1514
|
+
# }
|
1515
|
+
#
|
1516
|
+
# @!attribute [rw] s3_data_destination
|
1517
|
+
# The configuration details of an Amazon S3 input or output bucket.
|
1518
|
+
# @return [Types::S3DataConfig]
|
1519
|
+
#
|
1520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetExportJobOutput AWS API Documentation
|
1521
|
+
#
|
1522
|
+
class DatasetExportJobOutput < Struct.new(
|
1523
|
+
:s3_data_destination)
|
1524
|
+
SENSITIVE = []
|
1525
|
+
include Aws::Structure
|
1526
|
+
end
|
1527
|
+
|
1528
|
+
# Provides a summary of the properties of a dataset export job. For a
|
1529
|
+
# complete listing, call the DescribeDatasetExportJob API.
|
1530
|
+
#
|
1531
|
+
# @!attribute [rw] dataset_export_job_arn
|
1532
|
+
# The Amazon Resource Name (ARN) of the dataset export job.
|
1533
|
+
# @return [String]
|
1534
|
+
#
|
1535
|
+
# @!attribute [rw] job_name
|
1536
|
+
# The name of the dataset export job.
|
1537
|
+
# @return [String]
|
1538
|
+
#
|
1539
|
+
# @!attribute [rw] status
|
1540
|
+
# The status of the dataset export job.
|
1541
|
+
#
|
1542
|
+
# A dataset export job can be in one of the following states:
|
1543
|
+
#
|
1544
|
+
# * CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE -or- CREATE
|
1545
|
+
# FAILED
|
1546
|
+
#
|
1547
|
+
# ^
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] creation_date_time
|
1551
|
+
# The date and time (in Unix time) that the dataset export job was
|
1552
|
+
# created.
|
1553
|
+
# @return [Time]
|
1554
|
+
#
|
1555
|
+
# @!attribute [rw] last_updated_date_time
|
1556
|
+
# The date and time (in Unix time) that the dataset export job status
|
1557
|
+
# was last updated.
|
1558
|
+
# @return [Time]
|
1559
|
+
#
|
1560
|
+
# @!attribute [rw] failure_reason
|
1561
|
+
# If a dataset export job fails, the reason behind the failure.
|
1562
|
+
# @return [String]
|
1563
|
+
#
|
1564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetExportJobSummary AWS API Documentation
|
1565
|
+
#
|
1566
|
+
class DatasetExportJobSummary < Struct.new(
|
1567
|
+
:dataset_export_job_arn,
|
1568
|
+
:job_name,
|
1569
|
+
:status,
|
1570
|
+
:creation_date_time,
|
1571
|
+
:last_updated_date_time,
|
1572
|
+
:failure_reason)
|
1573
|
+
SENSITIVE = []
|
1574
|
+
include Aws::Structure
|
1575
|
+
end
|
1576
|
+
|
1345
1577
|
# A dataset group is a collection of related datasets (Interactions,
|
1346
1578
|
# User, and Item). You create a dataset group by calling
|
1347
1579
|
# CreateDatasetGroup. You then create a dataset and add it to a dataset
|
@@ -1556,7 +1788,8 @@ module Aws::Personalize
|
|
1556
1788
|
# @return [Time]
|
1557
1789
|
#
|
1558
1790
|
# @!attribute [rw] last_updated_date_time
|
1559
|
-
# The date and time (in Unix time) that the dataset
|
1791
|
+
# The date and time (in Unix time) that the dataset import job status
|
1792
|
+
# was last updated.
|
1560
1793
|
# @return [Time]
|
1561
1794
|
#
|
1562
1795
|
# @!attribute [rw] failure_reason
|
@@ -2037,6 +2270,48 @@ module Aws::Personalize
|
|
2037
2270
|
include Aws::Structure
|
2038
2271
|
end
|
2039
2272
|
|
2273
|
+
# @note When making an API call, you may pass DescribeDatasetExportJobRequest
|
2274
|
+
# data as a hash:
|
2275
|
+
#
|
2276
|
+
# {
|
2277
|
+
# dataset_export_job_arn: "Arn", # required
|
2278
|
+
# }
|
2279
|
+
#
|
2280
|
+
# @!attribute [rw] dataset_export_job_arn
|
2281
|
+
# The Amazon Resource Name (ARN) of the dataset export job to
|
2282
|
+
# describe.
|
2283
|
+
# @return [String]
|
2284
|
+
#
|
2285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetExportJobRequest AWS API Documentation
|
2286
|
+
#
|
2287
|
+
class DescribeDatasetExportJobRequest < Struct.new(
|
2288
|
+
:dataset_export_job_arn)
|
2289
|
+
SENSITIVE = []
|
2290
|
+
include Aws::Structure
|
2291
|
+
end
|
2292
|
+
|
2293
|
+
# @!attribute [rw] dataset_export_job
|
2294
|
+
# Information about the dataset export job, including the status.
|
2295
|
+
#
|
2296
|
+
# The status is one of the following values:
|
2297
|
+
#
|
2298
|
+
# * CREATE PENDING
|
2299
|
+
#
|
2300
|
+
# * CREATE IN\_PROGRESS
|
2301
|
+
#
|
2302
|
+
# * ACTIVE
|
2303
|
+
#
|
2304
|
+
# * CREATE FAILED
|
2305
|
+
# @return [Types::DatasetExportJob]
|
2306
|
+
#
|
2307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetExportJobResponse AWS API Documentation
|
2308
|
+
#
|
2309
|
+
class DescribeDatasetExportJobResponse < Struct.new(
|
2310
|
+
:dataset_export_job)
|
2311
|
+
SENSITIVE = []
|
2312
|
+
include Aws::Structure
|
2313
|
+
end
|
2314
|
+
|
2040
2315
|
# @note When making an API call, you may pass DescribeDatasetGroupRequest
|
2041
2316
|
# data as a hash:
|
2042
2317
|
#
|
@@ -2947,7 +3222,7 @@ module Aws::Personalize
|
|
2947
3222
|
# @return [Array<Types::BatchInferenceJobSummary>]
|
2948
3223
|
#
|
2949
3224
|
# @!attribute [rw] next_token
|
2950
|
-
# The token to use to
|
3225
|
+
# The token to use to retrieve the next page of results. The value is
|
2951
3226
|
# `null` when there are no more results to return.
|
2952
3227
|
# @return [String]
|
2953
3228
|
#
|
@@ -3011,6 +3286,57 @@ module Aws::Personalize
|
|
3011
3286
|
include Aws::Structure
|
3012
3287
|
end
|
3013
3288
|
|
3289
|
+
# @note When making an API call, you may pass ListDatasetExportJobsRequest
|
3290
|
+
# data as a hash:
|
3291
|
+
#
|
3292
|
+
# {
|
3293
|
+
# dataset_arn: "Arn",
|
3294
|
+
# next_token: "NextToken",
|
3295
|
+
# max_results: 1,
|
3296
|
+
# }
|
3297
|
+
#
|
3298
|
+
# @!attribute [rw] dataset_arn
|
3299
|
+
# The Amazon Resource Name (ARN) of the dataset to list the dataset
|
3300
|
+
# export jobs for.
|
3301
|
+
# @return [String]
|
3302
|
+
#
|
3303
|
+
# @!attribute [rw] next_token
|
3304
|
+
# A token returned from the previous call to `ListDatasetExportJobs`
|
3305
|
+
# for getting the next set of dataset export jobs (if they exist).
|
3306
|
+
# @return [String]
|
3307
|
+
#
|
3308
|
+
# @!attribute [rw] max_results
|
3309
|
+
# The maximum number of dataset export jobs to return.
|
3310
|
+
# @return [Integer]
|
3311
|
+
#
|
3312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobsRequest AWS API Documentation
|
3313
|
+
#
|
3314
|
+
class ListDatasetExportJobsRequest < Struct.new(
|
3315
|
+
:dataset_arn,
|
3316
|
+
:next_token,
|
3317
|
+
:max_results)
|
3318
|
+
SENSITIVE = []
|
3319
|
+
include Aws::Structure
|
3320
|
+
end
|
3321
|
+
|
3322
|
+
# @!attribute [rw] dataset_export_jobs
|
3323
|
+
# The list of dataset export jobs.
|
3324
|
+
# @return [Array<Types::DatasetExportJobSummary>]
|
3325
|
+
#
|
3326
|
+
# @!attribute [rw] next_token
|
3327
|
+
# A token for getting the next set of dataset export jobs (if they
|
3328
|
+
# exist).
|
3329
|
+
# @return [String]
|
3330
|
+
#
|
3331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobsResponse AWS API Documentation
|
3332
|
+
#
|
3333
|
+
class ListDatasetExportJobsResponse < Struct.new(
|
3334
|
+
:dataset_export_jobs,
|
3335
|
+
:next_token)
|
3336
|
+
SENSITIVE = []
|
3337
|
+
include Aws::Structure
|
3338
|
+
end
|
3339
|
+
|
3014
3340
|
# @note When making an API call, you may pass ListDatasetGroupsRequest
|
3015
3341
|
# data as a hash:
|
3016
3342
|
#
|
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.
|
4
|
+
version: 1.23.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-
|
11
|
+
date: 2021-04-26 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/
|
70
|
-
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
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
|
-
|
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
|