aws-sdk-forecastservice 1.7.0 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0b33b2df043658be3452db69e5c2ff2872f96f80a08a22a311d6542049761143
4
- data.tar.gz: 21f8d3f82ddddd9e0ea8b00a2a6ab062aa3cd31a641683e58a6668e7fa0a00c7
3
+ metadata.gz: 56e4be6cf1f6ca160b821a0c1eb0c42189f0a24cef070bc3a478a39610ae4faf
4
+ data.tar.gz: cb0e149d1db7ca1701f60e818d538fdb270e4d34920a485ddcac57deef526175
5
5
  SHA512:
6
- metadata.gz: d75c1b68aa5ee56c5331b93c915f2af0a521a36b84e7aac5cfd3c76978df29cf8db2c2cc3917f98f437f5a367a8ae779f15bc6e970e980a7225c2ed899679d63
7
- data.tar.gz: 3a731b75771270636d14b0106da450567b7cb0978f675b0c602b7c2c6d7efd261cabb90362a8cf489a1981a33b27ce2e9eea9c309f98824fdf4dc01bc9604239
6
+ metadata.gz: 64b03aa27a932a29bee9b89985b1bf2582ae31e3610fc1b4bba4fba54db0877b3aa781ba8c75f7cf9f6738c779c6cca65477100b3c4ee59518a9cfe914a8d066
7
+ data.tar.gz: 6cdc9e52a6f559c0f1643dfd9e2fc42eed4d137aeb99f13188979b39671e3e7a3085c3335bdadf422ab1ffb4cd6af7b3c657eea13f244ec712959c9d6abb9984
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-forecastservice/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::ForecastService
49
50
 
50
- GEM_VERSION = '1.7.0'
51
+ GEM_VERSION = '1.12.0'
51
52
 
52
53
  end
@@ -85,13 +85,28 @@ module Aws::ForecastService
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::ForecastService
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -356,7 +371,7 @@ module Aws::ForecastService
356
371
  #
357
372
  #
358
373
  #
359
- # [1]: https://github.com/aws-samples/amazon-forecast-samples/tree/master/data
374
+ # [1]: https://github.com/aws-samples/amazon-forecast-samples
360
375
  #
361
376
  # @option params [required, String] :dataset_name
362
377
  # A name for the dataset.
@@ -397,6 +412,38 @@ module Aws::ForecastService
397
412
  # Access Management (IAM) role that Amazon Forecast can assume to access
398
413
  # the key.
399
414
  #
415
+ # @option params [Array<Types::Tag>] :tags
416
+ # The optional metadata that you apply to the dataset to help you
417
+ # categorize and organize them. Each tag consists of a key and an
418
+ # optional value, both of which you define.
419
+ #
420
+ # The following basic restrictions apply to tags:
421
+ #
422
+ # * Maximum number of tags per resource - 50.
423
+ #
424
+ # * For each resource, each tag key must be unique, and each tag key can
425
+ # have only one value.
426
+ #
427
+ # * Maximum key length - 128 Unicode characters in UTF-8.
428
+ #
429
+ # * Maximum value length - 256 Unicode characters in UTF-8.
430
+ #
431
+ # * If your tagging schema is used across multiple services and
432
+ # resources, remember that other services may have restrictions on
433
+ # allowed characters. Generally allowed characters are: letters,
434
+ # numbers, and spaces representable in UTF-8, and the following
435
+ # characters: + - = . \_ : / @.
436
+ #
437
+ # * Tag keys and values are case sensitive.
438
+ #
439
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
440
+ # such as a prefix for keys as it is reserved for AWS use. You cannot
441
+ # edit or delete tag keys with this prefix. Values can have this
442
+ # prefix. If a tag value has `aws` as its prefix but the key does not,
443
+ # then Forecast considers it to be a user tag and will count against
444
+ # the limit of 50 tags. Tags with only the key prefix of `aws` do not
445
+ # count against your tags per resource limit.
446
+ #
400
447
  # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
401
448
  #
402
449
  # * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
@@ -420,6 +467,12 @@ module Aws::ForecastService
420
467
  # role_arn: "Arn", # required
421
468
  # kms_key_arn: "KMSKeyArn", # required
422
469
  # },
470
+ # tags: [
471
+ # {
472
+ # key: "TagKey", # required
473
+ # value: "TagValue", # required
474
+ # },
475
+ # ],
423
476
  # })
424
477
  #
425
478
  # @example Response structure
@@ -446,9 +499,9 @@ module Aws::ForecastService
446
499
  # To get a list of all your datasets groups, use the ListDatasetGroups
447
500
  # operation.
448
501
  #
449
- # <note markdown="1"> The `Status` of a dataset group must be `ACTIVE` before you can create
450
- # use the dataset group to create a predictor. To get the status, use
451
- # the DescribeDatasetGroup operation.
502
+ # <note markdown="1"> The `Status` of a dataset group must be `ACTIVE` before you can use
503
+ # the dataset group to create a predictor. To get the status, use the
504
+ # DescribeDatasetGroup operation.
452
505
  #
453
506
  # </note>
454
507
  #
@@ -471,6 +524,38 @@ module Aws::ForecastService
471
524
  # An array of Amazon Resource Names (ARNs) of the datasets that you want
472
525
  # to include in the dataset group.
473
526
  #
527
+ # @option params [Array<Types::Tag>] :tags
528
+ # The optional metadata that you apply to the dataset group to help you
529
+ # categorize and organize them. Each tag consists of a key and an
530
+ # optional value, both of which you define.
531
+ #
532
+ # The following basic restrictions apply to tags:
533
+ #
534
+ # * Maximum number of tags per resource - 50.
535
+ #
536
+ # * For each resource, each tag key must be unique, and each tag key can
537
+ # have only one value.
538
+ #
539
+ # * Maximum key length - 128 Unicode characters in UTF-8.
540
+ #
541
+ # * Maximum value length - 256 Unicode characters in UTF-8.
542
+ #
543
+ # * If your tagging schema is used across multiple services and
544
+ # resources, remember that other services may have restrictions on
545
+ # allowed characters. Generally allowed characters are: letters,
546
+ # numbers, and spaces representable in UTF-8, and the following
547
+ # characters: + - = . \_ : / @.
548
+ #
549
+ # * Tag keys and values are case sensitive.
550
+ #
551
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
552
+ # such as a prefix for keys as it is reserved for AWS use. You cannot
553
+ # edit or delete tag keys with this prefix. Values can have this
554
+ # prefix. If a tag value has `aws` as its prefix but the key does not,
555
+ # then Forecast considers it to be a user tag and will count against
556
+ # the limit of 50 tags. Tags with only the key prefix of `aws` do not
557
+ # count against your tags per resource limit.
558
+ #
474
559
  # @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
475
560
  #
476
561
  # * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
@@ -481,6 +566,12 @@ module Aws::ForecastService
481
566
  # dataset_group_name: "Name", # required
482
567
  # domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
483
568
  # dataset_arns: ["Arn"],
569
+ # tags: [
570
+ # {
571
+ # key: "TagKey", # required
572
+ # value: "TagValue", # required
573
+ # },
574
+ # ],
484
575
  # })
485
576
  #
486
577
  # @example Response structure
@@ -503,7 +594,9 @@ module Aws::ForecastService
503
594
  #
504
595
  # You must specify a DataSource object that includes an AWS Identity and
505
596
  # Access Management (IAM) role that Amazon Forecast can assume to access
506
- # the data. For more information, see aws-forecast-iam-roles.
597
+ # the data, as Amazon Forecast makes a copy of your data and processes
598
+ # it in an internal AWS system. For more information, see
599
+ # aws-forecast-iam-roles.
507
600
  #
508
601
  # The training data must be in CSV format. The delimiter must be a comma
509
602
  # (,).
@@ -512,6 +605,12 @@ module Aws::ForecastService
512
605
  # a folder in the S3 bucket. For the latter two cases, Amazon Forecast
513
606
  # imports all files up to the limit of 10,000 files.
514
607
  #
608
+ # Because dataset imports are not aggregated, your most recent dataset
609
+ # import is the one that is used when training a predictor or generating
610
+ # a forecast. Make sure that your most recent dataset import contains
611
+ # all of the data you want to model off of, and not just the new data
612
+ # collected since the previous import.
613
+ #
515
614
  # To get a list of all your dataset import jobs, filtered by specified
516
615
  # criteria, use the ListDatasetImportJobs operation.
517
616
  #
@@ -553,6 +652,38 @@ module Aws::ForecastService
553
652
  # If the format isn't specified, Amazon Forecast expects the format to
554
653
  # be "yyyy-MM-dd HH:mm:ss".
555
654
  #
655
+ # @option params [Array<Types::Tag>] :tags
656
+ # The optional metadata that you apply to the dataset import job to help
657
+ # you categorize and organize them. Each tag consists of a key and an
658
+ # optional value, both of which you define.
659
+ #
660
+ # The following basic restrictions apply to tags:
661
+ #
662
+ # * Maximum number of tags per resource - 50.
663
+ #
664
+ # * For each resource, each tag key must be unique, and each tag key can
665
+ # have only one value.
666
+ #
667
+ # * Maximum key length - 128 Unicode characters in UTF-8.
668
+ #
669
+ # * Maximum value length - 256 Unicode characters in UTF-8.
670
+ #
671
+ # * If your tagging schema is used across multiple services and
672
+ # resources, remember that other services may have restrictions on
673
+ # allowed characters. Generally allowed characters are: letters,
674
+ # numbers, and spaces representable in UTF-8, and the following
675
+ # characters: + - = . \_ : / @.
676
+ #
677
+ # * Tag keys and values are case sensitive.
678
+ #
679
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
680
+ # such as a prefix for keys as it is reserved for AWS use. You cannot
681
+ # edit or delete tag keys with this prefix. Values can have this
682
+ # prefix. If a tag value has `aws` as its prefix but the key does not,
683
+ # then Forecast considers it to be a user tag and will count against
684
+ # the limit of 50 tags. Tags with only the key prefix of `aws` do not
685
+ # count against your tags per resource limit.
686
+ #
556
687
  # @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
557
688
  #
558
689
  # * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
@@ -570,6 +701,12 @@ module Aws::ForecastService
570
701
  # },
571
702
  # },
572
703
  # timestamp_format: "TimestampFormat",
704
+ # tags: [
705
+ # {
706
+ # key: "TagKey", # required
707
+ # value: "TagValue", # required
708
+ # },
709
+ # ],
573
710
  # })
574
711
  #
575
712
  # @example Response structure
@@ -593,10 +730,9 @@ module Aws::ForecastService
593
730
  # operation.
594
731
  #
595
732
  # The range of the forecast is determined by the `ForecastHorizon`
596
- # value, which you specify in the CreatePredictor request, multiplied by
597
- # the `DataFrequency` value, which you specify in the CreateDataset
598
- # request. When you query a forecast, you can request a specific date
599
- # range within the forecast.
733
+ # value, which you specify in the CreatePredictor request. When you
734
+ # query a forecast, you can request a specific date range within the
735
+ # forecast.
600
736
  #
601
737
  # To get a list of all your forecasts, use the ListForecasts operation.
602
738
  #
@@ -621,12 +757,44 @@ module Aws::ForecastService
621
757
  # forecast.
622
758
  #
623
759
  # @option params [Array<String>] :forecast_types
624
- # The quantiles at which probabilistic forecasts are generated. You can
625
- # specify up to 5 quantiles per forecast. Accepted values include `0.01
626
- # to 0.99` (increments of .01 only) and `mean`. The mean forecast is
627
- # different from the median (0.50) when the distribution is not
628
- # symmetric (e.g. Beta, Negative Binomial). The default value is
629
- # `["0.1", "0.5", "0.9"]`.
760
+ # The quantiles at which probabilistic forecasts are generated. **You
761
+ # can currently specify up to 5 quantiles per forecast**. Accepted
762
+ # values include `0.01 to 0.99` (increments of .01 only) and `mean`. The
763
+ # mean forecast is different from the median (0.50) when the
764
+ # distribution is not symmetric (for example, Beta and Negative
765
+ # Binomial). The default value is `["0.1", "0.5", "0.9"]`.
766
+ #
767
+ # @option params [Array<Types::Tag>] :tags
768
+ # The optional metadata that you apply to the forecast to help you
769
+ # categorize and organize them. Each tag consists of a key and an
770
+ # optional value, both of which you define.
771
+ #
772
+ # The following basic restrictions apply to tags:
773
+ #
774
+ # * Maximum number of tags per resource - 50.
775
+ #
776
+ # * For each resource, each tag key must be unique, and each tag key can
777
+ # have only one value.
778
+ #
779
+ # * Maximum key length - 128 Unicode characters in UTF-8.
780
+ #
781
+ # * Maximum value length - 256 Unicode characters in UTF-8.
782
+ #
783
+ # * If your tagging schema is used across multiple services and
784
+ # resources, remember that other services may have restrictions on
785
+ # allowed characters. Generally allowed characters are: letters,
786
+ # numbers, and spaces representable in UTF-8, and the following
787
+ # characters: + - = . \_ : / @.
788
+ #
789
+ # * Tag keys and values are case sensitive.
790
+ #
791
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
792
+ # such as a prefix for keys as it is reserved for AWS use. You cannot
793
+ # edit or delete tag keys with this prefix. Values can have this
794
+ # prefix. If a tag value has `aws` as its prefix but the key does not,
795
+ # then Forecast considers it to be a user tag and will count against
796
+ # the limit of 50 tags. Tags with only the key prefix of `aws` do not
797
+ # count against your tags per resource limit.
630
798
  #
631
799
  # @return [Types::CreateForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
632
800
  #
@@ -638,6 +806,12 @@ module Aws::ForecastService
638
806
  # forecast_name: "Name", # required
639
807
  # predictor_arn: "Arn", # required
640
808
  # forecast_types: ["ForecastType"],
809
+ # tags: [
810
+ # {
811
+ # key: "TagKey", # required
812
+ # value: "TagValue", # required
813
+ # },
814
+ # ],
641
815
  # })
642
816
  #
643
817
  # @example Response structure
@@ -657,7 +831,7 @@ module Aws::ForecastService
657
831
  # Amazon Simple Storage Service (Amazon S3) bucket. The forecast file
658
832
  # name will match the following conventions:
659
833
  #
660
- # &lt;ForecastExportJobName&gt;\_&lt;ExportTimestamp&gt;\_&lt;PageNumber&gt;
834
+ # &lt;ForecastExportJobName&gt;\_&lt;ExportTimestamp&gt;\_&lt;PartNumber&gt;
661
835
  #
662
836
  # where the &lt;ExportTimestamp&gt; component is in Java
663
837
  # SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
@@ -695,6 +869,38 @@ module Aws::ForecastService
695
869
  # Management Service (KMS) key. The IAM role must allow Amazon Forecast
696
870
  # permission to access the key.
697
871
  #
872
+ # @option params [Array<Types::Tag>] :tags
873
+ # The optional metadata that you apply to the forecast export job to
874
+ # help you categorize and organize them. Each tag consists of a key and
875
+ # an optional value, both of which you define.
876
+ #
877
+ # The following basic restrictions apply to tags:
878
+ #
879
+ # * Maximum number of tags per resource - 50.
880
+ #
881
+ # * For each resource, each tag key must be unique, and each tag key can
882
+ # have only one value.
883
+ #
884
+ # * Maximum key length - 128 Unicode characters in UTF-8.
885
+ #
886
+ # * Maximum value length - 256 Unicode characters in UTF-8.
887
+ #
888
+ # * If your tagging schema is used across multiple services and
889
+ # resources, remember that other services may have restrictions on
890
+ # allowed characters. Generally allowed characters are: letters,
891
+ # numbers, and spaces representable in UTF-8, and the following
892
+ # characters: + - = . \_ : / @.
893
+ #
894
+ # * Tag keys and values are case sensitive.
895
+ #
896
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
897
+ # such as a prefix for keys as it is reserved for AWS use. You cannot
898
+ # edit or delete tag keys with this prefix. Values can have this
899
+ # prefix. If a tag value has `aws` as its prefix but the key does not,
900
+ # then Forecast considers it to be a user tag and will count against
901
+ # the limit of 50 tags. Tags with only the key prefix of `aws` do not
902
+ # count against your tags per resource limit.
903
+ #
698
904
  # @return [Types::CreateForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
699
905
  #
700
906
  # * {Types::CreateForecastExportJobResponse#forecast_export_job_arn #forecast_export_job_arn} => String
@@ -711,6 +917,12 @@ module Aws::ForecastService
711
917
  # kms_key_arn: "KMSKeyArn",
712
918
  # },
713
919
  # },
920
+ # tags: [
921
+ # {
922
+ # key: "TagKey", # required
923
+ # value: "TagValue", # required
924
+ # },
925
+ # ],
714
926
  # })
715
927
  #
716
928
  # @example Response structure
@@ -728,24 +940,20 @@ module Aws::ForecastService
728
940
 
729
941
  # Creates an Amazon Forecast predictor.
730
942
  #
731
- # In the request, you provide a dataset group and either specify an
732
- # algorithm or let Amazon Forecast choose the algorithm for you using
943
+ # In the request, provide a dataset group and either specify an
944
+ # algorithm or let Amazon Forecast choose an algorithm for you using
733
945
  # AutoML. If you specify an algorithm, you also can override
734
946
  # algorithm-specific hyperparameters.
735
947
  #
736
- # Amazon Forecast uses the chosen algorithm to train a model using the
737
- # latest version of the datasets in the specified dataset group. The
738
- # result is called a predictor. You then generate a forecast using the
739
- # CreateForecast operation.
948
+ # Amazon Forecast uses the algorithm to train a predictor using the
949
+ # latest version of the datasets in the specified dataset group. You can
950
+ # then generate a forecast using the CreateForecast operation.
740
951
  #
741
- # After training a model, the `CreatePredictor` operation also evaluates
742
- # it. To see the evaluation metrics, use the GetAccuracyMetrics
743
- # operation. Always review the evaluation metrics before deciding to use
744
- # the predictor to generate a forecast.
952
+ # To see the evaluation metrics, use the GetAccuracyMetrics operation.
745
953
  #
746
- # Optionally, you can specify a featurization configuration to fill and
747
- # aggregate the data fields in the `TARGET_TIME_SERIES` dataset to
748
- # improve model training. For more information, see FeaturizationConfig.
954
+ # You can specify a featurization configuration to fill and aggregate
955
+ # the data fields in the `TARGET_TIME_SERIES` dataset to improve model
956
+ # training. For more information, see FeaturizationConfig.
749
957
  #
750
958
  # For RELATED\_TIME\_SERIES datasets, `CreatePredictor` verifies that
751
959
  # the `DataFrequency` specified when the dataset was created matches the
@@ -753,12 +961,17 @@ module Aws::ForecastService
753
961
  # restriction. Amazon Forecast also verifies the delimiter and timestamp
754
962
  # format. For more information, see howitworks-datasets-groups.
755
963
  #
964
+ # By default, predictors are trained and evaluated at the 0.1 (P10), 0.5
965
+ # (P50), and 0.9 (P90) quantiles. You can choose custom forecast types
966
+ # to train and evaluate your predictor by setting the `ForecastTypes`.
967
+ #
756
968
  # **AutoML**
757
969
  #
758
970
  # If you want Amazon Forecast to evaluate each algorithm and choose the
759
971
  # one that minimizes the `objective function`, set `PerformAutoML` to
760
972
  # `true`. The `objective function` is defined as the mean of the
761
- # weighted p10, p50, and p90 quantile losses. For more information, see
973
+ # weighted losses over the forecast types. By default, these are the
974
+ # p10, p50, and p90 quantile losses. For more information, see
762
975
  # EvaluationResult.
763
976
  #
764
977
  # When AutoML is enabled, the following properties are disallowed:
@@ -791,9 +1004,9 @@ module Aws::ForecastService
791
1004
  #
792
1005
  # * `arn:aws:forecast:::algorithm/ARIMA`
793
1006
  #
794
- # * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
1007
+ # * `arn:aws:forecast:::algorithm/CNN-QR`
795
1008
  #
796
- # Supports hyperparameter optimization (HPO)
1009
+ # * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
797
1010
  #
798
1011
  # * `arn:aws:forecast:::algorithm/ETS`
799
1012
  #
@@ -813,6 +1026,14 @@ module Aws::ForecastService
813
1026
  # The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of
814
1027
  # the TARGET\_TIME\_SERIES dataset length.
815
1028
  #
1029
+ # @option params [Array<String>] :forecast_types
1030
+ # Specifies the forecast types used to train a predictor. You can
1031
+ # specify up to five forecast types. Forecast types can be quantiles
1032
+ # from 0.01 to 0.99, by increments of 0.01 or higher. You can also
1033
+ # specify the mean forecast with `mean`.
1034
+ #
1035
+ # The default value is `["0.10", "0.50", "0.9"]`.
1036
+ #
816
1037
  # @option params [Boolean] :perform_auto_ml
817
1038
  # Whether to perform AutoML. When Amazon Forecast performs AutoML, it
818
1039
  # evaluates the algorithms it provides and chooses the best algorithm
@@ -840,11 +1061,11 @@ module Aws::ForecastService
840
1061
  # hyperparameter. In this case, you are required to specify an algorithm
841
1062
  # and `PerformAutoML` must be false.
842
1063
  #
843
- # The following algorithm supports HPO:
1064
+ # The following algorithms support HPO:
844
1065
  #
845
1066
  # * DeepAR+
846
1067
  #
847
- # ^
1068
+ # * CNN-QR
848
1069
  #
849
1070
  # @option params [Hash<String,String>] :training_parameters
850
1071
  # The hyperparameters to override for model training. The
@@ -880,6 +1101,38 @@ module Aws::ForecastService
880
1101
  # Access Management (IAM) role that Amazon Forecast can assume to access
881
1102
  # the key.
882
1103
  #
1104
+ # @option params [Array<Types::Tag>] :tags
1105
+ # The optional metadata that you apply to the predictor to help you
1106
+ # categorize and organize them. Each tag consists of a key and an
1107
+ # optional value, both of which you define.
1108
+ #
1109
+ # The following basic restrictions apply to tags:
1110
+ #
1111
+ # * Maximum number of tags per resource - 50.
1112
+ #
1113
+ # * For each resource, each tag key must be unique, and each tag key can
1114
+ # have only one value.
1115
+ #
1116
+ # * Maximum key length - 128 Unicode characters in UTF-8.
1117
+ #
1118
+ # * Maximum value length - 256 Unicode characters in UTF-8.
1119
+ #
1120
+ # * If your tagging schema is used across multiple services and
1121
+ # resources, remember that other services may have restrictions on
1122
+ # allowed characters. Generally allowed characters are: letters,
1123
+ # numbers, and spaces representable in UTF-8, and the following
1124
+ # characters: + - = . \_ : / @.
1125
+ #
1126
+ # * Tag keys and values are case sensitive.
1127
+ #
1128
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
1129
+ # such as a prefix for keys as it is reserved for AWS use. You cannot
1130
+ # edit or delete tag keys with this prefix. Values can have this
1131
+ # prefix. If a tag value has `aws` as its prefix but the key does not,
1132
+ # then Forecast considers it to be a user tag and will count against
1133
+ # the limit of 50 tags. Tags with only the key prefix of `aws` do not
1134
+ # count against your tags per resource limit.
1135
+ #
883
1136
  # @return [Types::CreatePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
884
1137
  #
885
1138
  # * {Types::CreatePredictorResponse#predictor_arn #predictor_arn} => String
@@ -890,6 +1143,7 @@ module Aws::ForecastService
890
1143
  # predictor_name: "Name", # required
891
1144
  # algorithm_arn: "Arn",
892
1145
  # forecast_horizon: 1, # required
1146
+ # forecast_types: ["ForecastType"],
893
1147
  # perform_auto_ml: false,
894
1148
  # perform_hpo: false,
895
1149
  # training_parameters: {
@@ -955,6 +1209,12 @@ module Aws::ForecastService
955
1209
  # role_arn: "Arn", # required
956
1210
  # kms_key_arn: "KMSKeyArn", # required
957
1211
  # },
1212
+ # tags: [
1213
+ # {
1214
+ # key: "TagKey", # required
1215
+ # value: "TagValue", # required
1216
+ # },
1217
+ # ],
958
1218
  # })
959
1219
  #
960
1220
  # @example Response structure
@@ -975,6 +1235,12 @@ module Aws::ForecastService
975
1235
  # status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
976
1236
  # DescribeDataset operation.
977
1237
  #
1238
+ # <note markdown="1"> Forecast does not automatically update any dataset groups that contain
1239
+ # the deleted dataset. In order to update the dataset group, use the
1240
+ # operation, omitting the deleted dataset's ARN.
1241
+ #
1242
+ # </note>
1243
+ #
978
1244
  # @option params [required, String] :dataset_arn
979
1245
  # The Amazon Resource Name (ARN) of the dataset to delete.
980
1246
  #
@@ -1460,6 +1726,7 @@ module Aws::ForecastService
1460
1726
  # * {Types::DescribePredictorResponse#predictor_name #predictor_name} => String
1461
1727
  # * {Types::DescribePredictorResponse#algorithm_arn #algorithm_arn} => String
1462
1728
  # * {Types::DescribePredictorResponse#forecast_horizon #forecast_horizon} => Integer
1729
+ # * {Types::DescribePredictorResponse#forecast_types #forecast_types} => Array&lt;String&gt;
1463
1730
  # * {Types::DescribePredictorResponse#perform_auto_ml #perform_auto_ml} => Boolean
1464
1731
  # * {Types::DescribePredictorResponse#perform_hpo #perform_hpo} => Boolean
1465
1732
  # * {Types::DescribePredictorResponse#training_parameters #training_parameters} => Hash&lt;String,String&gt;
@@ -1488,6 +1755,8 @@ module Aws::ForecastService
1488
1755
  # resp.predictor_name #=> String
1489
1756
  # resp.algorithm_arn #=> String
1490
1757
  # resp.forecast_horizon #=> Integer
1758
+ # resp.forecast_types #=> Array
1759
+ # resp.forecast_types[0] #=> String
1491
1760
  # resp.perform_auto_ml #=> Boolean
1492
1761
  # resp.perform_hpo #=> Boolean
1493
1762
  # resp.training_parameters #=> Hash
@@ -1551,7 +1820,7 @@ module Aws::ForecastService
1551
1820
  # Provides metrics on the accuracy of the models that were trained by
1552
1821
  # the CreatePredictor operation. Use metrics to see how well the model
1553
1822
  # performed and to decide whether to use the predictor to generate a
1554
- # forecast. For more information, see metrics.
1823
+ # forecast. For more information, see [Predictor Metrics][1].
1555
1824
  #
1556
1825
  # This operation generates metrics for each backtest window that was
1557
1826
  # evaluated. The number of backtest windows (`NumberOfBacktestWindows`)
@@ -1572,6 +1841,10 @@ module Aws::ForecastService
1572
1841
  #
1573
1842
  # </note>
1574
1843
  #
1844
+ #
1845
+ #
1846
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
1847
+ #
1575
1848
  # @option params [required, String] :predictor_arn
1576
1849
  # The Amazon Resource Name (ARN) of the predictor to get metrics for.
1577
1850
  #
@@ -1598,6 +1871,10 @@ module Aws::ForecastService
1598
1871
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses #=> Array
1599
1872
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].quantile #=> Float
1600
1873
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].loss_value #=> Float
1874
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics #=> Array
1875
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].forecast_type #=> String
1876
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].wape #=> Float
1877
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].rmse #=> Float
1601
1878
  #
1602
1879
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics AWS API Documentation
1603
1880
  #
@@ -2031,6 +2308,132 @@ module Aws::ForecastService
2031
2308
  req.send_request(options)
2032
2309
  end
2033
2310
 
2311
+ # Lists the tags for an Amazon Forecast resource.
2312
+ #
2313
+ # @option params [required, String] :resource_arn
2314
+ # The Amazon Resource Name (ARN) that identifies the resource for which
2315
+ # to list the tags. Currently, the supported resources are Forecast
2316
+ # dataset groups, datasets, dataset import jobs, predictors, forecasts,
2317
+ # and forecast export jobs.
2318
+ #
2319
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2320
+ #
2321
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
2322
+ #
2323
+ # @example Request syntax with placeholder values
2324
+ #
2325
+ # resp = client.list_tags_for_resource({
2326
+ # resource_arn: "Arn", # required
2327
+ # })
2328
+ #
2329
+ # @example Response structure
2330
+ #
2331
+ # resp.tags #=> Array
2332
+ # resp.tags[0].key #=> String
2333
+ # resp.tags[0].value #=> String
2334
+ #
2335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResource AWS API Documentation
2336
+ #
2337
+ # @overload list_tags_for_resource(params = {})
2338
+ # @param [Hash] params ({})
2339
+ def list_tags_for_resource(params = {}, options = {})
2340
+ req = build_request(:list_tags_for_resource, params)
2341
+ req.send_request(options)
2342
+ end
2343
+
2344
+ # Associates the specified tags to a resource with the specified
2345
+ # `resourceArn`. If existing tags on a resource are not specified in the
2346
+ # request parameters, they are not changed. When a resource is deleted,
2347
+ # the tags associated with that resource are also deleted.
2348
+ #
2349
+ # @option params [required, String] :resource_arn
2350
+ # The Amazon Resource Name (ARN) that identifies the resource for which
2351
+ # to list the tags. Currently, the supported resources are Forecast
2352
+ # dataset groups, datasets, dataset import jobs, predictors, forecasts,
2353
+ # and forecast export jobs.
2354
+ #
2355
+ # @option params [required, Array<Types::Tag>] :tags
2356
+ # The tags to add to the resource. A tag is an array of key-value pairs.
2357
+ #
2358
+ # The following basic restrictions apply to tags:
2359
+ #
2360
+ # * Maximum number of tags per resource - 50.
2361
+ #
2362
+ # * For each resource, each tag key must be unique, and each tag key can
2363
+ # have only one value.
2364
+ #
2365
+ # * Maximum key length - 128 Unicode characters in UTF-8.
2366
+ #
2367
+ # * Maximum value length - 256 Unicode characters in UTF-8.
2368
+ #
2369
+ # * If your tagging schema is used across multiple services and
2370
+ # resources, remember that other services may have restrictions on
2371
+ # allowed characters. Generally allowed characters are: letters,
2372
+ # numbers, and spaces representable in UTF-8, and the following
2373
+ # characters: + - = . \_ : / @.
2374
+ #
2375
+ # * Tag keys and values are case sensitive.
2376
+ #
2377
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
2378
+ # such as a prefix for keys as it is reserved for AWS use. You cannot
2379
+ # edit or delete tag keys with this prefix. Values can have this
2380
+ # prefix. If a tag value has `aws` as its prefix but the key does not,
2381
+ # then Forecast considers it to be a user tag and will count against
2382
+ # the limit of 50 tags. Tags with only the key prefix of `aws` do not
2383
+ # count against your tags per resource limit.
2384
+ #
2385
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2386
+ #
2387
+ # @example Request syntax with placeholder values
2388
+ #
2389
+ # resp = client.tag_resource({
2390
+ # resource_arn: "Arn", # required
2391
+ # tags: [ # required
2392
+ # {
2393
+ # key: "TagKey", # required
2394
+ # value: "TagValue", # required
2395
+ # },
2396
+ # ],
2397
+ # })
2398
+ #
2399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResource AWS API Documentation
2400
+ #
2401
+ # @overload tag_resource(params = {})
2402
+ # @param [Hash] params ({})
2403
+ def tag_resource(params = {}, options = {})
2404
+ req = build_request(:tag_resource, params)
2405
+ req.send_request(options)
2406
+ end
2407
+
2408
+ # Deletes the specified tags from a resource.
2409
+ #
2410
+ # @option params [required, String] :resource_arn
2411
+ # The Amazon Resource Name (ARN) that identifies the resource for which
2412
+ # to list the tags. Currently, the supported resources are Forecast
2413
+ # dataset groups, datasets, dataset import jobs, predictors, forecasts,
2414
+ # and forecast exports.
2415
+ #
2416
+ # @option params [required, Array<String>] :tag_keys
2417
+ # The keys of the tags to be removed.
2418
+ #
2419
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2420
+ #
2421
+ # @example Request syntax with placeholder values
2422
+ #
2423
+ # resp = client.untag_resource({
2424
+ # resource_arn: "Arn", # required
2425
+ # tag_keys: ["TagKey"], # required
2426
+ # })
2427
+ #
2428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UntagResource AWS API Documentation
2429
+ #
2430
+ # @overload untag_resource(params = {})
2431
+ # @param [Hash] params ({})
2432
+ def untag_resource(params = {}, options = {})
2433
+ req = build_request(:untag_resource, params)
2434
+ req.send_request(options)
2435
+ end
2436
+
2034
2437
  # Replaces the datasets in a dataset group with the specified datasets.
2035
2438
  #
2036
2439
  # <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can use
@@ -2077,7 +2480,7 @@ module Aws::ForecastService
2077
2480
  params: params,
2078
2481
  config: config)
2079
2482
  context[:gem_name] = 'aws-sdk-forecastservice'
2080
- context[:gem_version] = '1.7.0'
2483
+ context[:gem_version] = '1.12.0'
2081
2484
  Seahorse::Client::Request.new(handlers, context)
2082
2485
  end
2083
2486