AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Forecast Service CreateAutoPredictor API operation.

Syntax

New-FRCAutoPredictor
-PredictorName <String>
-DataConfig_AdditionalDataset <AdditionalDataset[]>
-DataConfig_AttributeConfig <AttributeConfig[]>
-DataConfig_DatasetGroupArn <String>
-TimeAlignmentBoundary_DayOfMonth <Int32>
-TimeAlignmentBoundary_DayOfWeek <DayOfWeek>
-ExplainPredictor <Boolean>
-ForecastDimension <String[]>
-ForecastFrequency <String>
-ForecastHorizon <Int32>
-ForecastType <String[]>
-TimeAlignmentBoundary_Hour <Int32>
-EncryptionConfig_KMSKeyArn <String>
-MonitorConfig_MonitorName <String>
-TimeAlignmentBoundary_Month <Month>
-OptimizationMetric <OptimizationMetric>
-ReferencePredictorArn <String>
-EncryptionConfig_RoleArn <String>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonForecastServiceConfig>

Description

Creates an Amazon Forecast predictor. Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors. Creating new predictors The following parameters are required when creating a new predictor:
  • PredictorName - A unique name for the predictor.
  • DatasetGroupArn - The ARN of the dataset group used to train the predictor.
  • ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc).
  • ForecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
When creating a new predictor, do not specify a value for ReferencePredictorArn. Upgrading and retraining predictors The following parameters are required when retraining or upgrading a predictor:
  • PredictorName - A unique name for the predictor.
  • ReferencePredictorArn - The ARN of the predictor to retrain or upgrade.
When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and PredictorName.

Parameters

Amazon.PowerShell.Cmdlets.FRC.AmazonForecastServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataConfig_AdditionalDataset <AdditionalDataset[]>
Additional built-in datasets like Holidays and the Weather Index.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataConfig_AdditionalDatasets
-DataConfig_AttributeConfig <AttributeConfig[]>
Aggregation and filling options for attributes in your dataset group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataConfig_AttributeConfigs
-DataConfig_DatasetGroupArn <String>
The ARN of the dataset group used to train the predictor.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionConfig_KMSKeyArn <String>
The Amazon Resource Name (ARN) of the KMS key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionConfig_RoleArn <String>
The ARN of the IAM role that Amazon Forecast can assume to access the KMS key.Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExplainPredictor <Boolean>
Create an Explainability resource for the predictor.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ForecastDimension <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesForecastDimensions
-ForecastFrequency <String>
The frequency of predictions in a forecast.Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:
  • Minute - 1-59
  • Hour - 1-23
  • Day - 1-6
  • Week - 1-4
  • Month - 1-11
  • Year - 1
Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ForecastHorizon <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ForecastType <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesForecastTypes
-MonitorConfig_MonitorName <String>
The name of the monitor resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptimizationMetric <OptimizationMetric>
The accuracy metric used to optimize the predictor.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the PredictorName parameter. The -PassThru parameter is deprecated, use -Select '^PredictorName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PredictorName <String>
A unique name for the predictor
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ReferencePredictorArn <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'PredictorArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.CreateAutoPredictorResponse). Specifying the name of a property of type Amazon.ForecastService.Model.CreateAutoPredictorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TimeAlignmentBoundary_DayOfMonth <Int32>
The day of the month to use for time alignment during aggregation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeAlignmentBoundary_DayOfWeek <DayOfWeek>
The day of week to use for time alignment during aggregation. The day must be in uppercase.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeAlignmentBoundary_Hour <Int32>
The hour of day to use for time alignment during aggregation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeAlignmentBoundary_Month <Month>
The month to use for time alignment during aggregation. The month must be in uppercase.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a System.String object. The service call response (type Amazon.ForecastService.Model.CreateAutoPredictorResponse) can be returned by specifying '-Select *'.

Supported Version

AWS Tools for PowerShell: 2.x.y.z