String name
The name of the hyperparameter to tune.
Double maxValue
The maximum tunable value of the hyperparameter.
Double minValue
The minimum tunable value of the hyperparameter.
String scalingType
The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have values greater than 0.
hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
String datasetGroupName
A name for the dataset group.
String domain
The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value
specified for the Domain parameter of the CreateDataset operation must match.
The Domain and DatasetType that you choose determine the fields that must be present in
training data that you import to a dataset. For example, if you choose the RETAIL domain and
TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that
item_id, timestamp, and demand fields are present in your data. For more
information, see howitworks-datasets-groups.
List<E> datasetArns
An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
String datasetImportJobName
The name for the dataset import job. We recommend including the current timestamp in the name, for example,
20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException
exception.
String datasetArn
The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
DataSource dataSource
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM
role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified
in the EncryptionConfig parameter of the CreateDataset operation.
String timestampFormat
The format of timestamps in the dataset. The format that you specify depends on the DataFrequency
specified when the dataset was created. The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
String datasetImportJobArn
The Amazon Resource Name (ARN) of the dataset import job.
String datasetName
A name for the dataset.
String domain
The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value
specified for the Domain parameter of the CreateDatasetGroup operation must match.
The Domain and DatasetType that you choose determine the fields that must be present in
the training data that you import to the dataset. For example, if you choose the RETAIL domain and
TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id,
timestamp, and demand fields to be present in your data. For more information, see
howitworks-datasets-groups.
String datasetType
The dataset type. Valid values depend on the chosen Domain.
String dataFrequency
The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.
Schema schema
The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset
Domain and DatasetType that you choose determine the minimum required fields in your
training data. For information about the required fields for a specific dataset domain and type, see
howitworks-domains-ds-types.
EncryptionConfig encryptionConfig
An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
String datasetArn
The Amazon Resource Name (ARN) of the dataset.
String forecastExportJobName
The name for the forecast export job.
String forecastArn
The Amazon Resource Name (ARN) of the forecast that you want to export.
DataDestination destination
The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The IAM
role must allow Amazon Forecast permission to access the key.
String forecastExportJobArn
The Amazon Resource Name (ARN) of the export job.
String forecastName
A name for the forecast.
String predictorArn
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
List<E> forecastTypes
The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per forecast.
Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean
forecast is different from the median (0.50) when the distribution is not symmetric (e.g. Beta, Negative
Binomial). The default value is ["0.1", "0.5", "0.9"].
String forecastArn
The Amazon Resource Name (ARN) of the forecast.
String predictorName
A name for the predictor.
String algorithmArn
The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if PerformAutoML
is not set to true.
Supported algorithms:
arn:aws:forecast:::algorithm/ARIMA
arn:aws:forecast:::algorithm/Deep_AR_Plus
Supports hyperparameter optimization (HPO)
arn:aws:forecast:::algorithm/ETS
arn:aws:forecast:::algorithm/NPTS
arn:aws:forecast:::algorithm/Prophet
Integer forecastHorizon
Specifies the number of time-steps that the model is trained to predict. The forecast horizon is also called the prediction length.
For example, if you configure a dataset for daily data collection (using the DataFrequency parameter
of the CreateDataset operation) and set the forecast horizon to 10, the model returns predictions for 10
days.
The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.
Boolean performAutoML
Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it provides and chooses the best algorithm and configuration for your training dataset.
The default value is false. In this case, you are required to specify an algorithm.
Set PerformAutoML to true to have Amazon Forecast perform AutoML. This is a good option
if you aren't sure which algorithm is suitable for your training data. In this case, PerformHPO must
be false.
Boolean performHPO
Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as running a hyperparameter tuning job.
The default value is false. In this case, Amazon Forecast uses default hyperparameter values from
the chosen algorithm.
To override the default values, set PerformHPO to true and, optionally, supply the
HyperParameterTuningJobConfig object. The tuning job specifies a metric to optimize, which hyperparameters
participate in tuning, and the valid range for each tunable hyperparameter. In this case, you are required to
specify an algorithm and PerformAutoML must be false.
The following algorithm supports HPO:
DeepAR+
Map<K,V> trainingParameters
The hyperparameters to override for model training. The hyperparameters that you can override are listed in the individual algorithms. For the list of supported algorithms, see aws-forecast-choosing-recipes.
EvaluationParameters evaluationParameters
Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.
HyperParameterTuningJobConfig hPOConfig
Provides hyperparameter override values for the algorithm. If you don't provide this parameter, Amazon Forecast uses default values. The individual algorithms specify which hyperparameters support hyperparameter optimization (HPO). For more information, see aws-forecast-choosing-recipes.
If you included the HPOConfig object, you must set PerformHPO to true.
InputDataConfig inputDataConfig
Describes the dataset group that contains the data to use to train the predictor.
FeaturizationConfig featurizationConfig
The featurization configuration.
EncryptionConfig encryptionConfig
An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
String predictorArn
The Amazon Resource Name (ARN) of the predictor.
S3Config s3Config
The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
String datasetGroupName
The name of the dataset group.
Date creationTime
When the dataset group was created.
Date lastModificationTime
When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While
the dataset group is being updated, LastModificationTime is the current time of the
ListDatasetGroups call.
String datasetImportJobArn
The Amazon Resource Name (ARN) of the dataset import job.
String datasetImportJobName
The name of the dataset import job.
DataSource dataSource
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.
String status
The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the
import job status is CREATE_IN_PROGRESS, the status of the dataset is
UPDATE_IN_PROGRESS. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
String message
If an error occurred, an informational message about the error.
Date creationTime
When the dataset import job was created.
Date lastModificationTime
The last time that the dataset was modified. The time depends on the status of the job, as follows:
CREATE_PENDING - The same time as CreationTime.
CREATE_IN_PROGRESS - The current timestamp.
ACTIVE or CREATE_FAILED - When the job finished or failed.
String datasetArn
The Amazon Resource Name (ARN) of the dataset.
String datasetName
The name of the dataset.
String datasetType
The dataset type.
String domain
The domain associated with the dataset.
Date creationTime
When the dataset was created.
Date lastModificationTime
When you create a dataset, LastModificationTime is the same as CreationTime. While data
is being imported to the dataset, LastModificationTime is the current time of the
ListDatasets call. After a CreateDatasetImportJob operation has finished,
LastModificationTime is when the import job completed or failed.
S3Config s3Config
The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group to delete.
String datasetImportJobArn
The Amazon Resource Name (ARN) of the dataset import job to delete.
String datasetArn
The Amazon Resource Name (ARN) of the dataset to delete.
String forecastExportJobArn
The Amazon Resource Name (ARN) of the forecast export job to delete.
String forecastArn
The Amazon Resource Name (ARN) of the forecast to delete.
String predictorArn
The Amazon Resource Name (ARN) of the predictor to delete.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
String datasetGroupName
The name of the dataset group.
String datasetGroupArn
The ARN of the dataset group.
List<E> datasetArns
An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
String domain
The domain associated with the dataset group.
String status
The status of the dataset group. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
The UPDATE states apply when you call the UpdateDatasetGroup operation.
The Status of the dataset group must be ACTIVE before you can use the dataset group to
create a predictor.
Date creationTime
When the dataset group was created.
Date lastModificationTime
When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While
the dataset group is being updated, LastModificationTime is the current time of the
DescribeDatasetGroup call.
String datasetImportJobArn
The Amazon Resource Name (ARN) of the dataset import job.
String datasetImportJobName
The name of the dataset import job.
String datasetImportJobArn
The ARN of the dataset import job.
String datasetArn
The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
String timestampFormat
The format of timestamps in the dataset. The format that you specify depends on the DataFrequency
specified when the dataset was created. The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
DataSource dataSource
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.
If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.
Map<K,V> fieldStatistics
Statistical information about each field in the input data.
Double dataSize
The size of the dataset in gigabytes (GB) after the import job has finished.
String status
The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the
import job status is CREATE_IN_PROGRESS, the status of the dataset is
UPDATE_IN_PROGRESS. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
String message
If an error occurred, an informational message about the error.
Date creationTime
When the dataset import job was created.
Date lastModificationTime
The last time that the dataset was modified. The time depends on the status of the job, as follows:
CREATE_PENDING - The same time as CreationTime.
CREATE_IN_PROGRESS - The current timestamp.
ACTIVE or CREATE_FAILED - When the job finished or failed.
String datasetArn
The Amazon Resource Name (ARN) of the dataset.
String datasetArn
The Amazon Resource Name (ARN) of the dataset.
String datasetName
The name of the dataset.
String domain
The domain associated with the dataset.
String datasetType
The dataset type.
String dataFrequency
The frequency of data collection.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min" indicates every 30 minutes.
Schema schema
An array of SchemaAttribute objects that specify the dataset fields. Each
SchemaAttribute specifies the name and data type of a field.
EncryptionConfig encryptionConfig
The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
String status
The status of the dataset. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
The UPDATE states apply while data is imported to the dataset from a call to the
CreateDatasetImportJob operation and reflect the status of the dataset import job. For example, when the
import job status is CREATE_IN_PROGRESS, the status of the dataset is
UPDATE_IN_PROGRESS.
The Status of the dataset must be ACTIVE before you can import training data.
Date creationTime
When the dataset was created.
Date lastModificationTime
When you create a dataset, LastModificationTime is the same as CreationTime. While data
is being imported to the dataset, LastModificationTime is the current time of the
DescribeDataset call. After a CreateDatasetImportJob operation has finished,
LastModificationTime is when the import job completed or failed.
String forecastExportJobArn
The Amazon Resource Name (ARN) of the forecast export job.
String forecastExportJobArn
The ARN of the forecast export job.
String forecastExportJobName
The name of the forecast export job.
String forecastArn
The Amazon Resource Name (ARN) of the exported forecast.
DataDestination destination
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
String message
If an error occurred, an informational message about the error.
String status
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
The Status of the forecast export job must be ACTIVE before you can access the forecast
in your S3 bucket.
Date creationTime
When the forecast export job was created.
Date lastModificationTime
When the last successful export job finished.
String forecastArn
The Amazon Resource Name (ARN) of the forecast.
String forecastArn
The forecast ARN as specified in the request.
String forecastName
The name of the forecast.
List<E> forecastTypes
The quantiles at which proababilistic forecasts were generated.
String predictorArn
The ARN of the predictor used to generate the forecast.
String datasetGroupArn
The ARN of the dataset group that provided the data used to train the predictor.
String status
The status of the forecast. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
The Status of the forecast must be ACTIVE before you can query or export the forecast.
String message
If an error occurred, an informational message about the error.
Date creationTime
When the forecast creation task was created.
Date lastModificationTime
Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference
(creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is
complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
String predictorArn
The Amazon Resource Name (ARN) of the predictor that you want information about.
String predictorArn
The ARN of the predictor.
String predictorName
The name of the predictor.
String algorithmArn
The Amazon Resource Name (ARN) of the algorithm used for model training.
Integer forecastHorizon
The number of time-steps of the forecast. The forecast horizon is also called the prediction length.
Boolean performAutoML
Whether the predictor is set to perform AutoML.
Boolean performHPO
Whether the predictor is set to perform hyperparameter optimization (HPO).
Map<K,V> trainingParameters
The default training parameters or overrides selected during model training. If using the AutoML algorithm or if HPO is turned on while using the DeepAR+ algorithms, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.
EvaluationParameters evaluationParameters
Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.
HyperParameterTuningJobConfig hPOConfig
The hyperparameter override values for the algorithm.
InputDataConfig inputDataConfig
Describes the dataset group that contains the data to use to train the predictor.
FeaturizationConfig featurizationConfig
The featurization configuration.
EncryptionConfig encryptionConfig
An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
PredictorExecutionDetails predictorExecutionDetails
Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.
List<E> datasetImportJobArns
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
List<E> autoMLAlgorithmArns
When PerformAutoML is specified, the ARN of the chosen algorithm.
String status
The status of the predictor. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
The Status of the predictor must be ACTIVE before you can use the predictor to create a
forecast.
String message
If an error occurred, an informational message about the error.
Date creationTime
When the model training task was created.
Date lastModificationTime
Initially, the same as CreationTime (when the status is CREATE_PENDING). This value is
updated when training starts (when the status changes to CREATE_IN_PROGRESS), and when training has
completed (when the status changes to ACTIVE) or fails (when the status changes to
CREATE_FAILED).
String roleArn
The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an
InvalidInputException error.
String kMSKeyArn
The Amazon Resource Name (ARN) of the KMS key.
Integer numberOfBacktestWindows
The number of times to split the input data. The default is 1. Valid values are 1 through 5.
Integer backTestWindowOffset
The point from the end of the dataset where you want to split the data for model training and testing
(evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon.
BackTestWindowOffset can be used to mimic a past virtual forecast start date. This value must be
greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.
ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length
String algorithmArn
The Amazon Resource Name (ARN) of the algorithm that was evaluated.
List<E> testWindows
The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from the
EvaluationParameters object determines the number of windows in the array.
String attributeName
The name of the schema attribute that specifies the data field to be featurized. Only the target
field of the TARGET_TIME_SERIES dataset type is supported. For example, for the RETAIL
domain, the target is demand, and for the CUSTOM domain, the target is
target_value.
List<E> featurizationPipeline
An array of one FeaturizationMethod object that specifies the feature transformation method.
String forecastFrequency
The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
List<E> forecastDimensions
An array of dimension (field) names that specify how to group the generated forecast.
For example, suppose that you are generating a forecast for item sales across all of your stores, and your
dataset contains a store_id field. If you want the sales forecast for each item by store, you would
specify store_id as the dimension.
All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't need to be specified in
the CreatePredictor request. All forecast dimensions specified in the
RELATED_TIME_SERIES dataset must be specified in the CreatePredictor request.
List<E> featurizations
An array of featurization (transformation) information for the fields of a dataset. Only a single featurization is supported.
String featurizationMethodName
The name of the method. The "filling" method is the only supported method.
Map<K,V> featurizationMethodParameters
The method parameters (key-value pairs). Specify these parameters to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.
aggregation: sum, avg, first, min, max
frontfill: none
middlefill: zero, nan (not a number)
backfill: zero, nan
String forecastExportJobArn
The Amazon Resource Name (ARN) of the forecast export job.
String forecastExportJobName
The name of the forecast export job.
DataDestination destination
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
String status
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
The Status of the forecast export job must be ACTIVE before you can access the forecast
in your S3 bucket.
String message
If an error occurred, an informational message about the error.
Date creationTime
When the forecast export job was created.
Date lastModificationTime
When the last successful export job finished.
String forecastArn
The ARN of the forecast.
String forecastName
The name of the forecast.
String predictorArn
The ARN of the predictor used to generate the forecast.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
String status
The status of the forecast. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
The Status of the forecast must be ACTIVE before you can query or export the forecast.
String message
If an error occurred, an informational message about the error.
Date creationTime
When the forecast creation task was created.
Date lastModificationTime
Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference
(creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is
complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
String predictorArn
The Amazon Resource Name (ARN) of the predictor to get metrics for.
ParameterRanges parameterRanges
Specifies the ranges of valid values for the hyperparameters.
String name
The name of the hyperparameter to tune.
Integer maxValue
The maximum tunable value of the hyperparameter.
Integer minValue
The minimum tunable value of the hyperparameter.
String scalingType
The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have values greater than 0.
Not supported for IntegerParameterRange.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
String nextToken
If the result of the previous request was truncated, the response includes a NextToken. To retrieve
the next set of results, use the token in the next request. Tokens expire after 24 hours.
Integer maxResults
The number of items to return in the response.
List<E> filters
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS or IS_NOT, which specifies whether to include or exclude the datasets that match the
statement from the list, respectively. The match statement consists of a key and a value.
Filter properties
Condition - The condition to apply. Valid values are IS and IS_NOT. To
include the datasets that match the statement, specify IS. To exclude matching datasets, specify
IS_NOT.
Key - The name of the parameter to filter on. Valid values are DatasetArn and
Status.
Value - The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
String nextToken
If the result of the previous request was truncated, the response includes a NextToken. To retrieve
the next set of results, use the token in the next request. Tokens expire after 24 hours.
Integer maxResults
The number of items to return in the response.
List<E> filters
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS or IS_NOT, which specifies whether to include or exclude the forecast export jobs
that match the statement from the list, respectively. The match statement consists of a key and a value.
Filter properties
Condition - The condition to apply. Valid values are IS and IS_NOT. To
include the forecast export jobs that match the statement, specify IS. To exclude matching forecast
export jobs, specify IS_NOT.
Key - The name of the parameter to filter on. Valid values are ForecastArn and
Status.
Value - The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
String nextToken
If the result of the previous request was truncated, the response includes a NextToken. To retrieve
the next set of results, use the token in the next request. Tokens expire after 24 hours.
Integer maxResults
The number of items to return in the response.
List<E> filters
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS or IS_NOT, which specifies whether to include or exclude the forecasts that match
the statement from the list, respectively. The match statement consists of a key and a value.
Filter properties
Condition - The condition to apply. Valid values are IS and IS_NOT. To
include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify
IS_NOT.
Key - The name of the parameter to filter on. Valid values are DatasetGroupArn,
PredictorArn, and Status.
Value - The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
String nextToken
If the result of the previous request was truncated, the response includes a NextToken. To retrieve
the next set of results, use the token in the next request. Tokens expire after 24 hours.
Integer maxResults
The number of items to return in the response.
List<E> filters
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS or IS_NOT, which specifies whether to include or exclude the predictors that match
the statement from the list, respectively. The match statement consists of a key and a value.
Filter properties
Condition - The condition to apply. Valid values are IS and IS_NOT. To
include the predictors that match the statement, specify IS. To exclude matching predictors, specify
IS_NOT.
Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and
Status.
Value - The value to match.
For example, to list all predictors whose status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
List<E> categoricalParameterRanges
Specifies the tunable range for each categorical hyperparameter.
List<E> continuousParameterRanges
Specifies the tunable range for each continuous hyperparameter.
List<E> integerParameterRanges
Specifies the tunable range for each integer hyperparameter.
String predictorArn
The ARN of the predictor.
String predictorName
The name of the predictor.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
String status
The status of the predictor. States include:
ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
The Status of the predictor must be ACTIVE before you can use the predictor to create a
forecast.
String message
If an error occurred, an informational message about the error.
Date creationTime
When the model training task was created.
Date lastModificationTime
Initially, the same as CreationTime (status is CREATE_PENDING). Updated when training
starts (status changed to CREATE_IN_PROGRESS), and when training is complete (status changed to
ACTIVE) or fails (status changed to CREATE_FAILED).
String path
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
String roleArn
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon
S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the
key.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an
InvalidInputException error.
String kMSKeyArn
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
Integer count
The number of values in the field.
Integer countDistinct
The number of distinct values in the field.
Integer countNull
The number of null values in the field.
Integer countNan
The number of NAN (not a number) values in the field.
String min
For a numeric field, the minimum value in the field.
String max
For a numeric field, the maximum value in the field.
Double avg
For a numeric field, the average value in the field.
Double stddev
For a numeric field, the standard deviation.
Date testWindowStart
The time at which the test began.
Date testWindowEnd
The time at which the test ended.
String status
The status of the test. Possible status values are:
ACTIVE
CREATE_IN_PROGRESS
CREATE_FAILED
String message
If the test failed, the reason why it failed.
Double quantile
The quantile. Quantiles divide a probability distribution into regions of equal probability. For example, if the distribution was divided into 5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.
Double lossValue
The difference between the predicted value and the actual value over the quantile, weighted (normalized) by dividing by the sum over all quantiles.
Date testWindowStart
The timestamp that defines the start of the window.
Date testWindowEnd
The timestamp that defines the end of the window.
Integer itemCount
The number of data points within the window.
String evaluationType
The type of evaluation.
SUMMARY - The average metrics across all windows.
COMPUTED - The metrics for the specified window.
Metrics metrics
Provides metrics used to evaluate the performance of a predictor.
Copyright © 2020. All rights reserved.