{ "version":"2.0", "metadata":{ "apiVersion":"2018-06-26", "endpointPrefix":"forecast", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon Forecast Service", "serviceId":"forecast", "signatureVersion":"v4", "signingName":"forecast", "targetPrefix":"AmazonForecast", "uid":"forecast-2018-06-26" }, "operations":{ "CreateAutoPredictor":{ "name":"CreateAutoPredictor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAutoPredictorRequest"}, "output":{"shape":"CreateAutoPredictorResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates an Amazon Forecast predictor.

Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors.

Creating new predictors

The following parameters are required when creating a new predictor:

- `PredictorName` - A unique name for the predictor.

- `DatasetGroupArn` - The ARN of the dataset group used to train the predictor.

- `ForecastFrequency` - The granularity of your forecasts (hourly, daily, weekly, etc).

- `ForecastHorizon` - The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

When creating a new predictor, do not specify a value for `ReferencePredictorArn`.

Upgrading and retraining predictors

The following parameters are required when retraining or upgrading a predictor:

- `PredictorName` - A unique name for the predictor.

- `ReferencePredictorArn` - The ARN of the predictor to retrain or upgrade.

When upgrading or retraining a predictor, only specify values for the `ReferencePredictorArn` and `PredictorName`.

" }, "CreateDataset":{ "name":"CreateDataset", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDatasetRequest"}, "output":{"shape":"CreateDatasetResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

- `DataFrequency` - How frequently your historical time-series data is collected.

- `Domain` and `DatasetType` - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.

- `Schema` - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets.

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.

The `Status` of a dataset must be `ACTIVE` before you can import training data. Use the DescribeDataset operation to get the status.

" }, "CreateDatasetGroup":{ "name":"CreateDatasetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDatasetGroupRequest"}, "output":{"shape":"CreateDatasetGroupResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

The `Status` of a dataset group must be `ACTIVE` before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

" }, "CreateDatasetImportJob":{ "name":"CreateDatasetImportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDatasetImportJobRequest"}, "output":{"shape":"CreateDatasetImportJobResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal Amazon Web Services system. For more information, see Set up permissions.

The training data must be in CSV or Parquet format. The delimiter must be a comma (,).

You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.

Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.

" }, "CreateExplainability":{ "name":"CreateExplainability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateExplainabilityRequest"}, "output":{"shape":"CreateExplainabilityResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor)

Creates an Amazon Forecast Explainability.

Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they increase or decrease forecast values.

To enable Forecast Explainability, your predictor must include at least one of the following: related time series, item metadata, or additional datasets like Holidays and the Weather Index.

CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time series and time points, provide a Forecast ARN.

CreateExplainability with a Predictor ARN

You can only have one Explainability resource per predictor. If you already enabled `ExplainPredictor` in CreateAutoPredictor, that predictor already has an Explainability resource.

The following parameters are required when providing a Predictor ARN:

- `ExplainabilityName` - A unique name for the Explainability.

- `ResourceArn` - The Arn of the predictor.

- `TimePointGranularity` - Must be set to “ALL”.

- `TimeSeriesGranularity` - Must be set to “ALL”.

Do not specify a value for the following parameters:

- `DataSource` - Only valid when TimeSeriesGranularity is “SPECIFIC”.

- `Schema` - Only valid when TimeSeriesGranularity is “SPECIFIC”.

- `StartDateTime` - Only valid when TimePointGranularity is “SPECIFIC”.

- `EndDateTime` - Only valid when TimePointGranularity is “SPECIFIC”.

CreateExplainability with a Forecast ARN

You can specify a maximum of 50 time series and 500 time points.

The following parameters are required when providing a Predictor ARN:

- `ExplainabilityName` - A unique name for the Explainability.

- `ResourceArn` - The Arn of the forecast.

- `TimePointGranularity` - Either “ALL” or “SPECIFIC”.

- `TimeSeriesGranularity` - Either “ALL” or “SPECIFIC”.

If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:

- `DataSource` - The S3 location of the CSV file specifying your time series.

- `Schema` - The Schema defines the attributes and attribute types listed in the Data Source.

If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:

- `StartDateTime` - The first timestamp in the range of time points.

- `EndDateTime` - The last timestamp in the range of time points.

" }, "CreateExplainabilityExport":{ "name":"CreateExplainabilityExport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateExplainabilityExportRequest"}, "output":{"shape":"CreateExplainabilityExportResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.

You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

The `Status` of the export job must be `ACTIVE` before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.

" }, "CreateForecast":{ "name":"CreateForecast", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateForecastRequest"}, "output":{"shape":"CreateForecastResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a forecast for each item in the `TARGET_TIME_SERIES` dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the `ForecastHorizon` value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The `Status` of the forecast must be `ACTIVE` before you can query or export the forecast. Use the DescribeForecast operation to get the status.

By default, a forecast includes predictions for every item (`item_id`) in the dataset group that was used to train the predictor. However, you can use the `TimeSeriesSelector` object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.

" }, "CreateForecastExportJob":{ "name":"CreateForecastExportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateForecastExportJobRequest"}, "output":{"shape":"CreateForecastExportJobResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

The `Status` of the forecast export job must be `ACTIVE` before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

" }, "CreateMonitor":{ "name":"CreateMonitor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateMonitorRequest"}, "output":{"shape":"CreateMonitorResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.

" }, "CreatePredictor":{ "name":"CreatePredictor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePredictorRequest"}, "output":{"shape":"CreatePredictorResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use CreateAutoPredictor.

Creates an Amazon Forecast predictor.

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

To see the evaluation metrics, use the GetAccuracyMetrics operation.

You can specify a featurization configuration to fill and aggregate the data fields in the `TARGET_TIME_SERIES` dataset to improve model training. For more information, see FeaturizationConfig.

For RELATED_TIME_SERIES datasets, `CreatePredictor` verifies that the `DataFrequency` specified when the dataset was created matches the `ForecastFrequency`. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the `ForecastTypes`.

AutoML

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the `objective function`, set `PerformAutoML` to `true`. The `objective function` is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.

When AutoML is enabled, the following properties are disallowed:

- `AlgorithmArn`

- `HPOConfig`

- `PerformHPO`

- `TrainingParameters`

To get a list of all of your predictors, use the ListPredictors operation.

Before you can use the predictor to create a forecast, the `Status` of the predictor must be `ACTIVE`, signifying that training has completed. To get the status, use the DescribePredictor operation.

" }, "CreatePredictorBacktestExportJob":{ "name":"CreatePredictorBacktestExportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePredictorBacktestExportJobRequest"}, "output":{"shape":"CreatePredictorBacktestExportJobResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket.

The export file names will match the following conventions:

`<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv`

The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

The `Status` of the export job must be `ACTIVE` before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

" }, "CreateWhatIfAnalysis":{ "name":"CreateWhatIfAnalysis", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWhatIfAnalysisRequest"}, "output":{"shape":"CreateWhatIfAnalysisResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.

For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals.

You could create a scenario where everything is given a 25% markdown, and another where everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and another where the sale lasts for one month. With a what-if analysis, you can compare many different scenarios against each other.

Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.

The TimeSeriesSelector object defines the items that you want in the what-if analysis.

" }, "CreateWhatIfForecast":{ "name":"CreateWhatIfForecast", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWhatIfForecastRequest"}, "output":{"shape":"CreateWhatIfForecastResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset.

" }, "CreateWhatIfForecastExport":{ "name":"CreateWhatIfForecastExport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWhatIfForecastExportRequest"}, "output":{"shape":"CreateWhatIfForecastExportResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], "documentation":"

Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

`≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>`

The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.

The `Status` of the forecast export job must be `ACTIVE` before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.

" }, "DeleteDataset":{ "name":"DeleteDataset", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDatasetRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

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.

Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the UpdateDatasetGroup operation, omitting the deleted dataset's ARN.

", "idempotent":true }, "DeleteDatasetGroup":{ "name":"DeleteDatasetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDatasetGroupRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

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.

", "idempotent":true }, "DeleteDatasetImportJob":{ "name":"DeleteDatasetImportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDatasetImportJobRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

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.

", "idempotent":true }, "DeleteExplainability":{ "name":"DeleteExplainability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteExplainabilityRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

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.

", "idempotent":true }, "DeleteExplainabilityExport":{ "name":"DeleteExplainabilityExport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteExplainabilityExportRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes an Explainability export.

", "idempotent":true }, "DeleteForecast":{ "name":"DeleteForecast", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteForecastRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

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.

", "idempotent":true }, "DeleteForecastExportJob":{ "name":"DeleteForecastExportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteForecastExportJobRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

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.

", "idempotent":true }, "DeleteMonitor":{ "name":"DeleteMonitor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteMonitorRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes a monitor resource. You can only delete a monitor resource with a status of `ACTIVE`, `ACTIVE_STOPPED`, `CREATE_FAILED`, or `CREATE_STOPPED`.

", "idempotent":true }, "DeletePredictor":{ "name":"DeletePredictor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePredictorRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

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.

", "idempotent":true }, "DeletePredictorBacktestExportJob":{ "name":"DeletePredictorBacktestExportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePredictorBacktestExportJobRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes a predictor backtest export job.

", "idempotent":true }, "DeleteResourceTree":{ "name":"DeleteResourceTree", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteResourceTreeRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

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.

", "idempotent":true }, "DeleteWhatIfAnalysis":{ "name":"DeleteWhatIfAnalysis", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWhatIfAnalysisRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if analyses that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the DescribeWhatIfAnalysis operation.

You can't delete a what-if analysis while any of its forecasts are being exported.

", "idempotent":true }, "DeleteWhatIfForecast":{ "name":"DeleteWhatIfForecast", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWhatIfForecastRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if forecasts that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the DescribeWhatIfForecast operation.

You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.

", "idempotent":true }, "DeleteWhatIfForecastExport":{ "name":"DeleteWhatIfForecastExport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWhatIfForecastExportRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation. You can delete only what-if forecast exports that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the DescribeWhatIfForecastExport operation.

", "idempotent":true }, "DescribeAutoPredictor":{ "name":"DescribeAutoPredictor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAutoPredictorRequest"}, "output":{"shape":"DescribeAutoPredictorResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes a predictor created using the CreateAutoPredictor operation.

", "idempotent":true }, "DescribeDataset":{ "name":"DescribeDataset", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDatasetRequest"}, "output":{"shape":"DescribeDatasetResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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`

", "idempotent":true }, "DescribeDatasetGroup":{ "name":"DescribeDatasetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDatasetGroupRequest"}, "output":{"shape":"DescribeDatasetGroupResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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`

", "idempotent":true }, "DescribeDatasetImportJob":{ "name":"DescribeDatasetImportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDatasetImportJobRequest"}, "output":{"shape":"DescribeDatasetImportJobResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

", "idempotent":true }, "DescribeExplainability":{ "name":"DescribeExplainability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExplainabilityRequest"}, "output":{"shape":"DescribeExplainabilityResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes an Explainability resource created using the CreateExplainability operation.

", "idempotent":true }, "DescribeExplainabilityExport":{ "name":"DescribeExplainabilityExport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExplainabilityExportRequest"}, "output":{"shape":"DescribeExplainabilityExportResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes an Explainability export created using the CreateExplainabilityExport operation.

", "idempotent":true }, "DescribeForecast":{ "name":"DescribeForecast", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeForecastRequest"}, "output":{"shape":"DescribeForecastResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

", "idempotent":true }, "DescribeForecastExportJob":{ "name":"DescribeForecastExportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeForecastExportJobRequest"}, "output":{"shape":"DescribeForecastExportJobResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

", "idempotent":true }, "DescribeMonitor":{ "name":"DescribeMonitor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMonitorRequest"}, "output":{"shape":"DescribeMonitorResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties:

- `Baseline`

- `CreationTime`

- `LastEvaluationTime`

- `LastEvaluationState`

- `LastModificationTime`

- `Message`

- `Status`

", "idempotent":true }, "DescribePredictor":{ "name":"DescribePredictor", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePredictorRequest"}, "output":{"shape":"DescribePredictorResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor.

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the `CreatePredictor` request, this operation lists the following properties:

- `DatasetImportJobArns` - The dataset import jobs used to import training data.

- `AutoMLAlgorithmArns` - If AutoML is performed, the algorithms that were evaluated.

- `CreationTime`

- `LastModificationTime`

- `Status`

- `Message` - If an error occurred, information about the error.

", "idempotent":true }, "DescribePredictorBacktestExportJob":{ "name":"DescribePredictorBacktestExportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePredictorBacktestExportJobRequest"}, "output":{"shape":"DescribePredictorBacktestExportJobResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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)

", "idempotent":true }, "DescribeWhatIfAnalysis":{ "name":"DescribeWhatIfAnalysis", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWhatIfAnalysisRequest"}, "output":{"shape":"DescribeWhatIfAnalysisResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes the what-if analysis created using the CreateWhatIfAnalysis operation.

In addition to listing the properties provided in the `CreateWhatIfAnalysis` request, this operation lists the following properties:

- `CreationTime`

- `LastModificationTime`

- `Message` - If an error occurred, information about the error.

- `Status`

", "idempotent":true }, "DescribeWhatIfForecast":{ "name":"DescribeWhatIfForecast", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWhatIfForecastRequest"}, "output":{"shape":"DescribeWhatIfForecastResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes the what-if forecast created using the CreateWhatIfForecast operation.

In addition to listing the properties provided in the `CreateWhatIfForecast` request, this operation lists the following properties:

- `CreationTime`

- `LastModificationTime`

- `Message` - If an error occurred, information about the error.

- `Status`

", "idempotent":true }, "DescribeWhatIfForecastExport":{ "name":"DescribeWhatIfForecastExport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWhatIfForecastExportRequest"}, "output":{"shape":"DescribeWhatIfForecastExportResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.

In addition to listing the properties provided in the `CreateWhatIfForecastExport` request, this operation lists the following properties:

- `CreationTime`

- `LastModificationTime`

- `Message` - If an error occurred, information about the error.

- `Status`

", "idempotent":true }, "GetAccuracyMetrics":{ "name":"GetAccuracyMetrics", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAccuracyMetricsRequest"}, "output":{"shape":"GetAccuracyMetricsResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

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.

Before you can get accuracy metrics, the `Status` of the predictor must be `ACTIVE`, signifying that training has completed. To get the status, use the DescribePredictor operation.

", "idempotent":true }, "ListDatasetGroups":{ "name":"ListDatasetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDatasetGroupsRequest"}, "output":{"shape":"ListDatasetGroupsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"} ], "documentation":"

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.

", "idempotent":true }, "ListDatasetImportJobs":{ "name":"ListDatasetImportJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDatasetImportJobsRequest"}, "output":{"shape":"ListDatasetImportJobsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

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.

", "idempotent":true }, "ListDatasets":{ "name":"ListDatasets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDatasetsRequest"}, "output":{"shape":"ListDatasetsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"} ], "documentation":"

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.

", "idempotent":true }, "ListExplainabilities":{ "name":"ListExplainabilities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListExplainabilitiesRequest"}, "output":{"shape":"ListExplainabilitiesResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

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.

", "idempotent":true }, "ListExplainabilityExports":{ "name":"ListExplainabilityExports", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListExplainabilityExportsRequest"}, "output":{"shape":"ListExplainabilityExportsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

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.

", "idempotent":true }, "ListForecastExportJobs":{ "name":"ListForecastExportJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListForecastExportJobsRequest"}, "output":{"shape":"ListForecastExportJobsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

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.

", "idempotent":true }, "ListForecasts":{ "name":"ListForecasts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListForecastsRequest"}, "output":{"shape":"ListForecastsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

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.

", "idempotent":true }, "ListMonitorEvaluations":{ "name":"ListMonitorEvaluations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListMonitorEvaluationsRequest"}, "output":{"shape":"ListMonitorEvaluationsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.

For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.

", "idempotent":true }, "ListMonitors":{ "name":"ListMonitors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListMonitorsRequest"}, "output":{"shape":"ListMonitorsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.

", "idempotent":true }, "ListPredictorBacktestExportJobs":{ "name":"ListPredictorBacktestExportJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPredictorBacktestExportJobsRequest"}, "output":{"shape":"ListPredictorBacktestExportJobsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

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.

", "idempotent":true }, "ListPredictors":{ "name":"ListPredictors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPredictorsRequest"}, "output":{"shape":"ListPredictorsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

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.

", "idempotent":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidInputException"} ], "documentation":"

Lists the tags for an Amazon Forecast resource.

" }, "ListWhatIfAnalyses":{ "name":"ListWhatIfAnalyses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWhatIfAnalysesRequest"}, "output":{"shape":"ListWhatIfAnalysesResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation.

", "idempotent":true }, "ListWhatIfForecastExports":{ "name":"ListWhatIfForecastExports", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWhatIfForecastExportsRequest"}, "output":{"shape":"ListWhatIfForecastExportsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation.

", "idempotent":true }, "ListWhatIfForecasts":{ "name":"ListWhatIfForecasts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWhatIfForecastsRequest"}, "output":{"shape":"ListWhatIfForecastsResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidInputException"} ], "documentation":"

Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the DescribeWhatIfForecast operation.

", "idempotent":true }, "ResumeResource":{ "name":"ResumeResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResumeResourceRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Resumes a stopped monitor resource.

", "idempotent":true }, "StopResource":{ "name":"StopResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopResourceRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidInputException"} ], "documentation":"

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.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidInputException"} ], "documentation":"

Deletes the specified tags from a resource.

" }, "UpdateDatasetGroup":{ "name":"UpdateDatasetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDatasetGroupRequest"}, "output":{"shape":"UpdateDatasetGroupResponse"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Replaces the datasets in a dataset group with the specified datasets.

The `Status` of the dataset group must be `ACTIVE` before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.

", "idempotent":true } }, "shapes":{ "Action":{ "type":"structure", "required":[ "AttributeName", "Operation", "Value" ], "members":{ "AttributeName":{ "shape":"Name", "documentation":"

The related time series that you are modifying. This value is case insensitive.

" }, "Operation":{ "shape":"Operation", "documentation":"

The operation that is applied to the provided attribute. Operations include:

- `ADD` - adds `Value` to all rows of `AttributeName`.

- `SUBTRACT` - subtracts `Value` from all rows of `AttributeName`.

- `MULTIPLY` - multiplies all rows of `AttributeName` by `Value`.

- `DIVIDE` - divides all rows of `AttributeName` by `Value`.

" }, "Value":{ "shape":"Double", "documentation":"

The value that is applied for the chosen `Operation`.

" } }, "documentation":"

Defines the modifications that you are making to an attribute for a what-if forecast. For example, you can use this operation to create a what-if forecast that investigates a 10% off sale on all shoes. To do this, you specify `\"AttributeName\": \"shoes\"`, `\"Operation\": \"MULTIPLY\"`, and `\"Value\": \"0.90\"`. Pair this operation with the TimeSeriesCondition operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define a subset of attribute items that are modified.

" }, "AdditionalDataset":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the additional dataset. Valid names: `\"holiday\"` and `\"weather\"`.

" }, "Configuration":{ "shape":"Configuration", "documentation":"

Weather Index

To enable the Weather Index, do not specify a value for `Configuration`.

Holidays

Holidays

To enable Holidays, set `CountryCode` to one of the following two-letter country codes:

- \"AL\" - ALBANIA

- \"AR\" - ARGENTINA

- \"AT\" - AUSTRIA

- \"AU\" - AUSTRALIA

- \"BA\" - BOSNIA HERZEGOVINA

- \"BE\" - BELGIUM

- \"BG\" - BULGARIA

- \"BO\" - BOLIVIA

- \"BR\" - BRAZIL

- \"BY\" - BELARUS

- \"CA\" - CANADA

- \"CL\" - CHILE

- \"CO\" - COLOMBIA

- \"CR\" - COSTA RICA

- \"HR\" - CROATIA

- \"CZ\" - CZECH REPUBLIC

- \"DK\" - DENMARK

- \"EC\" - ECUADOR

- \"EE\" - ESTONIA

- \"ET\" - ETHIOPIA

- \"FI\" - FINLAND

- \"FR\" - FRANCE

- \"DE\" - GERMANY

- \"GR\" - GREECE

- \"HU\" - HUNGARY

- \"IS\" - ICELAND

- \"IN\" - INDIA

- \"IE\" - IRELAND

- \"IT\" - ITALY

- \"JP\" - JAPAN

- \"KZ\" - KAZAKHSTAN

- \"KR\" - KOREA

- \"LV\" - LATVIA

- \"LI\" - LIECHTENSTEIN

- \"LT\" - LITHUANIA

- \"LU\" - LUXEMBOURG

- \"MK\" - MACEDONIA

- \"MT\" - MALTA

- \"MX\" - MEXICO

- \"MD\" - MOLDOVA

- \"ME\" - MONTENEGRO

- \"NL\" - NETHERLANDS

- \"NZ\" - NEW ZEALAND

- \"NI\" - NICARAGUA

- \"NG\" - NIGERIA

- \"NO\" - NORWAY

- \"PA\" - PANAMA

- \"PY\" - PARAGUAY

- \"PE\" - PERU

- \"PL\" - POLAND

- \"PT\" - PORTUGAL

- \"RO\" - ROMANIA

- \"RU\" - RUSSIA

- \"RS\" - SERBIA

- \"SK\" - SLOVAKIA

- \"SI\" - SLOVENIA

- \"ZA\" - SOUTH AFRICA

- \"ES\" - SPAIN

- \"SE\" - SWEDEN

- \"CH\" - SWITZERLAND

- \"UA\" - UKRAINE

- \"AE\" - UNITED ARAB EMIRATES

- \"US\" - UNITED STATES

- \"UK\" - UNITED KINGDOM

- \"UY\" - URUGUAY

- \"VE\" - VENEZUELA

" } }, "documentation":"

Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.

Weather Index

The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.

Holidays

Holidays is a built-in dataset that incorporates national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.

" }, "AdditionalDatasets":{ "type":"list", "member":{"shape":"AdditionalDataset"}, "max":2, "min":1 }, "Arn":{ "type":"string", "max":256, "pattern":"arn:([a-z\\d-]+):forecast:.*:.*:.+" }, "ArnList":{ "type":"list", "member":{"shape":"Arn"} }, "AttributeConfig":{ "type":"structure", "required":[ "AttributeName", "Transformations" ], "members":{ "AttributeName":{ "shape":"Name", "documentation":"

The name of the attribute as specified in the schema. Amazon Forecast supports the target field of the target time series and the related time series datasets. For example, for the RETAIL domain, the target is `demand`.

" }, "Transformations":{ "shape":"Transformations", "documentation":"

The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.

The following list shows the parameters and their valid values for the \"filling\" featurization method for a Target Time Series dataset. Default values are bolded.

- `aggregation`: sum, `avg`, `first`, `min`, `max`

- `frontfill`: none

- `middlefill`: zero, `nan` (not a number), `value`, `median`, `mean`, `min`, `max`

- `backfill`: zero, `nan`, `value`, `median`, `mean`, `min`, `max`

The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):

- `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max`

- `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max`

- `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max`

To set a filling method to a specific value, set the fill parameter to `value` and define the value in a corresponding `_value` parameter. For example, to set backfilling to a value of 2, include the following: `\"backfill\": \"value\"` and `\"backfill_value\":\"2\"`.

" } }, "documentation":"

Provides information about the method used to transform attributes.

The following is an example using the RETAIL domain:

`{`

`\"AttributeName\": \"demand\",`

`\"Transformations\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\": \"zero\"}`

`}`

" }, "AttributeConfigs":{ "type":"list", "member":{"shape":"AttributeConfig"}, "max":50, "min":1 }, "AttributeType":{ "type":"string", "enum":[ "string", "integer", "float", "timestamp", "geolocation" ] }, "AttributeValue":{ "type":"string", "max":256, "pattern":".+" }, "AutoMLOverrideStrategy":{ "type":"string", "enum":[ "LatencyOptimized", "AccuracyOptimized" ] }, "Baseline":{ "type":"structure", "members":{ "PredictorBaseline":{ "shape":"PredictorBaseline", "documentation":"

The initial accuracy metrics for the predictor you are monitoring. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.

" } }, "documentation":"

Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.

" }, "BaselineMetric":{ "type":"structure", "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the metric.

" }, "Value":{ "shape":"Double", "documentation":"

The value for the metric.

" } }, "documentation":"

An individual metric that you can use for comparison as you evaluate your monitoring results.

" }, "BaselineMetrics":{ "type":"list", "member":{"shape":"BaselineMetric"} }, "Boolean":{"type":"boolean"}, "CategoricalParameterRange":{ "type":"structure", "required":[ "Name", "Values" ], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the categorical hyperparameter to tune.

" }, "Values":{ "shape":"Values", "documentation":"

A list of the tunable categories for the hyperparameter.

" } }, "documentation":"

Specifies a categorical hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

" }, "CategoricalParameterRanges":{ "type":"list", "member":{"shape":"CategoricalParameterRange"}, "max":20, "min":1 }, "Condition":{ "type":"string", "enum":[ "EQUALS", "NOT_EQUALS", "LESS_THAN", "GREATER_THAN" ] }, "Configuration":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"Values"} }, "ContinuousParameterRange":{ "type":"structure", "required":[ "Name", "MaxValue", "MinValue" ], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the hyperparameter to tune.

" }, "MaxValue":{ "shape":"Double", "documentation":"

The maximum tunable value of the hyperparameter.

" }, "MinValue":{ "shape":"Double", "documentation":"

The minimum tunable value of the hyperparameter.

" }, "ScalingType":{ "shape":"ScalingType", "documentation":"

The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

Auto

  Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

  Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

  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.

ReverseLogarithmic

  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:

" } }, "documentation":"

Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

" }, "ContinuousParameterRanges":{ "type":"list", "member":{"shape":"ContinuousParameterRange"}, "max":20, "min":1 }, "CreateAutoPredictorRequest":{ "type":"structure", "required":["PredictorName"], "members":{ "PredictorName":{ "shape":"Name", "documentation":"

A unique name for the predictor

" }, "ForecastHorizon":{ "shape":"Integer", "documentation":"

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the TARGET_TIME_SERIES dataset length. If you are retraining an existing AutoPredictor, then the maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.

If you are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you cannot update the forecast horizon parameter. You can meet this requirement by providing longer time-series in the dataset.

" }, "ForecastTypes":{ "shape":"ForecastTypes", "documentation":"

The forecast types used to train a predictor. You can specify up to five forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or higher. You can also specify the mean forecast with `mean`.

" }, "ForecastDimensions":{ "shape":"ForecastDimensions", "documentation":"

An array of dimension (field) names that specify how to group the generated forecast.

For example, if you are generating forecasts for item sales across all your stores, and your dataset contains a `store_id` field, you would specify `store_id` as a dimension to group sales forecasts for each store.

" }, "ForecastFrequency":{ "shape":"Frequency", "documentation":"

The frequency of predictions in a forecast.

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:

- Minute - 1-59

- Hour - 1-23

- Day - 1-6

- Week - 1-4

- Month - 1-11

- Year - 1

Thus, if you want every other week forecasts, specify \"2W\". Or, if you want quarterly forecasts, you specify \"3M\".

The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.

When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.

" }, "DataConfig":{ "shape":"DataConfig", "documentation":"

The data configuration for your dataset group and any additional datasets.

" }, "EncryptionConfig":{"shape":"EncryptionConfig"}, "ReferencePredictorArn":{ "shape":"Arn", "documentation":"

The ARN of the predictor to retrain or upgrade. This parameter is only used when retraining or upgrading a predictor. When creating a new predictor, do not specify a value for this parameter.

When upgrading or retraining a predictor, only specify values for the `ReferencePredictorArn` and `PredictorName`. The value for `PredictorName` must be a unique predictor name.

" }, "OptimizationMetric":{ "shape":"OptimizationMetric", "documentation":"

The accuracy metric used to optimize the predictor.

" }, "ExplainPredictor":{ "shape":"Boolean", "documentation":"

Create an Explainability resource for the predictor.

" }, "Tags":{ "shape":"Tags", "documentation":"

Optional metadata to help you categorize and organize your predictors. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

- For each resource, each tag key must be unique and each tag key must have one value.

- Maximum number of tags per resource: 50.

- Maximum key length: 128 Unicode characters in UTF-8.

- Maximum value length: 256 Unicode characters in UTF-8.

- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

- Key prefixes cannot include any upper or lowercase combination of `aws:` or `AWS:`. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

" }, "MonitorConfig":{ "shape":"MonitorConfig", "documentation":"

The configuration details for predictor monitoring. Provide a name for the monitor resource to enable predictor monitoring.

Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.

" }, "TimeAlignmentBoundary":{ "shape":"TimeAlignmentBoundary", "documentation":"

The time boundary Forecast uses to align and aggregate any data that doesn't align with your forecast frequency. Provide the unit of time and the time boundary as a key value pair. For more information on specifying a time boundary, see Specifying a Time Boundary. If you don't provide a time boundary, Forecast uses a set of Default Time Boundaries.

" } } }, "CreateAutoPredictorResponse":{ "type":"structure", "members":{ "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor.

" } } }, "CreateDatasetGroupRequest":{ "type":"structure", "required":[ "DatasetGroupName", "Domain" ], "members":{ "DatasetGroupName":{ "shape":"Name", "documentation":"

A name for the dataset group.

" }, "Domain":{ "shape":"Domain", "documentation":"

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 Dataset groups.

" }, "DatasetArns":{ "shape":"ArnList", "documentation":"

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

" }, "Tags":{ "shape":"Tags", "documentation":"

The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50.

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8.

- Maximum value length - 256 Unicode characters in UTF-8.

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.

" } } }, "CreateDatasetGroupResponse":{ "type":"structure", "members":{ "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" } } }, "CreateDatasetImportJobRequest":{ "type":"structure", "required":[ "DatasetImportJobName", "DatasetArn", "DataSource" ], "members":{ "DatasetImportJobName":{ "shape":"Name", "documentation":"

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.

" }, "DatasetArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

" }, "DataSource":{ "shape":"DataSource", "documentation":"

The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, `DataSource` must include an Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the `EncryptionConfig` parameter of the CreateDataset operation.

" }, "TimestampFormat":{ "shape":"TimestampFormat", "documentation":"

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\".

" }, "TimeZone":{ "shape":"TimeZone", "documentation":"

A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

Refer to the Joda-Time API for a complete list of valid time zone names.

" }, "UseGeolocationForTimeZone":{ "shape":"UseGeolocationForTimeZone", "documentation":"

Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.

" }, "GeolocationFormat":{ "shape":"GeolocationFormat", "documentation":"

The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

- `LAT_LONG` - the latitude and longitude in decimal format (Example: 47.61_-122.33).

- `CC_POSTALCODE` (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

" }, "Tags":{ "shape":"Tags", "documentation":"

The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50.

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8.

- Maximum value length - 256 Unicode characters in UTF-8.

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the imported data, CSV or PARQUET. The default value is CSV.

" }, "ImportMode":{ "shape":"ImportMode", "documentation":"

Specifies whether the dataset import job is a `FULL` or `INCREMENTAL` import. A `FULL` dataset import replaces all of the existing data with the newly imported data. An `INCREMENTAL` import appends the imported data to the existing data.

" } } }, "CreateDatasetImportJobResponse":{ "type":"structure", "members":{ "DatasetImportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset import job.

" } } }, "CreateDatasetRequest":{ "type":"structure", "required":[ "DatasetName", "Domain", "DatasetType", "Schema" ], "members":{ "DatasetName":{ "shape":"Name", "documentation":"

A name for the dataset.

" }, "Domain":{ "shape":"Domain", "documentation":"

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 Importing datasets.

" }, "DatasetType":{ "shape":"DatasetType", "documentation":"

The dataset type. Valid values depend on the chosen `Domain`.

" }, "DataFrequency":{ "shape":"Frequency", "documentation":"

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:

- Minute - 1-59

- Hour - 1-23

- Day - 1-6

- Week - 1-4

- Month - 1-11

- Year - 1

Thus, if you want every other week forecasts, specify \"2W\". Or, if you want quarterly forecasts, you specify \"3M\".

" }, "Schema":{ "shape":"Schema", "documentation":"

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types.

" }, "EncryptionConfig":{ "shape":"EncryptionConfig", "documentation":"

An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" }, "Tags":{ "shape":"Tags", "documentation":"

The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50.

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8.

- Maximum value length - 256 Unicode characters in UTF-8.

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.

" } } }, "CreateDatasetResponse":{ "type":"structure", "members":{ "DatasetArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" } } }, "CreateExplainabilityExportRequest":{ "type":"structure", "required":[ "ExplainabilityExportName", "ExplainabilityArn", "Destination" ], "members":{ "ExplainabilityExportName":{ "shape":"Name", "documentation":"

A unique name for the Explainability export.

" }, "ExplainabilityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability to export.

" }, "Destination":{"shape":"DataDestination"}, "Tags":{ "shape":"Tags", "documentation":"

Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

- For each resource, each tag key must be unique and each tag key must have one value.

- Maximum number of tags per resource: 50.

- Maximum key length: 128 Unicode characters in UTF-8.

- Maximum value length: 256 Unicode characters in UTF-8.

- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

- Key prefixes cannot include any upper or lowercase combination of `aws:` or `AWS:`. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the exported data, CSV or PARQUET.

" } } }, "CreateExplainabilityExportResponse":{ "type":"structure", "members":{ "ExplainabilityExportArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the export.

" } } }, "CreateExplainabilityRequest":{ "type":"structure", "required":[ "ExplainabilityName", "ResourceArn", "ExplainabilityConfig" ], "members":{ "ExplainabilityName":{ "shape":"Name", "documentation":"

A unique name for the Explainability.

" }, "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

" }, "ExplainabilityConfig":{ "shape":"ExplainabilityConfig", "documentation":"

The configuration settings that define the granularity of time series and time points for the Explainability.

" }, "DataSource":{"shape":"DataSource"}, "Schema":{"shape":"Schema"}, "EnableVisualization":{ "shape":"Boolean", "documentation":"

Create an Explainability visualization that is viewable within the Amazon Web Services console.

" }, "StartDateTime":{ "shape":"LocalDateTime", "documentation":"

If `TimePointGranularity` is set to `SPECIFIC`, define the first point for the Explainability.

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

" }, "EndDateTime":{ "shape":"LocalDateTime", "documentation":"

If `TimePointGranularity` is set to `SPECIFIC`, define the last time point for the Explainability.

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

" }, "Tags":{ "shape":"Tags", "documentation":"

Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

- For each resource, each tag key must be unique and each tag key must have one value.

- Maximum number of tags per resource: 50.

- Maximum key length: 128 Unicode characters in UTF-8.

- Maximum value length: 256 Unicode characters in UTF-8.

- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

- Key prefixes cannot include any upper or lowercase combination of `aws:` or `AWS:`. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

" } } }, "CreateExplainabilityResponse":{ "type":"structure", "members":{ "ExplainabilityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability.

" } } }, "CreateForecastExportJobRequest":{ "type":"structure", "required":[ "ForecastExportJobName", "ForecastArn", "Destination" ], "members":{ "ForecastExportJobName":{ "shape":"Name", "documentation":"

The name for the forecast export job.

" }, "ForecastArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the forecast that you want to export.

" }, "Destination":{ "shape":"DataDestination", "documentation":"

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, `Destination` must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

" }, "Tags":{ "shape":"Tags", "documentation":"

The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50.

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8.

- Maximum value length - 256 Unicode characters in UTF-8.

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the exported data, CSV or PARQUET. The default value is CSV.

" } } }, "CreateForecastExportJobResponse":{ "type":"structure", "members":{ "ForecastExportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the export job.

" } } }, "CreateForecastRequest":{ "type":"structure", "required":[ "ForecastName", "PredictorArn" ], "members":{ "ForecastName":{ "shape":"Name", "documentation":"

A name for the forecast.

" }, "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

" }, "ForecastTypes":{ "shape":"ForecastTypes", "documentation":"

The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include `0.01 to 0.99` (increments of .01 only) and `mean`. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).

The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are `[\"0.1\", \"0.5\", \"0.9\"]`.

" }, "Tags":{ "shape":"Tags", "documentation":"

The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50.

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8.

- Maximum value length - 256 Unicode characters in UTF-8.

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.

" }, "TimeSeriesSelector":{ "shape":"TimeSeriesSelector", "documentation":"

Defines the set of time series that are used to create the forecasts in a `TimeSeriesIdentifiers` object.

The `TimeSeriesIdentifiers` object needs the following information:

- `DataSource`

- `Format`

- `Schema`

" } } }, "CreateForecastResponse":{ "type":"structure", "members":{ "ForecastArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the forecast.

" } } }, "CreateMonitorRequest":{ "type":"structure", "required":[ "MonitorName", "ResourceArn" ], "members":{ "MonitorName":{ "shape":"Name", "documentation":"

The name of the monitor resource.

" }, "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor to monitor.

" }, "Tags":{ "shape":"Tags", "documentation":"

A list of tags to apply to the monitor resource.

" } } }, "CreateMonitorResponse":{ "type":"structure", "members":{ "MonitorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the monitor resource.

" } } }, "CreatePredictorBacktestExportJobRequest":{ "type":"structure", "required":[ "PredictorBacktestExportJobName", "PredictorArn", "Destination" ], "members":{ "PredictorBacktestExportJobName":{ "shape":"Name", "documentation":"

The name for the backtest export job.

" }, "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor that you want to export.

" }, "Destination":{"shape":"DataDestination"}, "Tags":{ "shape":"Tags", "documentation":"

Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

- For each resource, each tag key must be unique and each tag key must have one value.

- Maximum number of tags per resource: 50.

- Maximum key length: 128 Unicode characters in UTF-8.

- Maximum value length: 256 Unicode characters in UTF-8.

- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

- Key prefixes cannot include any upper or lowercase combination of `aws:` or `AWS:`. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the exported data, CSV or PARQUET. The default value is CSV.

" } } }, "CreatePredictorBacktestExportJobResponse":{ "type":"structure", "members":{ "PredictorBacktestExportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor backtest export job that you want to export.

" } } }, "CreatePredictorRequest":{ "type":"structure", "required":[ "PredictorName", "ForecastHorizon", "InputDataConfig", "FeaturizationConfig" ], "members":{ "PredictorName":{ "shape":"Name", "documentation":"

A name for the predictor.

" }, "AlgorithmArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if `PerformAutoML` is not set to `true`.

Supported algorithms:

- `arn:aws:forecast:::algorithm/ARIMA`

- `arn:aws:forecast:::algorithm/CNN-QR`

- `arn:aws:forecast:::algorithm/Deep_AR_Plus`

- `arn:aws:forecast:::algorithm/ETS`

- `arn:aws:forecast:::algorithm/NPTS`

- `arn:aws:forecast:::algorithm/Prophet`

" }, "ForecastHorizon":{ "shape":"Integer", "documentation":"

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.

" }, "ForecastTypes":{ "shape":"ForecastTypes", "documentation":"

Specifies the forecast types used to train a predictor. You can specify up to five forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or higher. You can also specify the mean forecast with `mean`.

The default value is `[\"0.10\", \"0.50\", \"0.9\"]`.

" }, "PerformAutoML":{ "shape":"Boolean", "documentation":"

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.

" }, "AutoMLOverrideStrategy":{ "shape":"AutoMLOverrideStrategy", "documentation":"

The `LatencyOptimized` AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

Used to overide the default AutoML strategy, which is to optimize predictor accuracy. To apply an AutoML strategy that minimizes training time, use `LatencyOptimized`.

This parameter is only valid for predictors trained using AutoML.

" }, "PerformHPO":{ "shape":"Boolean", "documentation":"

Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as running a hyperparameter tuning job.

The default value is `false`. In this case, Amazon Forecast uses default hyperparameter values from the chosen algorithm.

To override the default values, set `PerformHPO` to `true` and, optionally, supply the HyperParameterTuningJobConfig object. The tuning job specifies a metric to optimize, which hyperparameters participate in tuning, and the valid range for each tunable hyperparameter. In this case, you are required to specify an algorithm and `PerformAutoML` must be false.

The following algorithms support HPO:

- DeepAR+

- CNN-QR

" }, "TrainingParameters":{ "shape":"TrainingParameters", "documentation":"

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":{ "shape":"EvaluationParameters", "documentation":"

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.

" }, "HPOConfig":{ "shape":"HyperParameterTuningJobConfig", "documentation":"

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":{ "shape":"InputDataConfig", "documentation":"

Describes the dataset group that contains the data to use to train the predictor.

" }, "FeaturizationConfig":{ "shape":"FeaturizationConfig", "documentation":"

The featurization configuration.

" }, "EncryptionConfig":{ "shape":"EncryptionConfig", "documentation":"

An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" }, "Tags":{ "shape":"Tags", "documentation":"

The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50.

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8.

- Maximum value length - 256 Unicode characters in UTF-8.

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.

" }, "OptimizationMetric":{ "shape":"OptimizationMetric", "documentation":"

The accuracy metric used to optimize the predictor.

" } } }, "CreatePredictorResponse":{ "type":"structure", "members":{ "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor.

" } } }, "CreateWhatIfAnalysisRequest":{ "type":"structure", "required":[ "WhatIfAnalysisName", "ForecastArn" ], "members":{ "WhatIfAnalysisName":{ "shape":"Name", "documentation":"

The name of the what-if analysis. Each name must be unique.

" }, "ForecastArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the baseline forecast.

" }, "TimeSeriesSelector":{ "shape":"TimeSeriesSelector", "documentation":"

Defines the set of time series that are used in the what-if analysis with a `TimeSeriesIdentifiers` object. What-if analyses are performed only for the time series in this object.

The `TimeSeriesIdentifiers` object needs the following information:

- `DataSource`

- `Format`

- `Schema`

" }, "Tags":{ "shape":"Tags", "documentation":"

A list of tags to apply to the what if forecast.

" } } }, "CreateWhatIfAnalysisResponse":{ "type":"structure", "members":{ "WhatIfAnalysisArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the what-if analysis.

" } } }, "CreateWhatIfForecastExportRequest":{ "type":"structure", "required":[ "WhatIfForecastExportName", "WhatIfForecastArns", "Destination" ], "members":{ "WhatIfForecastExportName":{ "shape":"Name", "documentation":"

The name of the what-if forecast to export.

" }, "WhatIfForecastArns":{ "shape":"WhatIfForecastArnListForExport", "documentation":"

The list of what-if forecast Amazon Resource Names (ARNs) to export.

" }, "Destination":{ "shape":"DataDestination", "documentation":"

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, `Destination` must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

" }, "Tags":{ "shape":"Tags", "documentation":"

A list of tags to apply to the what if forecast.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the exported data, CSV or PARQUET.

" } } }, "CreateWhatIfForecastExportResponse":{ "type":"structure", "members":{ "WhatIfForecastExportArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast.

" } } }, "CreateWhatIfForecastRequest":{ "type":"structure", "required":[ "WhatIfForecastName", "WhatIfAnalysisArn" ], "members":{ "WhatIfForecastName":{ "shape":"Name", "documentation":"

The name of the what-if forecast. Names must be unique within each what-if analysis.

" }, "WhatIfAnalysisArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the what-if analysis.

" }, "TimeSeriesTransformations":{ "shape":"TimeSeriesTransformations", "documentation":"

The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

" }, "TimeSeriesReplacementsDataSource":{ "shape":"TimeSeriesReplacementsDataSource", "documentation":"

The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

" }, "Tags":{ "shape":"Tags", "documentation":"

A list of tags to apply to the what if forecast.

" } } }, "CreateWhatIfForecastResponse":{ "type":"structure", "members":{ "WhatIfForecastArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast.

" } } }, "DataConfig":{ "type":"structure", "required":["DatasetGroupArn"], "members":{ "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The ARN of the dataset group used to train the predictor.

" }, "AttributeConfigs":{ "shape":"AttributeConfigs", "documentation":"

Aggregation and filling options for attributes in your dataset group.

" }, "AdditionalDatasets":{ "shape":"AdditionalDatasets", "documentation":"

Additional built-in datasets like Holidays and the Weather Index.

" } }, "documentation":"

The data configuration for your dataset group and any additional datasets.

" }, "DataDestination":{ "type":"structure", "required":["S3Config"], "members":{ "S3Config":{ "shape":"S3Config", "documentation":"

The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

" } }, "documentation":"

The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).

" }, "DataSource":{ "type":"structure", "required":["S3Config"], "members":{ "S3Config":{ "shape":"S3Config", "documentation":"

The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.

" } }, "documentation":"

The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.

" }, "DatasetGroupSummary":{ "type":"structure", "members":{ "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" }, "DatasetGroupName":{ "shape":"Name", "documentation":"

The name of the dataset group.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the dataset group was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

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.

" } }, "documentation":"

Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To get the complete set of properties, call the DescribeDatasetGroup operation, and provide the `DatasetGroupArn`.

" }, "DatasetGroups":{ "type":"list", "member":{"shape":"DatasetGroupSummary"} }, "DatasetImportJobSummary":{ "type":"structure", "members":{ "DatasetImportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset import job.

" }, "DatasetImportJobName":{ "shape":"Name", "documentation":"

The name of the dataset import job.

" }, "DataSource":{ "shape":"DataSource", "documentation":"

The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, `DataSource` includes an Key Management Service (KMS) key.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the dataset import job. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the dataset import job was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "ImportMode":{ "shape":"ImportMode", "documentation":"

The import mode of the dataset import job, FULL or INCREMENTAL.

" } }, "documentation":"

Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the DescribeDatasetImportJob operation, and provide the `DatasetImportJobArn`.

" }, "DatasetImportJobs":{ "type":"list", "member":{"shape":"DatasetImportJobSummary"} }, "DatasetSummary":{ "type":"structure", "members":{ "DatasetArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" }, "DatasetName":{ "shape":"Name", "documentation":"

The name of the dataset.

" }, "DatasetType":{ "shape":"DatasetType", "documentation":"

The dataset type.

" }, "Domain":{ "shape":"Domain", "documentation":"

The domain associated with the dataset.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the dataset was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

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.

" } }, "documentation":"

Provides a summary of the dataset properties used in the ListDatasets operation. To get the complete set of properties, call the DescribeDataset operation, and provide the `DatasetArn`.

" }, "DatasetType":{ "type":"string", "enum":[ "TARGET_TIME_SERIES", "RELATED_TIME_SERIES", "ITEM_METADATA" ] }, "Datasets":{ "type":"list", "member":{"shape":"DatasetSummary"} }, "DayOfMonth":{ "type":"integer", "max":28, "min":1 }, "DayOfWeek":{ "type":"string", "enum":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "DeleteDatasetGroupRequest":{ "type":"structure", "required":["DatasetGroupArn"], "members":{ "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset group to delete.

" } } }, "DeleteDatasetImportJobRequest":{ "type":"structure", "required":["DatasetImportJobArn"], "members":{ "DatasetImportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset import job to delete.

" } } }, "DeleteDatasetRequest":{ "type":"structure", "required":["DatasetArn"], "members":{ "DatasetArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset to delete.

" } } }, "DeleteExplainabilityExportRequest":{ "type":"structure", "required":["ExplainabilityExportArn"], "members":{ "ExplainabilityExportArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability export to delete.

" } } }, "DeleteExplainabilityRequest":{ "type":"structure", "required":["ExplainabilityArn"], "members":{ "ExplainabilityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability resource to delete.

" } } }, "DeleteForecastExportJobRequest":{ "type":"structure", "required":["ForecastExportJobArn"], "members":{ "ForecastExportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the forecast export job to delete.

" } } }, "DeleteForecastRequest":{ "type":"structure", "required":["ForecastArn"], "members":{ "ForecastArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the forecast to delete.

" } } }, "DeleteMonitorRequest":{ "type":"structure", "required":["MonitorArn"], "members":{ "MonitorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the monitor resource to delete.

" } } }, "DeletePredictorBacktestExportJobRequest":{ "type":"structure", "required":["PredictorBacktestExportJobArn"], "members":{ "PredictorBacktestExportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor backtest export job to delete.

" } } }, "DeletePredictorRequest":{ "type":"structure", "required":["PredictorArn"], "members":{ "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor to delete.

" } } }, "DeleteResourceTreeRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the parent resource to delete. All child resources of the parent resource will also be deleted.

" } } }, "DeleteWhatIfAnalysisRequest":{ "type":"structure", "required":["WhatIfAnalysisArn"], "members":{ "WhatIfAnalysisArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the what-if analysis that you want to delete.

" } } }, "DeleteWhatIfForecastExportRequest":{ "type":"structure", "required":["WhatIfForecastExportArn"], "members":{ "WhatIfForecastExportArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast export that you want to delete.

" } } }, "DeleteWhatIfForecastRequest":{ "type":"structure", "required":["WhatIfForecastArn"], "members":{ "WhatIfForecastArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.

" } } }, "DescribeAutoPredictorRequest":{ "type":"structure", "required":["PredictorArn"], "members":{ "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor.

" } } }, "DescribeAutoPredictorResponse":{ "type":"structure", "members":{ "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor

" }, "PredictorName":{ "shape":"Name", "documentation":"

The name of the predictor.

" }, "ForecastHorizon":{ "shape":"Integer", "documentation":"

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

" }, "ForecastTypes":{ "shape":"ForecastTypes", "documentation":"

The forecast types used during predictor training. Default value is [\"0.1\",\"0.5\",\"0.9\"].

" }, "ForecastFrequency":{ "shape":"Frequency", "documentation":"

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.

" }, "ForecastDimensions":{ "shape":"ForecastDimensions", "documentation":"

An array of dimension (field) names that specify the attributes used to group your time series.

" }, "DatasetImportJobArns":{ "shape":"ArnList", "documentation":"

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

" }, "DataConfig":{ "shape":"DataConfig", "documentation":"

The data configuration for your dataset group and any additional datasets.

" }, "EncryptionConfig":{"shape":"EncryptionConfig"}, "ReferencePredictorSummary":{ "shape":"ReferencePredictorSummary", "documentation":"

The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.

" }, "EstimatedTimeRemainingInMinutes":{ "shape":"Long", "documentation":"

The estimated time remaining in minutes for the predictor training job to complete.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the predictor. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" }, "Message":{ "shape":"Message", "documentation":"

In the event of an error, a message detailing the cause of the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The timestamp of the CreateAutoPredictor request.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "OptimizationMetric":{ "shape":"OptimizationMetric", "documentation":"

The accuracy metric used to optimize the predictor.

" }, "ExplainabilityInfo":{ "shape":"ExplainabilityInfo", "documentation":"

Provides the status and ARN of the Predictor Explainability.

" }, "MonitorInfo":{ "shape":"MonitorInfo", "documentation":"

A object with the Amazon Resource Name (ARN) and status of the monitor resource.

" }, "TimeAlignmentBoundary":{ "shape":"TimeAlignmentBoundary", "documentation":"

The time boundary Forecast uses when aggregating data.

" } } }, "DescribeDatasetGroupRequest":{ "type":"structure", "required":["DatasetGroupArn"], "members":{ "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" } } }, "DescribeDatasetGroupResponse":{ "type":"structure", "members":{ "DatasetGroupName":{ "shape":"Name", "documentation":"

The name of the dataset group.

" }, "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The ARN of the dataset group.

" }, "DatasetArns":{ "shape":"ArnList", "documentation":"

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

" }, "Domain":{ "shape":"Domain", "documentation":"

The domain associated with the dataset group.

" }, "Status":{ "shape":"Status", "documentation":"

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.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the dataset group was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

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.

" } } }, "DescribeDatasetImportJobRequest":{ "type":"structure", "required":["DatasetImportJobArn"], "members":{ "DatasetImportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset import job.

" } } }, "DescribeDatasetImportJobResponse":{ "type":"structure", "members":{ "DatasetImportJobName":{ "shape":"Name", "documentation":"

The name of the dataset import job.

" }, "DatasetImportJobArn":{ "shape":"Arn", "documentation":"

The ARN of the dataset import job.

" }, "DatasetArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

" }, "TimestampFormat":{ "shape":"TimestampFormat", "documentation":"

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

" }, "TimeZone":{ "shape":"TimeZone", "documentation":"

The single time zone applied to every item in the dataset

" }, "UseGeolocationForTimeZone":{ "shape":"UseGeolocationForTimeZone", "documentation":"

Whether `TimeZone` is automatically derived from the geolocation attribute.

" }, "GeolocationFormat":{ "shape":"GeolocationFormat", "documentation":"

The format of the geolocation attribute. Valid Values:`\"LAT_LONG\"` and `\"CC_POSTALCODE\"`.

" }, "DataSource":{ "shape":"DataSource", "documentation":"

The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, `DataSource` includes an Key Management Service (KMS) key.

" }, "EstimatedTimeRemainingInMinutes":{ "shape":"Long", "documentation":"

The estimated time remaining in minutes for the dataset import job to complete.

" }, "FieldStatistics":{ "shape":"FieldStatistics", "documentation":"

Statistical information about each field in the input data.

" }, "DataSize":{ "shape":"Double", "documentation":"

The size of the dataset in gigabytes (GB) after the import job has finished.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the dataset import job. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

" }, "Message":{ "shape":"Message", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the dataset import job was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the imported data, CSV or PARQUET.

" }, "ImportMode":{ "shape":"ImportMode", "documentation":"

The import mode of the dataset import job, FULL or INCREMENTAL.

" } } }, "DescribeDatasetRequest":{ "type":"structure", "required":["DatasetArn"], "members":{ "DatasetArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" } } }, "DescribeDatasetResponse":{ "type":"structure", "members":{ "DatasetArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" }, "DatasetName":{ "shape":"Name", "documentation":"

The name of the dataset.

" }, "Domain":{ "shape":"Domain", "documentation":"

The domain associated with the dataset.

" }, "DatasetType":{ "shape":"DatasetType", "documentation":"

The dataset type.

" }, "DataFrequency":{ "shape":"Frequency", "documentation":"

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":{ "shape":"Schema", "documentation":"

An array of `SchemaAttribute` objects that specify the dataset fields. Each `SchemaAttribute` specifies the name and data type of a field.

" }, "EncryptionConfig":{ "shape":"EncryptionConfig", "documentation":"

The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" }, "Status":{ "shape":"Status", "documentation":"

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.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the dataset was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

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.

" } } }, "DescribeExplainabilityExportRequest":{ "type":"structure", "required":["ExplainabilityExportArn"], "members":{ "ExplainabilityExportArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability export.

" } } }, "DescribeExplainabilityExportResponse":{ "type":"structure", "members":{ "ExplainabilityExportArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability export.

" }, "ExplainabilityExportName":{ "shape":"Name", "documentation":"

The name of the Explainability export.

" }, "ExplainabilityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability export.

" }, "Destination":{"shape":"DataDestination"}, "Message":{ "shape":"Message", "documentation":"

Information about any errors that occurred during the export.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the Explainability export. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the Explainability export was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the exported data, CSV or PARQUET.

" } } }, "DescribeExplainabilityRequest":{ "type":"structure", "required":["ExplainabilityArn"], "members":{ "ExplainabilityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explaianability to describe.

" } } }, "DescribeExplainabilityResponse":{ "type":"structure", "members":{ "ExplainabilityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability.

" }, "ExplainabilityName":{ "shape":"Name", "documentation":"

The name of the Explainability.

" }, "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.

" }, "ExplainabilityConfig":{ "shape":"ExplainabilityConfig", "documentation":"

The configuration settings that define the granularity of time series and time points for the Explainability.

" }, "EnableVisualization":{ "shape":"Boolean", "documentation":"

Whether the visualization was enabled for the Explainability resource.

" }, "DataSource":{"shape":"DataSource"}, "Schema":{"shape":"Schema"}, "StartDateTime":{ "shape":"LocalDateTime", "documentation":"

If `TimePointGranularity` is set to `SPECIFIC`, the first time point in the Explainability.

" }, "EndDateTime":{ "shape":"LocalDateTime", "documentation":"

If `TimePointGranularity` is set to `SPECIFIC`, the last time point in the Explainability.

" }, "EstimatedTimeRemainingInMinutes":{ "shape":"Long", "documentation":"

The estimated time remaining in minutes for the CreateExplainability job to complete.

" }, "Message":{ "shape":"Message", "documentation":"

If an error occurred, a message about the error.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the Explainability resource. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the Explainability resource was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } } }, "DescribeForecastExportJobRequest":{ "type":"structure", "required":["ForecastExportJobArn"], "members":{ "ForecastExportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the forecast export job.

" } } }, "DescribeForecastExportJobResponse":{ "type":"structure", "members":{ "ForecastExportJobArn":{ "shape":"Arn", "documentation":"

The ARN of the forecast export job.

" }, "ForecastExportJobName":{ "shape":"Name", "documentation":"

The name of the forecast export job.

" }, "ForecastArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the exported forecast.

" }, "Destination":{ "shape":"DataDestination", "documentation":"

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

" }, "Message":{ "shape":"Message", "documentation":"

If an error occurred, an informational message about the error.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the forecast export job. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `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.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the forecast export job was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the exported data, CSV or PARQUET.

" } } }, "DescribeForecastRequest":{ "type":"structure", "required":["ForecastArn"], "members":{ "ForecastArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the forecast.

" } } }, "DescribeForecastResponse":{ "type":"structure", "members":{ "ForecastArn":{ "shape":"Arn", "documentation":"

The forecast ARN as specified in the request.

" }, "ForecastName":{ "shape":"Name", "documentation":"

The name of the forecast.

" }, "ForecastTypes":{ "shape":"ForecastTypes", "documentation":"

The quantiles at which probabilistic forecasts were generated.

" }, "PredictorArn":{ "shape":"Arn", "documentation":"

The ARN of the predictor used to generate the forecast.

" }, "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The ARN of the dataset group that provided the data used to train the predictor.

" }, "EstimatedTimeRemainingInMinutes":{ "shape":"Long", "documentation":"

The estimated time remaining in minutes for the forecast job to complete.

" }, "Status":{ "shape":"String", "documentation":"

The status of the forecast. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

The `Status` of the forecast must be `ACTIVE` before you can query or export the forecast.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the forecast creation task was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "TimeSeriesSelector":{ "shape":"TimeSeriesSelector", "documentation":"

The time series to include in the forecast.

" } } }, "DescribeMonitorRequest":{ "type":"structure", "required":["MonitorArn"], "members":{ "MonitorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the monitor resource to describe.

" } } }, "DescribeMonitorResponse":{ "type":"structure", "members":{ "MonitorName":{ "shape":"Name", "documentation":"

The name of the monitor.

" }, "MonitorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the monitor resource described.

" }, "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the auto predictor being monitored.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the monitor resource.

" }, "LastEvaluationTime":{ "shape":"Timestamp", "documentation":"

The timestamp of the latest evaluation completed by the monitor.

" }, "LastEvaluationState":{ "shape":"EvaluationState", "documentation":"

The state of the monitor's latest evaluation.

" }, "Baseline":{ "shape":"Baseline", "documentation":"

Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.

" }, "Message":{ "shape":"Message", "documentation":"

An error message, if any, for the monitor.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the monitor resource was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The timestamp of the latest modification to the monitor.

" }, "EstimatedEvaluationTimeRemainingInMinutes":{ "shape":"Long", "documentation":"

The estimated number of minutes remaining before the monitor resource finishes its current evaluation.

" } } }, "DescribePredictorBacktestExportJobRequest":{ "type":"structure", "required":["PredictorBacktestExportJobArn"], "members":{ "PredictorBacktestExportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor backtest export job.

" } } }, "DescribePredictorBacktestExportJobResponse":{ "type":"structure", "members":{ "PredictorBacktestExportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor backtest export job.

" }, "PredictorBacktestExportJobName":{ "shape":"Name", "documentation":"

The name of the predictor backtest export job.

" }, "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor.

" }, "Destination":{"shape":"DataDestination"}, "Message":{ "shape":"Message", "documentation":"

Information about any errors that may have occurred during the backtest export.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the predictor backtest export job. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the predictor backtest export job was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the exported data, CSV or PARQUET.

" } } }, "DescribePredictorRequest":{ "type":"structure", "required":["PredictorArn"], "members":{ "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor that you want information about.

" } } }, "DescribePredictorResponse":{ "type":"structure", "members":{ "PredictorArn":{ "shape":"Name", "documentation":"

The ARN of the predictor.

" }, "PredictorName":{ "shape":"Name", "documentation":"

The name of the predictor.

" }, "AlgorithmArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the algorithm used for model training.

" }, "AutoMLAlgorithmArns":{ "shape":"ArnList", "documentation":"

When `PerformAutoML` is specified, the ARN of the chosen algorithm.

" }, "ForecastHorizon":{ "shape":"Integer", "documentation":"

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

" }, "ForecastTypes":{ "shape":"ForecastTypes", "documentation":"

The forecast types used during predictor training. Default value is `[\"0.1\",\"0.5\",\"0.9\"]`

" }, "PerformAutoML":{ "shape":"Boolean", "documentation":"

Whether the predictor is set to perform AutoML.

" }, "AutoMLOverrideStrategy":{ "shape":"AutoMLOverrideStrategy", "documentation":"

The `LatencyOptimized` AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

The AutoML strategy used to train the predictor. Unless `LatencyOptimized` is specified, the AutoML strategy optimizes predictor accuracy.

This parameter is only valid for predictors trained using AutoML.

" }, "PerformHPO":{ "shape":"Boolean", "documentation":"

Whether the predictor is set to perform hyperparameter optimization (HPO).

" }, "TrainingParameters":{ "shape":"TrainingParameters", "documentation":"

The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

" }, "EvaluationParameters":{ "shape":"EvaluationParameters", "documentation":"

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.

" }, "HPOConfig":{ "shape":"HyperParameterTuningJobConfig", "documentation":"

The hyperparameter override values for the algorithm.

" }, "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"

Describes the dataset group that contains the data to use to train the predictor.

" }, "FeaturizationConfig":{ "shape":"FeaturizationConfig", "documentation":"

The featurization configuration.

" }, "EncryptionConfig":{ "shape":"EncryptionConfig", "documentation":"

An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" }, "PredictorExecutionDetails":{ "shape":"PredictorExecutionDetails", "documentation":"

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.

" }, "EstimatedTimeRemainingInMinutes":{ "shape":"Long", "documentation":"

The estimated time remaining in minutes for the predictor training job to complete.

" }, "IsAutoPredictor":{ "shape":"Boolean", "documentation":"

Whether the predictor was created with CreateAutoPredictor.

" }, "DatasetImportJobArns":{ "shape":"ArnList", "documentation":"

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the predictor. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

The `Status` of the predictor must be `ACTIVE` before you can use the predictor to create a forecast.

" }, "Message":{ "shape":"Message", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the model training task was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "OptimizationMetric":{ "shape":"OptimizationMetric", "documentation":"

The accuracy metric used to optimize the predictor.

" } } }, "DescribeWhatIfAnalysisRequest":{ "type":"structure", "required":["WhatIfAnalysisArn"], "members":{ "WhatIfAnalysisArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.

" } } }, "DescribeWhatIfAnalysisResponse":{ "type":"structure", "members":{ "WhatIfAnalysisName":{ "shape":"Name", "documentation":"

The name of the what-if analysis.

" }, "WhatIfAnalysisArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the what-if analysis.

" }, "ForecastArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast.

" }, "EstimatedTimeRemainingInMinutes":{ "shape":"Long", "documentation":"

The approximate time remaining to complete the what-if analysis, in minutes.

" }, "Status":{ "shape":"String", "documentation":"

The status of the what-if analysis. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

The `Status` of the what-if analysis must be `ACTIVE` before you can access the analysis.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the what-if analysis was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "TimeSeriesSelector":{"shape":"TimeSeriesSelector"} } }, "DescribeWhatIfForecastExportRequest":{ "type":"structure", "required":["WhatIfForecastExportArn"], "members":{ "WhatIfForecastExportArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.

" } } }, "DescribeWhatIfForecastExportResponse":{ "type":"structure", "members":{ "WhatIfForecastExportArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast export.

" }, "WhatIfForecastExportName":{ "shape":"Name", "documentation":"

The name of the what-if forecast export.

" }, "WhatIfForecastArns":{ "shape":"LongArnList", "documentation":"

An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

" }, "Destination":{"shape":"DataDestination"}, "Message":{ "shape":"Message", "documentation":"

If an error occurred, an informational message about the error.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the what-if forecast. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

The `Status` of the what-if forecast export must be `ACTIVE` before you can access the forecast export.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the what-if forecast export was created.

" }, "EstimatedTimeRemainingInMinutes":{ "shape":"Long", "documentation":"

The approximate time remaining to complete the what-if forecast export, in minutes.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "Format":{ "shape":"Format", "documentation":"

The format of the exported data, CSV or PARQUET.

" } } }, "DescribeWhatIfForecastRequest":{ "type":"structure", "required":["WhatIfForecastArn"], "members":{ "WhatIfForecastArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.

" } } }, "DescribeWhatIfForecastResponse":{ "type":"structure", "members":{ "WhatIfForecastName":{ "shape":"Name", "documentation":"

The name of the what-if forecast.

" }, "WhatIfForecastArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast.

" }, "WhatIfAnalysisArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.

" }, "EstimatedTimeRemainingInMinutes":{ "shape":"Long", "documentation":"

The approximate time remaining to complete the what-if forecast, in minutes.

" }, "Status":{ "shape":"String", "documentation":"

The status of the what-if forecast. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

The `Status` of the what-if forecast must be `ACTIVE` before you can access the forecast.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the what-if forecast was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" }, "TimeSeriesTransformations":{ "shape":"TimeSeriesTransformations", "documentation":"

An array of `Action` and `TimeSeriesConditions` elements that describe what transformations were applied to which time series.

" }, "TimeSeriesReplacementsDataSource":{ "shape":"TimeSeriesReplacementsDataSource", "documentation":"

An array of `S3Config`, `Schema`, and `Format` elements that describe the replacement time series.

" }, "ForecastTypes":{ "shape":"ForecastTypes", "documentation":"

The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are `[\"0.1\", \"0.5\", \"0.9\"]`.

" } } }, "Detail":{ "type":"string", "max":256 }, "Domain":{ "type":"string", "enum":[ "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS" ] }, "Double":{"type":"double"}, "EncryptionConfig":{ "type":"structure", "required":[ "RoleArn", "KMSKeyArn" ], "members":{ "RoleArn":{ "shape":"Arn", "documentation":"

The ARN of the IAM role that Amazon Forecast can assume to access the KMS key.

Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an `InvalidInputException` error.

" }, "KMSKeyArn":{ "shape":"KMSKeyArn", "documentation":"

The Amazon Resource Name (ARN) of the KMS key.

" } }, "documentation":"

An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.

" }, "ErrorMessage":{"type":"string"}, "ErrorMetric":{ "type":"structure", "members":{ "ForecastType":{ "shape":"ForecastType", "documentation":"

The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.

" }, "WAPE":{ "shape":"Double", "documentation":"

The weighted absolute percentage error (WAPE).

" }, "RMSE":{ "shape":"Double", "documentation":"

The root-mean-square error (RMSE).

" }, "MASE":{ "shape":"Double", "documentation":"

The Mean Absolute Scaled Error (MASE)

" }, "MAPE":{ "shape":"Double", "documentation":"

The Mean Absolute Percentage Error (MAPE)

" } }, "documentation":"

Provides detailed error metrics to evaluate the performance of a predictor. This object is part of the Metrics object.

" }, "ErrorMetrics":{ "type":"list", "member":{"shape":"ErrorMetric"} }, "EvaluationParameters":{ "type":"structure", "members":{ "NumberOfBacktestWindows":{ "shape":"Integer", "documentation":"

The number of times to split the input data. The default is 1. Valid values are 1 through 5.

" }, "BackTestWindowOffset":{ "shape":"Integer", "documentation":"

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

" } }, "documentation":"

Parameters that define how to split a dataset into training data and testing data, and the number of iterations to perform. These parameters are specified in the predefined algorithms but you can override them in the CreatePredictor request.

" }, "EvaluationResult":{ "type":"structure", "members":{ "AlgorithmArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the algorithm that was evaluated.

" }, "TestWindows":{ "shape":"TestWindows", "documentation":"

The array of test windows used for evaluating the algorithm. The `NumberOfBacktestWindows` from the EvaluationParameters object determines the number of windows in the array.

" } }, "documentation":"

The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.

" }, "EvaluationState":{ "type":"string", "max":256 }, "EvaluationType":{ "type":"string", "enum":[ "SUMMARY", "COMPUTED" ] }, "Explainabilities":{ "type":"list", "member":{"shape":"ExplainabilitySummary"} }, "ExplainabilityConfig":{ "type":"structure", "required":[ "TimeSeriesGranularity", "TimePointGranularity" ], "members":{ "TimeSeriesGranularity":{ "shape":"TimeSeriesGranularity", "documentation":"

To create an Explainability for all time series in your datasets, use `ALL`. To create an Explainability for specific time series in your datasets, use `SPECIFIC`.

Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.

" }, "TimePointGranularity":{ "shape":"TimePointGranularity", "documentation":"

To create an Explainability for all time points in your forecast horizon, use `ALL`. To create an Explainability for specific time points in your forecast horizon, use `SPECIFIC`.

Specify time points with the `StartDateTime` and `EndDateTime` parameters within the CreateExplainability operation.

" } }, "documentation":"

The ExplainabilityConfig data type defines the number of time series and time points included in CreateExplainability.

If you provide a predictor ARN for `ResourceArn`, you must set both `TimePointGranularity` and `TimeSeriesGranularity` to “ALL”. When creating Predictor Explainability, Amazon Forecast considers all time series and time points.

If you provide a forecast ARN for `ResourceArn`, you can set `TimePointGranularity` and `TimeSeriesGranularity` to either “ALL” or “Specific”.

" }, "ExplainabilityExportSummary":{ "type":"structure", "members":{ "ExplainabilityExportArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability export.

" }, "ExplainabilityExportName":{ "shape":"Name", "documentation":"

The name of the Explainability export

" }, "Destination":{"shape":"DataDestination"}, "Status":{ "shape":"Status", "documentation":"

The status of the Explainability export. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

Information about any errors that may have occurred during the Explainability export.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the Explainability was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } }, "documentation":"

Provides a summary of the Explainability export properties used in the ListExplainabilityExports operation. To get a complete set of properties, call the DescribeExplainabilityExport operation, and provide the `ExplainabilityExportArn`.

" }, "ExplainabilityExports":{ "type":"list", "member":{"shape":"ExplainabilityExportSummary"} }, "ExplainabilityInfo":{ "type":"structure", "members":{ "ExplainabilityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the Explainability. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" } }, "documentation":"

Provides information about the Explainability resource.

" }, "ExplainabilitySummary":{ "type":"structure", "members":{ "ExplainabilityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Explainability.

" }, "ExplainabilityName":{ "shape":"Name", "documentation":"

The name of the Explainability.

" }, "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

" }, "ExplainabilityConfig":{ "shape":"ExplainabilityConfig", "documentation":"

The configuration settings that define the granularity of time series and time points for the Explainability.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the Explainability. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" }, "Message":{ "shape":"Message", "documentation":"

Information about any errors that may have occurred during the Explainability creation process.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the Explainability was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } }, "documentation":"

Provides a summary of the Explainability properties used in the ListExplainabilities operation. To get a complete set of properties, call the DescribeExplainability operation, and provide the listed `ExplainabilityArn`.

" }, "Featurization":{ "type":"structure", "required":["AttributeName"], "members":{ "AttributeName":{ "shape":"Name", "documentation":"

The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of the `TARGET_TIME_SERIES` and the `RELATED_TIME_SERIES` datasets. For example, for the `RETAIL` domain, the target is `demand`, and for the `CUSTOM` domain, the target is `target_value`. For more information, see howitworks-missing-values.

" }, "FeaturizationPipeline":{ "shape":"FeaturizationPipeline", "documentation":"

An array of one `FeaturizationMethod` object that specifies the feature transformation method.

" } }, "documentation":"

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.

Provides featurization (transformation) information for a dataset field. This object is part of the FeaturizationConfig object.

For example:

`{`

`\"AttributeName\": \"demand\",`

`FeaturizationPipeline [ {`

`\"FeaturizationMethodName\": \"filling\",`

`\"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}`

`} ]`

`}`

" }, "FeaturizationConfig":{ "type":"structure", "required":["ForecastFrequency"], "members":{ "ForecastFrequency":{ "shape":"Frequency", "documentation":"

The frequency of predictions in a forecast.

Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:

- Minute - 1-59

- Hour - 1-23

- Day - 1-6

- Week - 1-4

- Month - 1-11

- Year - 1

Thus, if you want every other week forecasts, specify \"2W\". Or, if you want quarterly forecasts, you specify \"3M\".

The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.

When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the TARGET_TIME_SERIES dataset frequency.

" }, "ForecastDimensions":{ "shape":"ForecastDimensions", "documentation":"

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.

" }, "Featurizations":{ "shape":"Featurizations", "documentation":"

An array of featurization (transformation) information for the fields of a dataset.

" } }, "documentation":"

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.

In a CreatePredictor operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization.

You define featurization using the `FeaturizationConfig` object. You specify an array of transformations, one for each field that you want to featurize. You then include the `FeaturizationConfig` object in your `CreatePredictor` request. Amazon Forecast applies the featurization to the `TARGET_TIME_SERIES` and `RELATED_TIME_SERIES` datasets before model training.

You can create multiple featurization configurations. For example, you might call the `CreatePredictor` operation twice by specifying different featurization configurations.

" }, "FeaturizationMethod":{ "type":"structure", "required":["FeaturizationMethodName"], "members":{ "FeaturizationMethodName":{ "shape":"FeaturizationMethodName", "documentation":"

The name of the method. The \"filling\" method is the only supported method.

" }, "FeaturizationMethodParameters":{ "shape":"FeaturizationMethodParameters", "documentation":"

The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.

The following list shows the parameters and their valid values for the \"filling\" featurization method for a Target Time Series dataset. Bold signifies the default value.

- `aggregation`: sum, `avg`, `first`, `min`, `max`

- `frontfill`: none

- `middlefill`: zero, `nan` (not a number), `value`, `median`, `mean`, `min`, `max`

- `backfill`: zero, `nan`, `value`, `median`, `mean`, `min`, `max`

The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):

- `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max`

- `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max`

- `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max`

To set a filling method to a specific value, set the fill parameter to `value` and define the value in a corresponding `_value` parameter. For example, to set backfilling to a value of 2, include the following: `\"backfill\": \"value\"` and `\"backfill_value\":\"2\"`.

" } }, "documentation":"

Provides information about the method that featurizes (transforms) a dataset field. The method is part of the `FeaturizationPipeline` of the Featurization object.

The following is an example of how you specify a `FeaturizationMethod` object.

`{`

`\"FeaturizationMethodName\": \"filling\",`

`\"FeaturizationMethodParameters\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\": \"zero\"}`

`}`

" }, "FeaturizationMethodName":{ "type":"string", "enum":["filling"] }, "FeaturizationMethodParameters":{ "type":"map", "key":{"shape":"ParameterKey"}, "value":{"shape":"ParameterValue"}, "max":20, "min":1 }, "FeaturizationPipeline":{ "type":"list", "member":{"shape":"FeaturizationMethod"}, "max":1, "min":1 }, "Featurizations":{ "type":"list", "member":{"shape":"Featurization"}, "max":50, "min":1 }, "FieldStatistics":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"Statistics"} }, "Filter":{ "type":"structure", "required":[ "Key", "Value", "Condition" ], "members":{ "Key":{ "shape":"String", "documentation":"

The name of the parameter to filter on.

" }, "Value":{ "shape":"Arn", "documentation":"

The value to match.

" }, "Condition":{ "shape":"FilterConditionString", "documentation":"

The condition to apply. To include the objects that match the statement, specify `IS`. To exclude matching objects, specify `IS_NOT`.

" } }, "documentation":"

Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.

" }, "FilterConditionString":{ "type":"string", "enum":[ "IS", "IS_NOT" ] }, "Filters":{ "type":"list", "member":{"shape":"Filter"} }, "ForecastDimensions":{ "type":"list", "member":{"shape":"Name"}, "max":10, "min":1 }, "ForecastExportJobSummary":{ "type":"structure", "members":{ "ForecastExportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the forecast export job.

" }, "ForecastExportJobName":{ "shape":"Name", "documentation":"

The name of the forecast export job.

" }, "Destination":{ "shape":"DataDestination", "documentation":"

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the forecast export job. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `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.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the forecast export job was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } }, "documentation":"

Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed `ForecastExportJobArn`.

" }, "ForecastExportJobs":{ "type":"list", "member":{"shape":"ForecastExportJobSummary"} }, "ForecastSummary":{ "type":"structure", "members":{ "ForecastArn":{ "shape":"Arn", "documentation":"

The ARN of the forecast.

" }, "ForecastName":{ "shape":"Name", "documentation":"

The name of the forecast.

" }, "PredictorArn":{ "shape":"String", "documentation":"

The ARN of the predictor used to generate the forecast.

" }, "CreatedUsingAutoPredictor":{ "shape":"Boolean", "documentation":"

Whether the Forecast was created from an AutoPredictor.

" }, "DatasetGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the forecast. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

The `Status` of the forecast must be `ACTIVE` before you can query or export the forecast.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the forecast creation task was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } }, "documentation":"

Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the `ForecastArn` that is listed in the summary.

" }, "ForecastType":{ "type":"string", "max":4, "min":2, "pattern":"(^0?\\.\\d\\d?$|^mean$)" }, "ForecastTypes":{ "type":"list", "member":{"shape":"ForecastType"}, "max":20, "min":1 }, "Forecasts":{ "type":"list", "member":{"shape":"ForecastSummary"} }, "Format":{ "type":"string", "max":7, "pattern":"^CSV|PARQUET$" }, "Frequency":{ "type":"string", "max":5, "min":1, "pattern":"^Y|M|W|D|H|30min|15min|10min|5min|1min$" }, "GeolocationFormat":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9_]+$" }, "GetAccuracyMetricsRequest":{ "type":"structure", "required":["PredictorArn"], "members":{ "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor to get metrics for.

" } } }, "GetAccuracyMetricsResponse":{ "type":"structure", "members":{ "PredictorEvaluationResults":{ "shape":"PredictorEvaluationResults", "documentation":"

An array of results from evaluating the predictor.

" }, "IsAutoPredictor":{ "shape":"Boolean", "documentation":"

Whether the predictor was created with CreateAutoPredictor.

" }, "AutoMLOverrideStrategy":{ "shape":"AutoMLOverrideStrategy", "documentation":"

The `LatencyOptimized` AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

The AutoML strategy used to train the predictor. Unless `LatencyOptimized` is specified, the AutoML strategy optimizes predictor accuracy.

This parameter is only valid for predictors trained using AutoML.

" }, "OptimizationMetric":{ "shape":"OptimizationMetric", "documentation":"

The accuracy metric used to optimize the predictor.

" } } }, "Hour":{ "type":"integer", "max":23, "min":0 }, "HyperParameterTuningJobConfig":{ "type":"structure", "members":{ "ParameterRanges":{ "shape":"ParameterRanges", "documentation":"

Specifies the ranges of valid values for the hyperparameters.

" } }, "documentation":"

Configuration information for a hyperparameter tuning job. You specify this object in the CreatePredictor request.

A hyperparameter is a parameter that governs the model training process. You set hyperparameters before training starts, unlike model parameters, which are determined during training. The values of the hyperparameters effect which values are chosen for the model parameters.

In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter values that optimize a specified metric. Forecast accomplishes this by running many training jobs over a range of hyperparameter values. The optimum set of values depends on the algorithm, the training data, and the specified metric objective.

" }, "ImportMode":{ "type":"string", "enum":[ "FULL", "INCREMENTAL" ] }, "InputDataConfig":{ "type":"structure", "required":["DatasetGroupArn"], "members":{ "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" }, "SupplementaryFeatures":{ "shape":"SupplementaryFeatures", "documentation":"

An array of supplementary features. The only supported feature is a holiday calendar.

" } }, "documentation":"

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see DataConfig.

The data used to train a predictor. The data includes a dataset group and any supplementary features. You specify this object in the CreatePredictor request.

" }, "Integer":{"type":"integer"}, "IntegerParameterRange":{ "type":"structure", "required":[ "Name", "MaxValue", "MinValue" ], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the hyperparameter to tune.

" }, "MaxValue":{ "shape":"Integer", "documentation":"

The maximum tunable value of the hyperparameter.

" }, "MinValue":{ "shape":"Integer", "documentation":"

The minimum tunable value of the hyperparameter.

" }, "ScalingType":{ "shape":"ScalingType", "documentation":"

The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

Auto

  Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

  Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

  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.

ReverseLogarithmic

  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:

" } }, "documentation":"

Specifies an integer hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

" }, "IntegerParameterRanges":{ "type":"list", "member":{"shape":"IntegerParameterRange"}, "max":20, "min":1 }, "InvalidInputException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

We can't process the request because it includes an invalid value or a value that exceeds the valid range.

", "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The token is not valid. Tokens expire after 24 hours.

", "exception":true }, "KMSKeyArn":{ "type":"string", "max":256, "pattern":"arn:aws:kms:.*:key/.*" }, "LimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The limit on the number of resources per account has been exceeded.

", "exception":true }, "ListDatasetGroupsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" } } }, "ListDatasetGroupsResponse":{ "type":"structure", "members":{ "DatasetGroups":{ "shape":"DatasetGroups", "documentation":"

An array of objects that summarize each dataset group's properties.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" } } }, "ListDatasetImportJobsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

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\" } ]`

" } } }, "ListDatasetImportJobsResponse":{ "type":"structure", "members":{ "DatasetImportJobs":{ "shape":"DatasetImportJobs", "documentation":"

An array of objects that summarize each dataset import job's properties.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" } } }, "ListDatasetsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" } } }, "ListDatasetsResponse":{ "type":"structure", "members":{ "Datasets":{ "shape":"Datasets", "documentation":"

An array of objects that summarize each dataset's properties.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" } } }, "ListExplainabilitiesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items returned in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

An array of filters. For each filter, provide a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

- `Condition` - The condition to apply. Valid values are `IS` and `IS_NOT`.

- `Key` - The name of the parameter to filter on. Valid values are `ResourceArn` and `Status`.

- `Value` - The value to match.

" } } }, "ListExplainabilitiesResponse":{ "type":"structure", "members":{ "Explainabilities":{ "shape":"Explainabilities", "documentation":"

An array of objects that summarize the properties of each Explainability resource.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.

" } } }, "ListExplainabilityExportsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

An array of filters. For each filter, provide a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

- `Condition` - The condition to apply. Valid values are `IS` and `IS_NOT`.

- `Key` - The name of the parameter to filter on. Valid values are `ResourceArn` and `Status`.

- `Value` - The value to match.

" } } }, "ListExplainabilityExportsResponse":{ "type":"structure", "members":{ "ExplainabilityExports":{ "shape":"ExplainabilityExports", "documentation":"

An array of objects that summarize the properties of each Explainability export.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.

" } } }, "ListForecastExportJobsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

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\" } ]`

" } } }, "ListForecastExportJobsResponse":{ "type":"structure", "members":{ "ForecastExportJobs":{ "shape":"ForecastExportJobs", "documentation":"

An array of objects that summarize each export job's properties.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" } } }, "ListForecastsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

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\" } ]`

" } } }, "ListForecastsResponse":{ "type":"structure", "members":{ "Forecasts":{ "shape":"Forecasts", "documentation":"

An array of objects that summarize each forecast's properties.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" } } }, "ListMonitorEvaluationsRequest":{ "type":"structure", "required":["MonitorArn"], "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of monitoring results to return.

" }, "MonitorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the monitor resource to get results from.

" }, "Filters":{ "shape":"Filters", "documentation":"

An array of filters. For each filter, provide a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

- `Condition` - The condition to apply. Valid values are `IS` and `IS_NOT`.

- `Key` - The name of the parameter to filter on. The only valid value is `EvaluationState`.

- `Value` - The value to match. Valid values are only `SUCCESS` or `FAILURE`.

For example, to list only successful monitor evaluations, you would specify:

`\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"EvaluationState\", \"Value\": \"SUCCESS\" } ]`

" } } }, "ListMonitorEvaluationsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" }, "PredictorMonitorEvaluations":{ "shape":"PredictorMonitorEvaluations", "documentation":"

The monitoring results and predictor events collected by the monitor resource during different windows of time.

For information about monitoring see Viewing Monitoring Results. For more information about retrieving monitoring results see Viewing Monitoring Results.

" } } }, "ListMonitorsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of monitors to include in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

An array of filters. For each filter, provide a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

- `Condition` - The condition to apply. Valid values are `IS` and `IS_NOT`.

- `Key` - The name of the parameter to filter on. The only valid value is `Status`.

- `Value` - The value to match.

For example, to list all monitors who's status is ACTIVE, you would specify:

`\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" } ]`

" } } }, "ListMonitorsResponse":{ "type":"structure", "members":{ "Monitors":{ "shape":"Monitors", "documentation":"

An array of objects that summarize each monitor's properties.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" } } }, "ListPredictorBacktestExportJobsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

An array of filters. For each filter, provide a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude the predictor backtest export jobs that match the statement from the list. The match statement consists of a key and a value.

Filter properties

- `Condition` - The condition to apply. Valid values are `IS` and `IS_NOT`. To include the predictor backtest export jobs that match the statement, specify `IS`. To exclude matching predictor backtest export jobs, specify `IS_NOT`.

- `Key` - The name of the parameter to filter on. Valid values are `PredictorArn` and `Status`.

- `Value` - The value to match.

" } } }, "ListPredictorBacktestExportJobsResponse":{ "type":"structure", "members":{ "PredictorBacktestExportJobs":{ "shape":"PredictorBacktestExportJobs", "documentation":"

An array of objects that summarize the properties of each predictor backtest export job.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.

" } } }, "ListPredictorsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

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\" } ]`

" } } }, "ListPredictorsResponse":{ "type":"structure", "members":{ "Predictors":{ "shape":"Predictors", "documentation":"

An array of objects that summarize each predictor's properties.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"Tags", "documentation":"

The tags for the resource.

" } } }, "ListWhatIfAnalysesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

An array of filters. For each filter, you provide a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude the what-if analysis jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

- `Condition` - The condition to apply. Valid values are `IS` and `IS_NOT`. To include the what-if analysis jobs that match the statement, specify `IS`. To exclude matching what-if analysis jobs, specify `IS_NOT`.

- `Key` - The name of the parameter to filter on. Valid values are `WhatIfAnalysisArn` and `Status`.

- `Value` - The value to match.

For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:

`\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"WhatIfAnalysisArn\", \"Value\": \"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf\" } ]`

" } } }, "ListWhatIfAnalysesResponse":{ "type":"structure", "members":{ "WhatIfAnalyses":{ "shape":"WhatIfAnalyses", "documentation":"

An array of `WhatIfAnalysisSummary` objects that describe the matched analyses.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" } } }, "ListWhatIfForecastExportsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

An array of filters. For each filter, you provide a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude the what-if forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

- `Condition` - The condition to apply. Valid values are `IS` and `IS_NOT`. To include the forecast export jobs that match the statement, specify `IS`. To exclude matching forecast export jobs, specify `IS_NOT`.

- `Key` - The name of the parameter to filter on. Valid values are `WhatIfForecastExportArn` and `Status`.

- `Value` - The value to match.

For example, to list all jobs that export a forecast named electricityWIFExport, specify the following filter:

`\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"WhatIfForecastExportArn\", \"Value\": \"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport\" } ]`

" } } }, "ListWhatIfForecastExportsResponse":{ "type":"structure", "members":{ "WhatIfForecastExports":{ "shape":"WhatIfForecastExports", "documentation":"

An array of `WhatIfForecastExports` objects that describe the matched forecast exports.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" } } }, "ListWhatIfForecastsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of items to return in the response.

" }, "Filters":{ "shape":"Filters", "documentation":"

An array of filters. For each filter, you provide a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude the what-if forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

- `Condition` - The condition to apply. Valid values are `IS` and `IS_NOT`. To include the forecast export jobs that match the statement, specify `IS`. To exclude matching forecast export jobs, specify `IS_NOT`.

- `Key` - The name of the parameter to filter on. Valid values are `WhatIfForecastArn` and `Status`.

- `Value` - The value to match.

For example, to list all jobs that export a forecast named electricityWhatIfForecast, specify the following filter:

`\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"WhatIfForecastArn\", \"Value\": \"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast\" } ]`

" } } }, "ListWhatIfForecastsResponse":{ "type":"structure", "members":{ "WhatIfForecasts":{ "shape":"WhatIfForecasts", "documentation":"

An array of `WhatIfForecasts` objects that describe the matched forecasts.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "LocalDateTime":{ "type":"string", "max":19, "pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$" }, "Long":{"type":"long"}, "LongArn":{ "type":"string", "max":300, "pattern":"arn:([a-z\\d-]+):forecast:.*:.*:.+" }, "LongArnList":{ "type":"list", "member":{"shape":"LongArn"} }, "MaxResults":{ "type":"integer", "max":100, "min":1 }, "Message":{"type":"string"}, "MetricName":{ "type":"string", "max":256 }, "MetricResult":{ "type":"structure", "members":{ "MetricName":{ "shape":"MetricName", "documentation":"

The name of the metric.

" }, "MetricValue":{ "shape":"Double", "documentation":"

The value for the metric.

" } }, "documentation":"

An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric's value in the Baseline to see how your predictor's performance is changing.

For more information about metrics generated by Forecast see Evaluating Predictor Accuracy

" }, "MetricResults":{ "type":"list", "member":{"shape":"MetricResult"} }, "Metrics":{ "type":"structure", "members":{ "RMSE":{ "shape":"Double", "documentation":"

The root-mean-square error (RMSE).

", "deprecated":true, "deprecatedMessage":"This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE" }, "WeightedQuantileLosses":{ "shape":"WeightedQuantileLosses", "documentation":"

An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.

" }, "ErrorMetrics":{ "shape":"ErrorMetrics", "documentation":"

Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error (WAPE).

" }, "AverageWeightedQuantileLoss":{ "shape":"Double", "documentation":"

The average value of all weighted quantile losses.

" } }, "documentation":"

Provides metrics that are used to evaluate the performance of a predictor. This object is part of the WindowSummary object.

" }, "MonitorConfig":{ "type":"structure", "required":["MonitorName"], "members":{ "MonitorName":{ "shape":"Name", "documentation":"

The name of the monitor resource.

" } }, "documentation":"

The configuration details for the predictor monitor.

" }, "MonitorDataSource":{ "type":"structure", "members":{ "DatasetImportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.

" }, "ForecastArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.

" }, "PredictorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor resource you are monitoring.

" } }, "documentation":"

The source of the data the monitor used during the evaluation.

" }, "MonitorInfo":{ "type":"structure", "members":{ "MonitorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the monitor resource.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the monitor. States include:

- `ACTIVE`

- `ACTIVE_STOPPING`, `ACTIVE_STOPPED`

- `UPDATE_IN_PROGRESS`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" } }, "documentation":"

Provides information about the monitor resource.

" }, "MonitorSummary":{ "type":"structure", "members":{ "MonitorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the monitor resource.

" }, "MonitorName":{ "shape":"Name", "documentation":"

The name of the monitor resource.

" }, "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor being monitored.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the monitor. States include:

- `ACTIVE`

- `ACTIVE_STOPPING`, `ACTIVE_STOPPED`

- `UPDATE_IN_PROGRESS`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the monitor resource was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the monitor resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `STOPPED` - When the resource stopped.

- `ACTIVE` or `CREATE_FAILED` - When the monitor creation finished or failed.

" } }, "documentation":"

Provides a summary of the monitor properties used in the ListMonitors operation. To get a complete set of properties, call the DescribeMonitor operation, and provide the listed `MonitorArn`.

" }, "Monitors":{ "type":"list", "member":{"shape":"MonitorSummary"} }, "Month":{ "type":"string", "enum":[ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "Name":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z][a-zA-Z0-9_]*" }, "NextToken":{ "type":"string", "max":3000, "min":1, "pattern":".+" }, "Operation":{ "type":"string", "enum":[ "ADD", "SUBTRACT", "MULTIPLY", "DIVIDE" ] }, "OptimizationMetric":{ "type":"string", "enum":[ "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE" ] }, "ParameterKey":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9\\-\\_\\.\\/\\[\\]\\,\\\\]+$" }, "ParameterRanges":{ "type":"structure", "members":{ "CategoricalParameterRanges":{ "shape":"CategoricalParameterRanges", "documentation":"

Specifies the tunable range for each categorical hyperparameter.

" }, "ContinuousParameterRanges":{ "shape":"ContinuousParameterRanges", "documentation":"

Specifies the tunable range for each continuous hyperparameter.

" }, "IntegerParameterRanges":{ "shape":"IntegerParameterRanges", "documentation":"

Specifies the tunable range for each integer hyperparameter.

" } }, "documentation":"

Specifies the categorical, continuous, and integer hyperparameters, and their ranges of tunable values. The range of tunable values determines which values that a hyperparameter tuning job can choose for the specified hyperparameter. This object is part of the HyperParameterTuningJobConfig object.

" }, "ParameterValue":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9\\-\\_\\.\\/\\[\\]\\,\\\"\\\\\\s]+$" }, "PredictorBacktestExportJobSummary":{ "type":"structure", "members":{ "PredictorBacktestExportJobArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the predictor backtest export job.

" }, "PredictorBacktestExportJobName":{ "shape":"Name", "documentation":"

The name of the predictor backtest export job.

" }, "Destination":{"shape":"DataDestination"}, "Status":{ "shape":"Status", "documentation":"

The status of the predictor backtest export job. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

Information about any errors that may have occurred during the backtest export.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the predictor backtest export job was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } }, "documentation":"

Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs operation. To get a complete set of properties, call the DescribePredictorBacktestExportJob operation, and provide the listed `PredictorBacktestExportJobArn`.

" }, "PredictorBacktestExportJobs":{ "type":"list", "member":{"shape":"PredictorBacktestExportJobSummary"} }, "PredictorBaseline":{ "type":"structure", "members":{ "BaselineMetrics":{ "shape":"BaselineMetrics", "documentation":"

The initial accuracy metrics for the predictor. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.

" } }, "documentation":"

Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.

" }, "PredictorEvaluationResults":{ "type":"list", "member":{"shape":"EvaluationResult"} }, "PredictorEvent":{ "type":"structure", "members":{ "Detail":{ "shape":"Detail", "documentation":"

The type of event. For example, `Retrain`. A retraining event denotes the timepoint when a predictor was retrained. Any monitor results from before the `Datetime` are from the previous predictor. Any new metrics are for the newly retrained predictor.

" }, "Datetime":{ "shape":"Timestamp", "documentation":"

The timestamp for when the event occurred.

" } }, "documentation":"

Provides details about a predictor event, such as a retraining.

" }, "PredictorExecution":{ "type":"structure", "members":{ "AlgorithmArn":{ "shape":"Arn", "documentation":"

The ARN of the algorithm used to test the predictor.

" }, "TestWindows":{ "shape":"TestWindowDetails", "documentation":"

An array of test windows used to evaluate the algorithm. The `NumberOfBacktestWindows` from the object determines the number of windows in the array.

" } }, "documentation":"

The algorithm used to perform a backtest and the status of those tests.

" }, "PredictorExecutionDetails":{ "type":"structure", "members":{ "PredictorExecutions":{ "shape":"PredictorExecutions", "documentation":"

An array of the backtests performed to evaluate the accuracy of the predictor against a particular algorithm. The `NumberOfBacktestWindows` from the object determines the number of windows in the array.

" } }, "documentation":"

Contains details on the backtests performed to evaluate the accuracy of the predictor. The tests are returned in descending order of accuracy, with the most accurate backtest appearing first. You specify the number of backtests to perform when you call the operation.

" }, "PredictorExecutions":{ "type":"list", "member":{"shape":"PredictorExecution"}, "max":5, "min":1 }, "PredictorMonitorEvaluation":{ "type":"structure", "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the resource to monitor.

" }, "MonitorArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the monitor resource.

" }, "EvaluationTime":{ "shape":"Timestamp", "documentation":"

The timestamp that indicates when the monitor evaluation was started.

" }, "EvaluationState":{ "shape":"EvaluationState", "documentation":"

The status of the monitor evaluation. The state can be `SUCCESS` or `FAILURE`.

" }, "WindowStartDatetime":{ "shape":"Timestamp", "documentation":"

The timestamp that indicates the start of the window that is used for monitor evaluation.

" }, "WindowEndDatetime":{ "shape":"Timestamp", "documentation":"

The timestamp that indicates the end of the window that is used for monitor evaluation.

" }, "PredictorEvent":{ "shape":"PredictorEvent", "documentation":"

Provides details about a predictor event, such as a retraining.

" }, "MonitorDataSource":{ "shape":"MonitorDataSource", "documentation":"

The source of the data the monitor resource used during the evaluation.

" }, "MetricResults":{ "shape":"MetricResults", "documentation":"

A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the Baseline to see how your predictor's performance is changing.

" }, "NumItemsEvaluated":{ "shape":"Long", "documentation":"

The number of items considered during the evaluation.

" }, "Message":{ "shape":"Message", "documentation":"

Information about any errors that may have occurred during the monitor evaluation.

" } }, "documentation":"

Describes the results of a monitor evaluation.

" }, "PredictorMonitorEvaluations":{ "type":"list", "member":{"shape":"PredictorMonitorEvaluation"} }, "PredictorSummary":{ "type":"structure", "members":{ "PredictorArn":{ "shape":"Arn", "documentation":"

The ARN of the predictor.

" }, "PredictorName":{ "shape":"Name", "documentation":"

The name of the predictor.

" }, "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

" }, "IsAutoPredictor":{ "shape":"Boolean", "documentation":"

Whether AutoPredictor was used to create the predictor.

" }, "ReferencePredictorSummary":{ "shape":"ReferencePredictorSummary", "documentation":"

A summary of the reference predictor used if the predictor was retrained or upgraded.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the predictor. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

The `Status` of the predictor must be `ACTIVE` before you can use the predictor to create a forecast.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the model training task was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } }, "documentation":"

Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed `PredictorArn`.

" }, "Predictors":{ "type":"list", "member":{"shape":"PredictorSummary"} }, "ReferencePredictorSummary":{ "type":"structure", "members":{ "Arn":{ "shape":"Arn", "documentation":"

The ARN of the reference predictor.

" }, "State":{ "shape":"State", "documentation":"

Whether the reference predictor is `Active` or `Deleted`.

" } }, "documentation":"

Provides a summary of the reference predictor used when retraining or upgrading a predictor.

" }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

There is already a resource with this name. Try again with a different name.

", "exception":true }, "ResourceInUseException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The specified resource is in use.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

", "exception":true }, "ResumeResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the monitor resource to resume.

" } } }, "S3Config":{ "type":"structure", "required":[ "Path", "RoleArn" ], "members":{ "Path":{ "shape":"S3Path", "documentation":"

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

" }, "RoleArn":{ "shape":"Arn", "documentation":"

The ARN of the 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 Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an `InvalidInputException` error.

" }, "KMSKeyArn":{ "shape":"KMSKeyArn", "documentation":"

The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.

" } }, "documentation":"

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.

" }, "S3Path":{ "type":"string", "max":4096, "min":7, "pattern":"^s3://[a-z0-9].+$" }, "ScalingType":{ "type":"string", "enum":[ "Auto", "Linear", "Logarithmic", "ReverseLogarithmic" ] }, "Schema":{ "type":"structure", "members":{ "Attributes":{ "shape":"SchemaAttributes", "documentation":"

An array of attributes specifying the name and type of each field in a dataset.

" } }, "documentation":"

Defines the fields of a dataset.

" }, "SchemaAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"Name", "documentation":"

The name of the dataset field.

" }, "AttributeType":{ "shape":"AttributeType", "documentation":"

The data type of the field.

For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

" } }, "documentation":"

An attribute of a schema, which defines a dataset field. A schema attribute is required for every field in a dataset. The Schema object contains an array of `SchemaAttribute` objects.

" }, "SchemaAttributes":{ "type":"list", "member":{"shape":"SchemaAttribute"}, "max":100, "min":1 }, "State":{ "type":"string", "enum":[ "Active", "Deleted" ] }, "Statistics":{ "type":"structure", "members":{ "Count":{ "shape":"Integer", "documentation":"

The number of values in the field. If the response value is -1, refer to `CountLong`.

" }, "CountDistinct":{ "shape":"Integer", "documentation":"

The number of distinct values in the field. If the response value is -1, refer to `CountDistinctLong`.

" }, "CountNull":{ "shape":"Integer", "documentation":"

The number of null values in the field. If the response value is -1, refer to `CountNullLong`.

" }, "CountNan":{ "shape":"Integer", "documentation":"

The number of NAN (not a number) values in the field. If the response value is -1, refer to `CountNanLong`.

" }, "Min":{ "shape":"String", "documentation":"

For a numeric field, the minimum value in the field.

" }, "Max":{ "shape":"String", "documentation":"

For a numeric field, the maximum value in the field.

" }, "Avg":{ "shape":"Double", "documentation":"

For a numeric field, the average value in the field.

" }, "Stddev":{ "shape":"Double", "documentation":"

For a numeric field, the standard deviation.

" }, "CountLong":{ "shape":"Long", "documentation":"

The number of values in the field. `CountLong` is used instead of `Count` if the value is greater than 2,147,483,647.

" }, "CountDistinctLong":{ "shape":"Long", "documentation":"

The number of distinct values in the field. `CountDistinctLong` is used instead of `CountDistinct` if the value is greater than 2,147,483,647.

" }, "CountNullLong":{ "shape":"Long", "documentation":"

The number of null values in the field. `CountNullLong` is used instead of `CountNull` if the value is greater than 2,147,483,647.

" }, "CountNanLong":{ "shape":"Long", "documentation":"

The number of NAN (not a number) values in the field. `CountNanLong` is used instead of `CountNan` if the value is greater than 2,147,483,647.

" } }, "documentation":"

Provides statistics for each data field imported into to an Amazon Forecast dataset with the CreateDatasetImportJob operation.

" }, "Status":{ "type":"string", "max":256 }, "StopResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are `DatasetImportJobArn`, `PredictorArn`, `PredictorBacktestExportJobArn`, `ForecastArn`, `ForecastExportJobArn`, `ExplainabilityArn`, and `ExplainabilityExportArn`.

" } } }, "String":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9\\_]+$" }, "SupplementaryFeature":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the feature. Valid values: `\"holiday\"` and `\"weather\"`.

" }, "Value":{ "shape":"Value", "documentation":"

Weather Index

To enable the Weather Index, set the value to `\"true\"`

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

- \"AL\" - ALBANIA

- \"AR\" - ARGENTINA

- \"AT\" - AUSTRIA

- \"AU\" - AUSTRALIA

- \"BA\" - BOSNIA HERZEGOVINA

- \"BE\" - BELGIUM

- \"BG\" - BULGARIA

- \"BO\" - BOLIVIA

- \"BR\" - BRAZIL

- \"BY\" - BELARUS

- \"CA\" - CANADA

- \"CL\" - CHILE

- \"CO\" - COLOMBIA

- \"CR\" - COSTA RICA

- \"HR\" - CROATIA

- \"CZ\" - CZECH REPUBLIC

- \"DK\" - DENMARK

- \"EC\" - ECUADOR

- \"EE\" - ESTONIA

- \"ET\" - ETHIOPIA

- \"FI\" - FINLAND

- \"FR\" - FRANCE

- \"DE\" - GERMANY

- \"GR\" - GREECE

- \"HU\" - HUNGARY

- \"IS\" - ICELAND

- \"IN\" - INDIA

- \"IE\" - IRELAND

- \"IT\" - ITALY

- \"JP\" - JAPAN

- \"KZ\" - KAZAKHSTAN

- \"KR\" - KOREA

- \"LV\" - LATVIA

- \"LI\" - LIECHTENSTEIN

- \"LT\" - LITHUANIA

- \"LU\" - LUXEMBOURG

- \"MK\" - MACEDONIA

- \"MT\" - MALTA

- \"MX\" - MEXICO

- \"MD\" - MOLDOVA

- \"ME\" - MONTENEGRO

- \"NL\" - NETHERLANDS

- \"NZ\" - NEW ZEALAND

- \"NI\" - NICARAGUA

- \"NG\" - NIGERIA

- \"NO\" - NORWAY

- \"PA\" - PANAMA

- \"PY\" - PARAGUAY

- \"PE\" - PERU

- \"PL\" - POLAND

- \"PT\" - PORTUGAL

- \"RO\" - ROMANIA

- \"RU\" - RUSSIA

- \"RS\" - SERBIA

- \"SK\" - SLOVAKIA

- \"SI\" - SLOVENIA

- \"ZA\" - SOUTH AFRICA

- \"ES\" - SPAIN

- \"SE\" - SWEDEN

- \"CH\" - SWITZERLAND

- \"UA\" - UKRAINE

- \"AE\" - UNITED ARAB EMIRATES

- \"US\" - UNITED STATES

- \"UK\" - UNITED KINGDOM

- \"UY\" - URUGUAY

- \"VE\" - VENEZUELA

" } }, "documentation":"

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AdditionalDataset.

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in featurizations.

Weather Index

The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.

Holidays

Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.

" }, "SupplementaryFeatures":{ "type":"list", "member":{"shape":"SupplementaryFeature"}, "max":2, "min":1 }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values.

" }, "Value":{ "shape":"TagValue", "documentation":"

The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor within a tag category (key).

" } }, "documentation":"

The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50.

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8.

- Maximum value length - 256 Unicode characters in UTF-8.

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", "sensitive":true }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.

" }, "Tags":{ "shape":"Tags", "documentation":"

The tags to add to the resource. A tag is an array of key-value pairs.

The following basic restrictions apply to tags:

- Maximum number of tags per resource - 50.

- For each resource, each tag key must be unique, and each tag key can have only one value.

- Maximum key length - 128 Unicode characters in UTF-8.

- Maximum value length - 256 Unicode characters in UTF-8.

- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

- Tag keys and values are case sensitive.

- Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", "sensitive":true }, "Tags":{ "type":"list", "member":{"shape":"Tag"}, "max":200, "min":0 }, "TestWindowDetails":{ "type":"list", "member":{"shape":"TestWindowSummary"} }, "TestWindowSummary":{ "type":"structure", "members":{ "TestWindowStart":{ "shape":"Timestamp", "documentation":"

The time at which the test began.

" }, "TestWindowEnd":{ "shape":"Timestamp", "documentation":"

The time at which the test ended.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the test. Possible status values are:

- `ACTIVE`

- `CREATE_IN_PROGRESS`

- `CREATE_FAILED`

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If the test failed, the reason why it failed.

" } }, "documentation":"

The status, start time, and end time of a backtest, as well as a failure reason if applicable.

" }, "TestWindows":{ "type":"list", "member":{"shape":"WindowSummary"} }, "TimeAlignmentBoundary":{ "type":"structure", "members":{ "Month":{ "shape":"Month", "documentation":"

The month to use for time alignment during aggregation. The month must be in uppercase.

" }, "DayOfMonth":{ "shape":"DayOfMonth", "documentation":"

The day of the month to use for time alignment during aggregation.

" }, "DayOfWeek":{ "shape":"DayOfWeek", "documentation":"

The day of week to use for time alignment during aggregation. The day must be in uppercase.

" }, "Hour":{ "shape":"Hour", "documentation":"

The hour of day to use for time alignment during aggregation.

" } }, "documentation":"

The time boundary Forecast uses to align and aggregate your data to match your forecast frequency. Provide the unit of time and the time boundary as a key value pair. If you don't provide a time boundary, Forecast uses a set of Default Time Boundaries.

For more information about aggregation, see Data Aggregation for Different Forecast Frequencies. For more information setting a custom time boundary, see Specifying a Time Boundary.

" }, "TimePointGranularity":{ "type":"string", "enum":[ "ALL", "SPECIFIC" ] }, "TimeSeriesCondition":{ "type":"structure", "required":[ "AttributeName", "AttributeValue", "Condition" ], "members":{ "AttributeName":{ "shape":"Name", "documentation":"

The item_id, dimension name, IM name, or timestamp that you are modifying.

" }, "AttributeValue":{ "shape":"AttributeValue", "documentation":"

The value that is applied for the chosen `Condition`.

" }, "Condition":{ "shape":"Condition", "documentation":"

The condition to apply. Valid values are `EQUALS`, `NOT_EQUALS`, `LESS_THAN` and `GREATER_THAN`.

" } }, "documentation":"

Creates a subset of items within an attribute that are modified. For example, you can use this operation to create a subset of items that cost $5 or less. To do this, you specify `\"AttributeName\": \"price\"`, `\"AttributeValue\": \"5\"`, and `\"Condition\": \"LESS_THAN\"`. Pair this operation with the Action operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define how the attribute is modified.

" }, "TimeSeriesConditions":{ "type":"list", "member":{"shape":"TimeSeriesCondition"}, "max":10, "min":0 }, "TimeSeriesGranularity":{ "type":"string", "enum":[ "ALL", "SPECIFIC" ] }, "TimeSeriesIdentifiers":{ "type":"structure", "members":{ "DataSource":{"shape":"DataSource"}, "Schema":{"shape":"Schema"}, "Format":{ "shape":"Format", "documentation":"

The format of the data, either CSV or PARQUET.

" } }, "documentation":"

Details about the import file that contains the time series for which you want to create forecasts.

" }, "TimeSeriesReplacementsDataSource":{ "type":"structure", "required":[ "S3Config", "Schema" ], "members":{ "S3Config":{"shape":"S3Config"}, "Schema":{"shape":"Schema"}, "Format":{ "shape":"Format", "documentation":"

The format of the replacement data, CSV or PARQUET.

" }, "TimestampFormat":{ "shape":"TimestampFormat", "documentation":"

The timestamp format of the replacement data.

" } }, "documentation":"

A replacement dataset is a modified version of the baseline related time series that contains only the values that you want to include in a what-if forecast. The replacement dataset must contain the forecast dimensions and item identifiers in the baseline related time series as well as at least 1 changed time series. This dataset is merged with the baseline related time series to create a transformed dataset that is used for the what-if forecast.

" }, "TimeSeriesSelector":{ "type":"structure", "members":{ "TimeSeriesIdentifiers":{ "shape":"TimeSeriesIdentifiers", "documentation":"

Details about the import file that contains the time series for which you want to create forecasts.

" } }, "documentation":"

Defines the set of time series that are used to create the forecasts in a `TimeSeriesIdentifiers` object.

The `TimeSeriesIdentifiers` object needs the following information:

- `DataSource`

- `Format`

- `Schema`

" }, "TimeSeriesTransformation":{ "type":"structure", "members":{ "Action":{ "shape":"Action", "documentation":"

An array of actions that define a time series and how it is transformed. These transformations create a new time series that is used for the what-if analysis.

" }, "TimeSeriesConditions":{ "shape":"TimeSeriesConditions", "documentation":"

An array of conditions that define which members of the related time series are transformed.

" } }, "documentation":"

A transformation function is a pair of operations that select and modify the rows in a related time series. You select the rows that you want with a condition operation and you modify the rows with a transformation operation. All conditions are joined with an AND operation, meaning that all conditions must be true for the transformation to be applied. Transformations are applied in the order that they are listed.

" }, "TimeSeriesTransformations":{ "type":"list", "member":{"shape":"TimeSeriesTransformation"}, "max":30, "min":0 }, "TimeZone":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9\\/\\+\\-\\_]+$" }, "Timestamp":{"type":"timestamp"}, "TimestampFormat":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9\\-\\:\\.\\,\\'\\s]+$" }, "TrainingParameters":{ "type":"map", "key":{"shape":"ParameterKey"}, "value":{"shape":"ParameterValue"}, "max":100, "min":0 }, "Transformations":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"Value"}, "max":20, "min":1 }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.

" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

The keys of the tags to be removed.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateDatasetGroupRequest":{ "type":"structure", "required":[ "DatasetGroupArn", "DatasetArns" ], "members":{ "DatasetGroupArn":{ "shape":"Arn", "documentation":"

The ARN of the dataset group.

" }, "DatasetArns":{ "shape":"ArnList", "documentation":"

An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset group.

" } } }, "UpdateDatasetGroupResponse":{ "type":"structure", "members":{ } }, "UseGeolocationForTimeZone":{"type":"boolean"}, "Value":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9\\_\\-]+$" }, "Values":{ "type":"list", "member":{"shape":"Value"}, "max":20, "min":1 }, "WeightedQuantileLoss":{ "type":"structure", "members":{ "Quantile":{ "shape":"Double", "documentation":"

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.

" }, "LossValue":{ "shape":"Double", "documentation":"

The difference between the predicted value and the actual value over the quantile, weighted (normalized) by dividing by the sum over all quantiles.

" } }, "documentation":"

The weighted loss value for a quantile. This object is part of the Metrics object.

" }, "WeightedQuantileLosses":{ "type":"list", "member":{"shape":"WeightedQuantileLoss"} }, "WhatIfAnalyses":{ "type":"list", "member":{"shape":"WhatIfAnalysisSummary"} }, "WhatIfAnalysisSummary":{ "type":"structure", "members":{ "WhatIfAnalysisArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the what-if analysis.

" }, "WhatIfAnalysisName":{ "shape":"Name", "documentation":"

The name of the what-if analysis.

" }, "ForecastArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the what-if analysis. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

The `Status` of the what-if analysis must be `ACTIVE` before you can access the analysis.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the what-if analysis was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } }, "documentation":"

Provides a summary of the what-if analysis properties used in the ListWhatIfAnalyses operation. To get the complete set of properties, call the DescribeWhatIfAnalysis operation, and provide the `WhatIfAnalysisArn` that is listed in the summary.

" }, "WhatIfForecastArnListForExport":{ "type":"list", "member":{"shape":"LongArn"}, "max":50, "min":1 }, "WhatIfForecastExportSummary":{ "type":"structure", "members":{ "WhatIfForecastExportArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast export.

" }, "WhatIfForecastArns":{ "shape":"WhatIfForecastArnListForExport", "documentation":"

An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

" }, "WhatIfForecastExportName":{ "shape":"Name", "documentation":"

The what-if forecast export name.

" }, "Destination":{ "shape":"DataDestination", "documentation":"

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the what-if forecast export. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

The `Status` of the what-if analysis must be `ACTIVE` before you can access the analysis.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the what-if forecast export was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } }, "documentation":"

Provides a summary of the what-if forecast export properties used in the ListWhatIfForecastExports operation. To get the complete set of properties, call the DescribeWhatIfForecastExport operation, and provide the `WhatIfForecastExportArn` that is listed in the summary.

" }, "WhatIfForecastExports":{ "type":"list", "member":{"shape":"WhatIfForecastExportSummary"} }, "WhatIfForecastSummary":{ "type":"structure", "members":{ "WhatIfForecastArn":{ "shape":"LongArn", "documentation":"

The Amazon Resource Name (ARN) of the what-if forecast.

" }, "WhatIfForecastName":{ "shape":"Name", "documentation":"

The name of the what-if forecast.

" }, "WhatIfAnalysisArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the what-if forecast. States include:

- `ACTIVE`

- `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`

- `CREATE_STOPPING`, `CREATE_STOPPED`

- `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`

The `Status` of the what-if analysis must be `ACTIVE` before you can access the analysis.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

If an error occurred, an informational message about the error.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

When the what-if forecast was created.

" }, "LastModificationTime":{ "shape":"Timestamp", "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

- `CREATE_PENDING` - The `CreationTime`.

- `CREATE_IN_PROGRESS` - The current timestamp.

- `CREATE_STOPPING` - The current timestamp.

- `CREATE_STOPPED` - When the job stopped.

- `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.

" } }, "documentation":"

Provides a summary of the what-if forecast properties used in the ListWhatIfForecasts operation. To get the complete set of properties, call the DescribeWhatIfForecast operation, and provide the `WhatIfForecastArn` that is listed in the summary.

" }, "WhatIfForecasts":{ "type":"list", "member":{"shape":"WhatIfForecastSummary"} }, "WindowSummary":{ "type":"structure", "members":{ "TestWindowStart":{ "shape":"Timestamp", "documentation":"

The timestamp that defines the start of the window.

" }, "TestWindowEnd":{ "shape":"Timestamp", "documentation":"

The timestamp that defines the end of the window.

" }, "ItemCount":{ "shape":"Integer", "documentation":"

The number of data points within the window.

" }, "EvaluationType":{ "shape":"EvaluationType", "documentation":"

The type of evaluation.

- `SUMMARY` - The average metrics across all windows.

- `COMPUTED` - The metrics for the specified window.

" }, "Metrics":{ "shape":"Metrics", "documentation":"

Provides metrics used to evaluate the performance of a predictor.

" } }, "documentation":"

The metrics for a time range within the evaluation portion of a dataset. This object is part of the EvaluationResult object.

The `TestWindowStart` and `TestWindowEnd` parameters are determined by the `BackTestWindowOffset` parameter of the EvaluationParameters object.

" } }, "documentation":"

Provides APIs for creating and managing Amazon Forecast resources.

" }