Class: Aws::ForecastService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ForecastService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb
Overview
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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_auto_predictor(params = {}) ⇒ Types::CreateAutoPredictorResponse
Creates an Amazon Forecast predictor.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates an Amazon Forecast dataset.
-
#create_dataset_group(params = {}) ⇒ Types::CreateDatasetGroupResponse
Creates a dataset group, which holds a collection of related datasets.
-
#create_dataset_import_job(params = {}) ⇒ Types::CreateDatasetImportJobResponse
Imports your training data to an Amazon Forecast dataset.
-
#create_explainability(params = {}) ⇒ Types::CreateExplainabilityResponse
Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor). -
#create_explainability_export(params = {}) ⇒ Types::CreateExplainabilityExportResponse
Exports an Explainability resource created by the CreateExplainability operation.
-
#create_forecast(params = {}) ⇒ Types::CreateForecastResponse
Creates a forecast for each item in the
TARGET_TIME_SERIES
dataset that was used to train the predictor. -
#create_forecast_export_job(params = {}) ⇒ Types::CreateForecastExportJobResponse
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket.
-
#create_monitor(params = {}) ⇒ Types::CreateMonitorResponse
Creates a predictor monitor resource for an existing auto predictor.
-
#create_predictor(params = {}) ⇒ Types::CreatePredictorResponse
This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. -
#create_predictor_backtest_export_job(params = {}) ⇒ Types::CreatePredictorBacktestExportJobResponse
Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations.
-
#create_what_if_analysis(params = {}) ⇒ Types::CreateWhatIfAnalysisResponse
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.
-
#create_what_if_forecast(params = {}) ⇒ Types::CreateWhatIfForecastResponse
A what-if forecast is a forecast that is created from a modified version of the baseline forecast.
-
#create_what_if_forecast_export(params = {}) ⇒ Types::CreateWhatIfForecastExportResponse
Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket.
-
#delete_dataset(params = {}) ⇒ Struct
Deletes an Amazon Forecast dataset that was created using the [CreateDataset][1] operation.
-
#delete_dataset_group(params = {}) ⇒ Struct
Deletes a dataset group created using the [CreateDatasetGroup][1] operation.
-
#delete_dataset_import_job(params = {}) ⇒ Struct
Deletes a dataset import job created using the [CreateDatasetImportJob][1] operation.
-
#delete_explainability(params = {}) ⇒ Struct
Deletes an Explainability resource.
-
#delete_explainability_export(params = {}) ⇒ Struct
Deletes an Explainability export.
-
#delete_forecast(params = {}) ⇒ Struct
Deletes a forecast created using the CreateForecast operation.
-
#delete_forecast_export_job(params = {}) ⇒ Struct
Deletes a forecast export job created using the CreateForecastExportJob operation.
-
#delete_monitor(params = {}) ⇒ Struct
Deletes a monitor resource.
-
#delete_predictor(params = {}) ⇒ Struct
Deletes a predictor created using the DescribePredictor or CreatePredictor operations.
-
#delete_predictor_backtest_export_job(params = {}) ⇒ Struct
Deletes a predictor backtest export job.
-
#delete_resource_tree(params = {}) ⇒ Struct
Deletes an entire resource tree.
-
#delete_what_if_analysis(params = {}) ⇒ Struct
Deletes a what-if analysis created using the CreateWhatIfAnalysis operation.
-
#delete_what_if_forecast(params = {}) ⇒ Struct
Deletes a what-if forecast created using the CreateWhatIfForecast operation.
-
#delete_what_if_forecast_export(params = {}) ⇒ Struct
Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation.
-
#describe_auto_predictor(params = {}) ⇒ Types::DescribeAutoPredictorResponse
Describes a predictor created using the CreateAutoPredictor operation.
-
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Describes an Amazon Forecast dataset created using the [CreateDataset][1] operation.
-
#describe_dataset_group(params = {}) ⇒ Types::DescribeDatasetGroupResponse
Describes a dataset group created using the [CreateDatasetGroup][1] operation.
-
#describe_dataset_import_job(params = {}) ⇒ Types::DescribeDatasetImportJobResponse
Describes a dataset import job created using the [CreateDatasetImportJob][1] operation.
-
#describe_explainability(params = {}) ⇒ Types::DescribeExplainabilityResponse
Describes an Explainability resource created using the CreateExplainability operation.
-
#describe_explainability_export(params = {}) ⇒ Types::DescribeExplainabilityExportResponse
Describes an Explainability export created using the CreateExplainabilityExport operation.
-
#describe_forecast(params = {}) ⇒ Types::DescribeForecastResponse
Describes a forecast created using the CreateForecast operation.
-
#describe_forecast_export_job(params = {}) ⇒ Types::DescribeForecastExportJobResponse
Describes a forecast export job created using the CreateForecastExportJob operation.
-
#describe_monitor(params = {}) ⇒ Types::DescribeMonitorResponse
Describes a monitor resource.
-
#describe_predictor(params = {}) ⇒ Types::DescribePredictorResponse
This operation is only valid for legacy predictors created with CreatePredictor. -
#describe_predictor_backtest_export_job(params = {}) ⇒ Types::DescribePredictorBacktestExportJobResponse
Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
-
#describe_what_if_analysis(params = {}) ⇒ Types::DescribeWhatIfAnalysisResponse
Describes the what-if analysis created using the CreateWhatIfAnalysis operation.
-
#describe_what_if_forecast(params = {}) ⇒ Types::DescribeWhatIfForecastResponse
Describes the what-if forecast created using the CreateWhatIfForecast operation.
-
#describe_what_if_forecast_export(params = {}) ⇒ Types::DescribeWhatIfForecastExportResponse
Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.
-
#get_accuracy_metrics(params = {}) ⇒ Types::GetAccuracyMetricsResponse
Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation.
-
#list_dataset_groups(params = {}) ⇒ Types::ListDatasetGroupsResponse
Returns a list of dataset groups created using the [CreateDatasetGroup][1] operation.
-
#list_dataset_import_jobs(params = {}) ⇒ Types::ListDatasetImportJobsResponse
Returns a list of dataset import jobs created using the [CreateDatasetImportJob][1] operation.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Returns a list of datasets created using the [CreateDataset][1] operation.
-
#list_explainabilities(params = {}) ⇒ Types::ListExplainabilitiesResponse
Returns a list of Explainability resources created using the CreateExplainability operation.
-
#list_explainability_exports(params = {}) ⇒ Types::ListExplainabilityExportsResponse
Returns a list of Explainability exports created using the CreateExplainabilityExport operation.
-
#list_forecast_export_jobs(params = {}) ⇒ Types::ListForecastExportJobsResponse
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
-
#list_forecasts(params = {}) ⇒ Types::ListForecastsResponse
Returns a list of forecasts created using the CreateForecast operation.
-
#list_monitor_evaluations(params = {}) ⇒ Types::ListMonitorEvaluationsResponse
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.
-
#list_monitors(params = {}) ⇒ Types::ListMonitorsResponse
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation.
-
#list_predictor_backtest_export_jobs(params = {}) ⇒ Types::ListPredictorBacktestExportJobsResponse
Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation.
-
#list_predictors(params = {}) ⇒ Types::ListPredictorsResponse
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for an Amazon Forecast resource.
-
#list_what_if_analyses(params = {}) ⇒ Types::ListWhatIfAnalysesResponse
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation.
-
#list_what_if_forecast_exports(params = {}) ⇒ Types::ListWhatIfForecastExportsResponse
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation.
-
#list_what_if_forecasts(params = {}) ⇒ Types::ListWhatIfForecastsResponse
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation.
-
#resume_resource(params = {}) ⇒ Struct
Resumes a stopped monitor resource.
-
#stop_resource(params = {}) ⇒ Struct
Stops a resource.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn
. -
#untag_resource(params = {}) ⇒ Struct
Deletes the specified tags from a resource.
-
#update_dataset_group(params = {}) ⇒ Struct
Replaces the datasets in a dataset group with the specified datasets.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
420 421 422 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#create_auto_predictor(params = {}) ⇒ Types::CreateAutoPredictorResponse
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
.
670 671 672 673 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 670 def create_auto_predictor(params = {}, = {}) req = build_request(:create_auto_predictor, params) req.send_request() end |
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
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
andDatasetType
- 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.
To get a list of all your datasets, use the ListDatasets operation.
For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.
Status
of a dataset must be ACTIVE
before you can import
training data. Use the DescribeDataset operation to get the
status.
852 853 854 855 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 852 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() end |
#create_dataset_group(params = {}) ⇒ Types::CreateDatasetGroupResponse
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 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.
To get a list of all your datasets groups, use the ListDatasetGroups operation.
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 operation.
963 964 965 966 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 963 def create_dataset_group(params = {}, = {}) req = build_request(:create_dataset_group, params) req.send_request() end |
#create_dataset_import_job(params = {}) ⇒ Types::CreateDatasetImportJobResponse
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 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.
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 operation.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1151 def create_dataset_import_job(params = {}, = {}) req = build_request(:create_dataset_import_job, params) req.send_request() end |
#create_explainability(params = {}) ⇒ Types::CreateExplainabilityResponse
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
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
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.
1351 1352 1353 1354 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1351 def create_explainability(params = {}, = {}) req = build_request(:create_explainability, params) req.send_request() end |
#create_explainability_export(params = {}) ⇒ Types::CreateExplainabilityExportResponse
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.
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.
1446 1447 1448 1449 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1446 def create_explainability_export(params = {}, = {}) req = build_request(:create_explainability_export, params) req.send_request() end |
#create_forecast(params = {}) ⇒ Types::CreateForecastResponse
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.
For more information, see howitworks-forecast.
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.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1595 def create_forecast(params = {}, = {}) req = build_request(:create_forecast, params) req.send_request() end |
#create_forecast_export_job(params = {}) ⇒ Types::CreateForecastExportJobResponse
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.
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.
1710 1711 1712 1713 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1710 def create_forecast_export_job(params = {}, = {}) req = build_request(:create_forecast_export_job, params) req.send_request() end |
#create_monitor(params = {}) ⇒ Types::CreateMonitorResponse
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.
1762 1763 1764 1765 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1762 def create_monitor(params = {}, = {}) req = build_request(:create_monitor, params) req.send_request() end |
#create_predictor(params = {}) ⇒ Types::CreatePredictorResponse
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.
Status
of
the predictor must be ACTIVE
, signifying that training has
completed. To get the status, use the DescribePredictor operation.
2079 2080 2081 2082 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2079 def create_predictor(params = {}, = {}) req = build_request(:create_predictor, params) req.send_request() end |
#create_predictor_backtest_export_job(params = {}) ⇒ Types::CreatePredictorBacktestExportJobResponse
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:
<ExportJobName>_<ExportTimestamp>_<PartNumber>.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.
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.
2184 2185 2186 2187 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2184 def create_predictor_backtest_export_job(params = {}, = {}) req = build_request(:create_predictor_backtest_export_job, params) req.send_request() end |
#create_what_if_analysis(params = {}) ⇒ Types::CreateWhatIfAnalysisResponse
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.
2288 2289 2290 2291 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2288 def create_what_if_analysis(params = {}, = {}) req = build_request(:create_what_if_analysis, params) req.send_request() end |
#create_what_if_forecast(params = {}) ⇒ Types::CreateWhatIfForecastResponse
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.
2394 2395 2396 2397 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2394 def create_what_if_forecast(params = {}, = {}) req = build_request(:create_what_if_forecast, params) req.send_request() end |
#create_what_if_forecast_export(params = {}) ⇒ Types::CreateWhatIfForecastExportResponse
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:
≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
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.
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.
2482 2483 2484 2485 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2482 def create_what_if_forecast_export(params = {}, = {}) req = build_request(:create_what_if_forecast_export, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Struct
Deletes an Amazon Forecast dataset that was created using the
CreateDataset operation. You can only delete datasets that have a
status of ACTIVE
or CREATE_FAILED
. To get the status use the
DescribeDataset operation.
2520 2521 2522 2523 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2520 def delete_dataset(params = {}, = {}) req = build_request(:delete_dataset, params) req.send_request() end |
#delete_dataset_group(params = {}) ⇒ Struct
Deletes a dataset group created using the CreateDatasetGroup
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 operation.
This operation deletes only the dataset group, not the datasets in the group.
2553 2554 2555 2556 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2553 def delete_dataset_group(params = {}, = {}) req = build_request(:delete_dataset_group, params) req.send_request() end |
#delete_dataset_import_job(params = {}) ⇒ Struct
Deletes a dataset import job created using the
CreateDatasetImportJob operation. You can delete only dataset
import jobs that have a status of ACTIVE
or CREATE_FAILED
. To get
the status, use the DescribeDatasetImportJob operation.
2583 2584 2585 2586 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2583 def delete_dataset_import_job(params = {}, = {}) req = build_request(:delete_dataset_import_job, params) req.send_request() end |
#delete_explainability(params = {}) ⇒ Struct
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.
2610 2611 2612 2613 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2610 def delete_explainability(params = {}, = {}) req = build_request(:delete_explainability, params) req.send_request() end |
#delete_explainability_export(params = {}) ⇒ Struct
Deletes an Explainability export.
2632 2633 2634 2635 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2632 def delete_explainability_export(params = {}, = {}) req = build_request(:delete_explainability_export, params) req.send_request() end |
#delete_forecast(params = {}) ⇒ Struct
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.
2660 2661 2662 2663 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2660 def delete_forecast(params = {}, = {}) req = build_request(:delete_forecast, params) req.send_request() end |
#delete_forecast_export_job(params = {}) ⇒ Struct
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.
2685 2686 2687 2688 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2685 def delete_forecast_export_job(params = {}, = {}) req = build_request(:delete_forecast_export_job, params) req.send_request() end |
#delete_monitor(params = {}) ⇒ Struct
Deletes a monitor resource. You can only delete a monitor resource
with a status of ACTIVE
, ACTIVE_STOPPED
, CREATE_FAILED
, or
CREATE_STOPPED
.
2709 2710 2711 2712 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2709 def delete_monitor(params = {}, = {}) req = build_request(:delete_monitor, params) req.send_request() end |
#delete_predictor(params = {}) ⇒ Struct
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.
2734 2735 2736 2737 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2734 def delete_predictor(params = {}, = {}) req = build_request(:delete_predictor, params) req.send_request() end |
#delete_predictor_backtest_export_job(params = {}) ⇒ Struct
Deletes a predictor backtest export job.
2757 2758 2759 2760 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2757 def delete_predictor_backtest_export_job(params = {}, = {}) req = build_request(:delete_predictor_backtest_export_job, params) req.send_request() end |
#delete_resource_tree(params = {}) ⇒ Struct
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.
2804 2805 2806 2807 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2804 def delete_resource_tree(params = {}, = {}) req = build_request(:delete_resource_tree, params) req.send_request() end |
#delete_what_if_analysis(params = {}) ⇒ Struct
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.
2833 2834 2835 2836 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2833 def delete_what_if_analysis(params = {}, = {}) req = build_request(:delete_what_if_analysis, params) req.send_request() end |
#delete_what_if_forecast(params = {}) ⇒ Struct
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.
2863 2864 2865 2866 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2863 def delete_what_if_forecast(params = {}, = {}) req = build_request(:delete_what_if_forecast, params) req.send_request() end |
#delete_what_if_forecast_export(params = {}) ⇒ Struct
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.
2889 2890 2891 2892 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2889 def delete_what_if_forecast_export(params = {}, = {}) req = build_request(:delete_what_if_forecast_export, params) req.send_request() end |
#describe_auto_predictor(params = {}) ⇒ Types::DescribeAutoPredictorResponse
Describes a predictor created using the CreateAutoPredictor operation.
2972 2973 2974 2975 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2972 def describe_auto_predictor(params = {}, = {}) req = build_request(:describe_auto_predictor, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Describes an Amazon Forecast dataset created using the CreateDataset operation.
In addition to listing the parameters specified in the CreateDataset
request, this operation includes the following dataset properties:
CreationTime
LastModificationTime
Status
3035 3036 3037 3038 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3035 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, params) req.send_request() end |
#describe_dataset_group(params = {}) ⇒ Types::DescribeDatasetGroupResponse
Describes a dataset group created using the CreateDatasetGroup 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
3093 3094 3095 3096 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3093 def describe_dataset_group(params = {}, = {}) req = build_request(:describe_dataset_group, params) req.send_request() end |
#describe_dataset_import_job(params = {}) ⇒ Types::DescribeDatasetImportJobResponse
Describes a dataset import job created using the CreateDatasetImportJob 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.
3188 3189 3190 3191 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3188 def describe_dataset_import_job(params = {}, = {}) req = build_request(:describe_dataset_import_job, params) req.send_request() end |
#describe_explainability(params = {}) ⇒ Types::DescribeExplainabilityResponse
Describes an Explainability resource created using the CreateExplainability operation.
3248 3249 3250 3251 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3248 def describe_explainability(params = {}, = {}) req = build_request(:describe_explainability, params) req.send_request() end |
#describe_explainability_export(params = {}) ⇒ Types::DescribeExplainabilityExportResponse
Describes an Explainability export created using the CreateExplainabilityExport operation.
3295 3296 3297 3298 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3295 def describe_explainability_export(params = {}, = {}) req = build_request(:describe_explainability_export, params) req.send_request() end |
#describe_forecast(params = {}) ⇒ Types::DescribeForecastResponse
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.
3364 3365 3366 3367 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3364 def describe_forecast(params = {}, = {}) req = build_request(:describe_forecast, params) req.send_request() end |
#describe_forecast_export_job(params = {}) ⇒ Types::DescribeForecastExportJobResponse
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.
3423 3424 3425 3426 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3423 def describe_forecast_export_job(params = {}, = {}) req = build_request(:describe_forecast_export_job, params) req.send_request() end |
#describe_monitor(params = {}) ⇒ Types::DescribeMonitorResponse
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
3489 3490 3491 3492 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3489 def describe_monitor(params = {}, = {}) req = build_request(:describe_monitor, params) req.send_request() end |
#describe_predictor(params = {}) ⇒ Types::DescribePredictorResponse
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.
3624 3625 3626 3627 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3624 def describe_predictor(params = {}, = {}) req = build_request(:describe_predictor, params) req.send_request() end |
#describe_predictor_backtest_export_job(params = {}) ⇒ Types::DescribePredictorBacktestExportJobResponse
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)
3683 3684 3685 3686 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3683 def describe_predictor_backtest_export_job(params = {}, = {}) req = build_request(:describe_predictor_backtest_export_job, params) req.send_request() end |
#describe_what_if_analysis(params = {}) ⇒ Types::DescribeWhatIfAnalysisResponse
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
3747 3748 3749 3750 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3747 def describe_what_if_analysis(params = {}, = {}) req = build_request(:describe_what_if_analysis, params) req.send_request() end |
#describe_what_if_forecast(params = {}) ⇒ Types::DescribeWhatIfForecastResponse
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
3824 3825 3826 3827 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3824 def describe_what_if_forecast(params = {}, = {}) req = build_request(:describe_what_if_forecast, params) req.send_request() end |
#describe_what_if_forecast_export(params = {}) ⇒ Types::DescribeWhatIfForecastExportResponse
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
3887 3888 3889 3890 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3887 def describe_what_if_forecast_export(params = {}, = {}) req = build_request(:describe_what_if_forecast_export, params) req.send_request() end |
#get_accuracy_metrics(params = {}) ⇒ Types::GetAccuracyMetricsResponse
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.
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.
Status
of the predictor
must be ACTIVE
, signifying that training has completed. To get the
status, use the DescribePredictor operation.
3964 3965 3966 3967 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3964 def get_accuracy_metrics(params = {}, = {}) req = build_request(:get_accuracy_metrics, params) req.send_request() end |
#list_dataset_groups(params = {}) ⇒ Types::ListDatasetGroupsResponse
Returns a list of dataset groups created using the CreateDatasetGroup 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 operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4016 4017 4018 4019 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4016 def list_dataset_groups(params = {}, = {}) req = build_request(:list_dataset_groups, params) req.send_request() end |
#list_dataset_import_jobs(params = {}) ⇒ Types::ListDatasetImportJobsResponse
Returns a list of dataset import jobs created using the CreateDatasetImportJob 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 operation. You can filter the list by providing an array of Filter objects.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4106 4107 4108 4109 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4106 def list_dataset_import_jobs(params = {}, = {}) req = build_request(:list_dataset_import_jobs, params) req.send_request() end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Returns a list of datasets created using the CreateDataset 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 operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4159 4160 4161 4162 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4159 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, params) req.send_request() end |
#list_explainabilities(params = {}) ⇒ Types::ListExplainabilitiesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4236 4237 4238 4239 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4236 def list_explainabilities(params = {}, = {}) req = build_request(:list_explainabilities, params) req.send_request() end |
#list_explainability_exports(params = {}) ⇒ Types::ListExplainabilityExportsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4313 4314 4315 4316 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4313 def list_explainability_exports(params = {}, = {}) req = build_request(:list_explainability_exports, params) req.send_request() end |
#list_forecast_export_jobs(params = {}) ⇒ Types::ListForecastExportJobsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4398 4399 4400 4401 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4398 def list_forecast_export_jobs(params = {}, = {}) req = build_request(:list_forecast_export_jobs, params) req.send_request() end |
#list_forecasts(params = {}) ⇒ Types::ListForecastsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4480 4481 4482 4483 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4480 def list_forecasts(params = {}, = {}) req = build_request(:list_forecasts, params) req.send_request() end |
#list_monitor_evaluations(params = {}) ⇒ Types::ListMonitorEvaluationsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4579 4580 4581 4582 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4579 def list_monitor_evaluations(params = {}, = {}) req = build_request(:list_monitor_evaluations, params) req.send_request() end |
#list_monitors(params = {}) ⇒ Types::ListMonitorsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4657 4658 4659 4660 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4657 def list_monitors(params = {}, = {}) req = build_request(:list_monitors, params) req.send_request() end |
#list_predictor_backtest_export_jobs(params = {}) ⇒ Types::ListPredictorBacktestExportJobsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4737 4738 4739 4740 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4737 def list_predictor_backtest_export_jobs(params = {}, = {}) req = build_request(:list_predictor_backtest_export_jobs, params) req.send_request() end |
#list_predictors(params = {}) ⇒ Types::ListPredictorsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4822 4823 4824 4825 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4822 def list_predictors(params = {}, = {}) req = build_request(:list_predictors, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for an Amazon Forecast resource.
4853 4854 4855 4856 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4853 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_what_if_analyses(params = {}) ⇒ Types::ListWhatIfAnalysesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4937 4938 4939 4940 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 4937 def list_what_if_analyses(params = {}, = {}) req = build_request(:list_what_if_analyses, params) req.send_request() end |
#list_what_if_forecast_exports(params = {}) ⇒ Types::ListWhatIfForecastExportsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5025 5026 5027 5028 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 5025 def list_what_if_forecast_exports(params = {}, = {}) req = build_request(:list_what_if_forecast_exports, params) req.send_request() end |
#list_what_if_forecasts(params = {}) ⇒ Types::ListWhatIfForecastsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5109 5110 5111 5112 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 5109 def list_what_if_forecasts(params = {}, = {}) req = build_request(:list_what_if_forecasts, params) req.send_request() end |
#resume_resource(params = {}) ⇒ Struct
Resumes a stopped monitor resource.
5131 5132 5133 5134 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 5131 def resume_resource(params = {}, = {}) req = build_request(:resume_resource, params) req.send_request() end |
#stop_resource(params = {}) ⇒ Struct
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
5178 5179 5180 5181 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 5178 def stop_resource(params = {}, = {}) req = build_request(:stop_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
5240 5241 5242 5243 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 5240 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes the specified tags from a resource.
5267 5268 5269 5270 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 5267 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_dataset_group(params = {}) ⇒ Struct
Replaces the datasets in a dataset group with the specified datasets.
Status
of the dataset group must be ACTIVE
before you can use
the dataset group to create a predictor. Use the
DescribeDatasetGroup operation to get the status.
5304 5305 5306 5307 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 5304 def update_dataset_group(params = {}, = {}) req = build_request(:update_dataset_group, params) req.send_request() end |