API version 2018-06-26 of the Amazon Forecast Service SDK configuration.

We can't process the request because it includes an invalid value or a value that exceeds the valid range.

The token is not valid. Tokens expire after 24 hours.

The limit on the number of resources per account has been exceeded.

There is already a resource with this name. Try again with a different name.

The specified resource is in use.

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

See: newCreateAutoPredictor smart constructor.

Create a value of CreateAutoPredictor with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataConfig:CreateAutoPredictor', createAutoPredictor_dataConfig - The data configuration for your dataset group and any additional datasets.

$sel:encryptionConfig:CreateAutoPredictor', createAutoPredictor_encryptionConfig - Undocumented member.

$sel:explainPredictor:CreateAutoPredictor', createAutoPredictor_explainPredictor - Create an Explainability resource for the predictor.

CreateAutoPredictor, createAutoPredictor_forecastDimensions - 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.

CreateAutoPredictor, createAutoPredictor_forecastFrequency - The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

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

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

$sel:forecastHorizon:CreateAutoPredictor', createAutoPredictor_forecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

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

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

$sel:forecastTypes:CreateAutoPredictor', createAutoPredictor_forecastTypes - 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.

$sel:monitorConfig:CreateAutoPredictor', createAutoPredictor_monitorConfig - 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.

$sel:optimizationMetric:CreateAutoPredictor', createAutoPredictor_optimizationMetric - The accuracy metric used to optimize the predictor.

$sel:referencePredictorArn:CreateAutoPredictor', createAutoPredictor_referencePredictorArn - 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.

$sel:tags:CreateAutoPredictor', createAutoPredictor_tags - Optional metadata to help you categorize and organize your predictors. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

• For each resource, each tag key must be unique and each tag key must have one value.
• Maximum number of tags per resource: 50.
• Maximum key length: 128 Unicode characters in UTF-8.
• Maximum value length: 256 Unicode characters in UTF-8.
• Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
• Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

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

CreateAutoPredictor, createAutoPredictor_predictorName - A unique name for the predictor

See: newCreateAutoPredictorResponse smart constructor.

Create a value of CreateAutoPredictorResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateAutoPredictorResponse, createAutoPredictorResponse_predictorArn - The Amazon Resource Name (ARN) of the predictor.

$sel:httpStatus:CreateAutoPredictorResponse', createAutoPredictorResponse_httpStatus - The response's http status code.

See: newCreateDataset smart constructor.

Create a value of CreateDataset with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataFrequency:CreateDataset', createDataset_dataFrequency - The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

$sel:encryptionConfig:CreateDataset', createDataset_encryptionConfig - An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

$sel:tags:CreateDataset', createDataset_tags - The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50.
• For each resource, each tag key must be unique, and each tag key can have only one value.
• Maximum key length - 128 Unicode characters in UTF-8.
• Maximum value length - 256 Unicode characters in UTF-8.
• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
• Tag keys and values are case sensitive.
• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for 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.

CreateDataset, createDataset_datasetName - A name for the dataset.

CreateDataset, createDataset_domain - The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see Importing datasets.

CreateDataset, createDataset_datasetType - The dataset type. Valid values depend on the chosen Domain.

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

See: newCreateDatasetResponse smart constructor.

Create a value of CreateDatasetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDatasetResponse, createDatasetResponse_datasetArn - The Amazon Resource Name (ARN) of the dataset.

$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.

See: newCreateDatasetGroup smart constructor.

Create a value of CreateDatasetGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:datasetArns:CreateDatasetGroup', createDatasetGroup_datasetArns - An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

$sel:tags:CreateDatasetGroup', createDatasetGroup_tags - The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50.
• For each resource, each tag key must be unique, and each tag key can have only one value.
• Maximum key length - 128 Unicode characters in UTF-8.
• Maximum value length - 256 Unicode characters in UTF-8.
• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
• Tag keys and values are case sensitive.
• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for 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.

CreateDatasetGroup, createDatasetGroup_datasetGroupName - A name for the dataset group.

CreateDatasetGroup, createDatasetGroup_domain - The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see Dataset groups.

See: newCreateDatasetGroupResponse smart constructor.

Create a value of CreateDatasetGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDatasetGroupResponse, createDatasetGroupResponse_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group.

$sel:httpStatus:CreateDatasetGroupResponse', createDatasetGroupResponse_httpStatus - The response's http status code.

See: newCreateDatasetImportJob smart constructor.

Create a value of CreateDatasetImportJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:geolocationFormat:CreateDatasetImportJob', createDatasetImportJob_geolocationFormat - The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

• LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).
• CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

$sel:tags:CreateDatasetImportJob', createDatasetImportJob_tags - The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50.
• For each resource, each tag key must be unique, and each tag key can have only one value.
• Maximum key length - 128 Unicode characters in UTF-8.
• Maximum value length - 256 Unicode characters in UTF-8.
• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
• Tag keys and values are case sensitive.
• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for 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.

$sel:timeZone:CreateDatasetImportJob', createDatasetImportJob_timeZone - A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

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

CreateDatasetImportJob, createDatasetImportJob_timestampFormat - The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

• "yyyy-MM-dd"

  For the following data frequencies: Y, M, W, and D

• "yyyy-MM-dd HH:mm:ss"

  For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

$sel:useGeolocationForTimeZone:CreateDatasetImportJob', createDatasetImportJob_useGeolocationForTimeZone - 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.

CreateDatasetImportJob, createDatasetImportJob_datasetImportJobName - The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

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

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

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

See: newCreateDatasetImportJobResponse smart constructor.

Create a value of CreateDatasetImportJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDatasetImportJobResponse, createDatasetImportJobResponse_datasetImportJobArn - The Amazon Resource Name (ARN) of the dataset import job.

$sel:httpStatus:CreateDatasetImportJobResponse', createDatasetImportJobResponse_httpStatus - The response's http status code.

See: newCreateExplainability smart constructor.

Create a value of CreateExplainability with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateExplainability, createExplainability_dataSource - Undocumented member.

$sel:enableVisualization:CreateExplainability', createExplainability_enableVisualization - Create an Explainability visualization that is viewable within the AWS console.

$sel:endDateTime:CreateExplainability', createExplainability_endDateTime - 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)

CreateExplainability, createExplainability_schema - Undocumented member.

$sel:startDateTime:CreateExplainability', createExplainability_startDateTime - 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)

$sel:tags:CreateExplainability', createExplainability_tags - Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

• For each resource, each tag key must be unique and each tag key must have one value.
• Maximum number of tags per resource: 50.
• Maximum key length: 128 Unicode characters in UTF-8.
• Maximum value length: 256 Unicode characters in UTF-8.
• Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
• Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

CreateExplainability, createExplainability_explainabilityName - A unique name for the Explainability.

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

CreateExplainability, createExplainability_explainabilityConfig - The configuration settings that define the granularity of time series and time points for the Explainability.

See: newCreateExplainabilityResponse smart constructor.

Create a value of CreateExplainabilityResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateExplainabilityResponse, createExplainabilityResponse_explainabilityArn - The Amazon Resource Name (ARN) of the Explainability.

$sel:httpStatus:CreateExplainabilityResponse', createExplainabilityResponse_httpStatus - The response's http status code.

See: newCreateExplainabilityExport smart constructor.