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_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_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
Creates an Amazon Forecast predictor.
-
#create_predictor_backtest_export_job(params = {}) ⇒ Types::CreatePredictorBacktestExportJobResponse
Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation.
-
#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_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 CreatePredictor operation.
-
#delete_predictor_backtest_export_job(params = {}) ⇒ Struct
Deletes a predictor backtest export job.
-
#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_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
Describes a predictor created using the CreatePredictor operation.
-
#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_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 CreatePredictor operation.
-
#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.
334 335 336 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#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.
486 487 488 489 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 486 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.
585 586 587 588 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 585 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.
751 752 753 754 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 751 def create_dataset_import_job(params = {}, = {}) req = build_request(:create_dataset_import_job, 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.
856 857 858 859 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 856 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.
967 968 969 970 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 967 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.
1259 1260 1261 1262 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1259 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 CreatePredictor operation. 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.
1358 1359 1360 1361 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1358 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.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1389 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.
1417 1418 1419 1420 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1417 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.
1442 1443 1444 1445 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1442 def delete_dataset_import_job(params = {}, = {}) req = build_request(:delete_dataset_import_job, 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.
1470 1471 1472 1473 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1470 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.
1495 1496 1497 1498 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1495 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 CreatePredictor operation. You
can delete only predictor that have a status of ACTIVE
or
CREATE_FAILED
. To get the status, use the DescribePredictor
operation.
1520 1521 1522 1523 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1520 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.
1543 1544 1545 1546 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1543 def delete_predictor_backtest_export_job(params = {}, = {}) req = build_request(:delete_predictor_backtest_export_job, 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
1602 1603 1604 1605 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1602 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
1656 1657 1658 1659 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1656 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.
1737 1738 1739 1740 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1737 def describe_dataset_import_job(params = {}, = {}) req = build_request(:describe_dataset_import_job, 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.
1796 1797 1798 1799 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1796 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.
1853 1854 1855 1856 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1853 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.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 1974 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)
2031 2032 2033 2034 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2031 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.
2099 2100 2101 2102 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2099 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.
2145 2146 2147 2148 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2145 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.
2228 2229 2230 2231 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2228 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.
2275 2276 2277 2278 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2275 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, 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.
2360 2361 2362 2363 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2360 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.
2441 2442 2443 2444 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2441 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.
2521 2522 2523 2524 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2521 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 CreatePredictor operation. 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 DescribePredictor 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.
2602 2603 2604 2605 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2602 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.
2635 2636 2637 2638 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2635 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
2677 2678 2679 2680 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2677 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.
2741 2742 2743 2744 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2741 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.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2770 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.
2803 2804 2805 2806 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/client.rb', line 2803 def update_dataset_group(params = {}, = {}) req = build_request(:update_dataset_group, params) req.send_request() end |