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_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.
-
#delete_dataset(params = {}) ⇒ Struct
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation.
-
#delete_dataset_group(params = {}) ⇒ Struct
Deletes a dataset group created using the CreateDatasetGroup operation.
-
#delete_dataset_import_job(params = {}) ⇒ Struct
Deletes a dataset import job created using the CreateDatasetImportJob 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_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.
-
#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 operation.
-
#describe_dataset_group(params = {}) ⇒ Types::DescribeDatasetGroupResponse
Describes a dataset group created using the CreateDatasetGroup operation.
-
#describe_dataset_import_job(params = {}) ⇒ Types::DescribeDatasetImportJobResponse
Describes a dataset import job created using the CreateDatasetImportJob 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_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.
-
#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 operation.
-
#list_dataset_import_jobs(params = {}) ⇒ Types::ListDatasetImportJobsResponse
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Returns a list of datasets created using the CreateDataset 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_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.
-
#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.
358 359 360 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 358 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 being forecasted.
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
.
544 545 546 547 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 544 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 howitworks-datasets-groups.
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.
695 696 697 698 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 695 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 howitworks-datasets-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.
794 795 796 797 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 794 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 AWS 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 AWS system. For more information, see aws-forecast-iam-roles.
The training data must be in CSV format. The delimiter must be a comma (,).
You can specify the path to a specific CSV 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.
960 961 962 963 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 960 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.
1160 1161 1162 1163 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1160 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 AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
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.
1251 1252 1253 1254 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1251 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.
1356 1357 1358 1359 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1356 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 AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
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.
1467 1468 1469 1470 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1467 def create_forecast_export_job(params = {}, = {}) req = build_request(:create_forecast_export_job, 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.
1784 1785 1786 1787 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1784 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 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 AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
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.
1883 1884 1885 1886 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1883 def create_predictor_backtest_export_job(params = {}, = {}) req = build_request(:create_predictor_backtest_export_job, 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.
1914 1915 1916 1917 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1914 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.
1942 1943 1944 1945 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1942 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.
1967 1968 1969 1970 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1967 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.
1994 1995 1996 1997 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1994 def delete_explainability(params = {}, = {}) req = build_request(:delete_explainability, params) req.send_request() end |
#delete_explainability_export(params = {}) ⇒ Struct
Deletes an Explainability export.
2016 2017 2018 2019 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2016 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.
2044 2045 2046 2047 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2044 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.
2069 2070 2071 2072 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2069 def delete_forecast_export_job(params = {}, = {}) req = build_request(:delete_forecast_export_job, 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.
2094 2095 2096 2097 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2094 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.
2117 2118 2119 2120 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2117 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.
2164 2165 2166 2167 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2164 def delete_resource_tree(params = {}, = {}) req = build_request(:delete_resource_tree, params) req.send_request() end |
#describe_auto_predictor(params = {}) ⇒ Types::DescribeAutoPredictorResponse
Describes a predictor created using the CreateAutoPredictor operation.
2239 2240 2241 2242 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2239 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
2298 2299 2300 2301 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2298 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
2352 2353 2354 2355 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2352 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.
2439 2440 2441 2442 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2439 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.
2499 2500 2501 2502 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2499 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.
2544 2545 2546 2547 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2544 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.
2605 2606 2607 2608 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2605 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.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2662 def describe_forecast_export_job(params = {}, = {}) req = build_request(:describe_forecast_export_job, 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.
2797 2798 2799 2800 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2797 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)
2854 2855 2856 2857 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2854 def describe_predictor_backtest_export_job(params = {}, = {}) req = build_request(:describe_predictor_backtest_export_job, 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.
2931 2932 2933 2934 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2931 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.
2977 2978 2979 2980 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2977 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.
3060 3061 3062 3063 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3060 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.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3107 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.
3182 3183 3184 3185 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3182 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.
3257 3258 3259 3260 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3257 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.
3342 3343 3344 3345 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3342 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.
3424 3425 3426 3427 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3424 def list_forecasts(params = {}, = {}) req = build_request(:list_forecasts, 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.
3504 3505 3506 3507 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3504 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.
3589 3590 3591 3592 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3589 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.
3620 3621 3622 3623 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3620 def (params = {}, = {}) req = build_request(:list_tags_for_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
3667 3668 3669 3670 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3667 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.
3729 3730 3731 3732 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3729 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.
3756 3757 3758 3759 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3756 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.
3789 3790 3791 3792 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 3789 def update_dataset_group(params = {}, = {}) req = build_request(:update_dataset_group, params) req.send_request() end |