aws-sdk-forecastservice 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47c5be302516af22f5ed8d15fd0693158f3c643b466e061f167ead0fdb197dec
-  data.tar.gz: 57753a38f00308802d7378215da48681977bead8c61099a84e7dbecbd469671a
+  metadata.gz: 2a587c818057139037dfbbb41e988fce192d956badf1483f4dccbeb8464d6524
+  data.tar.gz: ad879ef3c6543efaa39c67a9237aadfe860f1aac3c648b639910fa769099eb89
 SHA512:
-  metadata.gz: 985391b7401ffa81e6a2c916c814b734f9aeb4e9d4fa519c7b7dc9edb11cf55104280b8858937b5ad7b1b60c4e3a42c2f2ec22d8c7d36762913d422d45d34cf8
-  data.tar.gz: 5b5f48e7719e315a3799be2e28150ca8f7254b0b8b2d66d9c9c0bab7930b52b9f601a0e5ac9dea7dd56c271449e8396a9ce75d7bc80375fd86d341cb0789d286
+  metadata.gz: b261917324858dd9620e203d5dd1ad29b963027644579968eac75128979014f92afac9939846f3debe157d714ddd5f86a404e58c0802cda55c57f58a99d0ba98
+  data.tar.gz: 41687118db951b177e18ddaf9e452af0a8ac63303c85aece33a3f8a3d813b6a083a77360a4a8777c50814e3e9bd552ddb57f753ced39fdc2c55411903198e2a1

data/lib/aws-sdk-forecastservice.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-forecastservice/customizations'
 # @!group service
 module Aws::ForecastService
 
-  GEM_VERSION = '1.13.0'
+  GEM_VERSION = '1.14.0'
 
 end

data/lib/aws-sdk-forecastservice/client.rb

@@ -459,7 +459,7 @@ module Aws::ForecastService
     #       attributes: [
     #         {
     #           attribute_name: "Name",
-    #           attribute_type: "string", # accepts string, integer, float, timestamp
+    #           attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
     #         },
     #       ],
     #     },
@@ -652,6 +652,34 @@ module Aws::ForecastService
     #   If the format isn't specified, Amazon Forecast expects the format to
     #   be "yyyy-MM-dd HH:mm:ss".
     #
+    # @option params [String] :time_zone
+    #   A single time zone for every item in your dataset. This option is
+    #   ideal for datasets with all timestamps within a single time zone, or
+    #   if all timestamps are normalized to a single time zone.
+    #
+    #   Refer to the [Joda-Time API][1] for a complete list of valid time zone
+    #   names.
+    #
+    #
+    #
+    #   [1]: http://joda-time.sourceforge.net/timezones.html
+    #
+    # @option params [Boolean] :use_geolocation_for_time_zone
+    #   Automatically derive time zone information from the geolocation
+    #   attribute. This option is ideal for datasets that contain timestamps
+    #   in multiple time zones and those timestamps are expressed in local
+    #   time.
+    #
+    # @option params [String] :geolocation_format
+    #   The format of the geolocation attribute. The geolocation attribute can
+    #   be formatted in one of two ways:
+    #
+    #   * `LAT_LONG` - the latitude and longitude in decimal format (Example:
+    #     47.61\_-122.33).
+    #
+    #   * `CC_POSTALCODE` (US Only) - the country code (US), followed by the
+    #     5-digit ZIP code (Example: US\_98121).
+    #
     # @option params [Array<Types::Tag>] :tags
     #   The optional metadata that you apply to the dataset import job to help
     #   you categorize and organize them. Each tag consists of a key and an
@@ -701,6 +729,9 @@ module Aws::ForecastService
     #       },
     #     },
     #     timestamp_format: "TimestampFormat",
+    #     time_zone: "TimeZone",
+    #     use_geolocation_for_time_zone: false,
+    #     geolocation_format: "GeolocationFormat",
     #     tags: [
     #       {
     #         key: "TagKey", # required
@@ -1231,13 +1262,26 @@ module Aws::ForecastService
     end
 
     # Exports backtest forecasts and accuracy metrics generated by the
-    # CreatePredictor operation. Two CSV files are exported to a specified
-    # S3 bucket.
+    # CreatePredictor operation. Two folders containing CSV files are
+    # exported to your specified S3 bucket.
     #
-    # You must specify a DataDestination object that includes an AWS
-    # Identity and Access Management (IAM) role that Amazon Forecast can
-    # assume to access the Amazon S3 bucket. For more information, see
-    # aws-forecast-iam-roles.
+    # The export file names will match the following conventions:
+    #
+    # `<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv`
+    #
+    # The &lt;ExportTimestamp&gt; component is in Java SimpleDate format
+    # (yyyy-MM-ddTHH-mm-ssZ).
+    #
+    # You must specify a DataDestination object that includes an Amazon S3
+    # bucket and an AWS Identity and Access Management (IAM) role that
+    # Amazon Forecast can assume to access the Amazon S3 bucket. For more
+    # information, see aws-forecast-iam-roles.
+    #
+    # <note markdown="1"> The `Status` of the export job must be `ACTIVE` before you can access
+    # the export in your Amazon S3 bucket. To get the status, use the
+    # DescribePredictorBacktestExportJob operation.
+    #
+    #  </note>
     #
     # @option params [required, String] :predictor_backtest_export_job_name
     #   The name for the backtest export job.
@@ -1247,9 +1291,9 @@ module Aws::ForecastService
     #   export.
     #
     # @option params [required, Types::DataDestination] :destination
-    #   The destination for an export job, an AWS Identity and Access
-    #   Management (IAM) role that allows Amazon Forecast to access the
-    #   location and, optionally, an AWS Key Management Service (KMS) key.
+    #   The destination for an export job. Provide an S3 path, an AWS Identity
+    #   and Access Management (IAM) role that allows Amazon Forecast to access
+    #   the location, and an AWS Key Management Service (KMS) key (optional).
     #
     # @option params [Array<Types::Tag>] :tags
     #   Optional metadata to help you categorize and organize your backtests.
@@ -1544,7 +1588,7 @@ module Aws::ForecastService
     #   resp.data_frequency #=> String
     #   resp.schema.attributes #=> Array
     #   resp.schema.attributes[0].attribute_name #=> String
-    #   resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp"
+    #   resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation"
     #   resp.encryption_config.role_arn #=> String
     #   resp.encryption_config.kms_key_arn #=> String
     #   resp.status #=> String
@@ -1642,6 +1686,9 @@ module Aws::ForecastService
     #   * {Types::DescribeDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
     #   * {Types::DescribeDatasetImportJobResponse#dataset_arn #dataset_arn} => String
     #   * {Types::DescribeDatasetImportJobResponse#timestamp_format #timestamp_format} => String
+    #   * {Types::DescribeDatasetImportJobResponse#time_zone #time_zone} => String
+    #   * {Types::DescribeDatasetImportJobResponse#use_geolocation_for_time_zone #use_geolocation_for_time_zone} => Boolean
+    #   * {Types::DescribeDatasetImportJobResponse#geolocation_format #geolocation_format} => String
     #   * {Types::DescribeDatasetImportJobResponse#data_source #data_source} => Types::DataSource
     #   * {Types::DescribeDatasetImportJobResponse#field_statistics #field_statistics} => Hash&lt;String,Types::Statistics&gt;
     #   * {Types::DescribeDatasetImportJobResponse#data_size #data_size} => Float
@@ -1662,6 +1709,9 @@ module Aws::ForecastService
     #   resp.dataset_import_job_arn #=> String
     #   resp.dataset_arn #=> String
     #   resp.timestamp_format #=> String
+    #   resp.time_zone #=> String
+    #   resp.use_geolocation_for_time_zone #=> Boolean
+    #   resp.geolocation_format #=> String
     #   resp.data_source.s3_config.path #=> String
     #   resp.data_source.s3_config.role_arn #=> String
     #   resp.data_source.s3_config.kms_key_arn #=> String
@@ -2726,7 +2776,7 @@ module Aws::ForecastService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-forecastservice'
-      context[:gem_version] = '1.13.0'
+      context[:gem_version] = '1.14.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-forecastservice/client_api.rb

@@ -93,6 +93,7 @@ module Aws::ForecastService
     ForecastTypes = Shapes::ListShape.new(name: 'ForecastTypes')
     Forecasts = Shapes::ListShape.new(name: 'Forecasts')
     Frequency = Shapes::StringShape.new(name: 'Frequency')
+    GeolocationFormat = Shapes::StringShape.new(name: 'GeolocationFormat')
     GetAccuracyMetricsRequest = Shapes::StructureShape.new(name: 'GetAccuracyMetricsRequest')
     GetAccuracyMetricsResponse = Shapes::StructureShape.new(name: 'GetAccuracyMetricsResponse')
     HyperParameterTuningJobConfig = Shapes::StructureShape.new(name: 'HyperParameterTuningJobConfig')
@@ -160,6 +161,7 @@ module Aws::ForecastService
     TestWindowDetails = Shapes::ListShape.new(name: 'TestWindowDetails')
     TestWindowSummary = Shapes::StructureShape.new(name: 'TestWindowSummary')
     TestWindows = Shapes::ListShape.new(name: 'TestWindows')
+    TimeZone = Shapes::StringShape.new(name: 'TimeZone')
     Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
     TimestampFormat = Shapes::StringShape.new(name: 'TimestampFormat')
     TrainingParameters = Shapes::MapShape.new(name: 'TrainingParameters')
@@ -167,6 +169,7 @@ module Aws::ForecastService
     UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
     UpdateDatasetGroupRequest = Shapes::StructureShape.new(name: 'UpdateDatasetGroupRequest')
     UpdateDatasetGroupResponse = Shapes::StructureShape.new(name: 'UpdateDatasetGroupResponse')
+    UseGeolocationForTimeZone = Shapes::BooleanShape.new(name: 'UseGeolocationForTimeZone')
     Value = Shapes::StringShape.new(name: 'Value')
     Values = Shapes::ListShape.new(name: 'Values')
     WeightedQuantileLoss = Shapes::StructureShape.new(name: 'WeightedQuantileLoss')
@@ -202,6 +205,9 @@ module Aws::ForecastService
     CreateDatasetImportJobRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DatasetArn"))
     CreateDatasetImportJobRequest.add_member(:data_source, Shapes::ShapeRef.new(shape: DataSource, required: true, location_name: "DataSource"))
     CreateDatasetImportJobRequest.add_member(:timestamp_format, Shapes::ShapeRef.new(shape: TimestampFormat, location_name: "TimestampFormat"))
+    CreateDatasetImportJobRequest.add_member(:time_zone, Shapes::ShapeRef.new(shape: TimeZone, location_name: "TimeZone"))
+    CreateDatasetImportJobRequest.add_member(:use_geolocation_for_time_zone, Shapes::ShapeRef.new(shape: UseGeolocationForTimeZone, location_name: "UseGeolocationForTimeZone"))
+    CreateDatasetImportJobRequest.add_member(:geolocation_format, Shapes::ShapeRef.new(shape: GeolocationFormat, location_name: "GeolocationFormat"))
     CreateDatasetImportJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
     CreateDatasetImportJobRequest.struct_class = Types::CreateDatasetImportJobRequest
 
@@ -340,6 +346,9 @@ module Aws::ForecastService
     DescribeDatasetImportJobResponse.add_member(:dataset_import_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DatasetImportJobArn"))
     DescribeDatasetImportJobResponse.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DatasetArn"))
     DescribeDatasetImportJobResponse.add_member(:timestamp_format, Shapes::ShapeRef.new(shape: TimestampFormat, location_name: "TimestampFormat"))
+    DescribeDatasetImportJobResponse.add_member(:time_zone, Shapes::ShapeRef.new(shape: TimeZone, location_name: "TimeZone"))
+    DescribeDatasetImportJobResponse.add_member(:use_geolocation_for_time_zone, Shapes::ShapeRef.new(shape: UseGeolocationForTimeZone, location_name: "UseGeolocationForTimeZone"))
+    DescribeDatasetImportJobResponse.add_member(:geolocation_format, Shapes::ShapeRef.new(shape: GeolocationFormat, location_name: "GeolocationFormat"))
     DescribeDatasetImportJobResponse.add_member(:data_source, Shapes::ShapeRef.new(shape: DataSource, location_name: "DataSource"))
     DescribeDatasetImportJobResponse.add_member(:field_statistics, Shapes::ShapeRef.new(shape: FieldStatistics, location_name: "FieldStatistics"))
     DescribeDatasetImportJobResponse.add_member(:data_size, Shapes::ShapeRef.new(shape: Double, location_name: "DataSize"))

data/lib/aws-sdk-forecastservice/types.rb

@@ -219,6 +219,9 @@ module Aws::ForecastService
     #           },
     #         },
     #         timestamp_format: "TimestampFormat",
+    #         time_zone: "TimeZone",
+    #         use_geolocation_for_time_zone: false,
+    #         geolocation_format: "GeolocationFormat",
     #         tags: [
     #           {
     #             key: "TagKey", # required
@@ -270,6 +273,37 @@ module Aws::ForecastService
     #   to be "yyyy-MM-dd HH:mm:ss".
     #   @return [String]
     #
+    # @!attribute [rw] time_zone
+    #   A single time zone for every item in your dataset. This option is
+    #   ideal for datasets with all timestamps within a single time zone, or
+    #   if all timestamps are normalized to a single time zone.
+    #
+    #   Refer to the [Joda-Time API][1] for a complete list of valid time
+    #   zone names.
+    #
+    #
+    #
+    #   [1]: http://joda-time.sourceforge.net/timezones.html
+    #   @return [String]
+    #
+    # @!attribute [rw] use_geolocation_for_time_zone
+    #   Automatically derive time zone information from the geolocation
+    #   attribute. This option is ideal for datasets that contain timestamps
+    #   in multiple time zones and those timestamps are expressed in local
+    #   time.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] geolocation_format
+    #   The format of the geolocation attribute. The geolocation attribute
+    #   can be formatted in one of two ways:
+    #
+    #   * `LAT_LONG` - the latitude and longitude in decimal format
+    #     (Example: 47.61\_-122.33).
+    #
+    #   * `CC_POSTALCODE` (US Only) - the country code (US), followed by the
+    #     5-digit ZIP code (Example: US\_98121).
+    #   @return [String]
+    #
     # @!attribute [rw] tags
     #   The optional metadata that you apply to the dataset import job to
     #   help you categorize and organize them. Each tag consists of a key
@@ -310,6 +344,9 @@ module Aws::ForecastService
       :dataset_arn,
       :data_source,
       :timestamp_format,
+      :time_zone,
+      :use_geolocation_for_time_zone,
+      :geolocation_format,
       :tags)
       SENSITIVE = []
       include Aws::Structure
@@ -339,7 +376,7 @@ module Aws::ForecastService
     #           attributes: [
     #             {
     #               attribute_name: "Name",
-    #               attribute_type: "string", # accepts string, integer, float, timestamp
+    #               attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
     #             },
     #           ],
     #         },
@@ -676,9 +713,10 @@ module Aws::ForecastService
     #   @return [String]
     #
     # @!attribute [rw] destination
-    #   The destination for an export job, an AWS Identity and Access
-    #   Management (IAM) role that allows Amazon Forecast to access the
-    #   location and, optionally, an AWS Key Management Service (KMS) key.
+    #   The destination for an export job. Provide an S3 path, an AWS
+    #   Identity and Access Management (IAM) role that allows Amazon
+    #   Forecast to access the location, and an AWS Key Management Service
+    #   (KMS) key (optional).
     #   @return [Types::DataDestination]
     #
     # @!attribute [rw] tags
@@ -1003,9 +1041,9 @@ module Aws::ForecastService
       include Aws::Structure
     end
 
-    # The destination for an export job, an AWS Identity and Access
-    # Management (IAM) role that allows Amazon Forecast to access the
-    # location and, optionally, an AWS Key Management Service (KMS) key.
+    # The destination for an export job. Provide an S3 path, an AWS Identity
+    # and Access Management (IAM) role that allows Amazon Forecast to access
+    # the location, and an AWS Key Management Service (KMS) key (optional).
     #
     # @note When making an API call, you may pass DataDestination
     #   data as a hash:
@@ -1472,6 +1510,20 @@ module Aws::ForecastService
     #     optionally, for: Y, M, W, and D
     #   @return [String]
     #
+    # @!attribute [rw] time_zone
+    #   The single time zone applied to every item in the dataset
+    #   @return [String]
+    #
+    # @!attribute [rw] use_geolocation_for_time_zone
+    #   Whether `TimeZone` is automatically derived from the geolocation
+    #   attribute.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] geolocation_format
+    #   The format of the geolocation attribute. Valid Values:`"LAT_LONG"`
+    #   and `"CC_POSTALCODE"`.
+    #   @return [String]
+    #
     # @!attribute [rw] data_source
     #   The location of the training data to import and an AWS Identity and
     #   Access Management (IAM) role that Amazon Forecast can assume to
@@ -1529,6 +1581,9 @@ module Aws::ForecastService
       :dataset_import_job_arn,
       :dataset_arn,
       :timestamp_format,
+      :time_zone,
+      :use_geolocation_for_time_zone,
+      :geolocation_format,
       :data_source,
       :field_statistics,
       :data_size,
@@ -1845,9 +1900,10 @@ module Aws::ForecastService
     #   @return [String]
     #
     # @!attribute [rw] destination
-    #   The destination for an export job, an AWS Identity and Access
-    #   Management (IAM) role that allows Amazon Forecast to access the
-    #   location and, optionally, an AWS Key Management Service (KMS) key.
+    #   The destination for an export job. Provide an S3 path, an AWS
+    #   Identity and Access Management (IAM) role that allows Amazon
+    #   Forecast to access the location, and an AWS Key Management Service
+    #   (KMS) key (optional).
     #   @return [Types::DataDestination]
     #
     # @!attribute [rw] message
@@ -3409,9 +3465,10 @@ module Aws::ForecastService
     #   @return [String]
     #
     # @!attribute [rw] destination
-    #   The destination for an export job, an AWS Identity and Access
-    #   Management (IAM) role that allows Amazon Forecast to access the
-    #   location and, optionally, an AWS Key Management Service (KMS) key.
+    #   The destination for an export job. Provide an S3 path, an AWS
+    #   Identity and Access Management (IAM) role that allows Amazon
+    #   Forecast to access the location, and an AWS Key Management Service
+    #   (KMS) key (optional).
     #   @return [Types::DataDestination]
     #
     # @!attribute [rw] status
@@ -3663,7 +3720,7 @@ module Aws::ForecastService
     #         attributes: [
     #           {
     #             attribute_name: "Name",
-    #             attribute_type: "string", # accepts string, integer, float, timestamp
+    #             attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
     #           },
     #         ],
     #       }
@@ -3690,7 +3747,7 @@ module Aws::ForecastService
     #
     #       {
     #         attribute_name: "Name",
-    #         attribute_type: "string", # accepts string, integer, float, timestamp
+    #         attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
     #       }
     #
     # @!attribute [rw] attribute_name
@@ -3761,16 +3818,30 @@ module Aws::ForecastService
     end
 
     # Describes a supplementary feature of a dataset group. This object is
-    # part of the InputDataConfig object.
+    # part of the InputDataConfig object. Forecast supports the Weather
+    # Index and Holidays built-in featurizations.
+    #
+    # **Weather Index**
     #
-    # The only supported feature is Holidays. If you use the calendar, all
-    # data in the datasets should belong to the same country as the
-    # calendar. For the holiday calendar data, see the [Jollyday][1]
-    # website.
+    # The Amazon Forecast Weather Index is a built-in featurization that
+    # incorporates historical and projected weather information into your
+    # model. The Weather Index supplements your datasets with over two years
+    # of historical weather data and up to 14 days of projected weather
+    # data. For more information, see [Amazon Forecast Weather Index][1].
     #
+    # **Holidays**
     #
+    # Holidays is a built-in featurization that incorporates a
+    # feature-engineered dataset of national holiday information into your
+    # model. It provides native support for the holiday calendars of 66
+    # countries. To view the holiday calendars, refer to the [Jollyday][2]
+    # library. For more information, see [Holidays Featurization][3].
     #
-    # [1]: http://jollyday.sourceforge.net/data.html
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/forecast/latest/dg/weather.html
+    # [2]: http://jollyday.sourceforge.net/data.html
+    # [3]: https://docs.aws.amazon.com/forecast/latest/dg/holidays.html
     #
     # @note When making an API call, you may pass SupplementaryFeature
     #   data as a hash:
@@ -3781,11 +3852,18 @@ module Aws::ForecastService
     #       }
     #
     # @!attribute [rw] name
-    #   The name of the feature. This must be "holiday".
+    #   The name of the feature. Valid values: `"holiday"` and `"weather"`.
     #   @return [String]
     #
     # @!attribute [rw] value
-    #   One of the following 2 letter country codes:
+    #   **Weather Index**
+    #
+    #   To enable the Weather Index, set the value to `"true"`
+    #
+    #   **Holidays**
+    #
+    #   To enable Holidays, specify a country with one of the following
+    #   two-letter country codes:
     #
     #   * "AL" - ALBANIA
     #
@@ -3984,7 +4062,7 @@ module Aws::ForecastService
     class Tag < Struct.new(
       :key,
       :value)
-      SENSITIVE = []
+      SENSITIVE = [:key, :value]
       include Aws::Structure
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-forecastservice
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2020-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core