# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/invocation_id.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/checksum_algorithm.rb' require 'aws-sdk-core/plugins/request_compression.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/recursion_detection.rb' require 'aws-sdk-core/plugins/sign.rb' require 'aws-sdk-core/plugins/protocols/json_rpc.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:forecastservice) module Aws::ForecastService # An API client for ForecastService. To construct a client, you need to configure a `:region` and `:credentials`. # # client = Aws::ForecastService::Client.new( # region: region_name, # credentials: credentials, # # ... # ) # # For details on configuring region and credentials see # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :forecastservice set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::InvocationId) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::ChecksumAlgorithm) add_plugin(Aws::Plugins::RequestCompression) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::RecursionDetection) add_plugin(Aws::Plugins::Sign) add_plugin(Aws::Plugins::Protocols::JsonRpc) add_plugin(Aws::ForecastService::Plugins::Endpoints) # @overload initialize(options) # @param [Hash] options # @option options [required, Aws::CredentialProvider] :credentials # Your AWS credentials. This can be an instance of any one of the # following classes: # # * `Aws::Credentials` - Used for configuring static, non-refreshing # credentials. # # * `Aws::SharedCredentials` - Used for loading static credentials from a # shared file, such as `~/.aws/config`. # # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. # # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to # assume a role after providing credentials via the web. # # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an # access token generated from `aws login`. # # * `Aws::ProcessCredentials` - Used for loading credentials from a # process that outputs to stdout. # # * `Aws::InstanceProfileCredentials` - Used for loading credentials # from an EC2 IMDS on an EC2 instance. # # * `Aws::ECSCredentials` - Used for loading credentials from # instances running in ECS. # # * `Aws::CognitoIdentityCredentials` - Used for loading credentials # from the Cognito Identity service. # # When `:credentials` are not configured directly, the following # locations will be searched for credentials: # # * `Aws.config[:credentials]` # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] # * `~/.aws/credentials` # * `~/.aws/config` # * EC2/ECS IMDS instance profile - When used by default, the timeouts # are very aggressive. Construct and pass an instance of # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to # enable retries and extended timeouts. Instance profile credential # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] # to true. # # @option options [required, String] :region # The AWS region to connect to. The configured `:region` is # used to determine the service `:endpoint`. When not passed, # a default `:region` is searched for in the following locations: # # * `Aws.config[:region]` # * `ENV['AWS_REGION']` # * `ENV['AMAZON_REGION']` # * `ENV['AWS_DEFAULT_REGION']` # * `~/.aws/credentials` # * `~/.aws/config` # # @option options [String] :access_key_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :adaptive_retry_wait_to_fill (true) # Used only in `adaptive` retry mode. When true, the request will sleep # until there is sufficent client side capacity to retry the request. # When false, the request will raise a `RetryCapacityNotAvailableError` and will # not retry instead of sleeping. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("127.0.0.1") # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client # side monitoring agent is running on, where client metrics will be published via UDP. # # @option options [Integer] :client_side_monitoring_port (31000) # Required for publishing client metrics. The port that the client side monitoring # agent is running on, where client metrics will be published via UDP. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :correct_clock_skew (true) # Used only in `standard` and adaptive retry modes. Specifies whether to apply # a clock skew correction and retry requests with skewed client clocks. # # @option options [String] :defaults_mode ("legacy") # See {Aws::DefaultsModeConfiguration} for a list of the # accepted modes and the configuration defaults that are included. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [Boolean] :disable_request_compression (false) # When set to 'true' the request body will not be compressed # for supported operations. # # @option options [String, URI::HTTPS, URI::HTTP] :endpoint # Normally you should not configure the `:endpoint` option # directly. This is normally constructed from the `:region` # option. Configuring `:endpoint` is normally reserved for # connecting to test or custom endpoints. The endpoint should # be a URI formatted like: # # 'http://example.com' # 'https://example.com' # 'http://example.com:123' # # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (60) # When :endpoint_discovery and :active_endpoint_cache is enabled, # Use this option to config the time interval in seconds for making # requests fetching endpoints information. Defaults to 60 sec. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. # # @option options [Boolean] :ignore_configured_endpoint_urls # Setting to true disables use of endpoint URLs provided via environment # variables and the shared configuration file. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [Integer] :max_attempts (3) # An integer representing the maximum number attempts that will be made for # a single request, including the initial attempt. For example, # setting this value to 5 will result in a request being retried up to # 4 times. Used in `standard` and `adaptive` retry modes. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Integer] :request_min_compression_size_bytes (10240) # The minimum size in bytes that triggers compression for request # bodies. The value must be non-negative integer value between 0 # and 10485780 bytes inclusive. # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. This option # is only used in the `legacy` retry mode. # # @option options [Symbol] :retry_jitter (:none) # A delay randomiser function used by the default backoff function. # Some predefined functions can be referenced by name - :none, :equal, :full, # otherwise a Proc that takes and returns a number. This option is only used # in the `legacy` retry mode. # # @see https://www.awsarchitectureblog.com/2015/03/backoff.html # # @option options [Integer] :retry_limit (3) # The maximum number of times to retry failed requests. Only # ~ 500 level server errors and certain ~ 400 level client errors # are retried. Generally, these are throttling errors, data # checksum errors, networking errors, timeout errors, auth errors, # endpoint discovery, and errors from expired credentials. # This option is only used in the `legacy` retry mode. # # @option options [Integer] :retry_max_delay (0) # The maximum number of seconds to delay between retries (0 for no limit) # used by the default backoff function. This option is only used in the # `legacy` retry mode. # # @option options [String] :retry_mode ("legacy") # Specifies which retry algorithm to use. Values are: # # * `legacy` - The pre-existing retry behavior. This is default value if # no retry mode is provided. # # * `standard` - A standardized set of retry rules across the AWS SDKs. # This includes support for retry quotas, which limit the number of # unsuccessful retries a client can make. # # * `adaptive` - An experimental retry mode that includes all the # functionality of `standard` mode along with automatic client side # throttling. This is a provisional mode that may change behavior # in the future. # # # @option options [String] :sdk_ua_app_id # A unique and opaque application ID that is appended to the # User-Agent header as app/sdk_ua_app_id. It should have a # maximum length of 50. This variable is sourced from environment # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :simple_json (false) # Disables request parameter conversion, validation, and formatting. # Also disable response data type conversions. This option is useful # when you want to ensure the highest level of performance by # avoiding overhead of walking request parameters and response data # structures. # # When `:simple_json` is enabled, the request parameters hash must # be formatted exactly as the DynamoDB API expects. # # @option options [Boolean] :stub_responses (false) # Causes the client to return stubbed responses. By default # fake responses are generated and returned. You can specify # the response data to return or errors to raise by calling # {ClientStubs#stub_responses}. See {ClientStubs} for more information. # # ** Please note ** When response stubbing is enabled, no HTTP # requests are made, and retries are disabled. # # @option options [Aws::TokenProvider] :token_provider # A Bearer Token Provider. This can be an instance of any one of the # following classes: # # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing # tokens. # # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an # access token generated from `aws login`. # # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain` # will be used to search for tokens configured for your profile in shared configuration files. # # @option options [Boolean] :use_dualstack_endpoint # When set to `true`, dualstack enabled endpoints (with `.aws` TLD) # will be used if available. # # @option options [Boolean] :use_fips_endpoint # When set to `true`, fips compatible endpoints will be used if available. # When a `fips` region is used, the region is normalized and this config # is set to `true`. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [Aws::ForecastService::EndpointProvider] :endpoint_provider # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ForecastService::EndpointParameters` # # @option options [Float] :http_continue_timeout (1) # The number of seconds to wait for a 100-continue response before sending the # request body. This option has no effect unless the request has "Expect" # header set to "100-continue". Defaults to `nil` which disables this # behaviour. This value can safely be set per request on the session. # # @option options [Float] :http_idle_timeout (5) # The number of seconds a connection is allowed to sit idle before it # is considered stale. Stale connections are closed and removed from the # pool before making a request. # # @option options [Float] :http_open_timeout (15) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [URI::HTTP,String] :http_proxy # A proxy to send requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_read_timeout (60) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [Boolean] :http_wire_trace (false) # When `true`, HTTP debug output will be sent to the `:logger`. # # @option options [Proc] :on_chunk_received # When a Proc object is provided, it will be used as callback when each chunk # of the response body is received. It provides three arguments: the chunk, # the number of bytes received, and the total number of # bytes in the response (or nil if the server did not send a `content-length`). # # @option options [Proc] :on_chunk_sent # When a Proc object is provided, it will be used as callback when each chunk # of the request body is sent. It provides three arguments: the chunk, # the number of bytes read from the body, and the total number of # bytes in the body. # # @option options [Boolean] :raise_response_errors (true) # When `true`, response errors are raised. # # @option options [String] :ssl_ca_bundle # Full path to the SSL certificate authority bundle file that should be used when # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or # `:ssl_ca_directory` the the system default will be used if available. # # @option options [String] :ssl_ca_directory # Full path of the directory that contains the unbundled SSL certificate # authority files for verifying peer certificates. If you do # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system # default will be used if available. # # @option options [String] :ssl_ca_store # Sets the X509::Store to verify peer certificate. # # @option options [Float] :ssl_timeout # Sets the SSL timeout in seconds # # @option options [Boolean] :ssl_verify_peer (true) # When `true`, SSL peer certificates are verified when establishing a connection. # def initialize(*args) super end # @!group API Operations # Creates an Amazon Forecast predictor. # # Amazon Forecast creates predictors with AutoPredictor, which involves # applying the optimal combination of algorithms to each time series in # your datasets. You can use CreateAutoPredictor to create new # predictors or upgrade/retrain existing predictors. # # **Creating new predictors** # # The following parameters are required when creating a new predictor: # # * `PredictorName` - A unique name for the predictor. # # * `DatasetGroupArn` - The ARN of the dataset group used to train the # predictor. # # * `ForecastFrequency` - The granularity of your forecasts (hourly, # daily, weekly, etc). # # * `ForecastHorizon` - The number of time-steps that the model # predicts. The forecast horizon is also called the prediction length. # # When creating a new predictor, do not specify a value for # `ReferencePredictorArn`. # # **Upgrading and retraining predictors** # # The following parameters are required when retraining or upgrading a # predictor: # # * `PredictorName` - A unique name for the predictor. # # * `ReferencePredictorArn` - The ARN of the predictor to retrain or # upgrade. # # When upgrading or retraining a predictor, only specify values for the # `ReferencePredictorArn` and `PredictorName`. # # @option params [required, String] :predictor_name # A unique name for the predictor # # @option params [Integer] :forecast_horizon # The number of time-steps that the model predicts. The forecast horizon # is also called the prediction length. # # The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of # the TARGET\_TIME\_SERIES dataset length. If you are retraining an # existing AutoPredictor, then the maximum forecast horizon is the # lesser of 500 time-steps or 1/3 of the TARGET\_TIME\_SERIES dataset # length. # # If you are upgrading to an AutoPredictor or retraining an existing # AutoPredictor, you cannot update the forecast horizon parameter. You # can meet this requirement by providing longer time-series in the # dataset. # # @option params [Array] :forecast_types # The forecast types used to train a predictor. You can specify up to # five forecast types. Forecast types can be quantiles from 0.01 to # 0.99, by increments of 0.01 or higher. You can also specify the mean # forecast with `mean`. # # @option params [Array] :forecast_dimensions # An array of dimension (field) names that specify how to group the # generated forecast. # # For example, if you are generating forecasts for item sales across all # your stores, and your dataset contains a `store_id` field, you would # specify `store_id` as a dimension to group sales forecasts for each # store. # # @option params [String] :forecast_frequency # The frequency of predictions in a forecast. # # Valid intervals are an integer followed by Y (Year), M (Month), W # (Week), D (Day), H (Hour), and min (Minute). For example, "1D" # indicates every day and "15min" indicates every 15 minutes. You # cannot specify a value that would overlap with the next larger # frequency. That means, for example, you cannot specify a frequency of # 60 minutes, because that is equivalent to 1 hour. The valid values for # each frequency are the following: # # * Minute - 1-59 # # * Hour - 1-23 # # * Day - 1-6 # # * Week - 1-4 # # * Month - 1-11 # # * Year - 1 # # Thus, if you want every other week forecasts, specify "2W". Or, if # you want quarterly forecasts, you specify "3M". # # The frequency must be greater than or equal to the # TARGET\_TIME\_SERIES dataset frequency. # # When a RELATED\_TIME\_SERIES dataset is provided, the frequency must # be equal to the RELATED\_TIME\_SERIES dataset frequency. # # @option params [Types::DataConfig] :data_config # The data configuration for your dataset group and any additional # datasets. # # @option params [Types::EncryptionConfig] :encryption_config # An Key Management Service (KMS) key and an Identity and Access # Management (IAM) role that Amazon Forecast can assume to access the # key. You can specify this optional object in the CreateDataset and # CreatePredictor requests. # # @option params [String] :reference_predictor_arn # The ARN of the predictor to retrain or upgrade. This parameter is only # used when retraining or upgrading a predictor. When creating a new # predictor, do not specify a value for this parameter. # # When upgrading or retraining a predictor, only specify values for the # `ReferencePredictorArn` and `PredictorName`. The value for # `PredictorName` must be a unique predictor name. # # @option params [String] :optimization_metric # The accuracy metric used to optimize the predictor. # # @option params [Boolean] :explain_predictor # Create an Explainability resource for the predictor. # # @option params [Array] :tags # Optional metadata to help you categorize and organize your predictors. # Each tag consists of a key and an optional value, both of which you # define. Tag keys and values are case sensitive. # # The following restrictions apply to tags: # # * For each resource, each tag key must be unique and each tag key must # have one value. # # * Maximum number of tags per resource: 50. # # * Maximum key length: 128 Unicode characters in UTF-8. # # * Maximum value length: 256 Unicode characters in UTF-8. # # * Accepted characters: all letters and numbers, spaces representable # in UTF-8, and + - = . \_ : / @. If your tagging schema is used # across other services and resources, the character restrictions of # those services also apply. # # * Key prefixes cannot include any upper or lowercase combination of # `aws:` or `AWS:`. Values can have this prefix. If a tag value has # `aws` as its prefix but the key does not, Forecast considers it to # be a user tag and will count against the limit of 50 tags. Tags with # only the key prefix of `aws` do not count against your tags per # resource limit. You cannot edit or delete tag keys with this prefix. # # @option params [Types::MonitorConfig] :monitor_config # The configuration details for predictor monitoring. Provide a name for # the monitor resource to enable predictor monitoring. # # Predictor monitoring allows you to see how your predictor's # performance changes over time. For more information, see [Predictor # Monitoring][1]. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html # # @option params [Types::TimeAlignmentBoundary] :time_alignment_boundary # The time boundary Forecast uses to align and aggregate any data that # doesn't align with your forecast frequency. Provide the unit of time # and the time boundary as a key value pair. For more information on # specifying a time boundary, see [Specifying a Time Boundary][1]. If # you don't provide a time boundary, Forecast uses a set of [Default # Time Boundaries][2]. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries # # @return [Types::CreateAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateAutoPredictorResponse#predictor_arn #predictor_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_auto_predictor({ # predictor_name: "Name", # required # forecast_horizon: 1, # forecast_types: ["ForecastType"], # forecast_dimensions: ["Name"], # forecast_frequency: "Frequency", # data_config: { # dataset_group_arn: "Arn", # required # attribute_configs: [ # { # attribute_name: "Name", # required # transformations: { # required # "Name" => "Value", # }, # }, # ], # additional_datasets: [ # { # name: "Name", # required # configuration: { # "Name" => ["Value"], # }, # }, # ], # }, # encryption_config: { # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # required # }, # reference_predictor_arn: "Arn", # optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE # explain_predictor: false, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # monitor_config: { # monitor_name: "Name", # required # }, # time_alignment_boundary: { # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER # day_of_month: 1, # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY # hour: 1, # }, # }) # # @example Response structure # # resp.predictor_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictor AWS API Documentation # # @overload create_auto_predictor(params = {}) # @param [Hash] params ({}) def create_auto_predictor(params = {}, options = {}) req = build_request(:create_auto_predictor, params) req.send_request(options) end # Creates an Amazon Forecast dataset. The information about the dataset # that you provide helps Forecast understand how to consume the data for # model training. This includes the following: # # * DataFrequency - How frequently your historical # time-series data is collected. # # * Domain and DatasetType - # Each dataset has an associated dataset domain and a type within the # domain. Amazon Forecast provides a list of predefined domains and # types within each domain. For each unique dataset domain and type # within the domain, Amazon Forecast requires your data to include a # minimum set of predefined fields. # # * Schema - A schema specifies the fields in the # dataset, including the field name and data type. # # After creating a dataset, you import your training data into it and # add the dataset to a dataset group. You use the dataset group to # create a predictor. For more information, see [Importing datasets][1]. # # To get a list of all your datasets, use the [ListDatasets][2] # operation. # # For example Forecast datasets, see the [Amazon Forecast Sample GitHub # repository][3]. # # The `Status` of a dataset must be `ACTIVE` before you can import # training data. Use the [DescribeDataset][4] operation to get the # status. # # # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html # [3]: https://github.com/aws-samples/amazon-forecast-samples # [4]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html # # @option params [required, String] :dataset_name # A name for the dataset. # # @option params [required, String] :domain # The domain associated with the dataset. When you add a dataset to a # dataset group, this value and the value specified for the `Domain` # parameter of the [CreateDatasetGroup][1] operation must match. # # The `Domain` and `DatasetType` that you choose determine the fields # that must be present in the training data that you import to the # dataset. For example, if you choose the `RETAIL` domain and # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires # `item_id`, `timestamp`, and `demand` fields to be present in your # data. For more information, see [Importing datasets][2]. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html # # @option params [required, String] :dataset_type # The dataset type. Valid values depend on the chosen `Domain`. # # @option params [String] :data_frequency # The frequency of data collection. This parameter is required for # RELATED\_TIME\_SERIES datasets. # # Valid intervals are an integer followed by Y (Year), M (Month), W # (Week), D (Day), H (Hour), and min (Minute). For example, "1D" # indicates every day and "15min" indicates every 15 minutes. You # cannot specify a value that would overlap with the next larger # frequency. That means, for example, you cannot specify a frequency of # 60 minutes, because that is equivalent to 1 hour. The valid values for # each frequency are the following: # # * Minute - 1-59 # # * Hour - 1-23 # # * Day - 1-6 # # * Week - 1-4 # # * Month - 1-11 # # * Year - 1 # # Thus, if you want every other week forecasts, specify "2W". Or, if # you want quarterly forecasts, you specify "3M". # # @option params [required, Types::Schema] :schema # The schema for the dataset. The schema attributes and their order must # match the fields in your data. The dataset `Domain` and `DatasetType` # that you choose determine the minimum required fields in your training # data. For information about the required fields for a specific dataset # domain and type, see [Dataset Domains and Dataset Types][1]. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html # # @option params [Types::EncryptionConfig] :encryption_config # An Key Management Service (KMS) key and the Identity and Access # Management (IAM) role that Amazon Forecast can assume to access the # key. # # @option params [Array] :tags # The optional metadata that you apply to the dataset to help you # categorize and organize them. Each tag consists of a key and an # optional value, both of which you define. # # The following basic restrictions apply to tags: # # * Maximum number of tags per resource - 50. # # * For each resource, each tag key must be unique, and each tag key can # have only one value. # # * Maximum key length - 128 Unicode characters in UTF-8. # # * Maximum value length - 256 Unicode characters in UTF-8. # # * If your tagging schema is used across multiple services and # resources, remember that other services may have restrictions on # allowed characters. Generally allowed characters are: letters, # numbers, and spaces representable in UTF-8, and the following # characters: + - = . \_ : / @. # # * Tag keys and values are case sensitive. # # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of # such as a prefix for keys as it is reserved for Amazon Web Services # use. You cannot edit or delete tag keys with this prefix. Values can # have this prefix. If a tag value has `aws` as its prefix but the key # does not, then Forecast considers it to be a user tag and will count # against the limit of 50 tags. Tags with only the key prefix of `aws` # do not count against your tags per resource limit. # # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_dataset({ # dataset_name: "Name", # required # domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS # dataset_type: "TARGET_TIME_SERIES", # required, accepts TARGET_TIME_SERIES, RELATED_TIME_SERIES, ITEM_METADATA # data_frequency: "Frequency", # schema: { # required # attributes: [ # { # attribute_name: "Name", # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation # }, # ], # }, # encryption_config: { # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # required # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @example Response structure # # resp.dataset_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDataset AWS API Documentation # # @overload create_dataset(params = {}) # @param [Hash] params ({}) def create_dataset(params = {}, options = {}) req = build_request(:create_dataset, params) req.send_request(options) end # Creates a dataset group, which holds a collection of related datasets. # You can add datasets to the dataset group when you create the dataset # group, or later by using the [UpdateDatasetGroup][1] operation. # # After creating a dataset group and adding datasets, you use the # dataset group when you create a predictor. For more information, see # [Dataset groups][2]. # # To get a list of all your datasets groups, use the # [ListDatasetGroups][3] operation. # # The `Status` of a dataset group must be `ACTIVE` before you can use # the dataset group to create a predictor. To get the status, use the # [DescribeDatasetGroup][4] operation. # # # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html # [4]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html # # @option params [required, String] :dataset_group_name # A name for the dataset group. # # @option params [required, String] :domain # The domain associated with the dataset group. When you add a dataset # to a dataset group, this value and the value specified for the # `Domain` parameter of the [CreateDataset][1] operation must match. # # The `Domain` and `DatasetType` that you choose determine the fields # that must be present in training data that you import to a dataset. # For example, if you choose the `RETAIL` domain and # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires # that `item_id`, `timestamp`, and `demand` fields are present in your # data. For more information, see [Dataset groups][2]. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html # # @option params [Array] :dataset_arns # An array of Amazon Resource Names (ARNs) of the datasets that you want # to include in the dataset group. # # @option params [Array] :tags # The optional metadata that you apply to the dataset group to help you # categorize and organize them. Each tag consists of a key and an # optional value, both of which you define. # # The following basic restrictions apply to tags: # # * Maximum number of tags per resource - 50. # # * For each resource, each tag key must be unique, and each tag key can # have only one value. # # * Maximum key length - 128 Unicode characters in UTF-8. # # * Maximum value length - 256 Unicode characters in UTF-8. # # * If your tagging schema is used across multiple services and # resources, remember that other services may have restrictions on # allowed characters. Generally allowed characters are: letters, # numbers, and spaces representable in UTF-8, and the following # characters: + - = . \_ : / @. # # * Tag keys and values are case sensitive. # # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of # such as a prefix for keys as it is reserved for Amazon Web Services # use. You cannot edit or delete tag keys with this prefix. Values can # have this prefix. If a tag value has `aws` as its prefix but the key # does not, then Forecast considers it to be a user tag and will count # against the limit of 50 tags. Tags with only the key prefix of `aws` # do not count against your tags per resource limit. # # @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_dataset_group({ # dataset_group_name: "Name", # required # domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS # dataset_arns: ["Arn"], # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @example Response structure # # resp.dataset_group_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetGroup AWS API Documentation # # @overload create_dataset_group(params = {}) # @param [Hash] params ({}) def create_dataset_group(params = {}, options = {}) req = build_request(:create_dataset_group, params) req.send_request(options) end # Imports your training data to an Amazon Forecast dataset. You provide # the location of your training data in an Amazon Simple Storage Service # (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset # that you want to import the data to. # # You must specify a [DataSource][1] object that includes an Identity # and Access Management (IAM) role that Amazon Forecast can assume to # access the data, as Amazon Forecast makes a copy of your data and # processes it in an internal Amazon Web Services system. For more # information, see [Set up permissions][2]. # # The training data must be in CSV or Parquet format. The delimiter must # be a comma (,). # # You can specify the path to a specific file, the S3 bucket, or to a # folder in the S3 bucket. For the latter two cases, Amazon Forecast # imports all files up to the limit of 10,000 files. # # Because dataset imports are not aggregated, your most recent dataset # import is the one that is used when training a predictor or generating # a forecast. Make sure that your most recent dataset import contains # all of the data you want to model off of, and not just the new data # collected since the previous import. # # To get a list of all your dataset import jobs, filtered by specified # criteria, use the [ListDatasetImportJobs][3] operation. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html # # @option params [required, String] :dataset_import_job_name # The name for the dataset import job. We recommend including the # current timestamp in the name, for example, `20190721DatasetImport`. # This can help you avoid getting a `ResourceAlreadyExistsException` # exception. # # @option params [required, String] :dataset_arn # The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you # want to import data to. # # @option params [required, Types::DataSource] :data_source # The location of the training data to import and an Identity and Access # Management (IAM) role that Amazon Forecast can assume to access the # data. The training data must be stored in an Amazon S3 bucket. # # If encryption is used, `DataSource` must include an Key Management # Service (KMS) key and the IAM role must allow Amazon Forecast # permission to access the key. The KMS key and IAM role must match # those specified in the `EncryptionConfig` parameter of the # [CreateDataset][1] operation. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html # # @option params [String] :timestamp_format # The format of timestamps in the dataset. The format that you specify # depends on the `DataFrequency` specified when the dataset was created. # The following formats are supported # # * "yyyy-MM-dd" # # For the following data frequencies: Y, M, W, and D # # * "yyyy-MM-dd HH:mm:ss" # # For the following data frequencies: H, 30min, 15min, and 1min; and # optionally, for: Y, M, W, and D # # 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] :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 # optional value, both of which you define. # # The following basic restrictions apply to tags: # # * Maximum number of tags per resource - 50. # # * For each resource, each tag key must be unique, and each tag key can # have only one value. # # * Maximum key length - 128 Unicode characters in UTF-8. # # * Maximum value length - 256 Unicode characters in UTF-8. # # * If your tagging schema is used across multiple services and # resources, remember that other services may have restrictions on # allowed characters. Generally allowed characters are: letters, # numbers, and spaces representable in UTF-8, and the following # characters: + - = . \_ : / @. # # * Tag keys and values are case sensitive. # # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of # such as a prefix for keys as it is reserved for Amazon Web Services # use. You cannot edit or delete tag keys with this prefix. Values can # have this prefix. If a tag value has `aws` as its prefix but the key # does not, then Forecast considers it to be a user tag and will count # against the limit of 50 tags. Tags with only the key prefix of `aws` # do not count against your tags per resource limit. # # @option params [String] :format # The format of the imported data, CSV or PARQUET. The default value is # CSV. # # @option params [String] :import_mode # Specifies whether the dataset import job is a `FULL` or `INCREMENTAL` # import. A `FULL` dataset import replaces all of the existing data with # the newly imported data. An `INCREMENTAL` import appends the imported # data to the existing data. # # @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_dataset_import_job({ # dataset_import_job_name: "Name", # required # dataset_arn: "Arn", # required # data_source: { # required # s3_config: { # required # path: "S3Path", # required # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # }, # }, # timestamp_format: "TimestampFormat", # time_zone: "TimeZone", # use_geolocation_for_time_zone: false, # geolocation_format: "GeolocationFormat", # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # format: "Format", # import_mode: "FULL", # accepts FULL, INCREMENTAL # }) # # @example Response structure # # resp.dataset_import_job_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJob AWS API Documentation # # @overload create_dataset_import_job(params = {}) # @param [Hash] params ({}) def create_dataset_import_job(params = {}, options = {}) req = build_request(:create_dataset_import_job, params) req.send_request(options) end # Explainability is only available for Forecasts and Predictors # generated from an AutoPredictor (CreateAutoPredictor) # # # # Creates an Amazon Forecast Explainability. # # Explainability helps you better understand how the attributes in your # datasets impact forecast. Amazon Forecast uses a metric called Impact # scores to quantify the relative impact of each attribute and determine # whether they increase or decrease forecast values. # # To enable Forecast Explainability, your predictor must include at # least one of the following: related time series, item metadata, or # additional datasets like Holidays and the Weather Index. # # CreateExplainability accepts either a Predictor ARN or Forecast ARN. # To receive aggregated Impact scores for all time series and time # points in your datasets, provide a Predictor ARN. To receive Impact # scores for specific time series and time points, provide a Forecast # ARN. # # **CreateExplainability with a Predictor ARN** # # You can only have one Explainability resource per predictor. If you # already enabled `ExplainPredictor` in CreateAutoPredictor, that # predictor already has an Explainability resource. # # # # The following parameters are required when providing a Predictor ARN: # # * `ExplainabilityName` - A unique name for the Explainability. # # * `ResourceArn` - The Arn of the predictor. # # * `TimePointGranularity` - Must be set to “ALL”. # # * `TimeSeriesGranularity` - Must be set to “ALL”. # # Do not specify a value for the following parameters: # # * `DataSource` - Only valid when TimeSeriesGranularity is “SPECIFIC”. # # * `Schema` - Only valid when TimeSeriesGranularity is “SPECIFIC”. # # * `StartDateTime` - Only valid when TimePointGranularity is # “SPECIFIC”. # # * `EndDateTime` - Only valid when TimePointGranularity is “SPECIFIC”. # # **CreateExplainability with a Forecast ARN** # # You can specify a maximum of 50 time series and 500 time points. # # # # The following parameters are required when providing a Predictor ARN: # # * `ExplainabilityName` - A unique name for the Explainability. # # * `ResourceArn` - The Arn of the forecast. # # * `TimePointGranularity` - Either “ALL” or “SPECIFIC”. # # * `TimeSeriesGranularity` - Either “ALL” or “SPECIFIC”. # # If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide # the following: # # * `DataSource` - The S3 location of the CSV file specifying your time # series. # # * `Schema` - The Schema defines the attributes and attribute types # listed in the Data Source. # # If you set TimePointGranularity to “SPECIFIC”, you must also provide # the following: # # * `StartDateTime` - The first timestamp in the range of time points. # # * `EndDateTime` - The last timestamp in the range of time points. # # @option params [required, String] :explainability_name # A unique name for the Explainability. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the Predictor or Forecast used to # create the Explainability. # # @option params [required, Types::ExplainabilityConfig] :explainability_config # The configuration settings that define the granularity of time series # and time points for the Explainability. # # @option params [Types::DataSource] :data_source # The source of your data, an Identity and Access Management (IAM) role # that allows Amazon Forecast to access the data and, optionally, an Key # Management Service (KMS) key. # # @option params [Types::Schema] :schema # Defines the fields of a dataset. # # @option params [Boolean] :enable_visualization # Create an Explainability visualization that is viewable within the # Amazon Web Services console. # # @option params [String] :start_date_time # If `TimePointGranularity` is set to `SPECIFIC`, define the first point # for the Explainability. # # Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: # 2015-01-01T20:00:00) # # @option params [String] :end_date_time # If `TimePointGranularity` is set to `SPECIFIC`, define the last time # point for the Explainability. # # Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: # 2015-01-01T20:00:00) # # @option params [Array] :tags # Optional metadata to help you categorize and organize your resources. # Each tag consists of a key and an optional value, both of which you # define. Tag keys and values are case sensitive. # # The following restrictions apply to tags: # # * For each resource, each tag key must be unique and each tag key must # have one value. # # * Maximum number of tags per resource: 50. # # * Maximum key length: 128 Unicode characters in UTF-8. # # * Maximum value length: 256 Unicode characters in UTF-8. # # * Accepted characters: all letters and numbers, spaces representable # in UTF-8, and + - = . \_ : / @. If your tagging schema is used # across other services and resources, the character restrictions of # those services also apply. # # * Key prefixes cannot include any upper or lowercase combination of # `aws:` or `AWS:`. Values can have this prefix. If a tag value has # `aws` as its prefix but the key does not, Forecast considers it to # be a user tag and will count against the limit of 50 tags. Tags with # only the key prefix of `aws` do not count against your tags per # resource limit. You cannot edit or delete tag keys with this prefix. # # @return [Types::CreateExplainabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateExplainabilityResponse#explainability_arn #explainability_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_explainability({ # explainability_name: "Name", # required # resource_arn: "Arn", # required # explainability_config: { # required # time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC # time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC # }, # data_source: { # s3_config: { # required # path: "S3Path", # required # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # }, # }, # schema: { # attributes: [ # { # attribute_name: "Name", # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation # }, # ], # }, # enable_visualization: false, # start_date_time: "LocalDateTime", # end_date_time: "LocalDateTime", # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @example Response structure # # resp.explainability_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainability AWS API Documentation # # @overload create_explainability(params = {}) # @param [Hash] params ({}) def create_explainability(params = {}, options = {}) req = build_request(:create_explainability, params) req.send_request(options) end # Exports an Explainability resource created by the CreateExplainability # operation. Exported files are exported to an Amazon Simple Storage # Service (Amazon S3) bucket. # # You must specify a DataDestination object that includes an Amazon S3 # bucket and an 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 `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 # DescribeExplainabilityExport operation. # # # # @option params [required, String] :explainability_export_name # A unique name for the Explainability export. # # @option params [required, String] :explainability_arn # The Amazon Resource Name (ARN) of the Explainability to export. # # @option params [required, Types::DataDestination] :destination # The destination for an export job. Provide an S3 path, an Identity and # Access Management (IAM) role that allows Amazon Forecast to access the # location, and an Key Management Service (KMS) key (optional). # # @option params [Array] :tags # Optional metadata to help you categorize and organize your resources. # Each tag consists of a key and an optional value, both of which you # define. Tag keys and values are case sensitive. # # The following restrictions apply to tags: # # * For each resource, each tag key must be unique and each tag key must # have one value. # # * Maximum number of tags per resource: 50. # # * Maximum key length: 128 Unicode characters in UTF-8. # # * Maximum value length: 256 Unicode characters in UTF-8. # # * Accepted characters: all letters and numbers, spaces representable # in UTF-8, and + - = . \_ : / @. If your tagging schema is used # across other services and resources, the character restrictions of # those services also apply. # # * Key prefixes cannot include any upper or lowercase combination of # `aws:` or `AWS:`. Values can have this prefix. If a tag value has # `aws` as its prefix but the key does not, Forecast considers it to # be a user tag and will count against the limit of 50 tags. Tags with # only the key prefix of `aws` do not count against your tags per # resource limit. You cannot edit or delete tag keys with this prefix. # # @option params [String] :format # The format of the exported data, CSV or PARQUET. # # @return [Types::CreateExplainabilityExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateExplainabilityExportResponse#explainability_export_arn #explainability_export_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_explainability_export({ # explainability_export_name: "Name", # required # explainability_arn: "Arn", # required # destination: { # required # s3_config: { # required # path: "S3Path", # required # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # }, # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # format: "Format", # }) # # @example Response structure # # resp.explainability_export_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExport AWS API Documentation # # @overload create_explainability_export(params = {}) # @param [Hash] params ({}) def create_explainability_export(params = {}, options = {}) req = build_request(:create_explainability_export, params) req.send_request(options) end # Creates a forecast for each item in the `TARGET_TIME_SERIES` dataset # that was used to train the predictor. This is known as inference. To # retrieve the forecast for a single item at low latency, use the # operation. To export the complete forecast into your Amazon Simple # Storage Service (Amazon S3) bucket, use the CreateForecastExportJob # operation. # # The range of the forecast is determined by the `ForecastHorizon` # value, which you specify in the CreatePredictor request. When you # query a forecast, you can request a specific date range within the # forecast. # # To get a list of all your forecasts, use the ListForecasts operation. # # The forecasts generated by Amazon Forecast are in the same time zone # as the dataset that was used to create the predictor. # # # # For more information, see howitworks-forecast. # # The `Status` of the forecast must be `ACTIVE` before you can query or # export the forecast. Use the DescribeForecast operation to get the # status. # # # # By default, a forecast includes predictions for every item (`item_id`) # in the dataset group that was used to train the predictor. However, # you can use the `TimeSeriesSelector` object to generate a forecast on # a subset of time series. Forecast creation is skipped for any time # series that you specify that are not in the input dataset. The # forecast export file will not contain these time series or their # forecasted values. # # @option params [required, String] :forecast_name # A name for the forecast. # # @option params [required, String] :predictor_arn # The Amazon Resource Name (ARN) of the predictor to use to generate the # forecast. # # @option params [Array] :forecast_types # The quantiles at which probabilistic forecasts are generated. **You # can currently specify up to 5 quantiles per forecast**. Accepted # values include `0.01 to 0.99` (increments of .01 only) and `mean`. The # mean forecast is different from the median (0.50) when the # distribution is not symmetric (for example, Beta and Negative # Binomial). # # The default quantiles are the quantiles you specified during predictor # creation. If you didn't specify quantiles, the default values are # `["0.1", "0.5", "0.9"]`. # # @option params [Array] :tags # The optional metadata that you apply to the forecast to help you # categorize and organize them. Each tag consists of a key and an # optional value, both of which you define. # # The following basic restrictions apply to tags: # # * Maximum number of tags per resource - 50. # # * For each resource, each tag key must be unique, and each tag key can # have only one value. # # * Maximum key length - 128 Unicode characters in UTF-8. # # * Maximum value length - 256 Unicode characters in UTF-8. # # * If your tagging schema is used across multiple services and # resources, remember that other services may have restrictions on # allowed characters. Generally allowed characters are: letters, # numbers, and spaces representable in UTF-8, and the following # characters: + - = . \_ : / @. # # * Tag keys and values are case sensitive. # # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of # such as a prefix for keys as it is reserved for Amazon Web Services # use. You cannot edit or delete tag keys with this prefix. Values can # have this prefix. If a tag value has `aws` as its prefix but the key # does not, then Forecast considers it to be a user tag and will count # against the limit of 50 tags. Tags with only the key prefix of `aws` # do not count against your tags per resource limit. # # @option params [Types::TimeSeriesSelector] :time_series_selector # Defines the set of time series that are used to create the forecasts # in a `TimeSeriesIdentifiers` object. # # The `TimeSeriesIdentifiers` object needs the following information: # # * `DataSource` # # * `Format` # # * `Schema` # # @return [Types::CreateForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateForecastResponse#forecast_arn #forecast_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_forecast({ # forecast_name: "Name", # required # predictor_arn: "Arn", # required # forecast_types: ["ForecastType"], # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # time_series_selector: { # time_series_identifiers: { # data_source: { # s3_config: { # required # path: "S3Path", # required # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # }, # }, # schema: { # attributes: [ # { # attribute_name: "Name", # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation # }, # ], # }, # format: "Format", # }, # }, # }) # # @example Response structure # # resp.forecast_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecast AWS API Documentation # # @overload create_forecast(params = {}) # @param [Hash] params ({}) def create_forecast(params = {}, options = {}) req = build_request(:create_forecast, params) req.send_request(options) end # Exports a forecast created by the CreateForecast operation to your # Amazon Simple Storage Service (Amazon S3) bucket. The forecast file # name will match the following conventions: # # <ForecastExportJobName>\_<ExportTimestamp>\_<PartNumber> # # where the <ExportTimestamp> component is in Java # SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). # # You must specify a DataDestination object that includes an 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. # # For more information, see howitworks-forecast. # # To get a list of all your forecast export jobs, use the # ListForecastExportJobs operation. # # The `Status` of the forecast export job must be `ACTIVE` before you # can access the forecast in your Amazon S3 bucket. To get the status, # use the DescribeForecastExportJob operation. # # # # @option params [required, String] :forecast_export_job_name # The name for the forecast export job. # # @option params [required, String] :forecast_arn # The Amazon Resource Name (ARN) of the forecast that you want to # export. # # @option params [required, Types::DataDestination] :destination # The location where you want to save the forecast and an Identity and # Access Management (IAM) role that Amazon Forecast can assume to access # the location. The forecast must be exported to an Amazon S3 bucket. # # If encryption is used, `Destination` must include an Key Management # Service (KMS) key. The IAM role must allow Amazon Forecast permission # to access the key. # # @option params [Array] :tags # The optional metadata that you apply to the forecast export job to # help you categorize and organize them. Each tag consists of a key and # an optional value, both of which you define. # # The following basic restrictions apply to tags: # # * Maximum number of tags per resource - 50. # # * For each resource, each tag key must be unique, and each tag key can # have only one value. # # * Maximum key length - 128 Unicode characters in UTF-8. # # * Maximum value length - 256 Unicode characters in UTF-8. # # * If your tagging schema is used across multiple services and # resources, remember that other services may have restrictions on # allowed characters. Generally allowed characters are: letters, # numbers, and spaces representable in UTF-8, and the following # characters: + - = . \_ : / @. # # * Tag keys and values are case sensitive. # # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of # such as a prefix for keys as it is reserved for Amazon Web Services # use. You cannot edit or delete tag keys with this prefix. Values can # have this prefix. If a tag value has `aws` as its prefix but the key # does not, then Forecast considers it to be a user tag and will count # against the limit of 50 tags. Tags with only the key prefix of `aws` # do not count against your tags per resource limit. # # @option params [String] :format # The format of the exported data, CSV or PARQUET. The default value is # CSV. # # @return [Types::CreateForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateForecastExportJobResponse#forecast_export_job_arn #forecast_export_job_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_forecast_export_job({ # forecast_export_job_name: "Name", # required # forecast_arn: "Arn", # required # destination: { # required # s3_config: { # required # path: "S3Path", # required # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # }, # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # format: "Format", # }) # # @example Response structure # # resp.forecast_export_job_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJob AWS API Documentation # # @overload create_forecast_export_job(params = {}) # @param [Hash] params ({}) def create_forecast_export_job(params = {}, options = {}) req = build_request(:create_forecast_export_job, params) req.send_request(options) end # Creates a predictor monitor resource for an existing auto predictor. # Predictor monitoring allows you to see how your predictor's # performance changes over time. For more information, see [Predictor # Monitoring][1]. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html # # @option params [required, String] :monitor_name # The name of the monitor resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the predictor to monitor. # # @option params [Array] :tags # A list of [tags][1] to apply to the monitor resource. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html # # @return [Types::CreateMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateMonitorResponse#monitor_arn #monitor_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_monitor({ # monitor_name: "Name", # required # resource_arn: "Arn", # required # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @example Response structure # # resp.monitor_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitor AWS API Documentation # # @overload create_monitor(params = {}) # @param [Hash] params ({}) def create_monitor(params = {}, options = {}) req = build_request(:create_monitor, params) req.send_request(options) end # This operation creates a legacy predictor that does not include all # the predictor functionalities provided by Amazon Forecast. To create a # predictor that is compatible with all aspects of Forecast, use # CreateAutoPredictor. # # # # Creates an Amazon Forecast predictor. # # In the request, provide a dataset group and either specify an # algorithm or let Amazon Forecast choose an algorithm for you using # AutoML. If you specify an algorithm, you also can override # algorithm-specific hyperparameters. # # Amazon Forecast uses the algorithm to train a predictor using the # latest version of the datasets in the specified dataset group. You can # then generate a forecast using the CreateForecast operation. # # To see the evaluation metrics, use the GetAccuracyMetrics operation. # # You can specify a featurization configuration to fill and aggregate # the data fields in the `TARGET_TIME_SERIES` dataset to improve model # training. For more information, see FeaturizationConfig. # # For RELATED\_TIME\_SERIES datasets, `CreatePredictor` verifies that # the `DataFrequency` specified when the dataset was created matches the # `ForecastFrequency`. TARGET\_TIME\_SERIES datasets don't have this # restriction. Amazon Forecast also verifies the delimiter and timestamp # format. For more information, see howitworks-datasets-groups. # # By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 # (P50), and 0.9 (P90) quantiles. You can choose custom forecast types # to train and evaluate your predictor by setting the `ForecastTypes`. # # **AutoML** # # If you want Amazon Forecast to evaluate each algorithm and choose the # one that minimizes the `objective function`, set `PerformAutoML` to # `true`. The `objective function` is defined as the mean of the # weighted losses over the forecast types. By default, these are the # p10, p50, and p90 quantile losses. For more information, see # EvaluationResult. # # When AutoML is enabled, the following properties are disallowed: # # * `AlgorithmArn` # # * `HPOConfig` # # * `PerformHPO` # # * `TrainingParameters` # # To get a list of all of your predictors, use the ListPredictors # operation. # # Before you can use the predictor to create a forecast, the `Status` of # the predictor must be `ACTIVE`, signifying that training has # completed. To get the status, use the DescribePredictor operation. # # # # @option params [required, String] :predictor_name # A name for the predictor. # # @option params [String] :algorithm_arn # The Amazon Resource Name (ARN) of the algorithm to use for model # training. Required if `PerformAutoML` is not set to `true`. # # **Supported algorithms:** # # * `arn:aws:forecast:::algorithm/ARIMA` # # * `arn:aws:forecast:::algorithm/CNN-QR` # # * `arn:aws:forecast:::algorithm/Deep_AR_Plus` # # * `arn:aws:forecast:::algorithm/ETS` # # * `arn:aws:forecast:::algorithm/NPTS` # # * `arn:aws:forecast:::algorithm/Prophet` # # @option params [required, Integer] :forecast_horizon # Specifies the number of time-steps that the model is trained to # predict. The forecast horizon is also called the prediction length. # # For example, if you configure a dataset for daily data collection # (using the `DataFrequency` parameter of the CreateDataset operation) # and set the forecast horizon to 10, the model returns predictions for # 10 days. # # The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of # the TARGET\_TIME\_SERIES dataset length. # # @option params [Array] :forecast_types # Specifies the forecast types used to train a predictor. You can # specify up to five forecast types. Forecast types can be quantiles # from 0.01 to 0.99, by increments of 0.01 or higher. You can also # specify the mean forecast with `mean`. # # The default value is `["0.10", "0.50", "0.9"]`. # # @option params [Boolean] :perform_auto_ml # Whether to perform AutoML. When Amazon Forecast performs AutoML, it # evaluates the algorithms it provides and chooses the best algorithm # and configuration for your training dataset. # # The default value is `false`. In this case, you are required to # specify an algorithm. # # Set `PerformAutoML` to `true` to have Amazon Forecast perform AutoML. # This is a good option if you aren't sure which algorithm is suitable # for your training data. In this case, `PerformHPO` must be false. # # @option params [String] :auto_ml_override_strategy # The `LatencyOptimized` AutoML override strategy is only available in # private beta. Contact Amazon Web Services Support or your account # manager to learn more about access privileges. # # # # Used to overide the default AutoML strategy, which is to optimize # predictor accuracy. To apply an AutoML strategy that minimizes # training time, use `LatencyOptimized`. # # This parameter is only valid for predictors trained using AutoML. # # @option params [Boolean] :perform_hpo # Whether to perform hyperparameter optimization (HPO). HPO finds # optimal hyperparameter values for your training data. The process of # performing HPO is known as running a hyperparameter tuning job. # # The default value is `false`. In this case, Amazon Forecast uses # default hyperparameter values from the chosen algorithm. # # To override the default values, set `PerformHPO` to `true` and, # optionally, supply the HyperParameterTuningJobConfig object. The # tuning job specifies a metric to optimize, which hyperparameters # participate in tuning, and the valid range for each tunable # hyperparameter. In this case, you are required to specify an algorithm # and `PerformAutoML` must be false. # # The following algorithms support HPO: # # * DeepAR+ # # * CNN-QR # # @option params [Hash] :training_parameters # The hyperparameters to override for model training. The # hyperparameters that you can override are listed in the individual # algorithms. For the list of supported algorithms, see # aws-forecast-choosing-recipes. # # @option params [Types::EvaluationParameters] :evaluation_parameters # Used to override the default evaluation parameters of the specified # algorithm. Amazon Forecast evaluates a predictor by splitting a # dataset into training data and testing data. The evaluation parameters # define how to perform the split and the number of iterations. # # @option params [Types::HyperParameterTuningJobConfig] :hpo_config # Provides hyperparameter override values for the algorithm. If you # don't provide this parameter, Amazon Forecast uses default values. # The individual algorithms specify which hyperparameters support # hyperparameter optimization (HPO). For more information, see # aws-forecast-choosing-recipes. # # If you included the `HPOConfig` object, you must set `PerformHPO` to # true. # # @option params [required, Types::InputDataConfig] :input_data_config # Describes the dataset group that contains the data to use to train the # predictor. # # @option params [required, Types::FeaturizationConfig] :featurization_config # The featurization configuration. # # @option params [Types::EncryptionConfig] :encryption_config # An Key Management Service (KMS) key and the Identity and Access # Management (IAM) role that Amazon Forecast can assume to access the # key. # # @option params [Array] :tags # The optional metadata that you apply to the predictor to help you # categorize and organize them. Each tag consists of a key and an # optional value, both of which you define. # # The following basic restrictions apply to tags: # # * Maximum number of tags per resource - 50. # # * For each resource, each tag key must be unique, and each tag key can # have only one value. # # * Maximum key length - 128 Unicode characters in UTF-8. # # * Maximum value length - 256 Unicode characters in UTF-8. # # * If your tagging schema is used across multiple services and # resources, remember that other services may have restrictions on # allowed characters. Generally allowed characters are: letters, # numbers, and spaces representable in UTF-8, and the following # characters: + - = . \_ : / @. # # * Tag keys and values are case sensitive. # # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of # such as a prefix for keys as it is reserved for Amazon Web Services # use. You cannot edit or delete tag keys with this prefix. Values can # have this prefix. If a tag value has `aws` as its prefix but the key # does not, then Forecast considers it to be a user tag and will count # against the limit of 50 tags. Tags with only the key prefix of `aws` # do not count against your tags per resource limit. # # @option params [String] :optimization_metric # The accuracy metric used to optimize the predictor. # # @return [Types::CreatePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreatePredictorResponse#predictor_arn #predictor_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_predictor({ # predictor_name: "Name", # required # algorithm_arn: "Arn", # forecast_horizon: 1, # required # forecast_types: ["ForecastType"], # perform_auto_ml: false, # auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized, AccuracyOptimized # perform_hpo: false, # training_parameters: { # "ParameterKey" => "ParameterValue", # }, # evaluation_parameters: { # number_of_backtest_windows: 1, # back_test_window_offset: 1, # }, # hpo_config: { # parameter_ranges: { # categorical_parameter_ranges: [ # { # name: "Name", # required # values: ["Value"], # required # }, # ], # continuous_parameter_ranges: [ # { # name: "Name", # required # max_value: 1.0, # required # min_value: 1.0, # required # scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic # }, # ], # integer_parameter_ranges: [ # { # name: "Name", # required # max_value: 1, # required # min_value: 1, # required # scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic # }, # ], # }, # }, # input_data_config: { # required # dataset_group_arn: "Arn", # required # supplementary_features: [ # { # name: "Name", # required # value: "Value", # required # }, # ], # }, # featurization_config: { # required # forecast_frequency: "Frequency", # required # forecast_dimensions: ["Name"], # featurizations: [ # { # attribute_name: "Name", # required # featurization_pipeline: [ # { # featurization_method_name: "filling", # required, accepts filling # featurization_method_parameters: { # "ParameterKey" => "ParameterValue", # }, # }, # ], # }, # ], # }, # encryption_config: { # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # required # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE # }) # # @example Response structure # # resp.predictor_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictor AWS API Documentation # # @overload create_predictor(params = {}) # @param [Hash] params ({}) def create_predictor(params = {}, options = {}) req = build_request(:create_predictor, params) req.send_request(options) end # Exports backtest forecasts and accuracy metrics generated by the # CreateAutoPredictor or CreatePredictor operations. Two folders # containing CSV or Parquet files are exported to your specified S3 # bucket. # # The export file names will match the following conventions: # # `__.csv` # # The <ExportTimestamp> 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 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 `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. # # # # @option params [required, String] :predictor_backtest_export_job_name # The name for the backtest export job. # # @option params [required, String] :predictor_arn # The Amazon Resource Name (ARN) of the predictor that you want to # export. # # @option params [required, Types::DataDestination] :destination # The destination for an export job. Provide an S3 path, an Identity and # Access Management (IAM) role that allows Amazon Forecast to access the # location, and an Key Management Service (KMS) key (optional). # # @option params [Array] :tags # Optional metadata to help you categorize and organize your backtests. # Each tag consists of a key and an optional value, both of which you # define. Tag keys and values are case sensitive. # # The following restrictions apply to tags: # # * For each resource, each tag key must be unique and each tag key must # have one value. # # * Maximum number of tags per resource: 50. # # * Maximum key length: 128 Unicode characters in UTF-8. # # * Maximum value length: 256 Unicode characters in UTF-8. # # * Accepted characters: all letters and numbers, spaces representable # in UTF-8, and + - = . \_ : / @. If your tagging schema is used # across other services and resources, the character restrictions of # those services also apply. # # * Key prefixes cannot include any upper or lowercase combination of # `aws:` or `AWS:`. Values can have this prefix. If a tag value has # `aws` as its prefix but the key does not, Forecast considers it to # be a user tag and will count against the limit of 50 tags. Tags with # only the key prefix of `aws` do not count against your tags per # resource limit. You cannot edit or delete tag keys with this prefix. # # @option params [String] :format # The format of the exported data, CSV or PARQUET. The default value is # CSV. # # @return [Types::CreatePredictorBacktestExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreatePredictorBacktestExportJobResponse#predictor_backtest_export_job_arn #predictor_backtest_export_job_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_predictor_backtest_export_job({ # predictor_backtest_export_job_name: "Name", # required # predictor_arn: "Arn", # required # destination: { # required # s3_config: { # required # path: "S3Path", # required # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # }, # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # format: "Format", # }) # # @example Response structure # # resp.predictor_backtest_export_job_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJob AWS API Documentation # # @overload create_predictor_backtest_export_job(params = {}) # @param [Hash] params ({}) def create_predictor_backtest_export_job(params = {}, options = {}) req = build_request(:create_predictor_backtest_export_job, params) req.send_request(options) end # What-if analysis is a scenario modeling technique where you make a # hypothetical change to a time series and compare the forecasts # generated by these changes against the baseline, unchanged time # series. It is important to remember that the purpose of a what-if # analysis is to understand how a forecast can change given different # modifications to the baseline time series. # # For example, imagine you are a clothing retailer who is considering an # end of season sale to clear space for new styles. After creating a # baseline forecast, you can use a what-if analysis to investigate how # different sales tactics might affect your goals. # # You could create a scenario where everything is given a 25% markdown, # and another where everything is given a fixed dollar markdown. You # could create a scenario where the sale lasts for one week and another # where the sale lasts for one month. With a what-if analysis, you can # compare many different scenarios against each other. # # Note that a what-if analysis is meant to display what the forecasting # model has learned and how it will behave in the scenarios that you are # evaluating. Do not blindly use the results of the what-if analysis to # make business decisions. For instance, forecasts might not be accurate # for novel scenarios where there is no reference available to determine # whether a forecast is good. # # The TimeSeriesSelector object defines the items that you want in the # what-if analysis. # # @option params [required, String] :what_if_analysis_name # The name of the what-if analysis. Each name must be unique. # # @option params [required, String] :forecast_arn # The Amazon Resource Name (ARN) of the baseline forecast. # # @option params [Types::TimeSeriesSelector] :time_series_selector # Defines the set of time series that are used in the what-if analysis # with a `TimeSeriesIdentifiers` object. What-if analyses are performed # only for the time series in this object. # # The `TimeSeriesIdentifiers` object needs the following information: # # * `DataSource` # # * `Format` # # * `Schema` # # @option params [Array] :tags # A list of [tags][1] to apply to the what if forecast. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html # # @return [Types::CreateWhatIfAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateWhatIfAnalysisResponse#what_if_analysis_arn #what_if_analysis_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_what_if_analysis({ # what_if_analysis_name: "Name", # required # forecast_arn: "Arn", # required # time_series_selector: { # time_series_identifiers: { # data_source: { # s3_config: { # required # path: "S3Path", # required # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # }, # }, # schema: { # attributes: [ # { # attribute_name: "Name", # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation # }, # ], # }, # format: "Format", # }, # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @example Response structure # # resp.what_if_analysis_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfAnalysis AWS API Documentation # # @overload create_what_if_analysis(params = {}) # @param [Hash] params ({}) def create_what_if_analysis(params = {}, options = {}) req = build_request(:create_what_if_analysis, params) req.send_request(options) end # A what-if forecast is a forecast that is created from a modified # version of the baseline forecast. Each what-if forecast incorporates # either a replacement dataset or a set of transformations to the # original dataset. # # @option params [required, String] :what_if_forecast_name # The name of the what-if forecast. Names must be unique within each # what-if analysis. # # @option params [required, String] :what_if_analysis_arn # The Amazon Resource Name (ARN) of the what-if analysis. # # @option params [Array] :time_series_transformations # The transformations that are applied to the baseline time series. Each # transformation contains an action and a set of conditions. An action # is applied only when all conditions are met. If no conditions are # provided, the action is applied to all items. # # @option params [Types::TimeSeriesReplacementsDataSource] :time_series_replacements_data_source # The replacement time series dataset, which contains the rows that you # want to change in the related time series dataset. A replacement time # series does not need to contain all rows that are in the baseline # related time series. Include only the rows (measure-dimension # combinations) that you want to include in the what-if forecast. # # This dataset is merged with the original time series to create a # transformed dataset that is used for the what-if analysis. # # This dataset should contain the items to modify (such as item\_id or # workforce\_type), any relevant dimensions, the timestamp column, and # at least one of the related time series columns. This file should not # contain duplicate timestamps for the same time series. # # Timestamps and item\_ids not included in this dataset are not included # in the what-if analysis. # # @option params [Array] :tags # A list of [tags][1] to apply to the what if forecast. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html # # @return [Types::CreateWhatIfForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateWhatIfForecastResponse#what_if_forecast_arn #what_if_forecast_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_what_if_forecast({ # what_if_forecast_name: "Name", # required # what_if_analysis_arn: "Arn", # required # time_series_transformations: [ # { # action: { # attribute_name: "Name", # required # operation: "ADD", # required, accepts ADD, SUBTRACT, MULTIPLY, DIVIDE # value: 1.0, # required # }, # time_series_conditions: [ # { # attribute_name: "Name", # required # attribute_value: "AttributeValue", # required # condition: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, LESS_THAN, GREATER_THAN # }, # ], # }, # ], # time_series_replacements_data_source: { # s3_config: { # required # path: "S3Path", # required # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # }, # schema: { # required # attributes: [ # { # attribute_name: "Name", # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation # }, # ], # }, # format: "Format", # timestamp_format: "TimestampFormat", # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @example Response structure # # resp.what_if_forecast_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecast AWS API Documentation # # @overload create_what_if_forecast(params = {}) # @param [Hash] params ({}) def create_what_if_forecast(params = {}, options = {}) req = build_request(:create_what_if_forecast, params) req.send_request(options) end # Exports a forecast created by the CreateWhatIfForecast operation to # your Amazon Simple Storage Service (Amazon S3) bucket. The forecast # file name will match the following conventions: # # `≈__` # # The <ExportTimestamp> component is in Java SimpleDateFormat # (yyyy-MM-ddTHH-mm-ssZ). # # You must specify a DataDestination object that includes an 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. # # For more information, see howitworks-forecast. # # To get a list of all your what-if forecast export jobs, use the # ListWhatIfForecastExports operation. # # The `Status` of the forecast export job must be `ACTIVE` before you # can access the forecast in your Amazon S3 bucket. To get the status, # use the DescribeWhatIfForecastExport operation. # # # # @option params [required, String] :what_if_forecast_export_name # The name of the what-if forecast to export. # # @option params [required, Array] :what_if_forecast_arns # The list of what-if forecast Amazon Resource Names (ARNs) to export. # # @option params [required, Types::DataDestination] :destination # The location where you want to save the forecast and an Identity and # Access Management (IAM) role that Amazon Forecast can assume to access # the location. The forecast must be exported to an Amazon S3 bucket. # # If encryption is used, `Destination` must include an Key Management # Service (KMS) key. The IAM role must allow Amazon Forecast permission # to access the key. # # @option params [Array] :tags # A list of [tags][1] to apply to the what if forecast. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html # # @option params [String] :format # The format of the exported data, CSV or PARQUET. # # @return [Types::CreateWhatIfForecastExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateWhatIfForecastExportResponse#what_if_forecast_export_arn #what_if_forecast_export_arn} => String # # @example Request syntax with placeholder values # # resp = client.create_what_if_forecast_export({ # what_if_forecast_export_name: "Name", # required # what_if_forecast_arns: ["LongArn"], # required # destination: { # required # s3_config: { # required # path: "S3Path", # required # role_arn: "Arn", # required # kms_key_arn: "KMSKeyArn", # }, # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # format: "Format", # }) # # @example Response structure # # resp.what_if_forecast_export_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecastExport AWS API Documentation # # @overload create_what_if_forecast_export(params = {}) # @param [Hash] params ({}) def create_what_if_forecast_export(params = {}, options = {}) req = build_request(:create_what_if_forecast_export, params) req.send_request(options) end # Deletes an Amazon Forecast dataset that was created using the # [CreateDataset][1] operation. You can only delete datasets that have a # status of `ACTIVE` or `CREATE_FAILED`. To get the status use the # [DescribeDataset][2] operation. # # Forecast does not automatically update any dataset groups that contain # the deleted dataset. In order to update the dataset group, use the # [UpdateDatasetGroup][3] operation, omitting the deleted dataset's # ARN. # # # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html # # @option params [required, String] :dataset_arn # The Amazon Resource Name (ARN) of the dataset to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_dataset({ # dataset_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDataset AWS API Documentation # # @overload delete_dataset(params = {}) # @param [Hash] params ({}) def delete_dataset(params = {}, options = {}) req = build_request(:delete_dataset, params) req.send_request(options) end # Deletes a dataset group created using the [CreateDatasetGroup][1] # operation. You can only delete dataset groups that have a status of # `ACTIVE`, `CREATE_FAILED`, or `UPDATE_FAILED`. To get the status, use # the [DescribeDatasetGroup][2] operation. # # This operation deletes only the dataset group, not the datasets in the # group. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html # # @option params [required, String] :dataset_group_arn # The Amazon Resource Name (ARN) of the dataset group to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_dataset_group({ # dataset_group_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetGroup AWS API Documentation # # @overload delete_dataset_group(params = {}) # @param [Hash] params ({}) def delete_dataset_group(params = {}, options = {}) req = build_request(:delete_dataset_group, params) req.send_request(options) end # Deletes a dataset import job created using the # [CreateDatasetImportJob][1] operation. You can delete only dataset # import jobs that have a status of `ACTIVE` or `CREATE_FAILED`. To get # the status, use the [DescribeDatasetImportJob][2] operation. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html # # @option params [required, String] :dataset_import_job_arn # The Amazon Resource Name (ARN) of the dataset import job to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_dataset_import_job({ # dataset_import_job_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetImportJob AWS API Documentation # # @overload delete_dataset_import_job(params = {}) # @param [Hash] params ({}) def delete_dataset_import_job(params = {}, options = {}) req = build_request(:delete_dataset_import_job, params) req.send_request(options) end # Deletes an Explainability resource. # # You can delete only predictor that have a status of `ACTIVE` or # `CREATE_FAILED`. To get the status, use the DescribeExplainability # operation. # # @option params [required, String] :explainability_arn # The Amazon Resource Name (ARN) of the Explainability resource to # delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_explainability({ # explainability_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainability AWS API Documentation # # @overload delete_explainability(params = {}) # @param [Hash] params ({}) def delete_explainability(params = {}, options = {}) req = build_request(:delete_explainability, params) req.send_request(options) end # Deletes an Explainability export. # # @option params [required, String] :explainability_export_arn # The Amazon Resource Name (ARN) of the Explainability export to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_explainability_export({ # explainability_export_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExport AWS API Documentation # # @overload delete_explainability_export(params = {}) # @param [Hash] params ({}) def delete_explainability_export(params = {}, options = {}) req = build_request(:delete_explainability_export, params) req.send_request(options) end # Deletes a forecast created using the CreateForecast operation. You can # delete only forecasts that have a status of `ACTIVE` or # `CREATE_FAILED`. To get the status, use the DescribeForecast # operation. # # You can't delete a forecast while it is being exported. After a # forecast is deleted, you can no longer query the forecast. # # @option params [required, String] :forecast_arn # The Amazon Resource Name (ARN) of the forecast to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_forecast({ # forecast_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecast AWS API Documentation # # @overload delete_forecast(params = {}) # @param [Hash] params ({}) def delete_forecast(params = {}, options = {}) req = build_request(:delete_forecast, params) req.send_request(options) end # Deletes a forecast export job created using the # CreateForecastExportJob operation. You can delete only export jobs # that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, # use the DescribeForecastExportJob operation. # # @option params [required, String] :forecast_export_job_arn # The Amazon Resource Name (ARN) of the forecast export job to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_forecast_export_job({ # forecast_export_job_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastExportJob AWS API Documentation # # @overload delete_forecast_export_job(params = {}) # @param [Hash] params ({}) def delete_forecast_export_job(params = {}, options = {}) req = build_request(:delete_forecast_export_job, params) req.send_request(options) end # Deletes a monitor resource. You can only delete a monitor resource # with a status of `ACTIVE`, `ACTIVE_STOPPED`, `CREATE_FAILED`, or # `CREATE_STOPPED`. # # @option params [required, String] :monitor_arn # The Amazon Resource Name (ARN) of the monitor resource to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_monitor({ # monitor_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteMonitor AWS API Documentation # # @overload delete_monitor(params = {}) # @param [Hash] params ({}) def delete_monitor(params = {}, options = {}) req = build_request(:delete_monitor, params) req.send_request(options) end # Deletes a predictor created using the DescribePredictor or # CreatePredictor operations. You can delete only predictor that have a # status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the # DescribePredictor operation. # # @option params [required, String] :predictor_arn # The Amazon Resource Name (ARN) of the predictor to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_predictor({ # predictor_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictor AWS API Documentation # # @overload delete_predictor(params = {}) # @param [Hash] params ({}) def delete_predictor(params = {}, options = {}) req = build_request(:delete_predictor, params) req.send_request(options) end # Deletes a predictor backtest export job. # # @option params [required, String] :predictor_backtest_export_job_arn # The Amazon Resource Name (ARN) of the predictor backtest export job to # delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_predictor_backtest_export_job({ # predictor_backtest_export_job_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJob AWS API Documentation # # @overload delete_predictor_backtest_export_job(params = {}) # @param [Hash] params ({}) def delete_predictor_backtest_export_job(params = {}, options = {}) req = build_request(:delete_predictor_backtest_export_job, params) req.send_request(options) end # Deletes an entire resource tree. This operation will delete the parent # resource and its child resources. # # Child resources are resources that were created from another resource. # For example, when a forecast is generated from a predictor, the # forecast is the child resource and the predictor is the parent # resource. # # Amazon Forecast resources possess the following parent-child resource # hierarchies: # # * **Dataset**: dataset import jobs # # * **Dataset Group**: predictors, predictor backtest export jobs, # forecasts, forecast export jobs # # * **Predictor**: predictor backtest export jobs, forecasts, forecast # export jobs # # * **Forecast**: forecast export jobs # # `DeleteResourceTree` will only delete Amazon Forecast resources, and # will not delete datasets or exported files stored in Amazon S3. # # # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the parent resource to delete. All # child resources of the parent resource will also be deleted. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_resource_tree({ # resource_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteResourceTree AWS API Documentation # # @overload delete_resource_tree(params = {}) # @param [Hash] params ({}) def delete_resource_tree(params = {}, options = {}) req = build_request(:delete_resource_tree, params) req.send_request(options) end # Deletes a what-if analysis created using the CreateWhatIfAnalysis # operation. You can delete only what-if analyses that have a status of # `ACTIVE` or `CREATE_FAILED`. To get the status, use the # DescribeWhatIfAnalysis operation. # # You can't delete a what-if analysis while any of its forecasts are # being exported. # # @option params [required, String] :what_if_analysis_arn # The Amazon Resource Name (ARN) of the what-if analysis that you want # to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_what_if_analysis({ # what_if_analysis_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfAnalysis AWS API Documentation # # @overload delete_what_if_analysis(params = {}) # @param [Hash] params ({}) def delete_what_if_analysis(params = {}, options = {}) req = build_request(:delete_what_if_analysis, params) req.send_request(options) end # Deletes a what-if forecast created using the CreateWhatIfForecast # operation. You can delete only what-if forecasts that have a status of # `ACTIVE` or `CREATE_FAILED`. To get the status, use the # DescribeWhatIfForecast operation. # # You can't delete a what-if forecast while it is being exported. After # a what-if forecast is deleted, you can no longer query the what-if # analysis. # # @option params [required, String] :what_if_forecast_arn # The Amazon Resource Name (ARN) of the what-if forecast that you want # to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_what_if_forecast({ # what_if_forecast_arn: "LongArn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfForecast AWS API Documentation # # @overload delete_what_if_forecast(params = {}) # @param [Hash] params ({}) def delete_what_if_forecast(params = {}, options = {}) req = build_request(:delete_what_if_forecast, params) req.send_request(options) end # Deletes a what-if forecast export created using the # CreateWhatIfForecastExport operation. You can delete only what-if # forecast exports that have a status of `ACTIVE` or `CREATE_FAILED`. To # get the status, use the DescribeWhatIfForecastExport operation. # # @option params [required, String] :what_if_forecast_export_arn # The Amazon Resource Name (ARN) of the what-if forecast export that you # want to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_what_if_forecast_export({ # what_if_forecast_export_arn: "LongArn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfForecastExport AWS API Documentation # # @overload delete_what_if_forecast_export(params = {}) # @param [Hash] params ({}) def delete_what_if_forecast_export(params = {}, options = {}) req = build_request(:delete_what_if_forecast_export, params) req.send_request(options) end # Describes a predictor created using the CreateAutoPredictor operation. # # @option params [required, String] :predictor_arn # The Amazon Resource Name (ARN) of the predictor. # # @return [Types::DescribeAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeAutoPredictorResponse#predictor_arn #predictor_arn} => String # * {Types::DescribeAutoPredictorResponse#predictor_name #predictor_name} => String # * {Types::DescribeAutoPredictorResponse#forecast_horizon #forecast_horizon} => Integer # * {Types::DescribeAutoPredictorResponse#forecast_types #forecast_types} => Array<String> # * {Types::DescribeAutoPredictorResponse#forecast_frequency #forecast_frequency} => String # * {Types::DescribeAutoPredictorResponse#forecast_dimensions #forecast_dimensions} => Array<String> # * {Types::DescribeAutoPredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array<String> # * {Types::DescribeAutoPredictorResponse#data_config #data_config} => Types::DataConfig # * {Types::DescribeAutoPredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig # * {Types::DescribeAutoPredictorResponse#reference_predictor_summary #reference_predictor_summary} => Types::ReferencePredictorSummary # * {Types::DescribeAutoPredictorResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer # * {Types::DescribeAutoPredictorResponse#status #status} => String # * {Types::DescribeAutoPredictorResponse#message #message} => String # * {Types::DescribeAutoPredictorResponse#creation_time #creation_time} => Time # * {Types::DescribeAutoPredictorResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribeAutoPredictorResponse#optimization_metric #optimization_metric} => String # * {Types::DescribeAutoPredictorResponse#explainability_info #explainability_info} => Types::ExplainabilityInfo # * {Types::DescribeAutoPredictorResponse#monitor_info #monitor_info} => Types::MonitorInfo # * {Types::DescribeAutoPredictorResponse#time_alignment_boundary #time_alignment_boundary} => Types::TimeAlignmentBoundary # # @example Request syntax with placeholder values # # resp = client.describe_auto_predictor({ # predictor_arn: "Arn", # required # }) # # @example Response structure # # resp.predictor_arn #=> String # resp.predictor_name #=> String # resp.forecast_horizon #=> Integer # resp.forecast_types #=> Array # resp.forecast_types[0] #=> String # resp.forecast_frequency #=> String # resp.forecast_dimensions #=> Array # resp.forecast_dimensions[0] #=> String # resp.dataset_import_job_arns #=> Array # resp.dataset_import_job_arns[0] #=> String # resp.data_config.dataset_group_arn #=> String # resp.data_config.attribute_configs #=> Array # resp.data_config.attribute_configs[0].attribute_name #=> String # resp.data_config.attribute_configs[0].transformations #=> Hash # resp.data_config.attribute_configs[0].transformations["Name"] #=> String # resp.data_config.additional_datasets #=> Array # resp.data_config.additional_datasets[0].name #=> String # resp.data_config.additional_datasets[0].configuration #=> Hash # resp.data_config.additional_datasets[0].configuration["Name"] #=> Array # resp.data_config.additional_datasets[0].configuration["Name"][0] #=> String # resp.encryption_config.role_arn #=> String # resp.encryption_config.kms_key_arn #=> String # resp.reference_predictor_summary.arn #=> String # resp.reference_predictor_summary.state #=> String, one of "Active", "Deleted" # resp.estimated_time_remaining_in_minutes #=> Integer # resp.status #=> String # resp.message #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE" # resp.explainability_info.explainability_arn #=> String # resp.explainability_info.status #=> String # resp.monitor_info.monitor_arn #=> String # resp.monitor_info.status #=> String # resp.time_alignment_boundary.month #=> String, one of "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" # resp.time_alignment_boundary.day_of_month #=> Integer # resp.time_alignment_boundary.day_of_week #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" # resp.time_alignment_boundary.hour #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor AWS API Documentation # # @overload describe_auto_predictor(params = {}) # @param [Hash] params ({}) def describe_auto_predictor(params = {}, options = {}) req = build_request(:describe_auto_predictor, params) req.send_request(options) end # Describes an Amazon Forecast dataset created using the # [CreateDataset][1] operation. # # In addition to listing the parameters specified in the `CreateDataset` # request, this operation includes the following dataset properties: # # * `CreationTime` # # * `LastModificationTime` # # * `Status` # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html # # @option params [required, String] :dataset_arn # The Amazon Resource Name (ARN) of the dataset. # # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDatasetResponse#dataset_arn #dataset_arn} => String # * {Types::DescribeDatasetResponse#dataset_name #dataset_name} => String # * {Types::DescribeDatasetResponse#domain #domain} => String # * {Types::DescribeDatasetResponse#dataset_type #dataset_type} => String # * {Types::DescribeDatasetResponse#data_frequency #data_frequency} => String # * {Types::DescribeDatasetResponse#schema #schema} => Types::Schema # * {Types::DescribeDatasetResponse#encryption_config #encryption_config} => Types::EncryptionConfig # * {Types::DescribeDatasetResponse#status #status} => String # * {Types::DescribeDatasetResponse#creation_time #creation_time} => Time # * {Types::DescribeDatasetResponse#last_modification_time #last_modification_time} => Time # # @example Request syntax with placeholder values # # resp = client.describe_dataset({ # dataset_arn: "Arn", # required # }) # # @example Response structure # # resp.dataset_arn #=> String # resp.dataset_name #=> String # resp.domain #=> String, one of "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS" # resp.dataset_type #=> String, one of "TARGET_TIME_SERIES", "RELATED_TIME_SERIES", "ITEM_METADATA" # 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", "geolocation" # resp.encryption_config.role_arn #=> String # resp.encryption_config.kms_key_arn #=> String # resp.status #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDataset AWS API Documentation # # @overload describe_dataset(params = {}) # @param [Hash] params ({}) def describe_dataset(params = {}, options = {}) req = build_request(:describe_dataset, params) req.send_request(options) end # Describes a dataset group created using the [CreateDatasetGroup][1] # operation. # # In addition to listing the parameters provided in the # `CreateDatasetGroup` request, this operation includes the following # properties: # # * `DatasetArns` - The datasets belonging to the group. # # * `CreationTime` # # * `LastModificationTime` # # * `Status` # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html # # @option params [required, String] :dataset_group_arn # The Amazon Resource Name (ARN) of the dataset group. # # @return [Types::DescribeDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDatasetGroupResponse#dataset_group_name #dataset_group_name} => String # * {Types::DescribeDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String # * {Types::DescribeDatasetGroupResponse#dataset_arns #dataset_arns} => Array<String> # * {Types::DescribeDatasetGroupResponse#domain #domain} => String # * {Types::DescribeDatasetGroupResponse#status #status} => String # * {Types::DescribeDatasetGroupResponse#creation_time #creation_time} => Time # * {Types::DescribeDatasetGroupResponse#last_modification_time #last_modification_time} => Time # # @example Request syntax with placeholder values # # resp = client.describe_dataset_group({ # dataset_group_arn: "Arn", # required # }) # # @example Response structure # # resp.dataset_group_name #=> String # resp.dataset_group_arn #=> String # resp.dataset_arns #=> Array # resp.dataset_arns[0] #=> String # resp.domain #=> String, one of "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS" # resp.status #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetGroup AWS API Documentation # # @overload describe_dataset_group(params = {}) # @param [Hash] params ({}) def describe_dataset_group(params = {}, options = {}) req = build_request(:describe_dataset_group, params) req.send_request(options) end # Describes a dataset import job created using the # [CreateDatasetImportJob][1] operation. # # In addition to listing the parameters provided in the # `CreateDatasetImportJob` request, this operation includes the # following properties: # # * `CreationTime` # # * `LastModificationTime` # # * `DataSize` # # * `FieldStatistics` # # * `Status` # # * `Message` - If an error occurred, information about the error. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html # # @option params [required, String] :dataset_import_job_arn # The Amazon Resource Name (ARN) of the dataset import job. # # @return [Types::DescribeDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDatasetImportJobResponse#dataset_import_job_name #dataset_import_job_name} => String # * {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#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer # * {Types::DescribeDatasetImportJobResponse#field_statistics #field_statistics} => Hash<String,Types::Statistics> # * {Types::DescribeDatasetImportJobResponse#data_size #data_size} => Float # * {Types::DescribeDatasetImportJobResponse#status #status} => String # * {Types::DescribeDatasetImportJobResponse#message #message} => String # * {Types::DescribeDatasetImportJobResponse#creation_time #creation_time} => Time # * {Types::DescribeDatasetImportJobResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribeDatasetImportJobResponse#format #format} => String # * {Types::DescribeDatasetImportJobResponse#import_mode #import_mode} => String # # @example Request syntax with placeholder values # # resp = client.describe_dataset_import_job({ # dataset_import_job_arn: "Arn", # required # }) # # @example Response structure # # resp.dataset_import_job_name #=> String # 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 # resp.estimated_time_remaining_in_minutes #=> Integer # resp.field_statistics #=> Hash # resp.field_statistics["String"].count #=> Integer # resp.field_statistics["String"].count_distinct #=> Integer # resp.field_statistics["String"].count_null #=> Integer # resp.field_statistics["String"].count_nan #=> Integer # resp.field_statistics["String"].min #=> String # resp.field_statistics["String"].max #=> String # resp.field_statistics["String"].avg #=> Float # resp.field_statistics["String"].stddev #=> Float # resp.field_statistics["String"].count_long #=> Integer # resp.field_statistics["String"].count_distinct_long #=> Integer # resp.field_statistics["String"].count_null_long #=> Integer # resp.field_statistics["String"].count_nan_long #=> Integer # resp.data_size #=> Float # resp.status #=> String # resp.message #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.format #=> String # resp.import_mode #=> String, one of "FULL", "INCREMENTAL" # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJob AWS API Documentation # # @overload describe_dataset_import_job(params = {}) # @param [Hash] params ({}) def describe_dataset_import_job(params = {}, options = {}) req = build_request(:describe_dataset_import_job, params) req.send_request(options) end # Describes an Explainability resource created using the # CreateExplainability operation. # # @option params [required, String] :explainability_arn # The Amazon Resource Name (ARN) of the Explaianability to describe. # # @return [Types::DescribeExplainabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeExplainabilityResponse#explainability_arn #explainability_arn} => String # * {Types::DescribeExplainabilityResponse#explainability_name #explainability_name} => String # * {Types::DescribeExplainabilityResponse#resource_arn #resource_arn} => String # * {Types::DescribeExplainabilityResponse#explainability_config #explainability_config} => Types::ExplainabilityConfig # * {Types::DescribeExplainabilityResponse#enable_visualization #enable_visualization} => Boolean # * {Types::DescribeExplainabilityResponse#data_source #data_source} => Types::DataSource # * {Types::DescribeExplainabilityResponse#schema #schema} => Types::Schema # * {Types::DescribeExplainabilityResponse#start_date_time #start_date_time} => String # * {Types::DescribeExplainabilityResponse#end_date_time #end_date_time} => String # * {Types::DescribeExplainabilityResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer # * {Types::DescribeExplainabilityResponse#message #message} => String # * {Types::DescribeExplainabilityResponse#status #status} => String # * {Types::DescribeExplainabilityResponse#creation_time #creation_time} => Time # * {Types::DescribeExplainabilityResponse#last_modification_time #last_modification_time} => Time # # @example Request syntax with placeholder values # # resp = client.describe_explainability({ # explainability_arn: "Arn", # required # }) # # @example Response structure # # resp.explainability_arn #=> String # resp.explainability_name #=> String # resp.resource_arn #=> String # resp.explainability_config.time_series_granularity #=> String, one of "ALL", "SPECIFIC" # resp.explainability_config.time_point_granularity #=> String, one of "ALL", "SPECIFIC" # resp.enable_visualization #=> Boolean # resp.data_source.s3_config.path #=> String # resp.data_source.s3_config.role_arn #=> String # resp.data_source.s3_config.kms_key_arn #=> 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", "geolocation" # resp.start_date_time #=> String # resp.end_date_time #=> String # resp.estimated_time_remaining_in_minutes #=> Integer # resp.message #=> String # resp.status #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainability AWS API Documentation # # @overload describe_explainability(params = {}) # @param [Hash] params ({}) def describe_explainability(params = {}, options = {}) req = build_request(:describe_explainability, params) req.send_request(options) end # Describes an Explainability export created using the # CreateExplainabilityExport operation. # # @option params [required, String] :explainability_export_arn # The Amazon Resource Name (ARN) of the Explainability export. # # @return [Types::DescribeExplainabilityExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeExplainabilityExportResponse#explainability_export_arn #explainability_export_arn} => String # * {Types::DescribeExplainabilityExportResponse#explainability_export_name #explainability_export_name} => String # * {Types::DescribeExplainabilityExportResponse#explainability_arn #explainability_arn} => String # * {Types::DescribeExplainabilityExportResponse#destination #destination} => Types::DataDestination # * {Types::DescribeExplainabilityExportResponse#message #message} => String # * {Types::DescribeExplainabilityExportResponse#status #status} => String # * {Types::DescribeExplainabilityExportResponse#creation_time #creation_time} => Time # * {Types::DescribeExplainabilityExportResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribeExplainabilityExportResponse#format #format} => String # # @example Request syntax with placeholder values # # resp = client.describe_explainability_export({ # explainability_export_arn: "Arn", # required # }) # # @example Response structure # # resp.explainability_export_arn #=> String # resp.explainability_export_name #=> String # resp.explainability_arn #=> String # resp.destination.s3_config.path #=> String # resp.destination.s3_config.role_arn #=> String # resp.destination.s3_config.kms_key_arn #=> String # resp.message #=> String # resp.status #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.format #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExport AWS API Documentation # # @overload describe_explainability_export(params = {}) # @param [Hash] params ({}) def describe_explainability_export(params = {}, options = {}) req = build_request(:describe_explainability_export, params) req.send_request(options) end # Describes a forecast created using the CreateForecast operation. # # In addition to listing the properties provided in the `CreateForecast` # request, this operation lists the following properties: # # * `DatasetGroupArn` - The dataset group that provided the training # data. # # * `CreationTime` # # * `LastModificationTime` # # * `Status` # # * `Message` - If an error occurred, information about the error. # # @option params [required, String] :forecast_arn # The Amazon Resource Name (ARN) of the forecast. # # @return [Types::DescribeForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeForecastResponse#forecast_arn #forecast_arn} => String # * {Types::DescribeForecastResponse#forecast_name #forecast_name} => String # * {Types::DescribeForecastResponse#forecast_types #forecast_types} => Array<String> # * {Types::DescribeForecastResponse#predictor_arn #predictor_arn} => String # * {Types::DescribeForecastResponse#dataset_group_arn #dataset_group_arn} => String # * {Types::DescribeForecastResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer # * {Types::DescribeForecastResponse#status #status} => String # * {Types::DescribeForecastResponse#message #message} => String # * {Types::DescribeForecastResponse#creation_time #creation_time} => Time # * {Types::DescribeForecastResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribeForecastResponse#time_series_selector #time_series_selector} => Types::TimeSeriesSelector # # @example Request syntax with placeholder values # # resp = client.describe_forecast({ # forecast_arn: "Arn", # required # }) # # @example Response structure # # resp.forecast_arn #=> String # resp.forecast_name #=> String # resp.forecast_types #=> Array # resp.forecast_types[0] #=> String # resp.predictor_arn #=> String # resp.dataset_group_arn #=> String # resp.estimated_time_remaining_in_minutes #=> Integer # resp.status #=> String # resp.message #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.time_series_selector.time_series_identifiers.data_source.s3_config.path #=> String # resp.time_series_selector.time_series_identifiers.data_source.s3_config.role_arn #=> String # resp.time_series_selector.time_series_identifiers.data_source.s3_config.kms_key_arn #=> String # resp.time_series_selector.time_series_identifiers.schema.attributes #=> Array # resp.time_series_selector.time_series_identifiers.schema.attributes[0].attribute_name #=> String # resp.time_series_selector.time_series_identifiers.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation" # resp.time_series_selector.time_series_identifiers.format #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecast AWS API Documentation # # @overload describe_forecast(params = {}) # @param [Hash] params ({}) def describe_forecast(params = {}, options = {}) req = build_request(:describe_forecast, params) req.send_request(options) end # Describes a forecast export job created using the # CreateForecastExportJob operation. # # In addition to listing the properties provided by the user in the # `CreateForecastExportJob` request, this operation lists the following # properties: # # * `CreationTime` # # * `LastModificationTime` # # * `Status` # # * `Message` - If an error occurred, information about the error. # # @option params [required, String] :forecast_export_job_arn # The Amazon Resource Name (ARN) of the forecast export job. # # @return [Types::DescribeForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeForecastExportJobResponse#forecast_export_job_arn #forecast_export_job_arn} => String # * {Types::DescribeForecastExportJobResponse#forecast_export_job_name #forecast_export_job_name} => String # * {Types::DescribeForecastExportJobResponse#forecast_arn #forecast_arn} => String # * {Types::DescribeForecastExportJobResponse#destination #destination} => Types::DataDestination # * {Types::DescribeForecastExportJobResponse#message #message} => String # * {Types::DescribeForecastExportJobResponse#status #status} => String # * {Types::DescribeForecastExportJobResponse#creation_time #creation_time} => Time # * {Types::DescribeForecastExportJobResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribeForecastExportJobResponse#format #format} => String # # @example Request syntax with placeholder values # # resp = client.describe_forecast_export_job({ # forecast_export_job_arn: "Arn", # required # }) # # @example Response structure # # resp.forecast_export_job_arn #=> String # resp.forecast_export_job_name #=> String # resp.forecast_arn #=> String # resp.destination.s3_config.path #=> String # resp.destination.s3_config.role_arn #=> String # resp.destination.s3_config.kms_key_arn #=> String # resp.message #=> String # resp.status #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.format #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJob AWS API Documentation # # @overload describe_forecast_export_job(params = {}) # @param [Hash] params ({}) def describe_forecast_export_job(params = {}, options = {}) req = build_request(:describe_forecast_export_job, params) req.send_request(options) end # Describes a monitor resource. In addition to listing the properties # provided in the CreateMonitor request, this operation lists the # following properties: # # * `Baseline` # # * `CreationTime` # # * `LastEvaluationTime` # # * `LastEvaluationState` # # * `LastModificationTime` # # * `Message` # # * `Status` # # @option params [required, String] :monitor_arn # The Amazon Resource Name (ARN) of the monitor resource to describe. # # @return [Types::DescribeMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeMonitorResponse#monitor_name #monitor_name} => String # * {Types::DescribeMonitorResponse#monitor_arn #monitor_arn} => String # * {Types::DescribeMonitorResponse#resource_arn #resource_arn} => String # * {Types::DescribeMonitorResponse#status #status} => String # * {Types::DescribeMonitorResponse#last_evaluation_time #last_evaluation_time} => Time # * {Types::DescribeMonitorResponse#last_evaluation_state #last_evaluation_state} => String # * {Types::DescribeMonitorResponse#baseline #baseline} => Types::Baseline # * {Types::DescribeMonitorResponse#message #message} => String # * {Types::DescribeMonitorResponse#creation_time #creation_time} => Time # * {Types::DescribeMonitorResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribeMonitorResponse#estimated_evaluation_time_remaining_in_minutes #estimated_evaluation_time_remaining_in_minutes} => Integer # # @example Request syntax with placeholder values # # resp = client.describe_monitor({ # monitor_arn: "Arn", # required # }) # # @example Response structure # # resp.monitor_name #=> String # resp.monitor_arn #=> String # resp.resource_arn #=> String # resp.status #=> String # resp.last_evaluation_time #=> Time # resp.last_evaluation_state #=> String # resp.baseline.predictor_baseline.baseline_metrics #=> Array # resp.baseline.predictor_baseline.baseline_metrics[0].name #=> String # resp.baseline.predictor_baseline.baseline_metrics[0].value #=> Float # resp.message #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.estimated_evaluation_time_remaining_in_minutes #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitor AWS API Documentation # # @overload describe_monitor(params = {}) # @param [Hash] params ({}) def describe_monitor(params = {}, options = {}) req = build_request(:describe_monitor, params) req.send_request(options) end # This operation is only valid for legacy predictors created with # CreatePredictor. If you are not using a legacy predictor, use # DescribeAutoPredictor. # # # # Describes a predictor created using the CreatePredictor operation. # # In addition to listing the properties provided in the # `CreatePredictor` request, this operation lists the following # properties: # # * `DatasetImportJobArns` - The dataset import jobs used to import # training data. # # * `AutoMLAlgorithmArns` - If AutoML is performed, the algorithms that # were evaluated. # # * `CreationTime` # # * `LastModificationTime` # # * `Status` # # * `Message` - If an error occurred, information about the error. # # @option params [required, String] :predictor_arn # The Amazon Resource Name (ARN) of the predictor that you want # information about. # # @return [Types::DescribePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribePredictorResponse#predictor_arn #predictor_arn} => String # * {Types::DescribePredictorResponse#predictor_name #predictor_name} => String # * {Types::DescribePredictorResponse#algorithm_arn #algorithm_arn} => String # * {Types::DescribePredictorResponse#auto_ml_algorithm_arns #auto_ml_algorithm_arns} => Array<String> # * {Types::DescribePredictorResponse#forecast_horizon #forecast_horizon} => Integer # * {Types::DescribePredictorResponse#forecast_types #forecast_types} => Array<String> # * {Types::DescribePredictorResponse#perform_auto_ml #perform_auto_ml} => Boolean # * {Types::DescribePredictorResponse#auto_ml_override_strategy #auto_ml_override_strategy} => String # * {Types::DescribePredictorResponse#perform_hpo #perform_hpo} => Boolean # * {Types::DescribePredictorResponse#training_parameters #training_parameters} => Hash<String,String> # * {Types::DescribePredictorResponse#evaluation_parameters #evaluation_parameters} => Types::EvaluationParameters # * {Types::DescribePredictorResponse#hpo_config #hpo_config} => Types::HyperParameterTuningJobConfig # * {Types::DescribePredictorResponse#input_data_config #input_data_config} => Types::InputDataConfig # * {Types::DescribePredictorResponse#featurization_config #featurization_config} => Types::FeaturizationConfig # * {Types::DescribePredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig # * {Types::DescribePredictorResponse#predictor_execution_details #predictor_execution_details} => Types::PredictorExecutionDetails # * {Types::DescribePredictorResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer # * {Types::DescribePredictorResponse#is_auto_predictor #is_auto_predictor} => Boolean # * {Types::DescribePredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array<String> # * {Types::DescribePredictorResponse#status #status} => String # * {Types::DescribePredictorResponse#message #message} => String # * {Types::DescribePredictorResponse#creation_time #creation_time} => Time # * {Types::DescribePredictorResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribePredictorResponse#optimization_metric #optimization_metric} => String # # @example Request syntax with placeholder values # # resp = client.describe_predictor({ # predictor_arn: "Arn", # required # }) # # @example Response structure # # resp.predictor_arn #=> String # resp.predictor_name #=> String # resp.algorithm_arn #=> String # resp.auto_ml_algorithm_arns #=> Array # resp.auto_ml_algorithm_arns[0] #=> String # resp.forecast_horizon #=> Integer # resp.forecast_types #=> Array # resp.forecast_types[0] #=> String # resp.perform_auto_ml #=> Boolean # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized", "AccuracyOptimized" # resp.perform_hpo #=> Boolean # resp.training_parameters #=> Hash # resp.training_parameters["ParameterKey"] #=> String # resp.evaluation_parameters.number_of_backtest_windows #=> Integer # resp.evaluation_parameters.back_test_window_offset #=> Integer # resp.hpo_config.parameter_ranges.categorical_parameter_ranges #=> Array # resp.hpo_config.parameter_ranges.categorical_parameter_ranges[0].name #=> String # resp.hpo_config.parameter_ranges.categorical_parameter_ranges[0].values #=> Array # resp.hpo_config.parameter_ranges.categorical_parameter_ranges[0].values[0] #=> String # resp.hpo_config.parameter_ranges.continuous_parameter_ranges #=> Array # resp.hpo_config.parameter_ranges.continuous_parameter_ranges[0].name #=> String # resp.hpo_config.parameter_ranges.continuous_parameter_ranges[0].max_value #=> Float # resp.hpo_config.parameter_ranges.continuous_parameter_ranges[0].min_value #=> Float # resp.hpo_config.parameter_ranges.continuous_parameter_ranges[0].scaling_type #=> String, one of "Auto", "Linear", "Logarithmic", "ReverseLogarithmic" # resp.hpo_config.parameter_ranges.integer_parameter_ranges #=> Array # resp.hpo_config.parameter_ranges.integer_parameter_ranges[0].name #=> String # resp.hpo_config.parameter_ranges.integer_parameter_ranges[0].max_value #=> Integer # resp.hpo_config.parameter_ranges.integer_parameter_ranges[0].min_value #=> Integer # resp.hpo_config.parameter_ranges.integer_parameter_ranges[0].scaling_type #=> String, one of "Auto", "Linear", "Logarithmic", "ReverseLogarithmic" # resp.input_data_config.dataset_group_arn #=> String # resp.input_data_config.supplementary_features #=> Array # resp.input_data_config.supplementary_features[0].name #=> String # resp.input_data_config.supplementary_features[0].value #=> String # resp.featurization_config.forecast_frequency #=> String # resp.featurization_config.forecast_dimensions #=> Array # resp.featurization_config.forecast_dimensions[0] #=> String # resp.featurization_config.featurizations #=> Array # resp.featurization_config.featurizations[0].attribute_name #=> String # resp.featurization_config.featurizations[0].featurization_pipeline #=> Array # resp.featurization_config.featurizations[0].featurization_pipeline[0].featurization_method_name #=> String, one of "filling" # resp.featurization_config.featurizations[0].featurization_pipeline[0].featurization_method_parameters #=> Hash # resp.featurization_config.featurizations[0].featurization_pipeline[0].featurization_method_parameters["ParameterKey"] #=> String # resp.encryption_config.role_arn #=> String # resp.encryption_config.kms_key_arn #=> String # resp.predictor_execution_details.predictor_executions #=> Array # resp.predictor_execution_details.predictor_executions[0].algorithm_arn #=> String # resp.predictor_execution_details.predictor_executions[0].test_windows #=> Array # resp.predictor_execution_details.predictor_executions[0].test_windows[0].test_window_start #=> Time # resp.predictor_execution_details.predictor_executions[0].test_windows[0].test_window_end #=> Time # resp.predictor_execution_details.predictor_executions[0].test_windows[0].status #=> String # resp.predictor_execution_details.predictor_executions[0].test_windows[0].message #=> String # resp.estimated_time_remaining_in_minutes #=> Integer # resp.is_auto_predictor #=> Boolean # resp.dataset_import_job_arns #=> Array # resp.dataset_import_job_arns[0] #=> String # resp.status #=> String # resp.message #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE" # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictor AWS API Documentation # # @overload describe_predictor(params = {}) # @param [Hash] params ({}) def describe_predictor(params = {}, options = {}) req = build_request(:describe_predictor, params) req.send_request(options) end # Describes a predictor backtest export job created using the # CreatePredictorBacktestExportJob operation. # # In addition to listing the properties provided by the user in the # `CreatePredictorBacktestExportJob` request, this operation lists the # following properties: # # * `CreationTime` # # * `LastModificationTime` # # * `Status` # # * `Message` (if an error occurred) # # @option params [required, String] :predictor_backtest_export_job_arn # The Amazon Resource Name (ARN) of the predictor backtest export job. # # @return [Types::DescribePredictorBacktestExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribePredictorBacktestExportJobResponse#predictor_backtest_export_job_arn #predictor_backtest_export_job_arn} => String # * {Types::DescribePredictorBacktestExportJobResponse#predictor_backtest_export_job_name #predictor_backtest_export_job_name} => String # * {Types::DescribePredictorBacktestExportJobResponse#predictor_arn #predictor_arn} => String # * {Types::DescribePredictorBacktestExportJobResponse#destination #destination} => Types::DataDestination # * {Types::DescribePredictorBacktestExportJobResponse#message #message} => String # * {Types::DescribePredictorBacktestExportJobResponse#status #status} => String # * {Types::DescribePredictorBacktestExportJobResponse#creation_time #creation_time} => Time # * {Types::DescribePredictorBacktestExportJobResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribePredictorBacktestExportJobResponse#format #format} => String # # @example Request syntax with placeholder values # # resp = client.describe_predictor_backtest_export_job({ # predictor_backtest_export_job_arn: "Arn", # required # }) # # @example Response structure # # resp.predictor_backtest_export_job_arn #=> String # resp.predictor_backtest_export_job_name #=> String # resp.predictor_arn #=> String # resp.destination.s3_config.path #=> String # resp.destination.s3_config.role_arn #=> String # resp.destination.s3_config.kms_key_arn #=> String # resp.message #=> String # resp.status #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.format #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJob AWS API Documentation # # @overload describe_predictor_backtest_export_job(params = {}) # @param [Hash] params ({}) def describe_predictor_backtest_export_job(params = {}, options = {}) req = build_request(:describe_predictor_backtest_export_job, params) req.send_request(options) end # Describes the what-if analysis created using the CreateWhatIfAnalysis # operation. # # In addition to listing the properties provided in the # `CreateWhatIfAnalysis` request, this operation lists the following # properties: # # * `CreationTime` # # * `LastModificationTime` # # * `Message` - If an error occurred, information about the error. # # * `Status` # # @option params [required, String] :what_if_analysis_arn # The Amazon Resource Name (ARN) of the what-if analysis that you are # interested in. # # @return [Types::DescribeWhatIfAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeWhatIfAnalysisResponse#what_if_analysis_name #what_if_analysis_name} => String # * {Types::DescribeWhatIfAnalysisResponse#what_if_analysis_arn #what_if_analysis_arn} => String # * {Types::DescribeWhatIfAnalysisResponse#forecast_arn #forecast_arn} => String # * {Types::DescribeWhatIfAnalysisResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer # * {Types::DescribeWhatIfAnalysisResponse#status #status} => String # * {Types::DescribeWhatIfAnalysisResponse#message #message} => String # * {Types::DescribeWhatIfAnalysisResponse#creation_time #creation_time} => Time # * {Types::DescribeWhatIfAnalysisResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribeWhatIfAnalysisResponse#time_series_selector #time_series_selector} => Types::TimeSeriesSelector # # @example Request syntax with placeholder values # # resp = client.describe_what_if_analysis({ # what_if_analysis_arn: "Arn", # required # }) # # @example Response structure # # resp.what_if_analysis_name #=> String # resp.what_if_analysis_arn #=> String # resp.forecast_arn #=> String # resp.estimated_time_remaining_in_minutes #=> Integer # resp.status #=> String # resp.message #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.time_series_selector.time_series_identifiers.data_source.s3_config.path #=> String # resp.time_series_selector.time_series_identifiers.data_source.s3_config.role_arn #=> String # resp.time_series_selector.time_series_identifiers.data_source.s3_config.kms_key_arn #=> String # resp.time_series_selector.time_series_identifiers.schema.attributes #=> Array # resp.time_series_selector.time_series_identifiers.schema.attributes[0].attribute_name #=> String # resp.time_series_selector.time_series_identifiers.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation" # resp.time_series_selector.time_series_identifiers.format #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfAnalysis AWS API Documentation # # @overload describe_what_if_analysis(params = {}) # @param [Hash] params ({}) def describe_what_if_analysis(params = {}, options = {}) req = build_request(:describe_what_if_analysis, params) req.send_request(options) end # Describes the what-if forecast created using the CreateWhatIfForecast # operation. # # In addition to listing the properties provided in the # `CreateWhatIfForecast` request, this operation lists the following # properties: # # * `CreationTime` # # * `LastModificationTime` # # * `Message` - If an error occurred, information about the error. # # * `Status` # # @option params [required, String] :what_if_forecast_arn # The Amazon Resource Name (ARN) of the what-if forecast that you are # interested in. # # @return [Types::DescribeWhatIfForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeWhatIfForecastResponse#what_if_forecast_name #what_if_forecast_name} => String # * {Types::DescribeWhatIfForecastResponse#what_if_forecast_arn #what_if_forecast_arn} => String # * {Types::DescribeWhatIfForecastResponse#what_if_analysis_arn #what_if_analysis_arn} => String # * {Types::DescribeWhatIfForecastResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer # * {Types::DescribeWhatIfForecastResponse#status #status} => String # * {Types::DescribeWhatIfForecastResponse#message #message} => String # * {Types::DescribeWhatIfForecastResponse#creation_time #creation_time} => Time # * {Types::DescribeWhatIfForecastResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribeWhatIfForecastResponse#time_series_transformations #time_series_transformations} => Array<Types::TimeSeriesTransformation> # * {Types::DescribeWhatIfForecastResponse#time_series_replacements_data_source #time_series_replacements_data_source} => Types::TimeSeriesReplacementsDataSource # * {Types::DescribeWhatIfForecastResponse#forecast_types #forecast_types} => Array<String> # # @example Request syntax with placeholder values # # resp = client.describe_what_if_forecast({ # what_if_forecast_arn: "LongArn", # required # }) # # @example Response structure # # resp.what_if_forecast_name #=> String # resp.what_if_forecast_arn #=> String # resp.what_if_analysis_arn #=> String # resp.estimated_time_remaining_in_minutes #=> Integer # resp.status #=> String # resp.message #=> String # resp.creation_time #=> Time # resp.last_modification_time #=> Time # resp.time_series_transformations #=> Array # resp.time_series_transformations[0].action.attribute_name #=> String # resp.time_series_transformations[0].action.operation #=> String, one of "ADD", "SUBTRACT", "MULTIPLY", "DIVIDE" # resp.time_series_transformations[0].action.value #=> Float # resp.time_series_transformations[0].time_series_conditions #=> Array # resp.time_series_transformations[0].time_series_conditions[0].attribute_name #=> String # resp.time_series_transformations[0].time_series_conditions[0].attribute_value #=> # resp.time_series_transformations[0].time_series_conditions[0].condition #=> String, one of "EQUALS", "NOT_EQUALS", "LESS_THAN", "GREATER_THAN" # resp.time_series_replacements_data_source.s3_config.path #=> String # resp.time_series_replacements_data_source.s3_config.role_arn #=> String # resp.time_series_replacements_data_source.s3_config.kms_key_arn #=> String # resp.time_series_replacements_data_source.schema.attributes #=> Array # resp.time_series_replacements_data_source.schema.attributes[0].attribute_name #=> String # resp.time_series_replacements_data_source.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation" # resp.time_series_replacements_data_source.format #=> String # resp.time_series_replacements_data_source.timestamp_format #=> String # resp.forecast_types #=> Array # resp.forecast_types[0] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecast AWS API Documentation # # @overload describe_what_if_forecast(params = {}) # @param [Hash] params ({}) def describe_what_if_forecast(params = {}, options = {}) req = build_request(:describe_what_if_forecast, params) req.send_request(options) end # Describes the what-if forecast export created using the # CreateWhatIfForecastExport operation. # # In addition to listing the properties provided in the # `CreateWhatIfForecastExport` request, this operation lists the # following properties: # # * `CreationTime` # # * `LastModificationTime` # # * `Message` - If an error occurred, information about the error. # # * `Status` # # @option params [required, String] :what_if_forecast_export_arn # The Amazon Resource Name (ARN) of the what-if forecast export that you # are interested in. # # @return [Types::DescribeWhatIfForecastExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeWhatIfForecastExportResponse#what_if_forecast_export_arn #what_if_forecast_export_arn} => String # * {Types::DescribeWhatIfForecastExportResponse#what_if_forecast_export_name #what_if_forecast_export_name} => String # * {Types::DescribeWhatIfForecastExportResponse#what_if_forecast_arns #what_if_forecast_arns} => Array<String> # * {Types::DescribeWhatIfForecastExportResponse#destination #destination} => Types::DataDestination # * {Types::DescribeWhatIfForecastExportResponse#message #message} => String # * {Types::DescribeWhatIfForecastExportResponse#status #status} => String # * {Types::DescribeWhatIfForecastExportResponse#creation_time #creation_time} => Time # * {Types::DescribeWhatIfForecastExportResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer # * {Types::DescribeWhatIfForecastExportResponse#last_modification_time #last_modification_time} => Time # * {Types::DescribeWhatIfForecastExportResponse#format #format} => String # # @example Request syntax with placeholder values # # resp = client.describe_what_if_forecast_export({ # what_if_forecast_export_arn: "LongArn", # required # }) # # @example Response structure # # resp.what_if_forecast_export_arn #=> String # resp.what_if_forecast_export_name #=> String # resp.what_if_forecast_arns #=> Array # resp.what_if_forecast_arns[0] #=> String # resp.destination.s3_config.path #=> String # resp.destination.s3_config.role_arn #=> String # resp.destination.s3_config.kms_key_arn #=> String # resp.message #=> String # resp.status #=> String # resp.creation_time #=> Time # resp.estimated_time_remaining_in_minutes #=> Integer # resp.last_modification_time #=> Time # resp.format #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecastExport AWS API Documentation # # @overload describe_what_if_forecast_export(params = {}) # @param [Hash] params ({}) def describe_what_if_forecast_export(params = {}, options = {}) req = build_request(:describe_what_if_forecast_export, params) req.send_request(options) end # Provides metrics on the accuracy of the models that were trained by # the CreatePredictor operation. Use metrics to see how well the model # performed and to decide whether to use the predictor to generate a # forecast. For more information, see [Predictor Metrics][1]. # # This operation generates metrics for each backtest window that was # evaluated. The number of backtest windows (`NumberOfBacktestWindows`) # is specified using the EvaluationParameters object, which is # optionally included in the `CreatePredictor` request. If # `NumberOfBacktestWindows` isn't specified, the number defaults to # one. # # The parameters of the `filling` method determine which items # contribute to the metrics. If you want all items to contribute, # specify `zero`. If you want only those items that have complete data # in the range being evaluated to contribute, specify `nan`. For more # information, see FeaturizationMethod. # # Before you can get accuracy metrics, the `Status` of the predictor # must be `ACTIVE`, signifying that training has completed. To get the # status, use the DescribePredictor operation. # # # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html # # @option params [required, String] :predictor_arn # The Amazon Resource Name (ARN) of the predictor to get metrics for. # # @return [Types::GetAccuracyMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetAccuracyMetricsResponse#predictor_evaluation_results #predictor_evaluation_results} => Array<Types::EvaluationResult> # * {Types::GetAccuracyMetricsResponse#is_auto_predictor #is_auto_predictor} => Boolean # * {Types::GetAccuracyMetricsResponse#auto_ml_override_strategy #auto_ml_override_strategy} => String # * {Types::GetAccuracyMetricsResponse#optimization_metric #optimization_metric} => String # # @example Request syntax with placeholder values # # resp = client.get_accuracy_metrics({ # predictor_arn: "Arn", # required # }) # # @example Response structure # # resp.predictor_evaluation_results #=> Array # resp.predictor_evaluation_results[0].algorithm_arn #=> String # resp.predictor_evaluation_results[0].test_windows #=> Array # resp.predictor_evaluation_results[0].test_windows[0].test_window_start #=> Time # resp.predictor_evaluation_results[0].test_windows[0].test_window_end #=> Time # resp.predictor_evaluation_results[0].test_windows[0].item_count #=> Integer # resp.predictor_evaluation_results[0].test_windows[0].evaluation_type #=> String, one of "SUMMARY", "COMPUTED" # resp.predictor_evaluation_results[0].test_windows[0].metrics.rmse #=> Float # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses #=> Array # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].quantile #=> Float # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].loss_value #=> Float # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics #=> Array # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].forecast_type #=> String # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].wape #=> Float # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].rmse #=> Float # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mase #=> Float # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mape #=> Float # resp.predictor_evaluation_results[0].test_windows[0].metrics.average_weighted_quantile_loss #=> Float # resp.is_auto_predictor #=> Boolean # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized", "AccuracyOptimized" # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE" # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics AWS API Documentation # # @overload get_accuracy_metrics(params = {}) # @param [Hash] params ({}) def get_accuracy_metrics(params = {}, options = {}) req = build_request(:get_accuracy_metrics, params) req.send_request(options) end # Returns a list of dataset groups created using the # [CreateDatasetGroup][1] operation. For each dataset group, this # operation returns a summary of its properties, including its Amazon # Resource Name (ARN). You can retrieve the complete set of properties # by using the dataset group ARN with the [DescribeDatasetGroup][2] # operation. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @return [Types::ListDatasetGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDatasetGroupsResponse#dataset_groups #dataset_groups} => Array<Types::DatasetGroupSummary> # * {Types::ListDatasetGroupsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_dataset_groups({ # next_token: "NextToken", # max_results: 1, # }) # # @example Response structure # # resp.dataset_groups #=> Array # resp.dataset_groups[0].dataset_group_arn #=> String # resp.dataset_groups[0].dataset_group_name #=> String # resp.dataset_groups[0].creation_time #=> Time # resp.dataset_groups[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetGroups AWS API Documentation # # @overload list_dataset_groups(params = {}) # @param [Hash] params ({}) def list_dataset_groups(params = {}, options = {}) req = build_request(:list_dataset_groups, params) req.send_request(options) end # Returns a list of dataset import jobs created using the # [CreateDatasetImportJob][1] operation. For each import job, this # operation returns a summary of its properties, including its Amazon # Resource Name (ARN). You can retrieve the complete set of properties # by using the ARN with the [DescribeDatasetImportJob][2] operation. You # can filter the list by providing an array of [Filter][3] objects. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @option params [Array] :filters # An array of filters. For each filter, you provide a condition and a # match statement. The condition is either `IS` or `IS_NOT`, which # specifies whether to include or exclude the datasets that match the # statement from the list, respectively. The match statement consists of # a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. To include the datasets that match the statement, specify # `IS`. To exclude matching datasets, specify `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `DatasetArn` and `Status`. # # * `Value` - The value to match. # # For example, to list all dataset import jobs whose status is ACTIVE, # you specify the following filter: # # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value": "ACTIVE" # \} ]` # # @return [Types::ListDatasetImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDatasetImportJobsResponse#dataset_import_jobs #dataset_import_jobs} => Array<Types::DatasetImportJobSummary> # * {Types::ListDatasetImportJobsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_dataset_import_jobs({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.dataset_import_jobs #=> Array # resp.dataset_import_jobs[0].dataset_import_job_arn #=> String # resp.dataset_import_jobs[0].dataset_import_job_name #=> String # resp.dataset_import_jobs[0].data_source.s3_config.path #=> String # resp.dataset_import_jobs[0].data_source.s3_config.role_arn #=> String # resp.dataset_import_jobs[0].data_source.s3_config.kms_key_arn #=> String # resp.dataset_import_jobs[0].status #=> String # resp.dataset_import_jobs[0].message #=> String # resp.dataset_import_jobs[0].creation_time #=> Time # resp.dataset_import_jobs[0].last_modification_time #=> Time # resp.dataset_import_jobs[0].import_mode #=> String, one of "FULL", "INCREMENTAL" # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetImportJobs AWS API Documentation # # @overload list_dataset_import_jobs(params = {}) # @param [Hash] params ({}) def list_dataset_import_jobs(params = {}, options = {}) req = build_request(:list_dataset_import_jobs, params) req.send_request(options) end # Returns a list of datasets created using the [CreateDataset][1] # operation. For each dataset, a summary of its properties, including # its Amazon Resource Name (ARN), is returned. To retrieve the complete # set of properties, use the ARN with the [DescribeDataset][2] # operation. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDatasetsResponse#datasets #datasets} => Array<Types::DatasetSummary> # * {Types::ListDatasetsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_datasets({ # next_token: "NextToken", # max_results: 1, # }) # # @example Response structure # # resp.datasets #=> Array # resp.datasets[0].dataset_arn #=> String # resp.datasets[0].dataset_name #=> String # resp.datasets[0].dataset_type #=> String, one of "TARGET_TIME_SERIES", "RELATED_TIME_SERIES", "ITEM_METADATA" # resp.datasets[0].domain #=> String, one of "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS" # resp.datasets[0].creation_time #=> Time # resp.datasets[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasets AWS API Documentation # # @overload list_datasets(params = {}) # @param [Hash] params ({}) def list_datasets(params = {}, options = {}) req = build_request(:list_datasets, params) req.send_request(options) end # Returns a list of Explainability resources created using the # CreateExplainability operation. This operation returns a summary for # each Explainability. You can filter the list using an array of Filter # objects. # # To retrieve the complete set of properties for a particular # Explainability resource, use the ARN with the DescribeExplainability # operation. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a NextToken. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items returned in the response. # # @option params [Array] :filters # An array of filters. For each filter, provide a condition and a match # statement. The condition is either `IS` or `IS_NOT`, which specifies # whether to include or exclude the resources that match the statement # from the list. The match statement consists of a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `ResourceArn` and `Status`. # # * `Value` - The value to match. # # @return [Types::ListExplainabilitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListExplainabilitiesResponse#explainabilities #explainabilities} => Array<Types::ExplainabilitySummary> # * {Types::ListExplainabilitiesResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_explainabilities({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.explainabilities #=> Array # resp.explainabilities[0].explainability_arn #=> String # resp.explainabilities[0].explainability_name #=> String # resp.explainabilities[0].resource_arn #=> String # resp.explainabilities[0].explainability_config.time_series_granularity #=> String, one of "ALL", "SPECIFIC" # resp.explainabilities[0].explainability_config.time_point_granularity #=> String, one of "ALL", "SPECIFIC" # resp.explainabilities[0].status #=> String # resp.explainabilities[0].message #=> String # resp.explainabilities[0].creation_time #=> Time # resp.explainabilities[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilities AWS API Documentation # # @overload list_explainabilities(params = {}) # @param [Hash] params ({}) def list_explainabilities(params = {}, options = {}) req = build_request(:list_explainabilities, params) req.send_request(options) end # Returns a list of Explainability exports created using the # CreateExplainabilityExport operation. This operation returns a summary # for each Explainability export. You can filter the list using an array # of Filter objects. # # To retrieve the complete set of properties for a particular # Explainability export, use the ARN with the DescribeExplainability # operation. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a NextToken. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @option params [Array] :filters # An array of filters. For each filter, provide a condition and a match # statement. The condition is either `IS` or `IS_NOT`, which specifies # whether to include or exclude resources that match the statement from # the list. The match statement consists of a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `ResourceArn` and `Status`. # # * `Value` - The value to match. # # @return [Types::ListExplainabilityExportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListExplainabilityExportsResponse#explainability_exports #explainability_exports} => Array<Types::ExplainabilityExportSummary> # * {Types::ListExplainabilityExportsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_explainability_exports({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.explainability_exports #=> Array # resp.explainability_exports[0].explainability_export_arn #=> String # resp.explainability_exports[0].explainability_export_name #=> String # resp.explainability_exports[0].destination.s3_config.path #=> String # resp.explainability_exports[0].destination.s3_config.role_arn #=> String # resp.explainability_exports[0].destination.s3_config.kms_key_arn #=> String # resp.explainability_exports[0].status #=> String # resp.explainability_exports[0].message #=> String # resp.explainability_exports[0].creation_time #=> Time # resp.explainability_exports[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExports AWS API Documentation # # @overload list_explainability_exports(params = {}) # @param [Hash] params ({}) def list_explainability_exports(params = {}, options = {}) req = build_request(:list_explainability_exports, params) req.send_request(options) end # Returns a list of forecast export jobs created using the # CreateForecastExportJob operation. For each forecast export job, this # operation returns a summary of its properties, including its Amazon # Resource Name (ARN). To retrieve the complete set of properties, use # the ARN with the DescribeForecastExportJob operation. You can filter # the list using an array of Filter objects. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @option params [Array] :filters # An array of filters. For each filter, you provide a condition and a # match statement. The condition is either `IS` or `IS_NOT`, which # specifies whether to include or exclude the forecast export jobs that # match the statement from the list, respectively. The match statement # consists of a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. To include the forecast export jobs that match the # statement, specify `IS`. To exclude matching forecast export jobs, # specify `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `ForecastArn` and `Status`. # # * `Value` - The value to match. # # For example, to list all jobs that export a forecast named # *electricityforecast*, specify the following filter: # # `"Filters": [ \{ "Condition": "IS", "Key": "ForecastArn", "Value": # "arn:aws:forecast:us-west-2::forecast/electricityforecast" \} # ]` # # @return [Types::ListForecastExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListForecastExportJobsResponse#forecast_export_jobs #forecast_export_jobs} => Array<Types::ForecastExportJobSummary> # * {Types::ListForecastExportJobsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_forecast_export_jobs({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.forecast_export_jobs #=> Array # resp.forecast_export_jobs[0].forecast_export_job_arn #=> String # resp.forecast_export_jobs[0].forecast_export_job_name #=> String # resp.forecast_export_jobs[0].destination.s3_config.path #=> String # resp.forecast_export_jobs[0].destination.s3_config.role_arn #=> String # resp.forecast_export_jobs[0].destination.s3_config.kms_key_arn #=> String # resp.forecast_export_jobs[0].status #=> String # resp.forecast_export_jobs[0].message #=> String # resp.forecast_export_jobs[0].creation_time #=> Time # resp.forecast_export_jobs[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobs AWS API Documentation # # @overload list_forecast_export_jobs(params = {}) # @param [Hash] params ({}) def list_forecast_export_jobs(params = {}, options = {}) req = build_request(:list_forecast_export_jobs, params) req.send_request(options) end # Returns a list of forecasts created using the CreateForecast # operation. For each forecast, this operation returns a summary of its # properties, including its Amazon Resource Name (ARN). To retrieve the # complete set of properties, specify the ARN with the DescribeForecast # operation. You can filter the list using an array of Filter objects. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @option params [Array] :filters # An array of filters. For each filter, you provide a condition and a # match statement. The condition is either `IS` or `IS_NOT`, which # specifies whether to include or exclude the forecasts that match the # statement from the list, respectively. The match statement consists of # a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. To include the forecasts that match the statement, specify # `IS`. To exclude matching forecasts, specify `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `DatasetGroupArn`, `PredictorArn`, and `Status`. # # * `Value` - The value to match. # # For example, to list all forecasts whose status is not ACTIVE, you # would specify: # # `"Filters": [ \{ "Condition": "IS_NOT", "Key": "Status", "Value": # "ACTIVE" \} ]` # # @return [Types::ListForecastsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListForecastsResponse#forecasts #forecasts} => Array<Types::ForecastSummary> # * {Types::ListForecastsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_forecasts({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.forecasts #=> Array # resp.forecasts[0].forecast_arn #=> String # resp.forecasts[0].forecast_name #=> String # resp.forecasts[0].predictor_arn #=> String # resp.forecasts[0].created_using_auto_predictor #=> Boolean # resp.forecasts[0].dataset_group_arn #=> String # resp.forecasts[0].status #=> String # resp.forecasts[0].message #=> String # resp.forecasts[0].creation_time #=> Time # resp.forecasts[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecasts AWS API Documentation # # @overload list_forecasts(params = {}) # @param [Hash] params ({}) def list_forecasts(params = {}, options = {}) req = build_request(:list_forecasts, params) req.send_request(options) end # Returns a list of the monitoring evaluation results and predictor # events collected by the monitor resource during different windows of # time. # # For information about monitoring see predictor-monitoring. For more # information about retrieving monitoring results see [Viewing # Monitoring Results][1]. # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The maximum number of monitoring results to return. # # @option params [required, String] :monitor_arn # The Amazon Resource Name (ARN) of the monitor resource to get results # from. # # @option params [Array] :filters # An array of filters. For each filter, provide a condition and a match # statement. The condition is either `IS` or `IS_NOT`, which specifies # whether to include or exclude the resources that match the statement # from the list. The match statement consists of a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. # # * `Key` - The name of the parameter to filter on. The only valid value # is `EvaluationState`. # # * `Value` - The value to match. Valid values are only `SUCCESS` or # `FAILURE`. # # For example, to list only successful monitor evaluations, you would # specify: # # `"Filters": [ \{ "Condition": "IS", "Key": "EvaluationState", "Value": # "SUCCESS" \} ]` # # @return [Types::ListMonitorEvaluationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListMonitorEvaluationsResponse#next_token #next_token} => String # * {Types::ListMonitorEvaluationsResponse#predictor_monitor_evaluations #predictor_monitor_evaluations} => Array<Types::PredictorMonitorEvaluation> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_monitor_evaluations({ # next_token: "NextToken", # max_results: 1, # monitor_arn: "Arn", # required # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.next_token #=> String # resp.predictor_monitor_evaluations #=> Array # resp.predictor_monitor_evaluations[0].resource_arn #=> String # resp.predictor_monitor_evaluations[0].monitor_arn #=> String # resp.predictor_monitor_evaluations[0].evaluation_time #=> Time # resp.predictor_monitor_evaluations[0].evaluation_state #=> String # resp.predictor_monitor_evaluations[0].window_start_datetime #=> Time # resp.predictor_monitor_evaluations[0].window_end_datetime #=> Time # resp.predictor_monitor_evaluations[0].predictor_event.detail #=> String # resp.predictor_monitor_evaluations[0].predictor_event.datetime #=> Time # resp.predictor_monitor_evaluations[0].monitor_data_source.dataset_import_job_arn #=> String # resp.predictor_monitor_evaluations[0].monitor_data_source.forecast_arn #=> String # resp.predictor_monitor_evaluations[0].monitor_data_source.predictor_arn #=> String # resp.predictor_monitor_evaluations[0].metric_results #=> Array # resp.predictor_monitor_evaluations[0].metric_results[0].metric_name #=> String # resp.predictor_monitor_evaluations[0].metric_results[0].metric_value #=> Float # resp.predictor_monitor_evaluations[0].num_items_evaluated #=> Integer # resp.predictor_monitor_evaluations[0].message #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluations AWS API Documentation # # @overload list_monitor_evaluations(params = {}) # @param [Hash] params ({}) def list_monitor_evaluations(params = {}, options = {}) req = build_request(:list_monitor_evaluations, params) req.send_request(options) end # Returns a list of monitors created with the CreateMonitor operation # and CreateAutoPredictor operation. For each monitor resource, this # operation returns of a summary of its properties, including its Amazon # Resource Name (ARN). You can retrieve a complete set of properties of # a monitor resource by specify the monitor's ARN in the # DescribeMonitor operation. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The maximum number of monitors to include in the response. # # @option params [Array] :filters # An array of filters. For each filter, provide a condition and a match # statement. The condition is either `IS` or `IS_NOT`, which specifies # whether to include or exclude the resources that match the statement # from the list. The match statement consists of a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. # # * `Key` - The name of the parameter to filter on. The only valid value # is `Status`. # # * `Value` - The value to match. # # For example, to list all monitors who's status is ACTIVE, you would # specify: # # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value": "ACTIVE" # \} ]` # # @return [Types::ListMonitorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListMonitorsResponse#monitors #monitors} => Array<Types::MonitorSummary> # * {Types::ListMonitorsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_monitors({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.monitors #=> Array # resp.monitors[0].monitor_arn #=> String # resp.monitors[0].monitor_name #=> String # resp.monitors[0].resource_arn #=> String # resp.monitors[0].status #=> String # resp.monitors[0].creation_time #=> Time # resp.monitors[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitors AWS API Documentation # # @overload list_monitors(params = {}) # @param [Hash] params ({}) def list_monitors(params = {}, options = {}) req = build_request(:list_monitors, params) req.send_request(options) end # Returns a list of predictor backtest export jobs created using the # CreatePredictorBacktestExportJob operation. This operation returns a # summary for each backtest export job. You can filter the list using an # array of Filter objects. # # To retrieve the complete set of properties for a particular backtest # export job, use the ARN with the DescribePredictorBacktestExportJob # operation. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a NextToken. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @option params [Array] :filters # An array of filters. For each filter, provide a condition and a match # statement. The condition is either `IS` or `IS_NOT`, which specifies # whether to include or exclude the predictor backtest export jobs that # match the statement from the list. The match statement consists of a # key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. To include the predictor backtest export jobs that match # the statement, specify `IS`. To exclude matching predictor backtest # export jobs, specify `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `PredictorArn` and `Status`. # # * `Value` - The value to match. # # @return [Types::ListPredictorBacktestExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListPredictorBacktestExportJobsResponse#predictor_backtest_export_jobs #predictor_backtest_export_jobs} => Array<Types::PredictorBacktestExportJobSummary> # * {Types::ListPredictorBacktestExportJobsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_predictor_backtest_export_jobs({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.predictor_backtest_export_jobs #=> Array # resp.predictor_backtest_export_jobs[0].predictor_backtest_export_job_arn #=> String # resp.predictor_backtest_export_jobs[0].predictor_backtest_export_job_name #=> String # resp.predictor_backtest_export_jobs[0].destination.s3_config.path #=> String # resp.predictor_backtest_export_jobs[0].destination.s3_config.role_arn #=> String # resp.predictor_backtest_export_jobs[0].destination.s3_config.kms_key_arn #=> String # resp.predictor_backtest_export_jobs[0].status #=> String # resp.predictor_backtest_export_jobs[0].message #=> String # resp.predictor_backtest_export_jobs[0].creation_time #=> Time # resp.predictor_backtest_export_jobs[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobs AWS API Documentation # # @overload list_predictor_backtest_export_jobs(params = {}) # @param [Hash] params ({}) def list_predictor_backtest_export_jobs(params = {}, options = {}) req = build_request(:list_predictor_backtest_export_jobs, params) req.send_request(options) end # Returns a list of predictors created using the CreateAutoPredictor or # CreatePredictor operations. For each predictor, this operation returns # a summary of its properties, including its Amazon Resource Name (ARN). # # You can retrieve the complete set of properties by using the ARN with # the DescribeAutoPredictor and DescribePredictor operations. You can # filter the list using an array of Filter objects. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @option params [Array] :filters # An array of filters. For each filter, you provide a condition and a # match statement. The condition is either `IS` or `IS_NOT`, which # specifies whether to include or exclude the predictors that match the # statement from the list, respectively. The match statement consists of # a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. To include the predictors that match the statement, # specify `IS`. To exclude matching predictors, specify `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `DatasetGroupArn` and `Status`. # # * `Value` - The value to match. # # For example, to list all predictors whose status is ACTIVE, you would # specify: # # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value": "ACTIVE" # \} ]` # # @return [Types::ListPredictorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListPredictorsResponse#predictors #predictors} => Array<Types::PredictorSummary> # * {Types::ListPredictorsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_predictors({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.predictors #=> Array # resp.predictors[0].predictor_arn #=> String # resp.predictors[0].predictor_name #=> String # resp.predictors[0].dataset_group_arn #=> String # resp.predictors[0].is_auto_predictor #=> Boolean # resp.predictors[0].reference_predictor_summary.arn #=> String # resp.predictors[0].reference_predictor_summary.state #=> String, one of "Active", "Deleted" # resp.predictors[0].status #=> String # resp.predictors[0].message #=> String # resp.predictors[0].creation_time #=> Time # resp.predictors[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictors AWS API Documentation # # @overload list_predictors(params = {}) # @param [Hash] params ({}) def list_predictors(params = {}, options = {}) req = build_request(:list_predictors, params) req.send_request(options) end # Lists the tags for an Amazon Forecast resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) that identifies the resource for which # to list the tags. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag> # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # resource_arn: "Arn", # required # }) # # @example Response structure # # resp.tags #=> Array # resp.tags[0].key #=> String # resp.tags[0].value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResource AWS API Documentation # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # Returns a list of what-if analyses created using the # CreateWhatIfAnalysis operation. For each what-if analysis, this # operation returns a summary of its properties, including its Amazon # Resource Name (ARN). You can retrieve the complete set of properties # by using the what-if analysis ARN with the DescribeWhatIfAnalysis # operation. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @option params [Array] :filters # An array of filters. For each filter, you provide a condition and a # match statement. The condition is either `IS` or `IS_NOT`, which # specifies whether to include or exclude the what-if analysis jobs that # match the statement from the list, respectively. The match statement # consists of a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. To include the what-if analysis jobs that match the # statement, specify `IS`. To exclude matching what-if analysis jobs, # specify `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `WhatIfAnalysisArn` and `Status`. # # * `Value` - The value to match. # # For example, to list all jobs that export a forecast named # *electricityWhatIf*, specify the following filter: # # `"Filters": [ \{ "Condition": "IS", "Key": "WhatIfAnalysisArn", # "Value": # "arn:aws:forecast:us-west-2::forecast/electricityWhatIf" \} # ]` # # @return [Types::ListWhatIfAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListWhatIfAnalysesResponse#what_if_analyses #what_if_analyses} => Array<Types::WhatIfAnalysisSummary> # * {Types::ListWhatIfAnalysesResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_what_if_analyses({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.what_if_analyses #=> Array # resp.what_if_analyses[0].what_if_analysis_arn #=> String # resp.what_if_analyses[0].what_if_analysis_name #=> String # resp.what_if_analyses[0].forecast_arn #=> String # resp.what_if_analyses[0].status #=> String # resp.what_if_analyses[0].message #=> String # resp.what_if_analyses[0].creation_time #=> Time # resp.what_if_analyses[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfAnalyses AWS API Documentation # # @overload list_what_if_analyses(params = {}) # @param [Hash] params ({}) def list_what_if_analyses(params = {}, options = {}) req = build_request(:list_what_if_analyses, params) req.send_request(options) end # Returns a list of what-if forecast exports created using the # CreateWhatIfForecastExport operation. For each what-if forecast # export, this operation returns a summary of its properties, including # its Amazon Resource Name (ARN). You can retrieve the complete set of # properties by using the what-if forecast export ARN with the # DescribeWhatIfForecastExport operation. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next
 request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @option params [Array] :filters # An array of filters. For each filter, you provide a condition and a # match statement. The condition is either `IS` or `IS_NOT`, which # specifies whether to include or exclude the what-if forecast export # jobs that match the statement from the list, respectively. The match # statement consists of a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. To include the forecast export jobs that match the # statement, specify `IS`. To exclude matching forecast export jobs, # specify `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `WhatIfForecastExportArn` and `Status`. # # * `Value` - The value to match. # # For example, to list all jobs that export a forecast named # *electricityWIFExport*, specify the following filter: # # `"Filters": [ \{ "Condition": "IS", "Key": "WhatIfForecastExportArn", # "Value": # "arn:aws:forecast:us-west-2::forecast/electricityWIFExport" # \} ]` # # @return [Types::ListWhatIfForecastExportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListWhatIfForecastExportsResponse#what_if_forecast_exports #what_if_forecast_exports} => Array<Types::WhatIfForecastExportSummary> # * {Types::ListWhatIfForecastExportsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_what_if_forecast_exports({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.what_if_forecast_exports #=> Array # resp.what_if_forecast_exports[0].what_if_forecast_export_arn #=> String # resp.what_if_forecast_exports[0].what_if_forecast_arns #=> Array # resp.what_if_forecast_exports[0].what_if_forecast_arns[0] #=> String # resp.what_if_forecast_exports[0].what_if_forecast_export_name #=> String # resp.what_if_forecast_exports[0].destination.s3_config.path #=> String # resp.what_if_forecast_exports[0].destination.s3_config.role_arn #=> String # resp.what_if_forecast_exports[0].destination.s3_config.kms_key_arn #=> String # resp.what_if_forecast_exports[0].status #=> String # resp.what_if_forecast_exports[0].message #=> String # resp.what_if_forecast_exports[0].creation_time #=> Time # resp.what_if_forecast_exports[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecastExports AWS API Documentation # # @overload list_what_if_forecast_exports(params = {}) # @param [Hash] params ({}) def list_what_if_forecast_exports(params = {}, options = {}) req = build_request(:list_what_if_forecast_exports, params) req.send_request(options) end # Returns a list of what-if forecasts created using the # CreateWhatIfForecast operation. For each what-if forecast, this # operation returns a summary of its properties, including its Amazon # Resource Name (ARN). You can retrieve the complete set of properties # by using the what-if forecast ARN with the DescribeWhatIfForecast # operation. # # @option params [String] :next_token # If the result of the previous request was truncated, the response # includes a `NextToken`. To retrieve the next set of results, use the # token in the next
 request. Tokens expire after 24 hours. # # @option params [Integer] :max_results # The number of items to return in the response. # # @option params [Array] :filters # An array of filters. For each filter, you provide a condition and a # match statement. The condition is either `IS` or `IS_NOT`, which # specifies whether to include or exclude the what-if forecast export # jobs that match the statement from the list, respectively. The match # statement consists of a key and a value. # # **Filter properties** # # * `Condition` - The condition to apply. Valid values are `IS` and # `IS_NOT`. To include the forecast export jobs that match the # statement, specify `IS`. To exclude matching forecast export jobs, # specify `IS_NOT`. # # * `Key` - The name of the parameter to filter on. Valid values are # `WhatIfForecastArn` and `Status`. # # * `Value` - The value to match. # # For example, to list all jobs that export a forecast named # *electricityWhatIfForecast*, specify the following filter: # # `"Filters": [ \{ "Condition": "IS", "Key": "WhatIfForecastArn", # "Value": # "arn:aws:forecast:us-west-2::forecast/electricityWhatIfForecast" # \} ]` # # @return [Types::ListWhatIfForecastsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListWhatIfForecastsResponse#what_if_forecasts #what_if_forecasts} => Array<Types::WhatIfForecastSummary> # * {Types::ListWhatIfForecastsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_what_if_forecasts({ # next_token: "NextToken", # max_results: 1, # filters: [ # { # key: "String", # required # value: "Arn", # required # condition: "IS", # required, accepts IS, IS_NOT # }, # ], # }) # # @example Response structure # # resp.what_if_forecasts #=> Array # resp.what_if_forecasts[0].what_if_forecast_arn #=> String # resp.what_if_forecasts[0].what_if_forecast_name #=> String # resp.what_if_forecasts[0].what_if_analysis_arn #=> String # resp.what_if_forecasts[0].status #=> String # resp.what_if_forecasts[0].message #=> String # resp.what_if_forecasts[0].creation_time #=> Time # resp.what_if_forecasts[0].last_modification_time #=> Time # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecasts AWS API Documentation # # @overload list_what_if_forecasts(params = {}) # @param [Hash] params ({}) def list_what_if_forecasts(params = {}, options = {}) req = build_request(:list_what_if_forecasts, params) req.send_request(options) end # Resumes a stopped monitor resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the monitor resource to resume. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.resume_resource({ # resource_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResource AWS API Documentation # # @overload resume_resource(params = {}) # @param [Hash] params ({}) def resume_resource(params = {}, options = {}) req = build_request(:resume_resource, params) req.send_request(options) end # Stops a resource. # # The resource undergoes the following states: `CREATE_STOPPING` and # `CREATE_STOPPED`. You cannot resume a resource once it has been # stopped. # # This operation can be applied to the following resources (and their # corresponding child resources): # # * Dataset Import Job # # * Predictor Job # # * Forecast Job # # * Forecast Export Job # # * Predictor Backtest Export Job # # * Explainability Job # # * Explainability Export Job # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) that identifies the resource to stop. # The supported ARNs are `DatasetImportJobArn`, `PredictorArn`, # `PredictorBacktestExportJobArn`, `ForecastArn`, # `ForecastExportJobArn`, `ExplainabilityArn`, and # `ExplainabilityExportArn`. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.stop_resource({ # resource_arn: "Arn", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/StopResource AWS API Documentation # # @overload stop_resource(params = {}) # @param [Hash] params ({}) def stop_resource(params = {}, options = {}) req = build_request(:stop_resource, params) req.send_request(options) end # Associates the specified tags to a resource with the specified # `resourceArn`. If existing tags on a resource are not specified in the # request parameters, they are not changed. When a resource is deleted, # the tags associated with that resource are also deleted. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) that identifies the resource for which # to list the tags. # # @option params [required, Array] :tags # The tags to add to the resource. A tag is an array of key-value pairs. # # The following basic restrictions apply to tags: # # * Maximum number of tags per resource - 50. # # * For each resource, each tag key must be unique, and each tag key can # have only one value. # # * Maximum key length - 128 Unicode characters in UTF-8. # # * Maximum value length - 256 Unicode characters in UTF-8. # # * If your tagging schema is used across multiple services and # resources, remember that other services may have restrictions on # allowed characters. Generally allowed characters are: letters, # numbers, and spaces representable in UTF-8, and the following # characters: + - = . \_ : / @. # # * Tag keys and values are case sensitive. # # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of # such as a prefix for keys as it is reserved for Amazon Web Services # use. You cannot edit or delete tag keys with this prefix. Values can # have this prefix. If a tag value has `aws` as its prefix but the key # does not, then Forecast considers it to be a user tag and will count # against the limit of 50 tags. Tags with only the key prefix of `aws` # do not count against your tags per resource limit. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # resource_arn: "Arn", # required # tags: [ # required # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResource AWS API Documentation # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Deletes the specified tags from a resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) that identifies the resource for which # to list the tags. # # @option params [required, Array] :tag_keys # The keys of the tags to be removed. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # resource_arn: "Arn", # required # tag_keys: ["TagKey"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UntagResource AWS API Documentation # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # Replaces the datasets in a dataset group with the specified datasets. # # The `Status` of the dataset group must be `ACTIVE` before you can use # the dataset group to create a predictor. Use the # [DescribeDatasetGroup][1] operation to get the status. # # # # # # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html # # @option params [required, String] :dataset_group_arn # The ARN of the dataset group. # # @option params [required, Array] :dataset_arns # An array of the Amazon Resource Names (ARNs) of the datasets to add to # the dataset group. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.update_dataset_group({ # dataset_group_arn: "Arn", # required # dataset_arns: ["Arn"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UpdateDatasetGroup AWS API Documentation # # @overload update_dataset_group(params = {}) # @param [Hash] params ({}) def update_dataset_group(params = {}, options = {}) req = build_request(:update_dataset_group, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-forecastservice' context[:gem_version] = '1.53.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end