Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) # Amazon Forecast Service The following actions are supported by Amazon Forecast Service: + [CreateAutoPredictor](API_CreateAutoPredictor.md) + [CreateDataset](API_CreateDataset.md) + [CreateDatasetGroup](API_CreateDatasetGroup.md) + [CreateDatasetImportJob](API_CreateDatasetImportJob.md) + [CreateExplainability](API_CreateExplainability.md) + [CreateExplainabilityExport](API_CreateExplainabilityExport.md) + [CreateForecast](API_CreateForecast.md) + [CreateForecastExportJob](API_CreateForecastExportJob.md) + [CreateMonitor](API_CreateMonitor.md) + [CreatePredictor](API_CreatePredictor.md) + [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) + [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) + [CreateWhatIfForecast](API_CreateWhatIfForecast.md) + [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) + [DeleteDataset](API_DeleteDataset.md) + [DeleteDatasetGroup](API_DeleteDatasetGroup.md) + [DeleteDatasetImportJob](API_DeleteDatasetImportJob.md) + [DeleteExplainability](API_DeleteExplainability.md) + [DeleteExplainabilityExport](API_DeleteExplainabilityExport.md) + [DeleteForecast](API_DeleteForecast.md) + [DeleteForecastExportJob](API_DeleteForecastExportJob.md) + [DeleteMonitor](API_DeleteMonitor.md) + [DeletePredictor](API_DeletePredictor.md) + [DeletePredictorBacktestExportJob](API_DeletePredictorBacktestExportJob.md) + [DeleteResourceTree](API_DeleteResourceTree.md) + [DeleteWhatIfAnalysis](API_DeleteWhatIfAnalysis.md) + [DeleteWhatIfForecast](API_DeleteWhatIfForecast.md) + [DeleteWhatIfForecastExport](API_DeleteWhatIfForecastExport.md) + [DescribeAutoPredictor](API_DescribeAutoPredictor.md) + [DescribeDataset](API_DescribeDataset.md) + [DescribeDatasetGroup](API_DescribeDatasetGroup.md) + [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) + [DescribeExplainability](API_DescribeExplainability.md) + [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) + [DescribeForecast](API_DescribeForecast.md) + [DescribeForecastExportJob](API_DescribeForecastExportJob.md) + [DescribeMonitor](API_DescribeMonitor.md) + [DescribePredictor](API_DescribePredictor.md) + [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) + [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) + [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) + [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) + [GetAccuracyMetrics](API_GetAccuracyMetrics.md) + [ListDatasetGroups](API_ListDatasetGroups.md) + [ListDatasetImportJobs](API_ListDatasetImportJobs.md) + [ListDatasets](API_ListDatasets.md) + [ListExplainabilities](API_ListExplainabilities.md) + [ListExplainabilityExports](API_ListExplainabilityExports.md) + [ListForecastExportJobs](API_ListForecastExportJobs.md) + [ListForecasts](API_ListForecasts.md) + [ListMonitorEvaluations](API_ListMonitorEvaluations.md) + [ListMonitors](API_ListMonitors.md) + [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md) + [ListPredictors](API_ListPredictors.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md) + [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) + [ListWhatIfForecasts](API_ListWhatIfForecasts.md) + [ResumeResource](API_ResumeResource.md) + [StopResource](API_StopResource.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateDatasetGroup](API_UpdateDatasetGroup.md) # CreateAutoPredictor Creates an Amazon Forecast predictor. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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](#API_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`. ## Request Syntax ``` { "DataConfig": { "AdditionalDatasets": [ { "Configuration": { "string" : [ "string" ] }, "Name": "string" } ], "AttributeConfigs": [ { "AttributeName": "string", "Transformations": { "string" : "string" } } ], "DatasetGroupArn": "string" }, "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "ExplainPredictor": boolean, "ForecastDimensions": [ "string" ], "ForecastFrequency": "string", "ForecastHorizon": number, "ForecastTypes": [ "string" ], "MonitorConfig": { "MonitorName": "string" }, "OptimizationMetric": "string", "PredictorName": "string", "ReferencePredictorArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeAlignmentBoundary": { "DayOfMonth": number, "DayOfWeek": "string", "Hour": number, "Month": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DataConfig](#API_CreateAutoPredictor_RequestSyntax) ** The data configuration for your dataset group and any additional datasets. Type: [DataConfig](API_DataConfig.md) object Required: No ** [EncryptionConfig](#API_CreateAutoPredictor_RequestSyntax) ** An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the [CreateDataset](API_CreateDataset.md) and [CreatePredictor](API_CreatePredictor.md) requests. Type: [EncryptionConfig](API_EncryptionConfig.md) object Required: No ** [ExplainPredictor](#API_CreateAutoPredictor_RequestSyntax) ** Create an Explainability resource for the predictor. Type: Boolean Required: No ** [ForecastDimensions](#API_CreateAutoPredictor_RequestSyntax) ** 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. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: No ** [ForecastFrequency](#API_CreateAutoPredictor_RequestSyntax) ** 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\$1TIME\$1SERIES dataset frequency. When a RELATED\$1TIME\$1SERIES dataset is provided, the frequency must be equal to the RELATED\$1TIME\$1SERIES dataset frequency. Type: String Length Constraints: Minimum length of 1. Maximum length of 5. Pattern: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` Required: No ** [ForecastHorizon](#API_CreateAutoPredictor_RequestSyntax) ** 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\$1TIME\$1SERIES 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\$1TIME\$1SERIES 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. Type: Integer Required: No ** [ForecastTypes](#API_CreateAutoPredictor_RequestSyntax) ** 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`. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 2. Maximum length of 4. Pattern: `(^0?\.\d\d?$|^mean$)` Required: No ** [MonitorConfig](#API_CreateAutoPredictor_RequestSyntax) ** 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](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html). Type: [MonitorConfig](API_MonitorConfig.md) object Required: No ** [OptimizationMetric](#API_CreateAutoPredictor_RequestSyntax) ** The accuracy metric used to optimize the predictor. Type: String Valid Values: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` Required: No ** [PredictorName](#API_CreateAutoPredictor_RequestSyntax) ** A unique name for the predictor Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [ReferencePredictorArn](#API_CreateAutoPredictor_RequestSyntax) ** 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. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: No ** [Tags](#API_CreateAutoPredictor_RequestSyntax) ** 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 \$1 - = . \$1 : / @. 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [TimeAlignmentBoundary](#API_CreateAutoPredictor_RequestSyntax) ** 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](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary). If you don't provide a time boundary, Forecast uses a set of [Default Time Boundaries](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries). Type: [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) object Required: No ## Response Syntax ``` { "PredictorArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PredictorArn](#API_CreateAutoPredictor_ResponseSyntax) ** The Amazon Resource Name (ARN) of the predictor. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateAutoPredictor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateAutoPredictor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateAutoPredictor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateAutoPredictor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateAutoPredictor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateAutoPredictor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateAutoPredictor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateAutoPredictor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateAutoPredictor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateAutoPredictor) # CreateDataset Creates an Amazon Forecast dataset. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html). To get a list of all your datasets, use the [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) operation. For example Forecast datasets, see the [Amazon Forecast Sample GitHub repository](https://github.com/aws-samples/amazon-forecast-samples). **Note** The `Status` of a dataset must be `ACTIVE` before you can import training data. Use the [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation to get the status. ## Request Syntax ``` { "DataFrequency": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DataFrequency](#API_CreateDataset_RequestSyntax) ** The frequency of data collection. This parameter is required for RELATED\$1TIME\$1SERIES 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". Type: String Length Constraints: Minimum length of 1. Maximum length of 5. Pattern: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` Required: No ** [DatasetName](#API_CreateDataset_RequestSyntax) ** A name for the dataset. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [DatasetType](#API_CreateDataset_RequestSyntax) ** The dataset type. Valid values depend on the chosen `Domain`. Type: String Valid Values: `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` Required: Yes ** [Domain](#API_CreateDataset_RequestSyntax) ** 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](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) 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](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html). Type: String Valid Values: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` Required: Yes ** [EncryptionConfig](#API_CreateDataset_RequestSyntax) ** An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. Type: [EncryptionConfig](API_EncryptionConfig.md) object Required: No ** [Schema](#API_CreateDataset_RequestSyntax) ** 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](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html). Type: [Schema](API_Schema.md) object Required: Yes ** [Tags](#API_CreateDataset_RequestSyntax) ** 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: \$1 - = . \$1 : / @. + 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 AWS 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "DatasetArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatasetArn](#API_CreateDataset_ResponseSyntax) ** The Amazon Resource Name (ARN) of the dataset. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateDataset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDataset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDataset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDataset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDataset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDataset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDataset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDataset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDataset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDataset) # CreateDatasetGroup 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](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see [Dataset groups](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html). To get a list of all your datasets groups, use the [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) operation. **Note** 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](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation. ## Request Syntax ``` { "DatasetArns": [ "string" ], "DatasetGroupName": "string", "Domain": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DatasetArns](#API_CreateDatasetGroup_RequestSyntax) ** An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: No ** [DatasetGroupName](#API_CreateDatasetGroup_RequestSyntax) ** A name for the dataset group. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [Domain](#API_CreateDatasetGroup_RequestSyntax) ** 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](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) 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](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html). Type: String Valid Values: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` Required: Yes ** [Tags](#API_CreateDatasetGroup_RequestSyntax) ** 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: \$1 - = . \$1 : / @. + 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 AWS 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "DatasetGroupArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the dataset group. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateDatasetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetGroup) # CreateDatasetImportJob 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. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) You must specify a [DataSource](https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html) object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see [Set up permissions](https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html). 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](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) operation. ## Request Syntax ``` { "DatasetArn": "string", "DatasetImportJobName": "string", "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "GeolocationFormat": "string", "ImportMode": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimestampFormat": "string", "TimeZone": "string", "UseGeolocationForTimeZone": boolean } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DatasetArn](#API_CreateDatasetImportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [DatasetImportJobName](#API_CreateDatasetImportJob_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [DataSource](#API_CreateDatasetImportJob_RequestSyntax) ** The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket. If encryption is used, `DataSource` must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the `EncryptionConfig` parameter of the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation. Type: [DataSource](API_DataSource.md) object Required: Yes ** [Format](#API_CreateDatasetImportJob_RequestSyntax) ** The format of the imported data, CSV or PARQUET. The default value is CSV. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` Required: No ** [GeolocationFormat](#API_CreateDatasetImportJob_RequestSyntax) ** 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\$1-122.33). + `CC_POSTALCODE` (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US\$198121). Type: String Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9_]+$` Required: No ** [ImportMode](#API_CreateDatasetImportJob_RequestSyntax) ** 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. Type: String Valid Values: `FULL | INCREMENTAL` Required: No ** [Tags](#API_CreateDatasetImportJob_RequestSyntax) ** 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: \$1 - = . \$1 : / @. + 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 AWS 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [TimestampFormat](#API_CreateDatasetImportJob_RequestSyntax) ** 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". Type: String Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9\-\:\.\,\'\s]+$` Required: No ** [TimeZone](#API_CreateDatasetImportJob_RequestSyntax) ** 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](http://joda-time.sourceforge.net/timezones.html) for a complete list of valid time zone names. Type: String Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9\/\+\-\_]+$` Required: No ** [UseGeolocationForTimeZone](#API_CreateDatasetImportJob_RequestSyntax) ** 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. Type: Boolean Required: No ## Response Syntax ``` { "DatasetImportJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the dataset import job. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateDatasetImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateDatasetImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateDatasetImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateDatasetImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateDatasetImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateDatasetImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateDatasetImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateDatasetImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateDatasetImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateDatasetImportJob) # CreateExplainability **Note** Explainability is only available for Forecasts and Predictors generated from an AutoPredictor ([CreateAutoPredictor](API_CreateAutoPredictor.md)) Creates an Amazon Forecast Explainability. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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. **Note** The ARIMA (AutoRegressive Integrated Moving Average), ETS (Exponential Smoothing State Space Model), and NPTS (Non-Parametric Time Series) models do not incorporate external time series data. Therefore, these models do not create an explainability report, even if you include the additional datasets. 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** **Note** You can only have one Explainability resource per predictor. If you already enabled `ExplainPredictor` in [CreateAutoPredictor](API_CreateAutoPredictor.md), 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** **Note** 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. ## Request Syntax ``` { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EnableVisualization": boolean, "EndDateTime": "string", "ExplainabilityConfig": { "TimePointGranularity": "string", "TimeSeriesGranularity": "string" }, "ExplainabilityName": "string", "ResourceArn": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "StartDateTime": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DataSource](#API_CreateExplainability_RequestSyntax) ** The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key. Type: [DataSource](API_DataSource.md) object Required: No ** [EnableVisualization](#API_CreateExplainability_RequestSyntax) ** Create an Explainability visualization that is viewable within the AWS console. Type: Boolean Required: No ** [EndDateTime](#API_CreateExplainability_RequestSyntax) ** 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) Type: String Length Constraints: Maximum length of 19. Pattern: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` Required: No ** [ExplainabilityConfig](#API_CreateExplainability_RequestSyntax) ** The configuration settings that define the granularity of time series and time points for the Explainability. Type: [ExplainabilityConfig](API_ExplainabilityConfig.md) object Required: Yes ** [ExplainabilityName](#API_CreateExplainability_RequestSyntax) ** A unique name for the Explainability. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [ResourceArn](#API_CreateExplainability_RequestSyntax) ** The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [Schema](#API_CreateExplainability_RequestSyntax) ** Defines the fields of a dataset. Type: [Schema](API_Schema.md) object Required: No ** [StartDateTime](#API_CreateExplainability_RequestSyntax) ** 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) Type: String Length Constraints: Maximum length of 19. Pattern: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` Required: No ** [Tags](#API_CreateExplainability_RequestSyntax) ** 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 \$1 - = . \$1 : / @. 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "ExplainabilityArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExplainabilityArn](#API_CreateExplainability_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Explainability. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateExplainability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainability) # CreateExplainabilityExport Exports an Explainability resource created by the [CreateExplainability](API_CreateExplainability.md) operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket. You must specify a [DataDestination](API_DataDestination.md) object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see [Set Up Permissions for Amazon Forecast](aws-forecast-iam-roles.md). **Note** 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](API_DescribeExplainabilityExport.md) operation. ## Request Syntax ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ExplainabilityArn": "string", "ExplainabilityExportName": "string", "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Destination](#API_CreateExplainabilityExport_RequestSyntax) ** The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional). Type: [DataDestination](API_DataDestination.md) object Required: Yes ** [ExplainabilityArn](#API_CreateExplainabilityExport_RequestSyntax) ** The Amazon Resource Name (ARN) of the Explainability to export. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [ExplainabilityExportName](#API_CreateExplainabilityExport_RequestSyntax) ** A unique name for the Explainability export. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [Format](#API_CreateExplainabilityExport_RequestSyntax) ** The format of the exported data, CSV or PARQUET. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` Required: No ** [Tags](#API_CreateExplainabilityExport_RequestSyntax) ** 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 \$1 - = . \$1 : / @. 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "ExplainabilityExportArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExplainabilityExportArn](#API_CreateExplainabilityExport_ResponseSyntax) ** The Amazon Resource Name (ARN) of the export. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateExplainabilityExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateExplainabilityExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateExplainabilityExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateExplainabilityExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateExplainabilityExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateExplainabilityExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateExplainabilityExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateExplainabilityExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateExplainabilityExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateExplainabilityExport) # CreateForecast 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 [QueryForecast](API_forecastquery_QueryForecast.md) operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the [CreateForecastExportJob](API_CreateForecastExportJob.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) The range of the forecast is determined by the `ForecastHorizon` value, which you specify in the [CreatePredictor](API_CreatePredictor.md) 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](API_ListForecasts.md) operation. **Note** 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 [Generating Forecasts](howitworks-forecast.md). **Note** The `Status` of the forecast must be `ACTIVE` before you can query or export the forecast. Use the [DescribeForecast](API_DescribeForecast.md) 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. ## Request Syntax ``` { "ForecastName": "string", "ForecastTypes": [ "string" ], "PredictorArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ForecastName](#API_CreateForecast_RequestSyntax) ** A name for the forecast. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [ForecastTypes](#API_CreateForecast_RequestSyntax) ** 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"]`. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 2. Maximum length of 4. Pattern: `(^0?\.\d\d?$|^mean$)` Required: No ** [PredictorArn](#API_CreateForecast_RequestSyntax) ** The Amazon Resource Name (ARN) of the predictor to use to generate the forecast. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [Tags](#API_CreateForecast_RequestSyntax) ** 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: \$1 - = . \$1 : / @. + 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 AWS 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [TimeSeriesSelector](#API_CreateForecast_RequestSyntax) ** 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` Type: [TimeSeriesSelector](API_TimeSeriesSelector.md) object Required: No ## Response Syntax ``` { "ForecastArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ForecastArn](#API_CreateForecast_ResponseSyntax) ** The Amazon Resource Name (ARN) of the forecast. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecast) # CreateForecastExportJob Exports a forecast created by the [CreateForecast](API_CreateForecast.md) operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions: \$1\$1 where the component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) You must specify a [DataDestination](API_DataDestination.md) object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see [Set Up Permissions for Amazon Forecast](aws-forecast-iam-roles.md). For more information, see [Generating Forecasts](howitworks-forecast.md). To get a list of all your forecast export jobs, use the [ListForecastExportJobs](API_ListForecastExportJobs.md) operation. **Note** 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](API_DescribeForecastExportJob.md) operation. ## Request Syntax ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastArn": "string", "ForecastExportJobName": "string", "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Destination](#API_CreateForecastExportJob_RequestSyntax) ** The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket. If encryption is used, `Destination` must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key. Type: [DataDestination](API_DataDestination.md) object Required: Yes ** [ForecastArn](#API_CreateForecastExportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the forecast that you want to export. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [ForecastExportJobName](#API_CreateForecastExportJob_RequestSyntax) ** The name for the forecast export job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [Format](#API_CreateForecastExportJob_RequestSyntax) ** The format of the exported data, CSV or PARQUET. The default value is CSV. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` Required: No ** [Tags](#API_CreateForecastExportJob_RequestSyntax) ** 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: \$1 - = . \$1 : / @. + 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 AWS 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "ForecastExportJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ForecastExportJobArn](#API_CreateForecastExportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the export job. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateForecastExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateForecastExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateForecastExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateForecastExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateForecastExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateForecastExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateForecastExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateForecastExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateForecastExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateForecastExportJob) # CreateMonitor 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](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html). **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "MonitorName": "string", "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [MonitorName](#API_CreateMonitor_RequestSyntax) ** The name of the monitor resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [ResourceArn](#API_CreateMonitor_RequestSyntax) ** The Amazon Resource Name (ARN) of the predictor to monitor. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [Tags](#API_CreateMonitor_RequestSyntax) ** A list of [tags](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) to apply to the monitor resource. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "MonitorArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MonitorArn](#API_CreateMonitor_ResponseSyntax) ** The Amazon Resource Name (ARN) of the monitor resource. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateMonitor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateMonitor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateMonitor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateMonitor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateMonitor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateMonitor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateMonitor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateMonitor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateMonitor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateMonitor) # CreatePredictor **Note** 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](API_CreateAutoPredictor.md). Creates an Amazon Forecast predictor. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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](API_CreateForecast.md) operation. To see the evaluation metrics, use the [GetAccuracyMetrics](API_GetAccuracyMetrics.md) 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](API_FeaturizationConfig.md). For RELATED\$1TIME\$1SERIES datasets, `CreatePredictor` verifies that the `DataFrequency` specified when the dataset was created matches the `ForecastFrequency`. TARGET\$1TIME\$1SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see [Importing Datasets](howitworks-datasets-groups.md). 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](API_EvaluationResult.md). 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](API_ListPredictors.md) operation. **Note** 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](API_DescribePredictor.md) operation. ## Request Syntax ``` { "AlgorithmArn": "string", "AutoMLOverrideStrategy": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EvaluationParameters": { "BackTestWindowOffset": number, "NumberOfBacktestWindows": number }, "FeaturizationConfig": { "Featurizations": [ { "AttributeName": "string", "FeaturizationPipeline": [ { "FeaturizationMethodName": "string", "FeaturizationMethodParameters": { "string" : "string" } } ] } ], "ForecastDimensions": [ "string" ], "ForecastFrequency": "string" }, "ForecastHorizon": number, "ForecastTypes": [ "string" ], "HPOConfig": { "ParameterRanges": { "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ] } }, "InputDataConfig": { "DatasetGroupArn": "string", "SupplementaryFeatures": [ { "Name": "string", "Value": "string" } ] }, "OptimizationMetric": "string", "PerformAutoML": boolean, "PerformHPO": boolean, "PredictorName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TrainingParameters": { "string" : "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AlgorithmArn](#API_CreatePredictor_RequestSyntax) ** 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` Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: No ** [AutoMLOverrideStrategy](#API_CreatePredictor_RequestSyntax) ** The `LatencyOptimized` AutoML override strategy is only available in private beta. Contact AWS 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. Type: String Valid Values: `LatencyOptimized | AccuracyOptimized` Required: No ** [EncryptionConfig](#API_CreatePredictor_RequestSyntax) ** An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. Type: [EncryptionConfig](API_EncryptionConfig.md) object Required: No ** [EvaluationParameters](#API_CreatePredictor_RequestSyntax) ** 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. Type: [EvaluationParameters](API_EvaluationParameters.md) object Required: No ** [FeaturizationConfig](#API_CreatePredictor_RequestSyntax) ** The featurization configuration. Type: [FeaturizationConfig](API_FeaturizationConfig.md) object Required: Yes ** [ForecastHorizon](#API_CreatePredictor_RequestSyntax) ** 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](API_CreateDataset.md) 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\$1TIME\$1SERIES dataset length. Type: Integer Required: Yes ** [ForecastTypes](#API_CreatePredictor_RequestSyntax) ** 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"]`. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 2. Maximum length of 4. Pattern: `(^0?\.\d\d?$|^mean$)` Required: No ** [HPOConfig](#API_CreatePredictor_RequestSyntax) ** 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 [Amazon Forecast Algorithms](aws-forecast-choosing-recipes.md). If you included the `HPOConfig` object, you must set `PerformHPO` to true. Type: [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) object Required: No ** [InputDataConfig](#API_CreatePredictor_RequestSyntax) ** Describes the dataset group that contains the data to use to train the predictor. Type: [InputDataConfig](API_InputDataConfig.md) object Required: Yes ** [OptimizationMetric](#API_CreatePredictor_RequestSyntax) ** The accuracy metric used to optimize the predictor. The default value is `AverageWeightedQuantileLoss`. Type: String Valid Values: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` Required: No ** [PerformAutoML](#API_CreatePredictor_RequestSyntax) ** 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. Type: Boolean Required: No ** [PerformHPO](#API_CreatePredictor_RequestSyntax) ** 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](API_HyperParameterTuningJobConfig.md) 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\$1 + CNN-QR Type: Boolean Required: No ** [PredictorName](#API_CreatePredictor_RequestSyntax) ** A name for the predictor. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [Tags](#API_CreatePredictor_RequestSyntax) ** 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: \$1 - = . \$1 : / @. + 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 AWS 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [TrainingParameters](#API_CreatePredictor_RequestSyntax) ** 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 [Amazon Forecast Algorithms](aws-forecast-choosing-recipes.md). Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Maximum length of 256. Key Pattern: `^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$` Value Length Constraints: Maximum length of 256. Value Pattern: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` Required: No ## Response Syntax ``` { "PredictorArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PredictorArn](#API_CreatePredictor_ResponseSyntax) ** The Amazon Resource Name (ARN) of the predictor. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreatePredictor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictor) # CreatePredictorBacktestExportJob Exports backtest forecasts and accuracy metrics generated by the [CreateAutoPredictor](API_CreateAutoPredictor.md) or [CreatePredictor](API_CreatePredictor.md) operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) The export file names will match the following conventions: `__.csv` The component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ). You must specify a [DataDestination](API_DataDestination.md) object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see [Set Up Permissions for Amazon Forecast](aws-forecast-iam-roles.md). **Note** 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](API_DescribePredictorBacktestExportJob.md) operation. ## Request Syntax ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "PredictorArn": "string", "PredictorBacktestExportJobName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Destination](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional). Type: [DataDestination](API_DataDestination.md) object Required: Yes ** [Format](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** The format of the exported data, CSV or PARQUET. The default value is CSV. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` Required: No ** [PredictorArn](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the predictor that you want to export. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [PredictorBacktestExportJobName](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** The name for the backtest export job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ** [Tags](#API_CreatePredictorBacktestExportJob_RequestSyntax) ** 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 \$1 - = . \$1 : / @. 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "PredictorBacktestExportJobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PredictorBacktestExportJobArn](#API_CreatePredictorBacktestExportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the predictor backtest export job that you want to export. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictorBacktestExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictorBacktestExportJob) # CreateWhatIfAnalysis 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. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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](API_TimeSeriesSelector.md) object defines the items that you want in the what-if analysis. **Note** Your data must be in comma-separated values (CSV) format to create a what-if analysis. ## Request Syntax ``` { "ForecastArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } }, "WhatIfAnalysisName": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ForecastArn](#API_CreateWhatIfAnalysis_RequestSyntax) ** The Amazon Resource Name (ARN) of the baseline forecast. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [Tags](#API_CreateWhatIfAnalysis_RequestSyntax) ** A list of [tags](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) to apply to the what if forecast. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [TimeSeriesSelector](#API_CreateWhatIfAnalysis_RequestSyntax) ** 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` Type: [TimeSeriesSelector](API_TimeSeriesSelector.md) object Required: No ** [WhatIfAnalysisName](#API_CreateWhatIfAnalysis_RequestSyntax) ** The name of the what-if analysis. Each name must be unique. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ## Response Syntax ``` { "WhatIfAnalysisArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [WhatIfAnalysisArn](#API_CreateWhatIfAnalysis_ResponseSyntax) ** The Amazon Resource Name (ARN) of the what-if analysis. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfAnalysis) # CreateWhatIfForecast 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. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "Tags": [ { "Key": "string", "Value": "string" } ], "TimeSeriesReplacementsDataSource": { "Format": "string", "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" }, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "TimestampFormat": "string" }, "TimeSeriesTransformations": [ { "Action": { "AttributeName": "string", "Operation": "string", "Value": number }, "TimeSeriesConditions": [ { "AttributeName": "string", "AttributeValue": "string", "Condition": "string" } ] } ], "WhatIfAnalysisArn": "string", "WhatIfForecastName": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Tags](#API_CreateWhatIfForecast_RequestSyntax) ** A list of [tags](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) to apply to the what if forecast. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [TimeSeriesReplacementsDataSource](#API_CreateWhatIfForecast_RequestSyntax) ** 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\$1id or workforce\$1type), 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. This file must be in CSV format. Timestamps and item\$1ids not included in this dataset are not included in the what-if analysis. Type: [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) object Required: No ** [TimeSeriesTransformations](#API_CreateWhatIfForecast_RequestSyntax) ** 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. Type: Array of [TimeSeriesTransformation](API_TimeSeriesTransformation.md) objects Array Members: Minimum number of 0 items. Maximum number of 30 items. Required: No ** [WhatIfAnalysisArn](#API_CreateWhatIfForecast_RequestSyntax) ** The Amazon Resource Name (ARN) of the what-if analysis. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [WhatIfForecastName](#API_CreateWhatIfForecast_RequestSyntax) ** The name of the what-if forecast. Names must be unique within each what-if analysis. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ## Response Syntax ``` { "WhatIfForecastArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [WhatIfForecastArn](#API_CreateWhatIfForecast_ResponseSyntax) ** The Amazon Resource Name (ARN) of the what-if forecast. Type: String Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateWhatIfForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecast) # CreateWhatIfForecastExport Exports a forecast created by the [CreateWhatIfForecast](API_CreateWhatIfForecast.md) operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions: `≈__` The component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) You must specify a [DataDestination](API_DataDestination.md) object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see [Set Up Permissions for Amazon Forecast](aws-forecast-iam-roles.md). For more information, see [Generating Forecasts](howitworks-forecast.md). To get a list of all your what-if forecast export jobs, use the [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) operation. **Note** 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](API_DescribeWhatIfForecastExport.md) operation. ## Request Syntax ``` { "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportName": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Destination](#API_CreateWhatIfForecastExport_RequestSyntax) ** The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket. If encryption is used, `Destination` must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key. Type: [DataDestination](API_DataDestination.md) object Required: Yes ** [Format](#API_CreateWhatIfForecastExport_RequestSyntax) ** The format of the exported data, CSV or PARQUET. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` Required: No ** [Tags](#API_CreateWhatIfForecastExport_RequestSyntax) ** A list of [tags](https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) to apply to the what if forecast. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [WhatIfForecastArns](#API_CreateWhatIfForecastExport_RequestSyntax) ** The list of what-if forecast Amazon Resource Names (ARNs) to export. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [WhatIfForecastExportName](#API_CreateWhatIfForecastExport_RequestSyntax) ** The name of the what-if forecast to export. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` Required: Yes ## Response Syntax ``` { "WhatIfForecastExportArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [WhatIfForecastExportArn](#API_CreateWhatIfForecastExport_ResponseSyntax) ** The Amazon Resource Name (ARN) of the what-if forecast. Type: String Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** There is already a resource with this name. Try again with a different name. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreateWhatIfForecastExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreateWhatIfForecastExport) # DeleteDataset Deletes an Amazon Forecast dataset that was created using the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation. You can only delete datasets that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status use the [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) **Note** Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation, omitting the deleted dataset's ARN. ## Request Syntax ``` { "DatasetArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DatasetArn](#API_DeleteDataset_RequestSyntax) ** The Amazon Resource Name (ARN) of the dataset to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteDataset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDataset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDataset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDataset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDataset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDataset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDataset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDataset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDataset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDataset) # DeleteDatasetGroup Deletes a dataset group created using the [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) 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](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) This operation deletes only the dataset group, not the datasets in the group. ## Request Syntax ``` { "DatasetGroupArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DatasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) ** The Amazon Resource Name (ARN) of the dataset group to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteDatasetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetGroup) # DeleteDatasetImportJob Deletes a dataset import job created using the [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation. You can delete only dataset import jobs that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the [DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "DatasetImportJobArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DatasetImportJobArn](#API_DeleteDatasetImportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the dataset import job to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteDatasetImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteDatasetImportJob) # DeleteExplainability Deletes an Explainability resource. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) You can delete only predictor that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the [DescribeExplainability](API_DescribeExplainability.md) operation. ## Request Syntax ``` { "ExplainabilityArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ExplainabilityArn](#API_DeleteExplainability_RequestSyntax) ** The Amazon Resource Name (ARN) of the Explainability resource to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteExplainability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainability) # DeleteExplainabilityExport Deletes an Explainability export. ## Request Syntax ``` { "ExplainabilityExportArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ExplainabilityExportArn](#API_DeleteExplainabilityExport_RequestSyntax) ** The Amazon Resource Name (ARN) of the Explainability export to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteExplainabilityExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteExplainabilityExport) # DeleteForecast Deletes a forecast created using the [CreateForecast](API_CreateForecast.md) operation. You can delete only forecasts that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the [DescribeForecast](API_DescribeForecast.md) operation. You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "ForecastArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ForecastArn](#API_DeleteForecast_RequestSyntax) ** The Amazon Resource Name (ARN) of the forecast to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecast) # DeleteForecastExportJob Deletes a forecast export job created using the [CreateForecastExportJob](API_CreateForecastExportJob.md) operation. You can delete only export jobs that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the [DescribeForecastExportJob](API_DescribeForecastExportJob.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "ForecastExportJobArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ForecastExportJobArn](#API_DeleteForecastExportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the forecast export job to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteForecastExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteForecastExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteForecastExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteForecastExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteForecastExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteForecastExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteForecastExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteForecastExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteForecastExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteForecastExportJob) # DeleteMonitor Deletes a monitor resource. You can only delete a monitor resource with a status of `ACTIVE`, `ACTIVE_STOPPED`, `CREATE_FAILED`, or `CREATE_STOPPED`. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "MonitorArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [MonitorArn](#API_DeleteMonitor_RequestSyntax) ** The Amazon Resource Name (ARN) of the monitor resource to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteMonitor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteMonitor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteMonitor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteMonitor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteMonitor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteMonitor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteMonitor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteMonitor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteMonitor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteMonitor) # DeletePredictor Deletes a predictor created using the [DescribePredictor](API_DescribePredictor.md) or [CreatePredictor](API_CreatePredictor.md) operations. You can delete only predictor that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the [DescribePredictor](API_DescribePredictor.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "PredictorArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PredictorArn](#API_DeletePredictor_RequestSyntax) ** The Amazon Resource Name (ARN) of the predictor to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeletePredictor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictor) # DeletePredictorBacktestExportJob Deletes a predictor backtest export job. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "PredictorBacktestExportJobArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PredictorBacktestExportJobArn](#API_DeletePredictorBacktestExportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the predictor backtest export job to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeletePredictorBacktestExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeletePredictorBacktestExportJob) # DeleteResourceTree Deletes an entire resource tree. This operation will delete the parent resource and its child resources. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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 **Note** `DeleteResourceTree` will only delete Amazon Forecast resources, and will not delete datasets or exported files stored in Amazon S3. ## Request Syntax ``` { "ResourceArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceArn](#API_DeleteResourceTree_RequestSyntax) ** The Amazon Resource Name (ARN) of the parent resource to delete. All child resources of the parent resource will also be deleted. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteResourceTree) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteResourceTree) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteResourceTree) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteResourceTree) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteResourceTree) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteResourceTree) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteResourceTree) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteResourceTree) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteResourceTree) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteResourceTree) # DeleteWhatIfAnalysis Deletes a what-if analysis created using the [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) operation. You can delete only what-if analyses that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) operation. You can't delete a what-if analysis while any of its forecasts are being exported. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "WhatIfAnalysisArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [WhatIfAnalysisArn](#API_DeleteWhatIfAnalysis_RequestSyntax) ** The Amazon Resource Name (ARN) of the what-if analysis that you want to delete. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfAnalysis) # DeleteWhatIfForecast Deletes a what-if forecast created using the [CreateWhatIfForecast](API_CreateWhatIfForecast.md) operation. You can delete only what-if forecasts that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) 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. ## Request Syntax ``` { "WhatIfForecastArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [WhatIfForecastArn](#API_DeleteWhatIfForecast_RequestSyntax) ** The Amazon Resource Name (ARN) of the what-if forecast that you want to delete. Type: String Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecast) # DeleteWhatIfForecastExport Deletes a what-if forecast export created using the [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) 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](API_DescribeWhatIfForecastExport.md) operation. ## Request Syntax ``` { "WhatIfForecastExportArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [WhatIfForecastExportArn](#API_DeleteWhatIfForecastExport_RequestSyntax) ** The Amazon Resource Name (ARN) of the what-if forecast export that you want to delete. Type: String Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DeleteWhatIfForecastExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DeleteWhatIfForecastExport) # DescribeAutoPredictor Describes a predictor created using the CreateAutoPredictor operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "PredictorArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PredictorArn](#API_DescribeAutoPredictor_RequestSyntax) ** The Amazon Resource Name (ARN) of the predictor. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DataConfig": { "AdditionalDatasets": [ { "Configuration": { "string" : [ "string" ] }, "Name": "string" } ], "AttributeConfigs": [ { "AttributeName": "string", "Transformations": { "string" : "string" } } ], "DatasetGroupArn": "string" }, "DatasetImportJobArns": [ "string" ], "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EstimatedTimeRemainingInMinutes": number, "ExplainabilityInfo": { "ExplainabilityArn": "string", "Status": "string" }, "ForecastDimensions": [ "string" ], "ForecastFrequency": "string", "ForecastHorizon": number, "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "MonitorInfo": { "MonitorArn": "string", "Status": "string" }, "OptimizationMetric": "string", "PredictorArn": "string", "PredictorName": "string", "ReferencePredictorSummary": { "Arn": "string", "State": "string" }, "Status": "string", "TimeAlignmentBoundary": { "DayOfMonth": number, "DayOfWeek": "string", "Hour": number, "Month": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeAutoPredictor_ResponseSyntax) ** The timestamp of the CreateAutoPredictor request. Type: Timestamp ** [DataConfig](#API_DescribeAutoPredictor_ResponseSyntax) ** The data configuration for your dataset group and any additional datasets. Type: [DataConfig](API_DataConfig.md) object ** [DatasetImportJobArns](#API_DescribeAutoPredictor_ResponseSyntax) ** An array of the ARNs of the dataset import jobs used to import training data for the predictor. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EncryptionConfig](#API_DescribeAutoPredictor_ResponseSyntax) ** An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the [CreateDataset](API_CreateDataset.md) and [CreatePredictor](API_CreatePredictor.md) requests. Type: [EncryptionConfig](API_EncryptionConfig.md) object ** [EstimatedTimeRemainingInMinutes](#API_DescribeAutoPredictor_ResponseSyntax) ** The estimated time remaining in minutes for the predictor training job to complete. Type: Long ** [ExplainabilityInfo](#API_DescribeAutoPredictor_ResponseSyntax) ** Provides the status and ARN of the Predictor Explainability. Type: [ExplainabilityInfo](API_ExplainabilityInfo.md) object ** [ForecastDimensions](#API_DescribeAutoPredictor_ResponseSyntax) ** An array of dimension (field) names that specify the attributes used to group your time series. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [ForecastFrequency](#API_DescribeAutoPredictor_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 5. Pattern: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` ** [ForecastHorizon](#API_DescribeAutoPredictor_ResponseSyntax) ** The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. Type: Integer ** [ForecastTypes](#API_DescribeAutoPredictor_ResponseSyntax) ** The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 2. Maximum length of 4. Pattern: `(^0?\.\d\d?$|^mean$)` ** [LastModificationTime](#API_DescribeAutoPredictor_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribeAutoPredictor_ResponseSyntax) ** In the event of an error, a message detailing the cause of the error. Type: String ** [MonitorInfo](#API_DescribeAutoPredictor_ResponseSyntax) ** A [MonitorInfo](API_MonitorInfo.md) object with the Amazon Resource Name (ARN) and status of the monitor resource. Type: [MonitorInfo](API_MonitorInfo.md) object ** [OptimizationMetric](#API_DescribeAutoPredictor_ResponseSyntax) ** The accuracy metric used to optimize the predictor. Type: String Valid Values: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PredictorArn](#API_DescribeAutoPredictor_ResponseSyntax) ** The Amazon Resource Name (ARN) of the predictor Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [PredictorName](#API_DescribeAutoPredictor_ResponseSyntax) ** The name of the predictor. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [ReferencePredictorSummary](#API_DescribeAutoPredictor_ResponseSyntax) ** The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors. Type: [ReferencePredictorSummary](API_ReferencePredictorSummary.md) object ** [Status](#API_DescribeAutoPredictor_ResponseSyntax) ** 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` Type: String Length Constraints: Maximum length of 256. ** [TimeAlignmentBoundary](#API_DescribeAutoPredictor_ResponseSyntax) ** The time boundary Forecast uses when aggregating data. Type: [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) object ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeAutoPredictor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeAutoPredictor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeAutoPredictor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeAutoPredictor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeAutoPredictor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeAutoPredictor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeAutoPredictor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeAutoPredictor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeAutoPredictor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeAutoPredictor) # DescribeDataset Describes an Amazon Forecast dataset created using the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) In addition to listing the parameters specified in the `CreateDataset` request, this operation includes the following dataset properties: + `CreationTime` + `LastModificationTime` + `Status` ## Request Syntax ``` { "DatasetArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DatasetArn](#API_DescribeDataset_RequestSyntax) ** The Amazon Resource Name (ARN) of the dataset. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DataFrequency": "string", "DatasetArn": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "LastModificationTime": number, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeDataset_ResponseSyntax) ** When the dataset was created. Type: Timestamp ** [DataFrequency](#API_DescribeDataset_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 5. Pattern: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` ** [DatasetArn](#API_DescribeDataset_ResponseSyntax) ** The Amazon Resource Name (ARN) of the dataset. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetName](#API_DescribeDataset_ResponseSyntax) ** The name of the dataset. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [DatasetType](#API_DescribeDataset_ResponseSyntax) ** The dataset type. Type: String Valid Values: `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA` ** [Domain](#API_DescribeDataset_ResponseSyntax) ** The domain associated with the dataset. Type: String Valid Values: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` ** [EncryptionConfig](#API_DescribeDataset_ResponseSyntax) ** The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. Type: [EncryptionConfig](API_EncryptionConfig.md) object ** [LastModificationTime](#API_DescribeDataset_ResponseSyntax) ** 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](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation has finished, `LastModificationTime` is when the import job completed or failed. Type: Timestamp ** [Schema](#API_DescribeDataset_ResponseSyntax) ** An array of `SchemaAttribute` objects that specify the dataset fields. Each `SchemaAttribute` specifies the name and data type of a field. Type: [Schema](API_Schema.md) object ** [Status](#API_DescribeDataset_ResponseSyntax) ** 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](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) 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. Type: String Length Constraints: Maximum length of 256. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDataset) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDataset) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDataset) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDataset) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDataset) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDataset) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDataset) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDataset) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDataset) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDataset) # DescribeDatasetGroup Describes a dataset group created using the [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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` ## Request Syntax ``` { "DatasetGroupArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DatasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) ** The Amazon Resource Name (ARN) of the dataset group. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DatasetArns": [ "string" ], "DatasetGroupArn": "string", "DatasetGroupName": "string", "Domain": "string", "LastModificationTime": number, "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeDatasetGroup_ResponseSyntax) ** When the dataset group was created. Type: Timestamp ** [DatasetArns](#API_DescribeDatasetGroup_ResponseSyntax) ** An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetGroupArn](#API_DescribeDatasetGroup_ResponseSyntax) ** The ARN of the dataset group. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetGroupName](#API_DescribeDatasetGroup_ResponseSyntax) ** The name of the dataset group. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Domain](#API_DescribeDatasetGroup_ResponseSyntax) ** The domain associated with the dataset group. Type: String Valid Values: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS` ** [LastModificationTime](#API_DescribeDatasetGroup_ResponseSyntax) ** When the dataset group was created or last updated from a call to the [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation. While the dataset group is being updated, `LastModificationTime` is the current time of the `DescribeDatasetGroup` call. Type: Timestamp ** [Status](#API_DescribeDatasetGroup_ResponseSyntax) ** 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](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation. The `Status` of the dataset group must be `ACTIVE` before you can use the dataset group to create a predictor. Type: String Length Constraints: Maximum length of 256. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDatasetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetGroup) # DescribeDatasetImportJob Describes a dataset import job created using the [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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. ## Request Syntax ``` { "DatasetImportJobArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the dataset import job. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DatasetArn": "string", "DatasetImportJobArn": "string", "DatasetImportJobName": "string", "DataSize": number, "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EstimatedTimeRemainingInMinutes": number, "FieldStatistics": { "string" : { "Avg": number, "Count": number, "CountDistinct": number, "CountDistinctLong": number, "CountLong": number, "CountNan": number, "CountNanLong": number, "CountNull": number, "CountNullLong": number, "Max": "string", "Min": "string", "Stddev": number } }, "Format": "string", "GeolocationFormat": "string", "ImportMode": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "TimestampFormat": "string", "TimeZone": "string", "UseGeolocationForTimeZone": boolean } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeDatasetImportJob_ResponseSyntax) ** When the dataset import job was created. Type: Timestamp ** [DatasetArn](#API_DescribeDatasetImportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the dataset that the training data was imported to. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetImportJobArn](#API_DescribeDatasetImportJob_ResponseSyntax) ** The ARN of the dataset import job. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [DatasetImportJobName](#API_DescribeDatasetImportJob_ResponseSyntax) ** The name of the dataset import job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [DataSize](#API_DescribeDatasetImportJob_ResponseSyntax) ** The size of the dataset in gigabytes (GB) after the import job has finished. Type: Double ** [DataSource](#API_DescribeDatasetImportJob_ResponseSyntax) ** The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. If encryption is used, `DataSource` includes an AWS Key Management Service (KMS) key. Type: [DataSource](API_DataSource.md) object ** [EstimatedTimeRemainingInMinutes](#API_DescribeDatasetImportJob_ResponseSyntax) ** The estimated time remaining in minutes for the dataset import job to complete. Type: Long ** [FieldStatistics](#API_DescribeDatasetImportJob_ResponseSyntax) ** Statistical information about each field in the input data. Type: String to [Statistics](API_Statistics.md) object map Key Length Constraints: Maximum length of 256. Key Pattern: `^[a-zA-Z0-9\_]+$` ** [Format](#API_DescribeDatasetImportJob_ResponseSyntax) ** The format of the imported data, CSV or PARQUET. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` ** [GeolocationFormat](#API_DescribeDatasetImportJob_ResponseSyntax) ** The format of the geolocation attribute. Valid Values:`"LAT_LONG"` and `"CC_POSTALCODE"`. Type: String Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9_]+$` ** [ImportMode](#API_DescribeDatasetImportJob_ResponseSyntax) ** The import mode of the dataset import job, FULL or INCREMENTAL. Type: String Valid Values: `FULL | INCREMENTAL` ** [LastModificationTime](#API_DescribeDatasetImportJob_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribeDatasetImportJob_ResponseSyntax) ** If an error occurred, an informational message about the error. Type: String ** [Status](#API_DescribeDatasetImportJob_ResponseSyntax) ** 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` Type: String Length Constraints: Maximum length of 256. ** [TimestampFormat](#API_DescribeDatasetImportJob_ResponseSyntax) ** 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 Type: String Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9\-\:\.\,\'\s]+$` ** [TimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) ** The single time zone applied to every item in the dataset Type: String Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9\/\+\-\_]+$` ** [UseGeolocationForTimeZone](#API_DescribeDatasetImportJob_ResponseSyntax) ** Whether `TimeZone` is automatically derived from the geolocation attribute. Type: Boolean ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeDatasetImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeDatasetImportJob) # DescribeExplainability Describes an Explainability resource created using the [CreateExplainability](API_CreateExplainability.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "ExplainabilityArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ExplainabilityArn](#API_DescribeExplainability_RequestSyntax) ** The Amazon Resource Name (ARN) of the Explaianability to describe. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EnableVisualization": boolean, "EndDateTime": "string", "EstimatedTimeRemainingInMinutes": number, "ExplainabilityArn": "string", "ExplainabilityConfig": { "TimePointGranularity": "string", "TimeSeriesGranularity": "string" }, "ExplainabilityName": "string", "LastModificationTime": number, "Message": "string", "ResourceArn": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "StartDateTime": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeExplainability_ResponseSyntax) ** When the Explainability resource was created. Type: Timestamp ** [DataSource](#API_DescribeExplainability_ResponseSyntax) ** The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key. Type: [DataSource](API_DataSource.md) object ** [EnableVisualization](#API_DescribeExplainability_ResponseSyntax) ** Whether the visualization was enabled for the Explainability resource. Type: Boolean ** [EndDateTime](#API_DescribeExplainability_ResponseSyntax) ** If `TimePointGranularity` is set to `SPECIFIC`, the last time point in the Explainability. Type: String Length Constraints: Maximum length of 19. Pattern: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` ** [EstimatedTimeRemainingInMinutes](#API_DescribeExplainability_ResponseSyntax) ** The estimated time remaining in minutes for the [CreateExplainability](API_CreateExplainability.md) job to complete. Type: Long ** [ExplainabilityArn](#API_DescribeExplainability_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Explainability. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ExplainabilityConfig](#API_DescribeExplainability_ResponseSyntax) ** The configuration settings that define the granularity of time series and time points for the Explainability. Type: [ExplainabilityConfig](API_ExplainabilityConfig.md) object ** [ExplainabilityName](#API_DescribeExplainability_ResponseSyntax) ** The name of the Explainability. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [LastModificationTime](#API_DescribeExplainability_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribeExplainability_ResponseSyntax) ** If an error occurred, a message about the error. Type: String ** [ResourceArn](#API_DescribeExplainability_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [Schema](#API_DescribeExplainability_ResponseSyntax) ** Defines the fields of a dataset. Type: [Schema](API_Schema.md) object ** [StartDateTime](#API_DescribeExplainability_ResponseSyntax) ** If `TimePointGranularity` is set to `SPECIFIC`, the first time point in the Explainability. Type: String Length Constraints: Maximum length of 19. Pattern: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$` ** [Status](#API_DescribeExplainability_ResponseSyntax) ** 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` Type: String Length Constraints: Maximum length of 256. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeExplainability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainability) # DescribeExplainabilityExport Describes an Explainability export created using the [CreateExplainabilityExport](API_CreateExplainabilityExport.md) operation. ## Request Syntax ``` { "ExplainabilityExportArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_RequestSyntax) ** The Amazon Resource Name (ARN) of the Explainability export. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ExplainabilityArn": "string", "ExplainabilityExportArn": "string", "ExplainabilityExportName": "string", "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeExplainabilityExport_ResponseSyntax) ** When the Explainability export was created. Type: Timestamp ** [Destination](#API_DescribeExplainabilityExport_ResponseSyntax) ** The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional). Type: [DataDestination](API_DataDestination.md) object ** [ExplainabilityArn](#API_DescribeExplainabilityExport_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Explainability export. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ExplainabilityExportArn](#API_DescribeExplainabilityExport_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Explainability export. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ExplainabilityExportName](#API_DescribeExplainabilityExport_ResponseSyntax) ** The name of the Explainability export. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Format](#API_DescribeExplainabilityExport_ResponseSyntax) ** The format of the exported data, CSV or PARQUET. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` ** [LastModificationTime](#API_DescribeExplainabilityExport_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribeExplainabilityExport_ResponseSyntax) ** Information about any errors that occurred during the export. Type: String ** [Status](#API_DescribeExplainabilityExport_ResponseSyntax) ** 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` Type: String Length Constraints: Maximum length of 256. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeExplainabilityExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeExplainabilityExport) # DescribeForecast Describes a forecast created using the [CreateForecast](API_CreateForecast.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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. ## Request Syntax ``` { "ForecastArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ForecastArn](#API_DescribeForecast_RequestSyntax) ** The Amazon Resource Name (ARN) of the forecast. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "DatasetGroupArn": "string", "EstimatedTimeRemainingInMinutes": number, "ForecastArn": "string", "ForecastName": "string", "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string", "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeForecast_ResponseSyntax) ** When the forecast creation task was created. Type: Timestamp ** [DatasetGroupArn](#API_DescribeForecast_ResponseSyntax) ** The ARN of the dataset group that provided the data used to train the predictor. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EstimatedTimeRemainingInMinutes](#API_DescribeForecast_ResponseSyntax) ** The estimated time remaining in minutes for the forecast job to complete. Type: Long ** [ForecastArn](#API_DescribeForecast_ResponseSyntax) ** The forecast ARN as specified in the request. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ForecastName](#API_DescribeForecast_ResponseSyntax) ** The name of the forecast. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [ForecastTypes](#API_DescribeForecast_ResponseSyntax) ** The quantiles at which probabilistic forecasts were generated. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 2. Maximum length of 4. Pattern: `(^0?\.\d\d?$|^mean$)` ** [LastModificationTime](#API_DescribeForecast_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribeForecast_ResponseSyntax) ** If an error occurred, an informational message about the error. Type: String ** [PredictorArn](#API_DescribeForecast_ResponseSyntax) ** The ARN of the predictor used to generate the forecast. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [Status](#API_DescribeForecast_ResponseSyntax) ** 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. Type: String Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9\_]+$` ** [TimeSeriesSelector](#API_DescribeForecast_ResponseSyntax) ** The time series to include in the forecast. Type: [TimeSeriesSelector](API_TimeSeriesSelector.md) object ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecast) # DescribeForecastExportJob Describes a forecast export job created using the [CreateForecastExportJob](API_CreateForecastExportJob.md) 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. ## Request Syntax ``` { "ForecastExportJobArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ForecastExportJobArn](#API_DescribeForecastExportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the forecast export job. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastArn": "string", "ForecastExportJobArn": "string", "ForecastExportJobName": "string", "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeForecastExportJob_ResponseSyntax) ** When the forecast export job was created. Type: Timestamp ** [Destination](#API_DescribeForecastExportJob_ResponseSyntax) ** The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported. Type: [DataDestination](API_DataDestination.md) object ** [ForecastArn](#API_DescribeForecastExportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the exported forecast. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ForecastExportJobArn](#API_DescribeForecastExportJob_ResponseSyntax) ** The ARN of the forecast export job. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [ForecastExportJobName](#API_DescribeForecastExportJob_ResponseSyntax) ** The name of the forecast export job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Format](#API_DescribeForecastExportJob_ResponseSyntax) ** The format of the exported data, CSV or PARQUET. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` ** [LastModificationTime](#API_DescribeForecastExportJob_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribeForecastExportJob_ResponseSyntax) ** If an error occurred, an informational message about the error. Type: String ** [Status](#API_DescribeForecastExportJob_ResponseSyntax) ** 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. Type: String Length Constraints: Maximum length of 256. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeForecastExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeForecastExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeForecastExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeForecastExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeForecastExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeForecastExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeForecastExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeForecastExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeForecastExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeForecastExportJob) # DescribeMonitor Describes a monitor resource. In addition to listing the properties provided in the [CreateMonitor](API_CreateMonitor.md) request, this operation lists the following properties: + `Baseline` + `CreationTime` + `LastEvaluationTime` + `LastEvaluationState` + `LastModificationTime` + `Message` + `Status` **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "MonitorArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [MonitorArn](#API_DescribeMonitor_RequestSyntax) ** The Amazon Resource Name (ARN) of the monitor resource to describe. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "Baseline": { "PredictorBaseline": { "BaselineMetrics": [ { "Name": "string", "Value": number } ] } }, "CreationTime": number, "EstimatedEvaluationTimeRemainingInMinutes": number, "LastEvaluationState": "string", "LastEvaluationTime": number, "LastModificationTime": number, "Message": "string", "MonitorArn": "string", "MonitorName": "string", "ResourceArn": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Baseline](#API_DescribeMonitor_ResponseSyntax) ** Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor. Type: [Baseline](API_Baseline.md) object ** [CreationTime](#API_DescribeMonitor_ResponseSyntax) ** The timestamp for when the monitor resource was created. Type: Timestamp ** [EstimatedEvaluationTimeRemainingInMinutes](#API_DescribeMonitor_ResponseSyntax) ** The estimated number of minutes remaining before the monitor resource finishes its current evaluation. Type: Long ** [LastEvaluationState](#API_DescribeMonitor_ResponseSyntax) ** The state of the monitor's latest evaluation. Type: String Length Constraints: Maximum length of 256. ** [LastEvaluationTime](#API_DescribeMonitor_ResponseSyntax) ** The timestamp of the latest evaluation completed by the monitor. Type: Timestamp ** [LastModificationTime](#API_DescribeMonitor_ResponseSyntax) ** The timestamp of the latest modification to the monitor. Type: Timestamp ** [Message](#API_DescribeMonitor_ResponseSyntax) ** An error message, if any, for the monitor. Type: String ** [MonitorArn](#API_DescribeMonitor_ResponseSyntax) ** The Amazon Resource Name (ARN) of the monitor resource described. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [MonitorName](#API_DescribeMonitor_ResponseSyntax) ** The name of the monitor. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [ResourceArn](#API_DescribeMonitor_ResponseSyntax) ** The Amazon Resource Name (ARN) of the auto predictor being monitored. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [Status](#API_DescribeMonitor_ResponseSyntax) ** The status of the monitor resource. Type: String Length Constraints: Maximum length of 256. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeMonitor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeMonitor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeMonitor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeMonitor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeMonitor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeMonitor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeMonitor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeMonitor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeMonitor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeMonitor) # DescribePredictor **Note** This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use [DescribeAutoPredictor](API_DescribeAutoPredictor.md). Describes a predictor created using the [CreatePredictor](API_CreatePredictor.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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. ## Request Syntax ``` { "PredictorArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PredictorArn](#API_DescribePredictor_RequestSyntax) ** The Amazon Resource Name (ARN) of the predictor that you want information about. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "AlgorithmArn": "string", "AutoMLAlgorithmArns": [ "string" ], "AutoMLOverrideStrategy": "string", "CreationTime": number, "DatasetImportJobArns": [ "string" ], "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EstimatedTimeRemainingInMinutes": number, "EvaluationParameters": { "BackTestWindowOffset": number, "NumberOfBacktestWindows": number }, "FeaturizationConfig": { "Featurizations": [ { "AttributeName": "string", "FeaturizationPipeline": [ { "FeaturizationMethodName": "string", "FeaturizationMethodParameters": { "string" : "string" } } ] } ], "ForecastDimensions": [ "string" ], "ForecastFrequency": "string" }, "ForecastHorizon": number, "ForecastTypes": [ "string" ], "HPOConfig": { "ParameterRanges": { "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ] } }, "InputDataConfig": { "DatasetGroupArn": "string", "SupplementaryFeatures": [ { "Name": "string", "Value": "string" } ] }, "IsAutoPredictor": boolean, "LastModificationTime": number, "Message": "string", "OptimizationMetric": "string", "PerformAutoML": boolean, "PerformHPO": boolean, "PredictorArn": "string", "PredictorExecutionDetails": { "PredictorExecutions": [ { "AlgorithmArn": "string", "TestWindows": [ { "Message": "string", "Status": "string", "TestWindowEnd": number, "TestWindowStart": number } ] } ] }, "PredictorName": "string", "Status": "string", "TrainingParameters": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AlgorithmArn](#API_DescribePredictor_ResponseSyntax) ** The Amazon Resource Name (ARN) of the algorithm used for model training. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [AutoMLAlgorithmArns](#API_DescribePredictor_ResponseSyntax) ** When `PerformAutoML` is specified, the ARN of the chosen algorithm. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [AutoMLOverrideStrategy](#API_DescribePredictor_ResponseSyntax) ** The `LatencyOptimized` AutoML override strategy is only available in private beta. Contact AWS 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. Type: String Valid Values: `LatencyOptimized | AccuracyOptimized` ** [CreationTime](#API_DescribePredictor_ResponseSyntax) ** When the model training task was created. Type: Timestamp ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) ** An array of the ARNs of the dataset import jobs used to import training data for the predictor. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EncryptionConfig](#API_DescribePredictor_ResponseSyntax) ** An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. Type: [EncryptionConfig](API_EncryptionConfig.md) object ** [EstimatedTimeRemainingInMinutes](#API_DescribePredictor_ResponseSyntax) ** The estimated time remaining in minutes for the predictor training job to complete. Type: Long ** [EvaluationParameters](#API_DescribePredictor_ResponseSyntax) ** 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. Type: [EvaluationParameters](API_EvaluationParameters.md) object ** [FeaturizationConfig](#API_DescribePredictor_ResponseSyntax) ** The featurization configuration. Type: [FeaturizationConfig](API_FeaturizationConfig.md) object ** [ForecastHorizon](#API_DescribePredictor_ResponseSyntax) ** The number of time-steps of the forecast. The forecast horizon is also called the prediction length. Type: Integer ** [ForecastTypes](#API_DescribePredictor_ResponseSyntax) ** The forecast types used during predictor training. Default value is `["0.1","0.5","0.9"]` Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 2. Maximum length of 4. Pattern: `(^0?\.\d\d?$|^mean$)` ** [HPOConfig](#API_DescribePredictor_ResponseSyntax) ** The hyperparameter override values for the algorithm. Type: [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) object ** [InputDataConfig](#API_DescribePredictor_ResponseSyntax) ** Describes the dataset group that contains the data to use to train the predictor. Type: [InputDataConfig](API_InputDataConfig.md) object ** [IsAutoPredictor](#API_DescribePredictor_ResponseSyntax) ** Whether the predictor was created with [CreateAutoPredictor](API_CreateAutoPredictor.md). Type: Boolean ** [LastModificationTime](#API_DescribePredictor_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribePredictor_ResponseSyntax) ** If an error occurred, an informational message about the error. Type: String ** [OptimizationMetric](#API_DescribePredictor_ResponseSyntax) ** The accuracy metric used to optimize the predictor. Type: String Valid Values: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PerformAutoML](#API_DescribePredictor_ResponseSyntax) ** Whether the predictor is set to perform AutoML. Type: Boolean ** [PerformHPO](#API_DescribePredictor_ResponseSyntax) ** Whether the predictor is set to perform hyperparameter optimization (HPO). Type: Boolean ** [PredictorArn](#API_DescribePredictor_ResponseSyntax) ** The ARN of the predictor. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [PredictorExecutionDetails](#API_DescribePredictor_ResponseSyntax) ** 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 [CreatePredictor](API_CreatePredictor.md) operation. Type: [PredictorExecutionDetails](API_PredictorExecutionDetails.md) object ** [PredictorName](#API_DescribePredictor_ResponseSyntax) ** The name of the predictor. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Status](#API_DescribePredictor_ResponseSyntax) ** 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. Type: String Length Constraints: Maximum length of 256. ** [TrainingParameters](#API_DescribePredictor_ResponseSyntax) ** The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR\$1, the optimized values for the chosen hyperparameters are returned. For more information, see [Amazon Forecast Algorithms](aws-forecast-choosing-recipes.md). Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 100 items. Key Length Constraints: Maximum length of 256. Key Pattern: `^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$` Value Length Constraints: Maximum length of 256. Value Pattern: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribePredictor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictor) # DescribePredictorBacktestExportJob Describes a predictor backtest export job created using the [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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) ## Request Syntax ``` { "PredictorBacktestExportJobArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the predictor backtest export job. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "PredictorBacktestExportJobArn": "string", "PredictorBacktestExportJobName": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** When the predictor backtest export job was created. Type: Timestamp ** [Destination](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional). Type: [DataDestination](API_DataDestination.md) object ** [Format](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** The format of the exported data, CSV or PARQUET. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` ** [LastModificationTime](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** Information about any errors that may have occurred during the backtest export. Type: String ** [PredictorArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the predictor. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [PredictorBacktestExportJobArn](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the predictor backtest export job. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [PredictorBacktestExportJobName](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** The name of the predictor backtest export job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ** [Status](#API_DescribePredictorBacktestExportJob_ResponseSyntax) ** 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` Type: String Length Constraints: Maximum length of 256. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictorBacktestExportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictorBacktestExportJob) # DescribeWhatIfAnalysis Describes the what-if analysis created using the [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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` ## Request Syntax ``` { "WhatIfAnalysisArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_RequestSyntax) ** The Amazon Resource Name (ARN) of the what-if analysis that you are interested in. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "EstimatedTimeRemainingInMinutes": number, "ForecastArn": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } }, "WhatIfAnalysisArn": "string", "WhatIfAnalysisName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** When the what-if analysis was created. Type: Timestamp ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** The approximate time remaining to complete the what-if analysis, in minutes. Type: Long ** [ForecastArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** The Amazon Resource Name (ARN) of the what-if forecast. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [LastModificationTime](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** If an error occurred, an informational message about the error. Type: String ** [Status](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 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. Type: String Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9\_]+$` ** [TimeSeriesSelector](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** 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` Type: [TimeSeriesSelector](API_TimeSeriesSelector.md) object ** [WhatIfAnalysisArn](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** The Amazon Resource Name (ARN) of the what-if analysis. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfAnalysisName](#API_DescribeWhatIfAnalysis_ResponseSyntax) ** The name of the what-if analysis. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfAnalysis) # DescribeWhatIfForecast Describes the what-if forecast created using the [CreateWhatIfForecast](API_CreateWhatIfForecast.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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` ## Request Syntax ``` { "WhatIfForecastArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_RequestSyntax) ** The Amazon Resource Name (ARN) of the what-if forecast that you are interested in. Type: String Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "EstimatedTimeRemainingInMinutes": number, "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "Status": "string", "TimeSeriesReplacementsDataSource": { "Format": "string", "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" }, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "TimestampFormat": "string" }, "TimeSeriesTransformations": [ { "Action": { "AttributeName": "string", "Operation": "string", "Value": number }, "TimeSeriesConditions": [ { "AttributeName": "string", "AttributeValue": "string", "Condition": "string" } ] } ], "WhatIfAnalysisArn": "string", "WhatIfForecastArn": "string", "WhatIfForecastName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeWhatIfForecast_ResponseSyntax) ** When the what-if forecast was created. Type: Timestamp ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecast_ResponseSyntax) ** The approximate time remaining to complete the what-if forecast, in minutes. Type: Long ** [ForecastTypes](#API_DescribeWhatIfForecast_ResponseSyntax) ** The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the [CreateWhatIfForecast](API_CreateWhatIfForecast.md) operation. If you didn't specify quantiles, the default values are `["0.1", "0.5", "0.9"]`. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 2. Maximum length of 4. Pattern: `(^0?\.\d\d?$|^mean$)` ** [LastModificationTime](#API_DescribeWhatIfForecast_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribeWhatIfForecast_ResponseSyntax) ** If an error occurred, an informational message about the error. Type: String ** [Status](#API_DescribeWhatIfForecast_ResponseSyntax) ** 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. Type: String Length Constraints: Maximum length of 256. Pattern: `^[a-zA-Z0-9\_]+$` ** [TimeSeriesReplacementsDataSource](#API_DescribeWhatIfForecast_ResponseSyntax) ** An array of `S3Config`, `Schema`, and `Format` elements that describe the replacement time series. Type: [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) object ** [TimeSeriesTransformations](#API_DescribeWhatIfForecast_ResponseSyntax) ** An array of `Action` and `TimeSeriesConditions` elements that describe what transformations were applied to which time series. Type: Array of [TimeSeriesTransformation](API_TimeSeriesTransformation.md) objects Array Members: Minimum number of 0 items. Maximum number of 30 items. ** [WhatIfAnalysisArn](#API_DescribeWhatIfForecast_ResponseSyntax) ** The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_ResponseSyntax) ** The Amazon Resource Name (ARN) of the what-if forecast. Type: String Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastName](#API_DescribeWhatIfForecast_ResponseSyntax) ** The name of the what-if forecast. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecast) # DescribeWhatIfForecastExport Describes the what-if forecast export created using the [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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` ## Request Syntax ``` { "WhatIfForecastExportArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_RequestSyntax) ** The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in. Type: String Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EstimatedTimeRemainingInMinutes": number, "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportArn": "string", "WhatIfForecastExportName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CreationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** When the what-if forecast export was created. Type: Timestamp ** [Destination](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional). Type: [DataDestination](API_DataDestination.md) object ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** The approximate time remaining to complete the what-if forecast export, in minutes. Type: Long ** [Format](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** The format of the exported data, CSV or PARQUET. Type: String Length Constraints: Maximum length of 7. Pattern: `^CSV|PARQUET$` ** [LastModificationTime](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 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. Type: Timestamp ** [Message](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** If an error occurred, an informational message about the error. Type: String ** [Status](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** 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. Type: String Length Constraints: Maximum length of 256. ** [WhatIfForecastArns](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource. Type: Array of strings Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastExportArn](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** The Amazon Resource Name (ARN) of the what-if forecast export. Type: String Length Constraints: Maximum length of 300. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastExportName](#API_DescribeWhatIfForecastExport_ResponseSyntax) ** The name of the what-if forecast export. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecastExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecastExport) # GetAccuracyMetrics Provides metrics on the accuracy of the models that were trained by the [CreatePredictor](API_CreatePredictor.md) 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](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html). **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (`NumberOfBacktestWindows`) is specified using the [EvaluationParameters](API_EvaluationParameters.md) 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](API_FeaturizationMethod.md). **Note** 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](API_DescribePredictor.md) operation. ## Request Syntax ``` { "PredictorArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PredictorArn](#API_GetAccuracyMetrics_RequestSyntax) ** The Amazon Resource Name (ARN) of the predictor to get metrics for. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "AutoMLOverrideStrategy": "string", "IsAutoPredictor": boolean, "OptimizationMetric": "string", "PredictorEvaluationResults": [ { "AlgorithmArn": "string", "TestWindows": [ { "EvaluationType": "string", "ItemCount": number, "Metrics": { "AverageWeightedQuantileLoss": number, "ErrorMetrics": [ { "ForecastType": "string", "MAPE": number, "MASE": number, "RMSE": number, "WAPE": number } ], "RMSE": number, "WeightedQuantileLosses": [ { "LossValue": number, "Quantile": number } ] }, "TestWindowEnd": number, "TestWindowStart": number } ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AutoMLOverrideStrategy](#API_GetAccuracyMetrics_ResponseSyntax) ** The `LatencyOptimized` AutoML override strategy is only available in private beta. Contact AWS 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. Type: String Valid Values: `LatencyOptimized | AccuracyOptimized` ** [IsAutoPredictor](#API_GetAccuracyMetrics_ResponseSyntax) ** Whether the predictor was created with [CreateAutoPredictor](API_CreateAutoPredictor.md). Type: Boolean ** [OptimizationMetric](#API_GetAccuracyMetrics_ResponseSyntax) ** The accuracy metric used to optimize the predictor. Type: String Valid Values: `WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PredictorEvaluationResults](#API_GetAccuracyMetrics_ResponseSyntax) ** An array of results from evaluating the predictor. Type: Array of [EvaluationResult](API_EvaluationResult.md) objects ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/GetAccuracyMetrics) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/GetAccuracyMetrics) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/GetAccuracyMetrics) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/GetAccuracyMetrics) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/GetAccuracyMetrics) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/GetAccuracyMetrics) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/GetAccuracyMetrics) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/GetAccuracyMetrics) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/GetAccuracyMetrics) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/GetAccuracyMetrics) # ListDatasetGroups Returns a list of dataset groups created using the [CreateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) 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](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [MaxResults](#API_ListDatasetGroups_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListDatasetGroups_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "DatasetGroups": [ { "CreationTime": number, "DatasetGroupArn": "string", "DatasetGroupName": "string", "LastModificationTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatasetGroups](#API_ListDatasetGroups_ResponseSyntax) ** An array of objects that summarize each dataset group's properties. Type: Array of [DatasetGroupSummary](API_DatasetGroupSummary.md) objects ** [NextToken](#API_ListDatasetGroups_ResponseSyntax) ** If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ## Errors ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListDatasetGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetGroups) # ListDatasetImportJobs Returns a list of dataset import jobs created using the [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) 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](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) operation. You can filter the list by providing an array of [Filter](https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html) objects. ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListDatasetImportJobs_RequestSyntax) ** 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" } ]` Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListDatasetImportJobs_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListDatasetImportJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "DatasetImportJobs": [ { "CreationTime": number, "DatasetImportJobArn": "string", "DatasetImportJobName": "string", "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ImportMode": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DatasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) ** An array of objects that summarize each dataset import job's properties. Type: Array of [DatasetImportJobSummary](API_DatasetImportJobSummary.md) objects ** [NextToken](#API_ListDatasetImportJobs_ResponseSyntax) ** If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListDatasetImportJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasetImportJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasetImportJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasetImportJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasetImportJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasetImportJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasetImportJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasetImportJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasetImportJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasetImportJobs) # ListDatasets Returns a list of datasets created using the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) 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](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [MaxResults](#API_ListDatasets_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListDatasets_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "Datasets": [ { "CreationTime": number, "DatasetArn": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "LastModificationTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Datasets](#API_ListDatasets_ResponseSyntax) ** An array of objects that summarize each dataset's properties. Type: Array of [DatasetSummary](API_DatasetSummary.md) objects ** [NextToken](#API_ListDatasets_ResponseSyntax) ** If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ## Errors ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListDatasets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListDatasets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListDatasets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListDatasets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListDatasets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListDatasets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListDatasets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListDatasets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListDatasets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListDatasets) # ListExplainabilities Returns a list of Explainability resources created using the [CreateExplainability](API_CreateExplainability.md) operation. This operation returns a summary for each Explainability. You can filter the list using an array of [Filter](API_Filter.md) objects. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the [DescribeExplainability](API_DescribeExplainability.md) operation. ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListExplainabilities_RequestSyntax) ** 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. Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListExplainabilities_RequestSyntax) ** The number of items returned in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListExplainabilities_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "Explainabilities": [ { "CreationTime": number, "ExplainabilityArn": "string", "ExplainabilityConfig": { "TimePointGranularity": "string", "TimeSeriesGranularity": "string" }, "ExplainabilityName": "string", "LastModificationTime": number, "Message": "string", "ResourceArn": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Explainabilities](#API_ListExplainabilities_ResponseSyntax) ** An array of objects that summarize the properties of each Explainability resource. Type: Array of [ExplainabilitySummary](API_ExplainabilitySummary.md) objects ** [NextToken](#API_ListExplainabilities_ResponseSyntax) ** Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListExplainabilities) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilities) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilities) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilities) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilities) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilities) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilities) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilities) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilities) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilities) # ListExplainabilityExports Returns a list of Explainability exports created using the [CreateExplainabilityExport](API_CreateExplainabilityExport.md) operation. This operation returns a summary for each Explainability export. You can filter the list using an array of [Filter](API_Filter.md) objects. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) To retrieve the complete set of properties for a particular Explainability export, use the ARN with the [DescribeExplainability](API_DescribeExplainability.md) operation. ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListExplainabilityExports_RequestSyntax) ** 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. Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListExplainabilityExports_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListExplainabilityExports_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "ExplainabilityExports": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ExplainabilityExportArn": "string", "ExplainabilityExportName": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ExplainabilityExports](#API_ListExplainabilityExports_ResponseSyntax) ** An array of objects that summarize the properties of each Explainability export. Type: Array of [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) objects ** [NextToken](#API_ListExplainabilityExports_ResponseSyntax) ** Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListExplainabilityExports) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListExplainabilityExports) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListExplainabilityExports) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListExplainabilityExports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListExplainabilityExports) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListExplainabilityExports) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListExplainabilityExports) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListExplainabilityExports) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListExplainabilityExports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListExplainabilityExports) # ListForecastExportJobs Returns a list of forecast export jobs created using the [CreateForecastExportJob](API_CreateForecastExportJob.md) 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](API_DescribeForecastExportJob.md) operation. You can filter the list using an array of [Filter](API_Filter.md) objects. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListForecastExportJobs_RequestSyntax) ** 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::forecast/electricityforecast" } ]` Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListForecastExportJobs_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListForecastExportJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "ForecastExportJobs": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastExportJobArn": "string", "ForecastExportJobName": "string", "LastModificationTime": number, "Message": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ForecastExportJobs](#API_ListForecastExportJobs_ResponseSyntax) ** An array of objects that summarize each export job's properties. Type: Array of [ForecastExportJobSummary](API_ForecastExportJobSummary.md) objects ** [NextToken](#API_ListForecastExportJobs_ResponseSyntax) ** If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListForecastExportJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecastExportJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecastExportJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecastExportJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecastExportJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecastExportJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecastExportJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecastExportJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecastExportJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecastExportJobs) # ListForecasts Returns a list of forecasts created using the [CreateForecast](API_CreateForecast.md) 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](API_DescribeForecast.md) operation. You can filter the list using an array of [Filter](API_Filter.md) objects. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListForecasts_RequestSyntax) ** 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" } ]` Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListForecasts_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListForecasts_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "Forecasts": [ { "CreatedUsingAutoPredictor": boolean, "CreationTime": number, "DatasetGroupArn": "string", "ForecastArn": "string", "ForecastName": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Forecasts](#API_ListForecasts_ResponseSyntax) ** An array of objects that summarize each forecast's properties. Type: Array of [ForecastSummary](API_ForecastSummary.md) objects ** [NextToken](#API_ListForecasts_ResponseSyntax) ** If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListForecasts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListForecasts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListForecasts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListForecasts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListForecasts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListForecasts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListForecasts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListForecasts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListForecasts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListForecasts) # ListMonitorEvaluations Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) For information about monitoring see [Predictor Monitoring](predictor-monitoring.md). For more information about retrieving monitoring results see [Viewing Monitoring Results](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "MonitorArn": "string", "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListMonitorEvaluations_RequestSyntax) ** 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" } ]` Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListMonitorEvaluations_RequestSyntax) ** The maximum number of monitoring results to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [MonitorArn](#API_ListMonitorEvaluations_RequestSyntax) ** The Amazon Resource Name (ARN) of the monitor resource to get results from. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [NextToken](#API_ListMonitorEvaluations_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "NextToken": "string", "PredictorMonitorEvaluations": [ { "EvaluationState": "string", "EvaluationTime": number, "Message": "string", "MetricResults": [ { "MetricName": "string", "MetricValue": number } ], "MonitorArn": "string", "MonitorDataSource": { "DatasetImportJobArn": "string", "ForecastArn": "string", "PredictorArn": "string" }, "NumItemsEvaluated": number, "PredictorEvent": { "Datetime": number, "Detail": "string" }, "ResourceArn": "string", "WindowEndDatetime": number, "WindowStartDatetime": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListMonitorEvaluations_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ** [PredictorMonitorEvaluations](#API_ListMonitorEvaluations_ResponseSyntax) ** The monitoring results and predictor events collected by the monitor resource during different windows of time. For information about monitoring see [Viewing Monitoring Results](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). For more information about retrieving monitoring results see [Viewing Monitoring Results](https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). Type: Array of [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) objects ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListMonitorEvaluations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitorEvaluations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitorEvaluations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitorEvaluations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitorEvaluations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitorEvaluations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitorEvaluations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitorEvaluations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitorEvaluations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListMonitorEvaluations) # ListMonitors Returns a list of monitors created with the [CreateMonitor](API_CreateMonitor.md) operation and [CreateAutoPredictor](API_CreateAutoPredictor.md) 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](API_DescribeMonitor.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListMonitors_RequestSyntax) ** 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" } ]` Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListMonitors_RequestSyntax) ** The maximum number of monitors to include in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListMonitors_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "Monitors": [ { "CreationTime": number, "LastModificationTime": number, "MonitorArn": "string", "MonitorName": "string", "ResourceArn": "string", "Status": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Monitors](#API_ListMonitors_ResponseSyntax) ** An array of objects that summarize each monitor's properties. Type: Array of [MonitorSummary](API_MonitorSummary.md) objects ** [NextToken](#API_ListMonitors_ResponseSyntax) ** If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListMonitors) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListMonitors) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListMonitors) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListMonitors) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListMonitors) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListMonitors) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListMonitors) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListMonitors) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListMonitors) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListMonitors) # ListPredictorBacktestExportJobs Returns a list of predictor backtest export jobs created using the [CreatePredictorBacktestExportJob](API_CreatePredictorBacktestExportJob.md) operation. This operation returns a summary for each backtest export job. You can filter the list using an array of [Filter](API_Filter.md) objects. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) To retrieve the complete set of properties for a particular backtest export job, use the ARN with the [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) operation. ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListPredictorBacktestExportJobs_RequestSyntax) ** 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. Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListPredictorBacktestExportJobs_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPredictorBacktestExportJobs_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "NextToken": "string", "PredictorBacktestExportJobs": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "LastModificationTime": number, "Message": "string", "PredictorBacktestExportJobArn": "string", "PredictorBacktestExportJobName": "string", "Status": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListPredictorBacktestExportJobs_ResponseSyntax) ** Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ** [PredictorBacktestExportJobs](#API_ListPredictorBacktestExportJobs_ResponseSyntax) ** An array of objects that summarize the properties of each predictor backtest export job. Type: Array of [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) objects ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictorBacktestExportJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListPredictorBacktestExportJobs) # ListPredictors Returns a list of predictors created using the [CreateAutoPredictor](API_CreateAutoPredictor.md) or [CreatePredictor](API_CreatePredictor.md) operations. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) You can retrieve the complete set of properties by using the ARN with the [DescribeAutoPredictor](API_DescribeAutoPredictor.md) and [DescribePredictor](API_DescribePredictor.md) operations. You can filter the list using an array of [Filter](API_Filter.md) objects. ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListPredictors_RequestSyntax) ** 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" } ]` Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListPredictors_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPredictors_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "NextToken": "string", "Predictors": [ { "CreationTime": number, "DatasetGroupArn": "string", "IsAutoPredictor": boolean, "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "PredictorName": "string", "ReferencePredictorSummary": { "Arn": "string", "State": "string" }, "Status": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListPredictors_ResponseSyntax) ** If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ** [Predictors](#API_ListPredictors_ResponseSyntax) ** An array of objects that summarize each predictor's properties. Type: Array of [PredictorSummary](API_PredictorSummary.md) objects ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListPredictors) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListPredictors) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListPredictors) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListPredictors) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListPredictors) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListPredictors) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListPredictors) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListPredictors) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListPredictors) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListPredictors) # ListTagsForResource Lists the tags for an Amazon Forecast resource. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "ResourceArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Syntax ``` { "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** The tags for the resource. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListTagsForResource) # ListWhatIfAnalyses Returns a list of what-if analyses created using the [CreateWhatIfAnalysis](API_CreateWhatIfAnalysis.md) 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](API_DescribeWhatIfAnalysis.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListWhatIfAnalyses_RequestSyntax) ** 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::forecast/electricityWhatIf" } ]` Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListWhatIfAnalyses_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListWhatIfAnalyses_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "NextToken": "string", "WhatIfAnalyses": [ { "CreationTime": number, "ForecastArn": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfAnalysisArn": "string", "WhatIfAnalysisName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListWhatIfAnalyses_ResponseSyntax) ** If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ** [WhatIfAnalyses](#API_ListWhatIfAnalyses_ResponseSyntax) ** An array of `WhatIfAnalysisSummary` objects that describe the matched analyses. Type: Array of [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) objects ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfAnalyses) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfAnalyses) # ListWhatIfForecastExports Returns a list of what-if forecast exports created using the [CreateWhatIfForecastExport](API_CreateWhatIfForecastExport.md) 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](API_DescribeWhatIfForecastExport.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListWhatIfForecastExports_RequestSyntax) ** 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::forecast/electricityWIFExport" } ]` Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListWhatIfForecastExports_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListWhatIfForecastExports_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "NextToken": "string", "WhatIfForecastExports": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportArn": "string", "WhatIfForecastExportName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListWhatIfForecastExports_ResponseSyntax) ** If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ** [WhatIfForecastExports](#API_ListWhatIfForecastExports_ResponseSyntax) ** An array of `WhatIfForecastExports` objects that describe the matched forecast exports. Type: Array of [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) objects ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecastExports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecastExports) # ListWhatIfForecasts Returns a list of what-if forecasts created using the [CreateWhatIfForecast](API_CreateWhatIfForecast.md) 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](API_DescribeWhatIfForecast.md) operation. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "Filters": [ { "Condition": "string", "Key": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_ListWhatIfForecasts_RequestSyntax) ** 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::forecast/electricityWhatIfForecast" } ]` Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListWhatIfForecasts_RequestSyntax) ** The number of items to return in the response. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListWhatIfForecasts_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` Required: No ## Response Syntax ``` { "NextToken": "string", "WhatIfForecasts": [ { "CreationTime": number, "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfAnalysisArn": "string", "WhatIfForecastArn": "string", "WhatIfForecastName": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListWhatIfForecasts_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 3000. Pattern: `.+` ** [WhatIfForecasts](#API_ListWhatIfForecasts_ResponseSyntax) ** An array of `WhatIfForecasts` objects that describe the matched forecasts. Type: Array of [WhatIfForecastSummary](API_WhatIfForecastSummary.md) objects ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** InvalidNextTokenException ** The token is not valid. Tokens expire after 24 hours. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfForecasts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecasts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecasts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecasts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecasts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecasts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecasts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecasts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecasts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecasts) # ResumeResource Resumes a stopped monitor resource. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "ResourceArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceArn](#API_ResumeResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the monitor resource to resume. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ResumeResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ResumeResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ResumeResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ResumeResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ResumeResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ResumeResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ResumeResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ResumeResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ResumeResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ResumeResource) # StopResource Stops a resource. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 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 ## Request Syntax ``` { "ResourceArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceArn](#API_StopResource_RequestSyntax) ** The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are `DatasetImportJobArn`, `PredictorArn`, `PredictorBacktestExportJobArn`, `ForecastArn`, `ForecastExportJobArn`, `ExplainabilityArn`, and `ExplainabilityExportArn`. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/StopResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/StopResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/StopResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/StopResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/StopResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/StopResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/StopResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/StopResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/StopResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/StopResource) # TagResource 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. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [Tags](#API_TagResource_RequestSyntax) ** 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: \$1 - = . \$1 : / @. + 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 AWS 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** LimitExceededException ** The limit on the number of resources per account has been exceeded. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TagResource) # UntagResource Deletes the specified tags from a resource. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) ## Request Syntax ``` { "ResourceArn": "string", "TagKeys": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [TagKeys](#API_UntagResource_RequestSyntax) ** The keys of the tags to be removed. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UntagResource) # UpdateDatasetGroup Replaces the datasets in a dataset group with the specified datasets. **Important** Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) **Note** The `Status` of the dataset group must be `ACTIVE` before you can use the dataset group to create a predictor. Use the [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation to get the status. ## Request Syntax ``` { "DatasetArns": [ "string" ], "DatasetGroupArn": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DatasetArns](#API_UpdateDatasetGroup_RequestSyntax) ** An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset group. Type: Array of strings Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ** [DatasetGroupArn](#API_UpdateDatasetGroup_RequestSyntax) ** The ARN of the dataset group. Type: String Length Constraints: Maximum length of 256. Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** InvalidInputException ** We can't process the request because it includes an invalid value or a value that exceeds the valid range. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/UpdateDatasetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/UpdateDatasetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/UpdateDatasetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/UpdateDatasetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/UpdateDatasetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/UpdateDatasetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/UpdateDatasetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/UpdateDatasetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/UpdateDatasetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/UpdateDatasetGroup)