AWS.Tools.ForecastQueryService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ForecastQueryService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQForecastCmdlet"> <summary> Retrieves a forecast for a single item, filtered by the supplied criteria. <para> The criteria is a key-value pair. The key is either <c>item_id</c> (or the equivalent non-timestamp, non-target field) from the <c>TARGET_TIME_SERIES</c> dataset, or one of the forecast dimensions specified as part of the <c>FeaturizationConfig</c> object. </para><para> By default, <c>QueryForecast</c> returns the complete date range for the filtered forecast. You can request a specific date range. </para><para> To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQForecastCmdlet.EndDate"> <summary> <para> <para>The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQForecastCmdlet.Filter"> <summary> <para> <para>The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for <c>client_21</c> in the electricity usage dataset, specify the following:</para><para><c>{"item_id" : "client_21"}</c></para><para>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQForecastCmdlet.ForecastArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the forecast to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQForecastCmdlet.StartDate"> <summary> <para> <para>The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQForecastCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQForecastCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Forecast'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastQueryService.Model.QueryForecastResponse). Specifying the name of a property of type Amazon.ForecastQueryService.Model.QueryForecastResponse 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.FRCQ.SelectFRCQForecastCmdlet.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.FRCQ.SelectFRCQForecastCmdlet.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.FRCQ.SelectFRCQWhatIfForecastCmdlet"> <summary> Retrieves a what-if forecast. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQWhatIfForecastCmdlet.EndDate"> <summary> <para> <para>The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQWhatIfForecastCmdlet.Filter"> <summary> <para> <para>The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for <c>client_21</c> in the electricity usage dataset, specify the following:</para><para><c>{"item_id" : "client_21"}</c></para><para>To get the full what-if forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html">CreateForecastExportJob</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQWhatIfForecastCmdlet.StartDate"> <summary> <para> <para>The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQWhatIfForecastCmdlet.WhatIfForecastArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the what-if forecast to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQWhatIfForecastCmdlet.NextToken"> <summary> <para> <para>If the result of the previous request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQWhatIfForecastCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Forecast'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastQueryService.Model.QueryWhatIfForecastResponse). Specifying the name of a property of type Amazon.ForecastQueryService.Model.QueryWhatIfForecastResponse 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.FRCQ.SelectFRCQWhatIfForecastCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WhatIfForecastArn parameter. The -PassThru parameter is deprecated, use -Select '^WhatIfForecastArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FRCQ.SelectFRCQWhatIfForecastCmdlet.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> |