AWS.Tools.ForecastService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ForecastService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCAccuracyMetricCmdlet"> <summary> Provides metrics on the accuracy of the models that were trained by the <a>CreatePredictor</a> operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast. <para> Metrics are generated for each backtest window evaluated. For more information, see <a>EvaluationParameters</a>. </para><para> The parameters of the <code>filling</code> method determine which items contribute to the metrics. If <code>zero</code> is specified, all items contribute. If <code>nan</code> is specified, only those items that have complete data in the range being evaluated contribute. For more information, see <a>FeaturizationMethod</a>. </para><para> For an example of how to train a model and review metrics, see <a>getting-started</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCAccuracyMetricCmdlet.PredictorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the predictor to get metrics for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCAccuracyMetricCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PredictorEvaluationResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.GetAccuracyMetricsResponse). Specifying the name of a property of type Amazon.ForecastService.Model.GetAccuracyMetricsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCAccuracyMetricCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PredictorArn parameter. The -PassThru parameter is deprecated, use -Select '^PredictorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetCmdlet"> <summary> Describes an Amazon Forecast dataset created using the <a>CreateDataset</a> operation. <para> In addition to listing the properties provided by the user in the <code>CreateDataset</code> request, this operation includes the following properties: </para><ul><li><para><code>CreationTime</code></para></li><li><para><code>LastModificationTime</code></para></li><li><para><code>Status</code></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DescribeDatasetResponse). Specifying the name of a property of type Amazon.ForecastService.Model.DescribeDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetGroupCmdlet"> <summary> Describes a dataset group created using the <a>CreateDatasetGroup</a> operation. <para> In addition to listing the properties provided by the user in the <code>CreateDatasetGroup</code> request, this operation includes the following properties: </para><ul><li><para><code>DatasetArns</code> - The datasets belonging to the group. </para></li><li><para><code>CreationTime</code></para></li><li><para><code>LastModificationTime</code></para></li><li><para><code>Status</code></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetGroupCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DescribeDatasetGroupResponse). Specifying the name of a property of type Amazon.ForecastService.Model.DescribeDatasetGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetGroupArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetGroupListCmdlet"> <summary> Returns a list of dataset groups created using the <a>CreateDatasetGroup</a> operation. For each dataset group, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeDatasetGroup</a> operation.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetGroupListCmdlet.MaxResult"> <summary> <para> <para>The number of items to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetGroupListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.ListDatasetGroupsResponse). Specifying the name of a property of type Amazon.ForecastService.Model.ListDatasetGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetGroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobCmdlet"> <summary> Describes a dataset import job created using the <a>CreateDatasetImportJob</a> operation. <para> In addition to listing the properties provided by the user in the <code>CreateDatasetImportJob</code> request, this operation includes the following properties: </para><ul><li><para><code>CreationTime</code></para></li><li><para><code>LastModificationTime</code></para></li><li><para><code>DataSize</code></para></li><li><para><code>FieldStatistics</code></para></li><li><para><code>Status</code></para></li><li><para><code>Message</code> - If an error occurred, information about the error. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobCmdlet.DatasetImportJobArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset import job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DescribeDatasetImportJobResponse). Specifying the name of a property of type Amazon.ForecastService.Model.DescribeDatasetImportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetImportJobArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetImportJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobListCmdlet"> <summary> Returns a list of dataset import jobs created using the <a>CreateDatasetImportJob</a> operation. For each import job, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeDatasetImportJob</a> operation. You can filter the list by providing an array of <a>Filter</a> objects.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobListCmdlet.Filter"> <summary> <para> <para>An array of filters. For each filter, you provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, <code>Name</code> is the only valid key, which filters on the <code>DatasetImportJobName</code> property.</para><ul><li><para><code>Condition</code> - <code>IS</code> or <code>IS_NOT</code></para></li><li><para><code>Key</code> - <code>Name</code></para></li><li><para><code>Value</code> - the value to match</para></li></ul><para>For example, to list all dataset import jobs named <i>my_dataset_import_job</i>, you would specify:</para><para><code>"Filters": [ { "Condition": "IS", "Key": "Name", "Value": "my_dataset_import_job" } ]</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobListCmdlet.MaxResult"> <summary> <para> <para>The number of items to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetImportJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.ListDatasetImportJobsResponse). Specifying the name of a property of type Amazon.ForecastService.Model.ListDatasetImportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetImportJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetListCmdlet"> <summary> Returns a list of datasets created using the <a>CreateDataset</a> operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeDataset</a> operation.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetListCmdlet.MaxResult"> <summary> <para> <para>The number of items to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Datasets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.ListDatasetsResponse). Specifying the name of a property of type Amazon.ForecastService.Model.ListDatasetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCDatasetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastCmdlet"> <summary> Describes a forecast created using the <a>CreateForecast</a> operation. <para> In addition to listing the properties provided by the user in the <code>CreateForecast</code> request, this operation includes the following properties: </para><ul><li><para><code>DatasetGroupArn</code> - The dataset group that provided the training data. </para></li><li><para><code>CreationTime</code></para></li><li><para><code>LastModificationTime</code></para></li><li><para><code>Status</code></para></li><li><para><code>Message</code> - If an error occurred, information about the error. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastCmdlet.ForecastArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the forecast.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DescribeForecastResponse). Specifying the name of a property of type Amazon.ForecastService.Model.DescribeForecastResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ForecastArn parameter. The -PassThru parameter is deprecated, use -Select '^ForecastArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobCmdlet"> <summary> Describes a forecast export job created using the <a>CreateForecastExportJob</a> operation. <para> In addition to listing the properties provided by the user in the <code>CreateForecastExportJob</code> request, this operation includes the following properties: </para><ul><li><para><code>CreationTime</code></para></li><li><para><code>LastModificationTime</code></para></li><li><para><code>Status</code></para></li><li><para><code>Message</code> - If an error occurred, information about the error. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobCmdlet.ForecastExportJobArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the forecast export job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DescribeForecastExportJobResponse). Specifying the name of a property of type Amazon.ForecastService.Model.DescribeForecastExportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ForecastExportJobArn parameter. The -PassThru parameter is deprecated, use -Select '^ForecastExportJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobListCmdlet"> <summary> Returns a list of forecast export jobs created using the <a>CreateForecastExportJob</a> operation. For each forecast export job, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeForecastExportJob</a> operation. The list can be filtered using an array of <a>Filter</a> objects.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobListCmdlet.Filter"> <summary> <para> <para>An array of filters. For each filter, you provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, <code>Name</code> is the only valid key, which filters on the <code>ForecastExportJobName</code> property.</para><ul><li><para><code>Condition</code> - <code>IS</code> or <code>IS_NOT</code></para></li><li><para><code>Key</code> - <code>Name</code></para></li><li><para><code>Value</code> - the value to match</para></li></ul><para>For example, to list all forecast export jobs named <i>my_forecast_export_job</i>, you would specify:</para><para><code>"Filters": [ { "Condition": "IS", "Key": "Name", "Value": "my_forecast_export_job" } ]</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobListCmdlet.MaxResult"> <summary> <para> <para>The number of items to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ForecastExportJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.ListForecastExportJobsResponse). Specifying the name of a property of type Amazon.ForecastService.Model.ListForecastExportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastExportJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastListCmdlet"> <summary> Returns a list of forecasts created using the <a>CreateForecast</a> operation. For each forecast, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeForecast</a> operation. The list can be filtered using an array of <a>Filter</a> objects.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastListCmdlet.Filter"> <summary> <para> <para>An array of filters. For each filter, you provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, <code>Name</code> is the only valid key, which filters on the <code>ForecastName</code> property.</para><ul><li><para><code>Condition</code> - <code>IS</code> or <code>IS_NOT</code></para></li><li><para><code>Key</code> - <code>Name</code></para></li><li><para><code>Value</code> - the value to match</para></li></ul><para>For example, to list all forecasts named <i>my_forecast</i>, you would specify:</para><para><code>"Filters": [ { "Condition": "IS", "Key": "Name", "Value": "my_forecast" } ]</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastListCmdlet.MaxResult"> <summary> <para> <para>The number of items to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Forecasts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.ListForecastsResponse). Specifying the name of a property of type Amazon.ForecastService.Model.ListForecastsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCForecastListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorCmdlet"> <summary> Describes a predictor created using the <a>CreatePredictor</a> operation. <para> In addition to listing the properties provided by the user in the <code>CreatePredictor</code> request, this operation includes the following properties: </para><ul><li><para><code>DatasetImportJobArns</code> - The dataset import jobs used to import training data. </para></li><li><para><code>AutoMLAlgorithmArns</code> - If AutoML is performed, the algorithms evaluated. </para></li><li><para><code>CreationTime</code></para></li><li><para><code>LastModificationTime</code></para></li><li><para><code>Status</code></para></li><li><para><code>Message</code> - If an error occurred, information about the error. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorCmdlet.PredictorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the predictor that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DescribePredictorResponse). Specifying the name of a property of type Amazon.ForecastService.Model.DescribePredictorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PredictorArn parameter. The -PassThru parameter is deprecated, use -Select '^PredictorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorListCmdlet"> <summary> Returns a list of predictors created using the <a>CreatePredictor</a> operation. For each predictor, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribePredictor</a> operation. The list can be filtered using an array of <a>Filter</a> objects.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorListCmdlet.Filter"> <summary> <para> <para>An array of filters. For each filter, you provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, <code>Name</code> is the only valid key, which filters on the <code>PredictorName</code> property.</para><ul><li><para><code>Condition</code> - <code>IS</code> or <code>IS_NOT</code></para></li><li><para><code>Key</code> - <code>Name</code></para></li><li><para><code>Value</code> - the value to match</para></li></ul><para>For example, to list all predictors named <i>my_predictor</i>, you would specify:</para><para><code>"Filters": [ { "Condition": "IS", "Key": "Name", "Value": "my_predictor" } ]</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorListCmdlet.MaxResult"> <summary> <para> <para>The number of items to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Predictors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.ListPredictorsResponse). Specifying the name of a property of type Amazon.ForecastService.Model.ListPredictorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.GetFRCPredictorListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet"> <summary> Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following: <ul><li><para><i><code>DataFrequency</code></i> - How frequently your historical time-series data is collected. Amazon Forecast uses this information when training the model and generating a forecast. </para></li><li><para><i><code>Domain</code></i> and <i><code>DatasetType</code></i> - 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. </para></li><li><para><i><code>Schema</code></i> - A schema specifies the fields of the dataset, including the field name and data type. </para></li></ul><para> After creating a dataset, you import your training data into the dataset and add the dataset to a dataset group. You then use the dataset group to create a predictor. For more information, see <a>howitworks-datasets-groups</a>. </para><para> To get a list of all your datasets, use the <a>ListDatasets</a> operation. </para><note><para> The <code>Status</code> of a dataset must be <code>ACTIVE</code> before you can import training data. Use the <a>DescribeDataset</a> operation to get the status. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.Schema_Attribute"> <summary> <para> <para>An array of attributes specifying the name and type of each field in a dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.DataFrequency"> <summary> <para> <para>The frequency of data collection.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.DatasetName"> <summary> <para> <para>A name for the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.DatasetType"> <summary> <para> <para>The dataset type. Valid values depend on the chosen <code>Domain</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.Domain"> <summary> <para> <para>The domain associated with the dataset. The <code>Domain</code> and <code>DatasetType</code> 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 <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the <code>DatasetType</code>, Amazon Forecast requires <code>item_id</code>, <code>timestamp</code>, and <code>demand</code> fields to be present in your data. For more information, see <a>howitworks-datasets-groups</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.EncryptionConfig_KMSKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.EncryptionConfig_RoleArn"> <summary> <para> <para>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the AWS KMS key.</para><para>Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an <code>InvalidInputException</code> is thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.CreateDatasetResponse). Specifying the name of a property of type Amazon.ForecastService.Model.CreateDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetName parameter. The -PassThru parameter is deprecated, use -Select '^DatasetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetGroupCmdlet"> <summary> Creates an Amazon Forecast dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or you can add datasets later with the <a>UpdateDatasetGroup</a> operation. <para> After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see <a>howitworks-datasets-groups</a>. </para><para> To get a list of all your datasets groups, use the <a>ListDatasetGroups</a> operation. </para><note><para> The <code>Status</code> of a dataset group must be <code>ACTIVE</code> before you can create a predictor using the dataset group. Use the <a>DescribeDatasetGroup</a> operation to get the status. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetGroupCmdlet.DatasetArn"> <summary> <para> <para>An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetGroupCmdlet.DatasetGroupName"> <summary> <para> <para>A name for the dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetGroupCmdlet.Domain"> <summary> <para> <para>The domain associated with the dataset group. The <code>Domain</code> and <code>DatasetType</code> 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 <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the <code>DatasetType</code>, Amazon Forecast requires <code>item_id</code>, <code>timestamp</code>, and <code>demand</code> fields to be present in your data. For more information, see <a>howitworks-datasets-groups</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetGroupArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.CreateDatasetGroupResponse). Specifying the name of a property of type Amazon.ForecastService.Model.CreateDatasetGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetGroupName parameter. The -PassThru parameter is deprecated, use -Select '^DatasetGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet"> <summary> 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. <para> You must specify a <a>DataSource</a> object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. For more information, see <a>aws-forecast-iam-roles</a>. </para><para> Two properties of the training data are optionally specified: </para><ul><li><para> The delimiter that separates the data fields. </para><para> The default delimiter is a comma (,), which is the only supported delimiter in this release. </para></li><li><para> The format of timestamps. </para><para> If the format is not specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss". </para></li></ul><para> When Amazon Forecast uploads your training data, it verifies that the data was collected at the <code>DataFrequency</code> specified when the target dataset was created. For more information, see <a>CreateDataset</a> and <a>howitworks-datasets-groups</a>. Amazon Forecast also verifies the delimiter and timestamp format. </para><para> You can use the <a>ListDatasetImportJobs</a> operation to get a list of all your dataset import jobs, filtered by specified criteria. </para><para> To get a list of all your dataset import jobs, filtered by the specified criteria, use the <a>ListDatasetGroups</a> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet.DatasetImportJobName"> <summary> <para> <para>The name for the dataset import job. It is recommended to include the current timestamp in the name to guard against getting a <code>ResourceAlreadyExistsException</code> exception, for example, <code>20190721DatasetImport</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet.S3Config_KMSKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet.S3Config_Path"> <summary> <para> <para>The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet.S3Config_RoleArn"> <summary> <para> <para>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or file(s).</para><para>Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an <code>InvalidInputException</code> is thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet.TimestampFormat"> <summary> <para> <para>The format of timestamps in the dataset. Two formats are supported, dependent on the <code>DataFrequency</code> specified when the dataset was created.</para><ul><li><para>"yyyy-MM-dd"</para><para>For data frequencies: Y, M, W, and D</para></li><li><para>"yyyy-MM-dd HH:mm:ss"</para><para>For data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetImportJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.CreateDatasetImportJobResponse). Specifying the name of a property of type Amazon.ForecastService.Model.CreateDatasetImportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCDatasetImportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastCmdlet"> <summary> Creates a forecast for each item in the <code>TARGET_TIME_SERIES</code> dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3), use the <a>CreateForecastExportJob</a> operation. <para> The range of the forecast is determined by the <code>ForecastHorizon</code>, specified in the <a>CreatePredictor</a> request, multiplied by the <code>DataFrequency</code>, specified in the <a>CreateDataset</a> request. When you query a forecast, you can request a specific date range within the complete forecast. </para><para> To get a list of all your forecasts, use the <a>ListForecasts</a> operation. </para><note><para> The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor. </para></note><para> For more information, see <a>howitworks-forecast</a>. </para><note><para> The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the forecast. Use the <a>DescribeForecast</a> operation to get the status. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastCmdlet.ForecastName"> <summary> <para> <para>The name for the forecast.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastCmdlet.PredictorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ForecastArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.CreateForecastResponse). Specifying the name of a property of type Amazon.ForecastService.Model.CreateForecastResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PredictorArn parameter. The -PassThru parameter is deprecated, use -Select '^PredictorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastExportJobCmdlet"> <summary> Exports a forecast created by the <a>CreateForecast</a> operation to your Amazon Simple Storage Service (Amazon S3) bucket. <para> You must specify a <a>DataDestination</a> 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 <a>aws-forecast-iam-roles</a>. </para><para> For more information, see <a>howitworks-forecast</a>. </para><para> To get a list of all your forecast export jobs, use the <a>ListForecastExportJobs</a> operation. </para><note><para> The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before you can access the forecast in your Amazon S3 bucket. Use the <a>DescribeForecastExportJob</a> operation to get the status. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastExportJobCmdlet.ForecastArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the forecast that you want to export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastExportJobCmdlet.ForecastExportJobName"> <summary> <para> <para>The name for the forecast export job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastExportJobCmdlet.S3Config_KMSKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastExportJobCmdlet.S3Config_Path"> <summary> <para> <para>The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastExportJobCmdlet.S3Config_RoleArn"> <summary> <para> <para>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or file(s).</para><para>Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an <code>InvalidInputException</code> is thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ForecastExportJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.CreateForecastExportJobResponse). Specifying the name of a property of type Amazon.ForecastService.Model.CreateForecastExportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastExportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ForecastArn parameter. The -PassThru parameter is deprecated, use -Select '^ForecastArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCForecastExportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet"> <summary> Creates an Amazon Forecast predictor. <para> In the request, you provide a dataset group and either specify an algorithm or let Amazon Forecast choose the algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters. </para><para> Amazon Forecast uses the chosen algorithm to train a model using the latest version of the datasets in the specified dataset group. The result is called a predictor. You then generate a forecast using the <a>CreateForecast</a> operation. </para><para> After training a model, the <code>CreatePredictor</code> operation also evaluates it. To see the evaluation metrics, use the <a>GetAccuracyMetrics</a> operation. Always review the evaluation metrics before deciding to use the predictor to generate a forecast. </para><para> Optionally, you can specify a featurization configuration to fill and aggragate the data fields in the <code>TARGET_TIME_SERIES</code> dataset to improve model training. For more information, see <a>FeaturizationConfig</a>. </para><para><b>AutoML</b></para><para> If you set <code>PerformAutoML</code> to <code>true</code>, Amazon Forecast evaluates each algorithm and chooses the one that minimizes the <code>objective function</code>. The <code>objective function</code> is defined as the mean of the weighted p10, p50, and p90 quantile losses. For more information, see <a>EvaluationResult</a>. </para><para> When AutoML is enabled, the following properties are disallowed: </para><ul><li><para><code>AlgorithmArn</code></para></li><li><para><code>HPOConfig</code></para></li><li><para><code>PerformHPO</code></para></li><li><para><code>TrainingParameters</code></para></li></ul><para> To get a list of all your predictors, use the <a>ListPredictors</a> operation. </para><note><para> The <code>Status</code> of the predictor must be <code>ACTIVE</code>, signifying that training has completed, before you can use the predictor to create a forecast. Use the <a>DescribePredictor</a> operation to get the status. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.AlgorithmArn"> <summary> <para> Amazon.ForecastService.Model.CreatePredictorRequest.AlgorithmArn </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.EvaluationParameters_BackTestWindowOffset"> <summary> <para> <para>The point from the end of the dataset where you want to split the data for model training and evaluation. The value is specified as the number of data points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.ParameterRanges_CategoricalParameterRange"> <summary> <para> <para>Specifies the tunable range for each categorical hyperparameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.ParameterRanges_ContinuousParameterRange"> <summary> <para> <para>Specifies the tunable range for each continuous hyperparameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.InputDataConfig_DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.FeaturizationConfig_Featurization"> <summary> <para> <para>An array of featurization (transformation) information for the fields of a dataset. In this release, only a single featurization is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.FeaturizationConfig_ForecastDimension"> <summary> <para> <para>An array of dimension (field) names that specify how to group the generated forecast.</para><para>For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a <code>store_id</code> field. If you want the sales forecast for each item by store, you would specify <code>store_id</code> as the dimension.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.FeaturizationConfig_ForecastFrequency"> <summary> <para> <para>The frequency of predictions in a forecast.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.ForecastHorizon"> <summary> <para> <para>Specifies the number of time-steps that the model is trained to predict. The forecast horizon is also called the prediction length.</para><para>For example, if you configure a dataset for daily data collection (using the <code>DataFrequency</code> parameter of the <a>CreateDataset</a> operation) and set the forecast horizon to 10, the model returns predictions for 10 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.ParameterRanges_IntegerParameterRange"> <summary> <para> <para>Specifies the tunable range for each integer hyperparameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.EncryptionConfig_KMSKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.EvaluationParameters_NumberOfBacktestWindow"> <summary> <para> <para>The number of times to split the input data. The default is 1. The range is 1 through 5.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.PerformAutoML"> <summary> <para> <para>Whether to perform AutoML. The default value is <code>false</code>. In this case, you are required to specify an algorithm.</para><para>If you want Amazon Forecast to evaluate the algorithms it provides and choose the best algorithm and configuration for your training dataset, set <code>PerformAutoML</code> to <code>true</code>. This is a good option if you aren't sure which algorithm is suitable for your application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.PerformHPO"> <summary> <para> <para>Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as a hyperparameter tuning job.</para><para>The default value is <code>false</code>. In this case, Amazon Forecast uses default hyperparameter values from the chosen algorithm.</para><para>To override the default values, set <code>PerformHPO</code> to <code>true</code> and supply the <a>HyperParameterTuningJobConfig</a> object. The tuning job specifies an objective metric, the hyperparameters to optimize, and the valid range for each hyperparameter.</para><para>The following algorithms support HPO:</para><ul><li><para>DeepAR+</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.PredictorName"> <summary> <para> <para>A name for the predictor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.EncryptionConfig_RoleArn"> <summary> <para> <para>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the AWS KMS key.</para><para>Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an <code>InvalidInputException</code> is thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.InputDataConfig_SupplementaryFeature"> <summary> <para> <para>An array of supplementary features. For this release, the only supported feature is a holiday calendar.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.TrainingParameter"> <summary> <para> <para>The training parameters to override for model training. The parameters that you can override are listed in the individual algorithms in <a>aws-forecast-choosing-recipes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.Select"> <summary> 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.CreatePredictorResponse). Specifying the name of a property of type Amazon.ForecastService.Model.CreatePredictorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.NewFRCPredictorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetCmdlet"> <summary> Deletes an Amazon Forecast dataset created using the <a>CreateDataset</a> operation. To be deleted, the dataset must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribeDataset</a> operation to get the status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DeleteDatasetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetGroupCmdlet"> <summary> Deletes a dataset group created using the <a>CreateDatasetGroup</a> operation. To be deleted, the dataset group must have a status of <code>ACTIVE</code>, <code>CREATE_FAILED</code>, or <code>UPDATE_FAILED</code>. Use the <a>DescribeDatasetGroup</a> operation to get the status. <para> The operation deletes only the dataset group, not the datasets in the group. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetGroupCmdlet.DatasetGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DeleteDatasetGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetGroupArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetImportJobCmdlet"> <summary> Deletes a dataset import job created using the <a>CreateDatasetImportJob</a> operation. To be deleted, the import job must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribeDatasetImportJob</a> operation to get the status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetImportJobCmdlet.DatasetImportJobArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset import job to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DeleteDatasetImportJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetImportJobArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetImportJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCDatasetImportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastCmdlet"> <summary> Deletes a forecast created using the <a>CreateForecast</a> operation. To be deleted, the forecast must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribeForecast</a> operation to get the status. <para> You can't delete a forecast while it is being exported. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastCmdlet.ForecastArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the forecast to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DeleteForecastResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ForecastArn parameter. The -PassThru parameter is deprecated, use -Select '^ForecastArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastExportJobCmdlet"> <summary> Deletes a forecast export job created using the <a>CreateForecastExportJob</a> operation. To be deleted, the export job must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribeForecastExportJob</a> operation to get the status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastExportJobCmdlet.ForecastExportJobArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the forecast export job to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DeleteForecastExportJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastExportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ForecastExportJobArn parameter. The -PassThru parameter is deprecated, use -Select '^ForecastExportJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCForecastExportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCPredictorCmdlet"> <summary> Deletes a predictor created using the <a>CreatePredictor</a> operation. To be deleted, the predictor must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribePredictor</a> operation to get the status. <para> Any forecasts generated by the predictor will no longer be available. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCPredictorCmdlet.PredictorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the predictor to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCPredictorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.DeletePredictorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCPredictorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PredictorArn parameter. The -PassThru parameter is deprecated, use -Select '^PredictorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.RemoveFRCPredictorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FRC.UpdateFRCDatasetGroupCmdlet"> <summary> Replaces any existing datasets in the dataset group with the specified datasets. <note><para> The <code>Status</code> of the dataset group must be <code>ACTIVE</code> before creating a predictor using the dataset group. Use the <a>DescribeDatasetGroup</a> operation to get the status. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.UpdateFRCDatasetGroupCmdlet.DatasetArn"> <summary> <para> <para>An array of Amazon Resource Names (ARNs) of the datasets to add to the dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.UpdateFRCDatasetGroupCmdlet.DatasetGroupArn"> <summary> <para> <para>The ARN of the dataset group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.UpdateFRCDatasetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.UpdateDatasetGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.UpdateFRCDatasetGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetGroupArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRC.UpdateFRCDatasetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |