aws-sdk-forecastservice 1.7.0 → 1.8.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/lib/aws-sdk-forecastservice.rb +1 -1
- data/lib/aws-sdk-forecastservice/client.rb +381 -14
- data/lib/aws-sdk-forecastservice/client_api.rb +74 -0
- data/lib/aws-sdk-forecastservice/types.rb +560 -32
- metadata +2 -2
@@ -109,6 +109,8 @@ module Aws::ForecastService
|
|
109
109
|
ListForecastsResponse = Shapes::StructureShape.new(name: 'ListForecastsResponse')
|
110
110
|
ListPredictorsRequest = Shapes::StructureShape.new(name: 'ListPredictorsRequest')
|
111
111
|
ListPredictorsResponse = Shapes::StructureShape.new(name: 'ListPredictorsResponse')
|
112
|
+
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
113
|
+
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
112
114
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
113
115
|
Message = Shapes::StringShape.new(name: 'Message')
|
114
116
|
Metrics = Shapes::StructureShape.new(name: 'Metrics')
|
@@ -137,12 +139,21 @@ module Aws::ForecastService
|
|
137
139
|
String = Shapes::StringShape.new(name: 'String')
|
138
140
|
SupplementaryFeature = Shapes::StructureShape.new(name: 'SupplementaryFeature')
|
139
141
|
SupplementaryFeatures = Shapes::ListShape.new(name: 'SupplementaryFeatures')
|
142
|
+
Tag = Shapes::StructureShape.new(name: 'Tag')
|
143
|
+
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
144
|
+
TagKeys = Shapes::ListShape.new(name: 'TagKeys')
|
145
|
+
TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
|
146
|
+
TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
|
147
|
+
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
148
|
+
Tags = Shapes::ListShape.new(name: 'Tags')
|
140
149
|
TestWindowDetails = Shapes::ListShape.new(name: 'TestWindowDetails')
|
141
150
|
TestWindowSummary = Shapes::StructureShape.new(name: 'TestWindowSummary')
|
142
151
|
TestWindows = Shapes::ListShape.new(name: 'TestWindows')
|
143
152
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
144
153
|
TimestampFormat = Shapes::StringShape.new(name: 'TimestampFormat')
|
145
154
|
TrainingParameters = Shapes::MapShape.new(name: 'TrainingParameters')
|
155
|
+
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
156
|
+
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
146
157
|
UpdateDatasetGroupRequest = Shapes::StructureShape.new(name: 'UpdateDatasetGroupRequest')
|
147
158
|
UpdateDatasetGroupResponse = Shapes::StructureShape.new(name: 'UpdateDatasetGroupResponse')
|
148
159
|
Value = Shapes::StringShape.new(name: 'Value')
|
@@ -170,6 +181,7 @@ module Aws::ForecastService
|
|
170
181
|
CreateDatasetGroupRequest.add_member(:dataset_group_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "DatasetGroupName"))
|
171
182
|
CreateDatasetGroupRequest.add_member(:domain, Shapes::ShapeRef.new(shape: Domain, required: true, location_name: "Domain"))
|
172
183
|
CreateDatasetGroupRequest.add_member(:dataset_arns, Shapes::ShapeRef.new(shape: ArnList, location_name: "DatasetArns"))
|
184
|
+
CreateDatasetGroupRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
173
185
|
CreateDatasetGroupRequest.struct_class = Types::CreateDatasetGroupRequest
|
174
186
|
|
175
187
|
CreateDatasetGroupResponse.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DatasetGroupArn"))
|
@@ -179,6 +191,7 @@ module Aws::ForecastService
|
|
179
191
|
CreateDatasetImportJobRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DatasetArn"))
|
180
192
|
CreateDatasetImportJobRequest.add_member(:data_source, Shapes::ShapeRef.new(shape: DataSource, required: true, location_name: "DataSource"))
|
181
193
|
CreateDatasetImportJobRequest.add_member(:timestamp_format, Shapes::ShapeRef.new(shape: TimestampFormat, location_name: "TimestampFormat"))
|
194
|
+
CreateDatasetImportJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
182
195
|
CreateDatasetImportJobRequest.struct_class = Types::CreateDatasetImportJobRequest
|
183
196
|
|
184
197
|
CreateDatasetImportJobResponse.add_member(:dataset_import_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DatasetImportJobArn"))
|
@@ -190,6 +203,7 @@ module Aws::ForecastService
|
|
190
203
|
CreateDatasetRequest.add_member(:data_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "DataFrequency"))
|
191
204
|
CreateDatasetRequest.add_member(:schema, Shapes::ShapeRef.new(shape: Schema, required: true, location_name: "Schema"))
|
192
205
|
CreateDatasetRequest.add_member(:encryption_config, Shapes::ShapeRef.new(shape: EncryptionConfig, location_name: "EncryptionConfig"))
|
206
|
+
CreateDatasetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
193
207
|
CreateDatasetRequest.struct_class = Types::CreateDatasetRequest
|
194
208
|
|
195
209
|
CreateDatasetResponse.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DatasetArn"))
|
@@ -198,6 +212,7 @@ module Aws::ForecastService
|
|
198
212
|
CreateForecastExportJobRequest.add_member(:forecast_export_job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "ForecastExportJobName"))
|
199
213
|
CreateForecastExportJobRequest.add_member(:forecast_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "ForecastArn"))
|
200
214
|
CreateForecastExportJobRequest.add_member(:destination, Shapes::ShapeRef.new(shape: DataDestination, required: true, location_name: "Destination"))
|
215
|
+
CreateForecastExportJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
201
216
|
CreateForecastExportJobRequest.struct_class = Types::CreateForecastExportJobRequest
|
202
217
|
|
203
218
|
CreateForecastExportJobResponse.add_member(:forecast_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ForecastExportJobArn"))
|
@@ -206,6 +221,7 @@ module Aws::ForecastService
|
|
206
221
|
CreateForecastRequest.add_member(:forecast_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "ForecastName"))
|
207
222
|
CreateForecastRequest.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorArn"))
|
208
223
|
CreateForecastRequest.add_member(:forecast_types, Shapes::ShapeRef.new(shape: ForecastTypes, location_name: "ForecastTypes"))
|
224
|
+
CreateForecastRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
209
225
|
CreateForecastRequest.struct_class = Types::CreateForecastRequest
|
210
226
|
|
211
227
|
CreateForecastResponse.add_member(:forecast_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ForecastArn"))
|
@@ -222,6 +238,7 @@ module Aws::ForecastService
|
|
222
238
|
CreatePredictorRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
223
239
|
CreatePredictorRequest.add_member(:featurization_config, Shapes::ShapeRef.new(shape: FeaturizationConfig, required: true, location_name: "FeaturizationConfig"))
|
224
240
|
CreatePredictorRequest.add_member(:encryption_config, Shapes::ShapeRef.new(shape: EncryptionConfig, location_name: "EncryptionConfig"))
|
241
|
+
CreatePredictorRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
225
242
|
CreatePredictorRequest.struct_class = Types::CreatePredictorRequest
|
226
243
|
|
227
244
|
CreatePredictorResponse.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorArn"))
|
@@ -525,6 +542,12 @@ module Aws::ForecastService
|
|
525
542
|
ListPredictorsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
526
543
|
ListPredictorsResponse.struct_class = Types::ListPredictorsResponse
|
527
544
|
|
545
|
+
ListTagsForResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "ResourceArn"))
|
546
|
+
ListTagsForResourceRequest.struct_class = Types::ListTagsForResourceRequest
|
547
|
+
|
548
|
+
ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
549
|
+
ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
|
550
|
+
|
528
551
|
Metrics.add_member(:rmse, Shapes::ShapeRef.new(shape: Double, location_name: "RMSE"))
|
529
552
|
Metrics.add_member(:weighted_quantile_losses, Shapes::ShapeRef.new(shape: WeightedQuantileLosses, location_name: "WeightedQuantileLosses"))
|
530
553
|
Metrics.struct_class = Types::Metrics
|
@@ -595,6 +618,20 @@ module Aws::ForecastService
|
|
595
618
|
|
596
619
|
SupplementaryFeatures.member = Shapes::ShapeRef.new(shape: SupplementaryFeature)
|
597
620
|
|
621
|
+
Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))
|
622
|
+
Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, required: true, location_name: "Value"))
|
623
|
+
Tag.struct_class = Types::Tag
|
624
|
+
|
625
|
+
TagKeys.member = Shapes::ShapeRef.new(shape: TagKey)
|
626
|
+
|
627
|
+
TagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "ResourceArn"))
|
628
|
+
TagResourceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, required: true, location_name: "Tags"))
|
629
|
+
TagResourceRequest.struct_class = Types::TagResourceRequest
|
630
|
+
|
631
|
+
TagResourceResponse.struct_class = Types::TagResourceResponse
|
632
|
+
|
633
|
+
Tags.member = Shapes::ShapeRef.new(shape: Tag)
|
634
|
+
|
598
635
|
TestWindowDetails.member = Shapes::ShapeRef.new(shape: TestWindowSummary)
|
599
636
|
|
600
637
|
TestWindowSummary.add_member(:test_window_start, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TestWindowStart"))
|
@@ -608,6 +645,12 @@ module Aws::ForecastService
|
|
608
645
|
TrainingParameters.key = Shapes::ShapeRef.new(shape: ParameterKey)
|
609
646
|
TrainingParameters.value = Shapes::ShapeRef.new(shape: ParameterValue)
|
610
647
|
|
648
|
+
UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "ResourceArn"))
|
649
|
+
UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeys, required: true, location_name: "TagKeys"))
|
650
|
+
UntagResourceRequest.struct_class = Types::UntagResourceRequest
|
651
|
+
|
652
|
+
UntagResourceResponse.struct_class = Types::UntagResourceResponse
|
653
|
+
|
611
654
|
UpdateDatasetGroupRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DatasetGroupArn"))
|
612
655
|
UpdateDatasetGroupRequest.add_member(:dataset_arns, Shapes::ShapeRef.new(shape: ArnList, required: true, location_name: "DatasetArns"))
|
613
656
|
UpdateDatasetGroupRequest.struct_class = Types::UpdateDatasetGroupRequest
|
@@ -955,6 +998,37 @@ module Aws::ForecastService
|
|
955
998
|
)
|
956
999
|
end)
|
957
1000
|
|
1001
|
+
api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|
|
1002
|
+
o.name = "ListTagsForResource"
|
1003
|
+
o.http_method = "POST"
|
1004
|
+
o.http_request_uri = "/"
|
1005
|
+
o.input = Shapes::ShapeRef.new(shape: ListTagsForResourceRequest)
|
1006
|
+
o.output = Shapes::ShapeRef.new(shape: ListTagsForResourceResponse)
|
1007
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1008
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1009
|
+
end)
|
1010
|
+
|
1011
|
+
api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
|
1012
|
+
o.name = "TagResource"
|
1013
|
+
o.http_method = "POST"
|
1014
|
+
o.http_request_uri = "/"
|
1015
|
+
o.input = Shapes::ShapeRef.new(shape: TagResourceRequest)
|
1016
|
+
o.output = Shapes::ShapeRef.new(shape: TagResourceResponse)
|
1017
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1018
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1019
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1020
|
+
end)
|
1021
|
+
|
1022
|
+
api.add_operation(:untag_resource, Seahorse::Model::Operation.new.tap do |o|
|
1023
|
+
o.name = "UntagResource"
|
1024
|
+
o.http_method = "POST"
|
1025
|
+
o.http_request_uri = "/"
|
1026
|
+
o.input = Shapes::ShapeRef.new(shape: UntagResourceRequest)
|
1027
|
+
o.output = Shapes::ShapeRef.new(shape: UntagResourceResponse)
|
1028
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1029
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1030
|
+
end)
|
1031
|
+
|
958
1032
|
api.add_operation(:update_dataset_group, Seahorse::Model::Operation.new.tap do |o|
|
959
1033
|
o.name = "UpdateDatasetGroup"
|
960
1034
|
o.http_method = "POST"
|
@@ -119,6 +119,12 @@ module Aws::ForecastService
|
|
119
119
|
# dataset_group_name: "Name", # required
|
120
120
|
# domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
|
121
121
|
# dataset_arns: ["Arn"],
|
122
|
+
# tags: [
|
123
|
+
# {
|
124
|
+
# key: "TagKey", # required
|
125
|
+
# value: "TagValue", # required
|
126
|
+
# },
|
127
|
+
# ],
|
122
128
|
# }
|
123
129
|
#
|
124
130
|
# @!attribute [rw] dataset_group_name
|
@@ -143,12 +149,46 @@ module Aws::ForecastService
|
|
143
149
|
# want to include in the dataset group.
|
144
150
|
# @return [Array<String>]
|
145
151
|
#
|
152
|
+
# @!attribute [rw] tags
|
153
|
+
# The optional metadata that you apply to the dataset group to help
|
154
|
+
# you categorize and organize them. Each tag consists of a key and an
|
155
|
+
# optional value, both of which you define.
|
156
|
+
#
|
157
|
+
# The following basic restrictions apply to tags:
|
158
|
+
#
|
159
|
+
# * Maximum number of tags per resource - 50.
|
160
|
+
#
|
161
|
+
# * For each resource, each tag key must be unique, and each tag key
|
162
|
+
# can have only one value.
|
163
|
+
#
|
164
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
165
|
+
#
|
166
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
167
|
+
#
|
168
|
+
# * If your tagging schema is used across multiple services and
|
169
|
+
# resources, remember that other services may have restrictions on
|
170
|
+
# allowed characters. Generally allowed characters are: letters,
|
171
|
+
# numbers, and spaces representable in UTF-8, and the following
|
172
|
+
# characters: + - = . \_ : / @.
|
173
|
+
#
|
174
|
+
# * Tag keys and values are case sensitive.
|
175
|
+
#
|
176
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
177
|
+
# of such as a prefix for keys as it is reserved for AWS use. You
|
178
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
179
|
+
# this prefix. If a tag value has `aws` as its prefix but the key
|
180
|
+
# does not, then Forecast considers it to be a user tag and will
|
181
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
182
|
+
# of `aws` do not count against your tags per resource limit.
|
183
|
+
# @return [Array<Types::Tag>]
|
184
|
+
#
|
146
185
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetGroupRequest AWS API Documentation
|
147
186
|
#
|
148
187
|
class CreateDatasetGroupRequest < Struct.new(
|
149
188
|
:dataset_group_name,
|
150
189
|
:domain,
|
151
|
-
:dataset_arns
|
190
|
+
:dataset_arns,
|
191
|
+
:tags)
|
152
192
|
SENSITIVE = []
|
153
193
|
include Aws::Structure
|
154
194
|
end
|
@@ -179,6 +219,12 @@ module Aws::ForecastService
|
|
179
219
|
# },
|
180
220
|
# },
|
181
221
|
# timestamp_format: "TimestampFormat",
|
222
|
+
# tags: [
|
223
|
+
# {
|
224
|
+
# key: "TagKey", # required
|
225
|
+
# value: "TagValue", # required
|
226
|
+
# },
|
227
|
+
# ],
|
182
228
|
# }
|
183
229
|
#
|
184
230
|
# @!attribute [rw] dataset_import_job_name
|
@@ -224,13 +270,47 @@ module Aws::ForecastService
|
|
224
270
|
# to be "yyyy-MM-dd HH:mm:ss".
|
225
271
|
# @return [String]
|
226
272
|
#
|
273
|
+
# @!attribute [rw] tags
|
274
|
+
# The optional metadata that you apply to the dataset import job to
|
275
|
+
# help you categorize and organize them. Each tag consists of a key
|
276
|
+
# and an optional value, both of which you define.
|
277
|
+
#
|
278
|
+
# The following basic restrictions apply to tags:
|
279
|
+
#
|
280
|
+
# * Maximum number of tags per resource - 50.
|
281
|
+
#
|
282
|
+
# * For each resource, each tag key must be unique, and each tag key
|
283
|
+
# can have only one value.
|
284
|
+
#
|
285
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
286
|
+
#
|
287
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
288
|
+
#
|
289
|
+
# * If your tagging schema is used across multiple services and
|
290
|
+
# resources, remember that other services may have restrictions on
|
291
|
+
# allowed characters. Generally allowed characters are: letters,
|
292
|
+
# numbers, and spaces representable in UTF-8, and the following
|
293
|
+
# characters: + - = . \_ : / @.
|
294
|
+
#
|
295
|
+
# * Tag keys and values are case sensitive.
|
296
|
+
#
|
297
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
298
|
+
# of such as a prefix for keys as it is reserved for AWS use. You
|
299
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
300
|
+
# this prefix. If a tag value has `aws` as its prefix but the key
|
301
|
+
# does not, then Forecast considers it to be a user tag and will
|
302
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
303
|
+
# of `aws` do not count against your tags per resource limit.
|
304
|
+
# @return [Array<Types::Tag>]
|
305
|
+
#
|
227
306
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJobRequest AWS API Documentation
|
228
307
|
#
|
229
308
|
class CreateDatasetImportJobRequest < Struct.new(
|
230
309
|
:dataset_import_job_name,
|
231
310
|
:dataset_arn,
|
232
311
|
:data_source,
|
233
|
-
:timestamp_format
|
312
|
+
:timestamp_format,
|
313
|
+
:tags)
|
234
314
|
SENSITIVE = []
|
235
315
|
include Aws::Structure
|
236
316
|
end
|
@@ -267,6 +347,12 @@ module Aws::ForecastService
|
|
267
347
|
# role_arn: "Arn", # required
|
268
348
|
# kms_key_arn: "KMSKeyArn", # required
|
269
349
|
# },
|
350
|
+
# tags: [
|
351
|
+
# {
|
352
|
+
# key: "TagKey", # required
|
353
|
+
# value: "TagValue", # required
|
354
|
+
# },
|
355
|
+
# ],
|
270
356
|
# }
|
271
357
|
#
|
272
358
|
# @!attribute [rw] dataset_name
|
@@ -314,6 +400,39 @@ module Aws::ForecastService
|
|
314
400
|
# access the key.
|
315
401
|
# @return [Types::EncryptionConfig]
|
316
402
|
#
|
403
|
+
# @!attribute [rw] tags
|
404
|
+
# The optional metadata that you apply to the dataset to help you
|
405
|
+
# categorize and organize them. Each tag consists of a key and an
|
406
|
+
# optional value, both of which you define.
|
407
|
+
#
|
408
|
+
# The following basic restrictions apply to tags:
|
409
|
+
#
|
410
|
+
# * Maximum number of tags per resource - 50.
|
411
|
+
#
|
412
|
+
# * For each resource, each tag key must be unique, and each tag key
|
413
|
+
# can have only one value.
|
414
|
+
#
|
415
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
416
|
+
#
|
417
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
418
|
+
#
|
419
|
+
# * If your tagging schema is used across multiple services and
|
420
|
+
# resources, remember that other services may have restrictions on
|
421
|
+
# allowed characters. Generally allowed characters are: letters,
|
422
|
+
# numbers, and spaces representable in UTF-8, and the following
|
423
|
+
# characters: + - = . \_ : / @.
|
424
|
+
#
|
425
|
+
# * Tag keys and values are case sensitive.
|
426
|
+
#
|
427
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
428
|
+
# of such as a prefix for keys as it is reserved for AWS use. You
|
429
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
430
|
+
# this prefix. If a tag value has `aws` as its prefix but the key
|
431
|
+
# does not, then Forecast considers it to be a user tag and will
|
432
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
433
|
+
# of `aws` do not count against your tags per resource limit.
|
434
|
+
# @return [Array<Types::Tag>]
|
435
|
+
#
|
317
436
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetRequest AWS API Documentation
|
318
437
|
#
|
319
438
|
class CreateDatasetRequest < Struct.new(
|
@@ -322,7 +441,8 @@ module Aws::ForecastService
|
|
322
441
|
:dataset_type,
|
323
442
|
:data_frequency,
|
324
443
|
:schema,
|
325
|
-
:encryption_config
|
444
|
+
:encryption_config,
|
445
|
+
:tags)
|
326
446
|
SENSITIVE = []
|
327
447
|
include Aws::Structure
|
328
448
|
end
|
@@ -352,6 +472,12 @@ module Aws::ForecastService
|
|
352
472
|
# kms_key_arn: "KMSKeyArn",
|
353
473
|
# },
|
354
474
|
# },
|
475
|
+
# tags: [
|
476
|
+
# {
|
477
|
+
# key: "TagKey", # required
|
478
|
+
# value: "TagValue", # required
|
479
|
+
# },
|
480
|
+
# ],
|
355
481
|
# }
|
356
482
|
#
|
357
483
|
# @!attribute [rw] forecast_export_job_name
|
@@ -374,12 +500,46 @@ module Aws::ForecastService
|
|
374
500
|
# Forecast permission to access the key.
|
375
501
|
# @return [Types::DataDestination]
|
376
502
|
#
|
503
|
+
# @!attribute [rw] tags
|
504
|
+
# The optional metadata that you apply to the forecast export job to
|
505
|
+
# help you categorize and organize them. Each tag consists of a key
|
506
|
+
# and an optional value, both of which you define.
|
507
|
+
#
|
508
|
+
# The following basic restrictions apply to tags:
|
509
|
+
#
|
510
|
+
# * Maximum number of tags per resource - 50.
|
511
|
+
#
|
512
|
+
# * For each resource, each tag key must be unique, and each tag key
|
513
|
+
# can have only one value.
|
514
|
+
#
|
515
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
516
|
+
#
|
517
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
518
|
+
#
|
519
|
+
# * If your tagging schema is used across multiple services and
|
520
|
+
# resources, remember that other services may have restrictions on
|
521
|
+
# allowed characters. Generally allowed characters are: letters,
|
522
|
+
# numbers, and spaces representable in UTF-8, and the following
|
523
|
+
# characters: + - = . \_ : / @.
|
524
|
+
#
|
525
|
+
# * Tag keys and values are case sensitive.
|
526
|
+
#
|
527
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
528
|
+
# of such as a prefix for keys as it is reserved for AWS use. You
|
529
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
530
|
+
# this prefix. If a tag value has `aws` as its prefix but the key
|
531
|
+
# does not, then Forecast considers it to be a user tag and will
|
532
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
533
|
+
# of `aws` do not count against your tags per resource limit.
|
534
|
+
# @return [Array<Types::Tag>]
|
535
|
+
#
|
377
536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJobRequest AWS API Documentation
|
378
537
|
#
|
379
538
|
class CreateForecastExportJobRequest < Struct.new(
|
380
539
|
:forecast_export_job_name,
|
381
540
|
:forecast_arn,
|
382
|
-
:destination
|
541
|
+
:destination,
|
542
|
+
:tags)
|
383
543
|
SENSITIVE = []
|
384
544
|
include Aws::Structure
|
385
545
|
end
|
@@ -403,6 +563,12 @@ module Aws::ForecastService
|
|
403
563
|
# forecast_name: "Name", # required
|
404
564
|
# predictor_arn: "Arn", # required
|
405
565
|
# forecast_types: ["ForecastType"],
|
566
|
+
# tags: [
|
567
|
+
# {
|
568
|
+
# key: "TagKey", # required
|
569
|
+
# value: "TagValue", # required
|
570
|
+
# },
|
571
|
+
# ],
|
406
572
|
# }
|
407
573
|
#
|
408
574
|
# @!attribute [rw] forecast_name
|
@@ -415,20 +581,54 @@ module Aws::ForecastService
|
|
415
581
|
# @return [String]
|
416
582
|
#
|
417
583
|
# @!attribute [rw] forecast_types
|
418
|
-
# The quantiles at which probabilistic forecasts are generated. You
|
419
|
-
# can specify up to 5 quantiles per forecast
|
420
|
-
# `0.01 to 0.99` (increments of .01 only) and `mean`.
|
421
|
-
# forecast is different from the median (0.50) when the
|
422
|
-
# is not symmetric (
|
423
|
-
# is `["0.1", "0.5", "0.9"]`.
|
584
|
+
# The quantiles at which probabilistic forecasts are generated. **You
|
585
|
+
# can currently specify up to 5 quantiles per forecast**. Accepted
|
586
|
+
# values include `0.01 to 0.99` (increments of .01 only) and `mean`.
|
587
|
+
# The mean forecast is different from the median (0.50) when the
|
588
|
+
# distribution is not symmetric (for example, Beta and Negative
|
589
|
+
# Binomial). The default value is `["0.1", "0.5", "0.9"]`.
|
424
590
|
# @return [Array<String>]
|
425
591
|
#
|
592
|
+
# @!attribute [rw] tags
|
593
|
+
# The optional metadata that you apply to the forecast to help you
|
594
|
+
# categorize and organize them. Each tag consists of a key and an
|
595
|
+
# optional value, both of which you define.
|
596
|
+
#
|
597
|
+
# The following basic restrictions apply to tags:
|
598
|
+
#
|
599
|
+
# * Maximum number of tags per resource - 50.
|
600
|
+
#
|
601
|
+
# * For each resource, each tag key must be unique, and each tag key
|
602
|
+
# can have only one value.
|
603
|
+
#
|
604
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
605
|
+
#
|
606
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
607
|
+
#
|
608
|
+
# * If your tagging schema is used across multiple services and
|
609
|
+
# resources, remember that other services may have restrictions on
|
610
|
+
# allowed characters. Generally allowed characters are: letters,
|
611
|
+
# numbers, and spaces representable in UTF-8, and the following
|
612
|
+
# characters: + - = . \_ : / @.
|
613
|
+
#
|
614
|
+
# * Tag keys and values are case sensitive.
|
615
|
+
#
|
616
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
617
|
+
# of such as a prefix for keys as it is reserved for AWS use. You
|
618
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
619
|
+
# this prefix. If a tag value has `aws` as its prefix but the key
|
620
|
+
# does not, then Forecast considers it to be a user tag and will
|
621
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
622
|
+
# of `aws` do not count against your tags per resource limit.
|
623
|
+
# @return [Array<Types::Tag>]
|
624
|
+
#
|
426
625
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastRequest AWS API Documentation
|
427
626
|
#
|
428
627
|
class CreateForecastRequest < Struct.new(
|
429
628
|
:forecast_name,
|
430
629
|
:predictor_arn,
|
431
|
-
:forecast_types
|
630
|
+
:forecast_types,
|
631
|
+
:tags)
|
432
632
|
SENSITIVE = []
|
433
633
|
include Aws::Structure
|
434
634
|
end
|
@@ -517,6 +717,12 @@ module Aws::ForecastService
|
|
517
717
|
# role_arn: "Arn", # required
|
518
718
|
# kms_key_arn: "KMSKeyArn", # required
|
519
719
|
# },
|
720
|
+
# tags: [
|
721
|
+
# {
|
722
|
+
# key: "TagKey", # required
|
723
|
+
# value: "TagValue", # required
|
724
|
+
# },
|
725
|
+
# ],
|
520
726
|
# }
|
521
727
|
#
|
522
728
|
# @!attribute [rw] predictor_name
|
@@ -632,6 +838,39 @@ module Aws::ForecastService
|
|
632
838
|
# access the key.
|
633
839
|
# @return [Types::EncryptionConfig]
|
634
840
|
#
|
841
|
+
# @!attribute [rw] tags
|
842
|
+
# The optional metadata that you apply to the predictor to help you
|
843
|
+
# categorize and organize them. Each tag consists of a key and an
|
844
|
+
# optional value, both of which you define.
|
845
|
+
#
|
846
|
+
# The following basic restrictions apply to tags:
|
847
|
+
#
|
848
|
+
# * Maximum number of tags per resource - 50.
|
849
|
+
#
|
850
|
+
# * For each resource, each tag key must be unique, and each tag key
|
851
|
+
# can have only one value.
|
852
|
+
#
|
853
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
854
|
+
#
|
855
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
856
|
+
#
|
857
|
+
# * If your tagging schema is used across multiple services and
|
858
|
+
# resources, remember that other services may have restrictions on
|
859
|
+
# allowed characters. Generally allowed characters are: letters,
|
860
|
+
# numbers, and spaces representable in UTF-8, and the following
|
861
|
+
# characters: + - = . \_ : / @.
|
862
|
+
#
|
863
|
+
# * Tag keys and values are case sensitive.
|
864
|
+
#
|
865
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
866
|
+
# of such as a prefix for keys as it is reserved for AWS use. You
|
867
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
868
|
+
# this prefix. If a tag value has `aws` as its prefix but the key
|
869
|
+
# does not, then Forecast considers it to be a user tag and will
|
870
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
871
|
+
# of `aws` do not count against your tags per resource limit.
|
872
|
+
# @return [Array<Types::Tag>]
|
873
|
+
#
|
635
874
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorRequest AWS API Documentation
|
636
875
|
#
|
637
876
|
class CreatePredictorRequest < Struct.new(
|
@@ -645,7 +884,8 @@ module Aws::ForecastService
|
|
645
884
|
:hpo_config,
|
646
885
|
:input_data_config,
|
647
886
|
:featurization_config,
|
648
|
-
:encryption_config
|
887
|
+
:encryption_config,
|
888
|
+
:tags)
|
649
889
|
SENSITIVE = []
|
650
890
|
include Aws::Structure
|
651
891
|
end
|
@@ -1394,7 +1634,7 @@ module Aws::ForecastService
|
|
1394
1634
|
# @return [String]
|
1395
1635
|
#
|
1396
1636
|
# @!attribute [rw] forecast_types
|
1397
|
-
# The quantiles at which
|
1637
|
+
# The quantiles at which probabilistic forecasts were generated.
|
1398
1638
|
# @return [Array<String>]
|
1399
1639
|
#
|
1400
1640
|
# @!attribute [rw] predictor_arn
|
@@ -1743,10 +1983,11 @@ module Aws::ForecastService
|
|
1743
1983
|
#
|
1744
1984
|
# @!attribute [rw] attribute_name
|
1745
1985
|
# The name of the schema attribute that specifies the data field to be
|
1746
|
-
# featurized.
|
1747
|
-
#
|
1748
|
-
#
|
1749
|
-
# `target_value`.
|
1986
|
+
# featurized. Amazon Forecast supports the target field of the
|
1987
|
+
# `TARGET_TIME_SERIES` and the `RELATED_TIME_SERIES` datasets. For
|
1988
|
+
# example, for the `RETAIL` domain, the target is `demand`, and for
|
1989
|
+
# the `CUSTOM` domain, the target is `target_value`. For more
|
1990
|
+
# information, see howitworks-missing-values.
|
1750
1991
|
# @return [String]
|
1751
1992
|
#
|
1752
1993
|
# @!attribute [rw] featurization_pipeline
|
@@ -1772,8 +2013,8 @@ module Aws::ForecastService
|
|
1772
2013
|
# specify an array of transformations, one for each field that you want
|
1773
2014
|
# to featurize. You then include the `FeaturizationConfig` object in
|
1774
2015
|
# your `CreatePredictor` request. Amazon Forecast applies the
|
1775
|
-
# featurization to the `TARGET_TIME_SERIES`
|
1776
|
-
# training.
|
2016
|
+
# featurization to the `TARGET_TIME_SERIES` and `RELATED_TIME_SERIES`
|
2017
|
+
# datasets before model training.
|
1777
2018
|
#
|
1778
2019
|
# You can create multiple featurization configurations. For example, you
|
1779
2020
|
# might call the `CreatePredictor` operation twice by specifying
|
@@ -1833,7 +2074,7 @@ module Aws::ForecastService
|
|
1833
2074
|
#
|
1834
2075
|
# @!attribute [rw] featurizations
|
1835
2076
|
# An array of featurization (transformation) information for the
|
1836
|
-
# fields of a dataset.
|
2077
|
+
# fields of a dataset.
|
1837
2078
|
# @return [Array<Types::Featurization>]
|
1838
2079
|
#
|
1839
2080
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/FeaturizationConfig AWS API Documentation
|
@@ -1848,9 +2089,7 @@ module Aws::ForecastService
|
|
1848
2089
|
|
1849
2090
|
# Provides information about the method that featurizes (transforms) a
|
1850
2091
|
# dataset field. The method is part of the `FeaturizationPipeline` of
|
1851
|
-
# the Featurization object.
|
1852
|
-
# `FeaturizationMethodParameters`, Amazon Forecast uses default
|
1853
|
-
# parameters.
|
2092
|
+
# the Featurization object.
|
1854
2093
|
#
|
1855
2094
|
# The following is an example of how you specify a `FeaturizationMethod`
|
1856
2095
|
# object.
|
@@ -1859,8 +2098,8 @@ module Aws::ForecastService
|
|
1859
2098
|
#
|
1860
2099
|
# `"FeaturizationMethodName": "filling",`
|
1861
2100
|
#
|
1862
|
-
# `"FeaturizationMethodParameters": \{"aggregation": "
|
1863
|
-
# "
|
2101
|
+
# `"FeaturizationMethodParameters": \{"aggregation": "sum",
|
2102
|
+
# "middlefill": "zero", "backfill": "zero"\}`
|
1864
2103
|
#
|
1865
2104
|
# `\}`
|
1866
2105
|
#
|
@@ -1880,17 +2119,33 @@ module Aws::ForecastService
|
|
1880
2119
|
# @return [String]
|
1881
2120
|
#
|
1882
2121
|
# @!attribute [rw] featurization_method_parameters
|
1883
|
-
# The method parameters (key-value pairs)
|
1884
|
-
# override the default values.
|
1885
|
-
#
|
2122
|
+
# The method parameters (key-value pairs), which are a map of override
|
2123
|
+
# parameters. Specify these parameters to override the default values.
|
2124
|
+
# Related Time Series attributes do not accept aggregation parameters.
|
2125
|
+
#
|
2126
|
+
# The following list shows the parameters and their valid values for
|
2127
|
+
# the "filling" featurization method for a **Target Time Series**
|
2128
|
+
# dataset. Bold signifies the default value.
|
1886
2129
|
#
|
1887
2130
|
# * `aggregation`\: **sum**, `avg`, `first`, `min`, `max`
|
1888
2131
|
#
|
1889
2132
|
# * `frontfill`\: **none**
|
1890
2133
|
#
|
1891
|
-
# * `middlefill`\: **zero**, `nan` (not a number)
|
2134
|
+
# * `middlefill`\: **zero**, `nan` (not a number), `value`, `median`,
|
2135
|
+
# `mean`, `min`, `max`
|
2136
|
+
#
|
2137
|
+
# * `backfill`\: **zero**, `nan`, `value`, `median`, `mean`, `min`,
|
2138
|
+
# `max`
|
2139
|
+
#
|
2140
|
+
# The following list shows the parameters and their valid values for a
|
2141
|
+
# **Related Time Series** featurization method (there are no
|
2142
|
+
# defaults):
|
1892
2143
|
#
|
1893
|
-
# * `
|
2144
|
+
# * `middlefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
|
2145
|
+
#
|
2146
|
+
# * `backfill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
|
2147
|
+
#
|
2148
|
+
# * `futurefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
|
1894
2149
|
# @return [Hash<String,String>]
|
1895
2150
|
#
|
1896
2151
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/FeaturizationMethod AWS API Documentation
|
@@ -2709,6 +2964,40 @@ module Aws::ForecastService
|
|
2709
2964
|
include Aws::Structure
|
2710
2965
|
end
|
2711
2966
|
|
2967
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
2968
|
+
# data as a hash:
|
2969
|
+
#
|
2970
|
+
# {
|
2971
|
+
# resource_arn: "Arn", # required
|
2972
|
+
# }
|
2973
|
+
#
|
2974
|
+
# @!attribute [rw] resource_arn
|
2975
|
+
# The Amazon Resource Name (ARN) that identifies the resource for
|
2976
|
+
# which to list the tags. Currently, the supported resources are
|
2977
|
+
# Forecast dataset groups, datasets, dataset import jobs, predictors,
|
2978
|
+
# forecasts, and forecast export jobs.
|
2979
|
+
# @return [String]
|
2980
|
+
#
|
2981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResourceRequest AWS API Documentation
|
2982
|
+
#
|
2983
|
+
class ListTagsForResourceRequest < Struct.new(
|
2984
|
+
:resource_arn)
|
2985
|
+
SENSITIVE = []
|
2986
|
+
include Aws::Structure
|
2987
|
+
end
|
2988
|
+
|
2989
|
+
# @!attribute [rw] tags
|
2990
|
+
# The tags for the resource.
|
2991
|
+
# @return [Array<Types::Tag>]
|
2992
|
+
#
|
2993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResourceResponse AWS API Documentation
|
2994
|
+
#
|
2995
|
+
class ListTagsForResourceResponse < Struct.new(
|
2996
|
+
:tags)
|
2997
|
+
SENSITIVE = []
|
2998
|
+
include Aws::Structure
|
2999
|
+
end
|
3000
|
+
|
2712
3001
|
# Provides metrics that are used to evaluate the performance of a
|
2713
3002
|
# predictor. This object is part of the WindowSummary object.
|
2714
3003
|
#
|
@@ -3097,6 +3386,35 @@ module Aws::ForecastService
|
|
3097
3386
|
# as the calendar. For the holiday calendar data, see the [Jollyday][1]
|
3098
3387
|
# web site.
|
3099
3388
|
#
|
3389
|
+
# India and Korea's holidays are not included in the Jollyday library,
|
3390
|
+
# but both are supported by Amazon Forecast. Their holidays are:
|
3391
|
+
#
|
3392
|
+
# **"IN" - INDIA**
|
3393
|
+
#
|
3394
|
+
# * `JANUARY 26 - REPUBLIC DAY`
|
3395
|
+
#
|
3396
|
+
# * `AUGUST 15 - INDEPENDENCE DAY`
|
3397
|
+
#
|
3398
|
+
# * `OCTOBER 2 GANDHI'S BIRTHDAY`
|
3399
|
+
#
|
3400
|
+
# **"KR" - KOREA**
|
3401
|
+
#
|
3402
|
+
# * `JANUARY 1 - NEW YEAR`
|
3403
|
+
#
|
3404
|
+
# * `MARCH 1 - INDEPENDENCE MOVEMENT DAY`
|
3405
|
+
#
|
3406
|
+
# * `MAY 5 - CHILDREN'S DAY`
|
3407
|
+
#
|
3408
|
+
# * `JUNE 6 - MEMORIAL DAY`
|
3409
|
+
#
|
3410
|
+
# * `AUGUST 15 - LIBERATION DAY`
|
3411
|
+
#
|
3412
|
+
# * `OCTOBER 3 - NATIONAL FOUNDATION DAY`
|
3413
|
+
#
|
3414
|
+
# * `OCTOBER 9 - HANGEUL DAY`
|
3415
|
+
#
|
3416
|
+
# * `DECEMBER 25 - CHRISTMAS DAY`
|
3417
|
+
#
|
3100
3418
|
#
|
3101
3419
|
#
|
3102
3420
|
# [1]: http://jollyday.sourceforge.net/data.html
|
@@ -3116,15 +3434,69 @@ module Aws::ForecastService
|
|
3116
3434
|
# @!attribute [rw] value
|
3117
3435
|
# One of the following 2 letter country codes:
|
3118
3436
|
#
|
3437
|
+
# * "AR" - ARGENTINA
|
3438
|
+
#
|
3439
|
+
# * "AT" - AUSTRIA
|
3440
|
+
#
|
3119
3441
|
# * "AU" - AUSTRALIA
|
3120
3442
|
#
|
3443
|
+
# * "BE" - BELGIUM
|
3444
|
+
#
|
3445
|
+
# * "BR" - BRAZIL
|
3446
|
+
#
|
3447
|
+
# * "CA" - CANADA
|
3448
|
+
#
|
3449
|
+
# * "CN" - CHINA
|
3450
|
+
#
|
3451
|
+
# * "CZ" - CZECH REPUBLIC
|
3452
|
+
#
|
3453
|
+
# * "DK" - DENMARK
|
3454
|
+
#
|
3455
|
+
# * "EC" - ECUADOR
|
3456
|
+
#
|
3457
|
+
# * "FI" - FINLAND
|
3458
|
+
#
|
3459
|
+
# * "FR" - FRANCE
|
3460
|
+
#
|
3121
3461
|
# * "DE" - GERMANY
|
3122
3462
|
#
|
3463
|
+
# * "HU" - HUNGARY
|
3464
|
+
#
|
3465
|
+
# * "IE" - IRELAND
|
3466
|
+
#
|
3467
|
+
# * "IN" - INDIA
|
3468
|
+
#
|
3469
|
+
# * "IT" - ITALY
|
3470
|
+
#
|
3123
3471
|
# * "JP" - JAPAN
|
3124
3472
|
#
|
3125
|
-
# * "
|
3473
|
+
# * "KR" - KOREA
|
3474
|
+
#
|
3475
|
+
# * "LU" - LUXEMBOURG
|
3126
3476
|
#
|
3127
|
-
# * "
|
3477
|
+
# * "MX" - MEXICO
|
3478
|
+
#
|
3479
|
+
# * "NL" - NETHERLANDS
|
3480
|
+
#
|
3481
|
+
# * "NO" - NORWAY
|
3482
|
+
#
|
3483
|
+
# * "PL" - POLAND
|
3484
|
+
#
|
3485
|
+
# * "PT" - PORTUGAL
|
3486
|
+
#
|
3487
|
+
# * "RU" - RUSSIA
|
3488
|
+
#
|
3489
|
+
# * "ZA" - SOUTH AFRICA
|
3490
|
+
#
|
3491
|
+
# * "ES" - SPAIN
|
3492
|
+
#
|
3493
|
+
# * "SE" - SWEDEN
|
3494
|
+
#
|
3495
|
+
# * "CH" - SWITZERLAND
|
3496
|
+
#
|
3497
|
+
# * "US" - UNITED STATES
|
3498
|
+
#
|
3499
|
+
# * "UK" - UNITED KINGDOM
|
3128
3500
|
# @return [String]
|
3129
3501
|
#
|
3130
3502
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/SupplementaryFeature AWS API Documentation
|
@@ -3136,6 +3508,130 @@ module Aws::ForecastService
|
|
3136
3508
|
include Aws::Structure
|
3137
3509
|
end
|
3138
3510
|
|
3511
|
+
# The optional metadata that you apply to a resource to help you
|
3512
|
+
# categorize and organize them. Each tag consists of a key and an
|
3513
|
+
# optional value, both of which you define.
|
3514
|
+
#
|
3515
|
+
# The following basic restrictions apply to tags:
|
3516
|
+
#
|
3517
|
+
# * Maximum number of tags per resource - 50.
|
3518
|
+
#
|
3519
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
3520
|
+
# have only one value.
|
3521
|
+
#
|
3522
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
3523
|
+
#
|
3524
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
3525
|
+
#
|
3526
|
+
# * If your tagging schema is used across multiple services and
|
3527
|
+
# resources, remember that other services may have restrictions on
|
3528
|
+
# allowed characters. Generally allowed characters are: letters,
|
3529
|
+
# numbers, and spaces representable in UTF-8, and the following
|
3530
|
+
# characters: + - = . \_ : / @.
|
3531
|
+
#
|
3532
|
+
# * Tag keys and values are case sensitive.
|
3533
|
+
#
|
3534
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
3535
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
3536
|
+
# edit or delete tag keys with this prefix. Values can have this
|
3537
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
3538
|
+
# then Forecast considers it to be a user tag and will count against
|
3539
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
3540
|
+
# count against your tags per resource limit.
|
3541
|
+
#
|
3542
|
+
# @note When making an API call, you may pass Tag
|
3543
|
+
# data as a hash:
|
3544
|
+
#
|
3545
|
+
# {
|
3546
|
+
# key: "TagKey", # required
|
3547
|
+
# value: "TagValue", # required
|
3548
|
+
# }
|
3549
|
+
#
|
3550
|
+
# @!attribute [rw] key
|
3551
|
+
# One part of a key-value pair that makes up a tag. A `key` is a
|
3552
|
+
# general label that acts like a category for more specific tag
|
3553
|
+
# values.
|
3554
|
+
# @return [String]
|
3555
|
+
#
|
3556
|
+
# @!attribute [rw] value
|
3557
|
+
# The optional part of a key-value pair that makes up a tag. A `value`
|
3558
|
+
# acts as a descriptor within a tag category (key).
|
3559
|
+
# @return [String]
|
3560
|
+
#
|
3561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Tag AWS API Documentation
|
3562
|
+
#
|
3563
|
+
class Tag < Struct.new(
|
3564
|
+
:key,
|
3565
|
+
:value)
|
3566
|
+
SENSITIVE = []
|
3567
|
+
include Aws::Structure
|
3568
|
+
end
|
3569
|
+
|
3570
|
+
# @note When making an API call, you may pass TagResourceRequest
|
3571
|
+
# data as a hash:
|
3572
|
+
#
|
3573
|
+
# {
|
3574
|
+
# resource_arn: "Arn", # required
|
3575
|
+
# tags: [ # required
|
3576
|
+
# {
|
3577
|
+
# key: "TagKey", # required
|
3578
|
+
# value: "TagValue", # required
|
3579
|
+
# },
|
3580
|
+
# ],
|
3581
|
+
# }
|
3582
|
+
#
|
3583
|
+
# @!attribute [rw] resource_arn
|
3584
|
+
# The Amazon Resource Name (ARN) that identifies the resource for
|
3585
|
+
# which to list the tags. Currently, the supported resources are
|
3586
|
+
# Forecast dataset groups, datasets, dataset import jobs, predictors,
|
3587
|
+
# forecasts, and forecast export jobs.
|
3588
|
+
# @return [String]
|
3589
|
+
#
|
3590
|
+
# @!attribute [rw] tags
|
3591
|
+
# The tags to add to the resource. A tag is an array of key-value
|
3592
|
+
# pairs.
|
3593
|
+
#
|
3594
|
+
# The following basic restrictions apply to tags:
|
3595
|
+
#
|
3596
|
+
# * Maximum number of tags per resource - 50.
|
3597
|
+
#
|
3598
|
+
# * For each resource, each tag key must be unique, and each tag key
|
3599
|
+
# can have only one value.
|
3600
|
+
#
|
3601
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
3602
|
+
#
|
3603
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
3604
|
+
#
|
3605
|
+
# * If your tagging schema is used across multiple services and
|
3606
|
+
# resources, remember that other services may have restrictions on
|
3607
|
+
# allowed characters. Generally allowed characters are: letters,
|
3608
|
+
# numbers, and spaces representable in UTF-8, and the following
|
3609
|
+
# characters: + - = . \_ : / @.
|
3610
|
+
#
|
3611
|
+
# * Tag keys and values are case sensitive.
|
3612
|
+
#
|
3613
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
|
3614
|
+
# of such as a prefix for keys as it is reserved for AWS use. You
|
3615
|
+
# cannot edit or delete tag keys with this prefix. Values can have
|
3616
|
+
# this prefix. If a tag value has `aws` as its prefix but the key
|
3617
|
+
# does not, then Forecast considers it to be a user tag and will
|
3618
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
3619
|
+
# of `aws` do not count against your tags per resource limit.
|
3620
|
+
# @return [Array<Types::Tag>]
|
3621
|
+
#
|
3622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResourceRequest AWS API Documentation
|
3623
|
+
#
|
3624
|
+
class TagResourceRequest < Struct.new(
|
3625
|
+
:resource_arn,
|
3626
|
+
:tags)
|
3627
|
+
SENSITIVE = []
|
3628
|
+
include Aws::Structure
|
3629
|
+
end
|
3630
|
+
|
3631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResourceResponse AWS API Documentation
|
3632
|
+
#
|
3633
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
3634
|
+
|
3139
3635
|
# The status, start time, and end time of a backtest, as well as a
|
3140
3636
|
# failure reason if applicable.
|
3141
3637
|
#
|
@@ -3172,6 +3668,38 @@ module Aws::ForecastService
|
|
3172
3668
|
include Aws::Structure
|
3173
3669
|
end
|
3174
3670
|
|
3671
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
3672
|
+
# data as a hash:
|
3673
|
+
#
|
3674
|
+
# {
|
3675
|
+
# resource_arn: "Arn", # required
|
3676
|
+
# tag_keys: ["TagKey"], # required
|
3677
|
+
# }
|
3678
|
+
#
|
3679
|
+
# @!attribute [rw] resource_arn
|
3680
|
+
# The Amazon Resource Name (ARN) that identifies the resource for
|
3681
|
+
# which to list the tags. Currently, the supported resources are
|
3682
|
+
# Forecast dataset groups, datasets, dataset import jobs, predictors,
|
3683
|
+
# forecasts, and forecast exports.
|
3684
|
+
# @return [String]
|
3685
|
+
#
|
3686
|
+
# @!attribute [rw] tag_keys
|
3687
|
+
# The keys of the tags to be removed.
|
3688
|
+
# @return [Array<String>]
|
3689
|
+
#
|
3690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UntagResourceRequest AWS API Documentation
|
3691
|
+
#
|
3692
|
+
class UntagResourceRequest < Struct.new(
|
3693
|
+
:resource_arn,
|
3694
|
+
:tag_keys)
|
3695
|
+
SENSITIVE = []
|
3696
|
+
include Aws::Structure
|
3697
|
+
end
|
3698
|
+
|
3699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UntagResourceResponse AWS API Documentation
|
3700
|
+
#
|
3701
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
3702
|
+
|
3175
3703
|
# @note When making an API call, you may pass UpdateDatasetGroupRequest
|
3176
3704
|
# data as a hash:
|
3177
3705
|
#
|