Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(client-forecast*): fix API docs #1981

Merged
merged 1 commit into from
Jan 29, 2021
Merged

fix(client-forecast*): fix API docs #1981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 15 additions & 5 deletions clients/client-forecast/Forecast.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,11 +520,21 @@ export class Forecast extends ForecastClient {
}

/**
* <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreatePredictor</a> operation. Two CSV files are exported to a specified
* S3 bucket.</p>
* <p>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>.</p>
* <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreatePredictor</a> operation. Two folders containing CSV files are exported
* to your specified S3 bucket.</p>
* <p> The export file names will match the following conventions:</p>
* <p>
* <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>
* </p>
* <p>The <ExportTimestamp> component is in Java SimpleDate format
* (yyyy-MM-ddTHH-mm-ssZ).</p>
* <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
* bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
* bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
* <note>
* <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before
* you can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribePredictorBacktestExportJob</a> operation.</p>
* </note>
*/
public createPredictorBacktestExportJob(
args: CreatePredictorBacktestExportJobCommandInput,
Expand Down
20 changes: 15 additions & 5 deletions clients/client-forecast/commands/CreatePredictorBacktestExportJobCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,21 @@ export type CreatePredictorBacktestExportJobCommandInput = CreatePredictorBackte
export type CreatePredictorBacktestExportJobCommandOutput = CreatePredictorBacktestExportJobResponse & __MetadataBearer;

/**
* <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreatePredictor</a> operation. Two CSV files are exported to a specified
* S3 bucket.</p>
* <p>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>.</p>
* <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreatePredictor</a> operation. Two folders containing CSV files are exported
* to your specified S3 bucket.</p>
* <p> The export file names will match the following conventions:</p>
* <p>
* <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>
* </p>
* <p>The <ExportTimestamp> component is in Java SimpleDate format
* (yyyy-MM-ddTHH-mm-ssZ).</p>
* <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
* bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
* bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
* <note>
* <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before
* you can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribePredictorBacktestExportJob</a> operation.</p>
* </note>
*/
export class CreatePredictorBacktestExportJobCommand extends $Command<
CreatePredictorBacktestExportJobCommandInput,
Expand Down
92 changes: 78 additions & 14 deletions clients/client-forecast/models/models_0.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,9 +476,38 @@ export interface CreateDatasetImportJobRequest {
*/
TimestampFormat?: string;

/**
* <p>A single time zone for every item in your dataset. This option is ideal for datasets
* with all timestamps within a single time zone, or if all timestamps are normalized to a
* single time zone. </p>
* <p>Refer to the <a href="http://joda-time.sourceforge.net/timezones.html">Joda-Time
* API</a> for a complete list of valid time zone names.</p>
*/
TimeZone?: string;

/**
* <p>Automatically derive time zone information from the geolocation attribute. This option
* is ideal for datasets that contain timestamps in multiple time zones and those
* timestamps are expressed in local time.</p>
*/
UseGeolocationForTimeZone?: boolean;

/**
* <p>The format of the geolocation attribute. The geolocation attribute can be formatted in
* one of two ways:</p>
* <ul>
* <li>
* <p>
* <code>LAT_LONG</code> - the latitude and longitude in decimal format (Example: 47.61_-122.33).</p>
* </li>
* <li>
* <p>
* <code>CC_POSTALCODE</code> (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).</p>
* </li>
* </ul>
*/
GeolocationFormat?: string;

/**
* <p>The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
* <p>The following basic restrictions apply to tags:</p>
Expand Down Expand Up @@ -600,8 +629,8 @@ export namespace CreateForecastResponse {
}

/**
* <p>The destination for an export job, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
* to access the location and, optionally, an AWS Key Management Service (KMS) key. </p>
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
*/
export interface DataDestination {
/**
Expand Down Expand Up @@ -1109,19 +1138,40 @@ export namespace HyperParameterTuningJobConfig {
}

/**
* <p>Describes a supplementary feature of a dataset group. This object is part of the <a>InputDataConfig</a> object.</p>
* <p>The only supported feature is Holidays. If you use the calendar, all data in the
* datasets should belong to the same country as the calendar. For the holiday calendar data, see
* the <a href="http://jollyday.sourceforge.net/data.html">Jollyday</a> website.</p>
* <p>Describes a supplementary feature of a dataset group. This object is part of the <a>InputDataConfig</a> object. Forecast supports the Weather Index and Holidays built-in
* featurizations.</p>
* <p>
* <b>Weather Index</b>
* </p>
* <p>The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and
* projected weather information into your model. The Weather Index supplements your datasets
* with over two years of historical weather data and up to 14 days of projected weather data.
* For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/weather.html">Amazon Forecast Weather Index</a>.</p>
* <p>
* <b>Holidays</b>
* </p>
* <p>Holidays is a built-in featurization that incorporates a feature-engineered dataset of
* national holiday information into your model. It provides native support for the holiday
* calendars of 66 countries. To view the holiday calendars, refer to the <a href="http://jollyday.sourceforge.net/data.html">Jollyday</a> library. For more
* information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/holidays.html">Holidays Featurization</a>.</p>
*/
export interface SupplementaryFeature {
/**
* <p>The name of the feature. This must be "holiday".</p>
* <p>The name of the feature. Valid values: <code>"holiday"</code> and <code>"weather"</code>.</p>
*/
Name: string | undefined;

/**
* <p>One of the following 2 letter country codes:</p>
* <p>
* <b>Weather Index</b>
* </p>
* <p>To enable the Weather Index, set the value to <code>"true"</code>
* </p>
* <p>
* <b>Holidays</b>
* </p>
* <p>To enable Holidays, specify a country with one of the following two-letter country
* codes:</p>
* <ul>
* <li>
* <p>"AL" - ALBANIA</p>
Expand Down Expand Up @@ -1558,8 +1608,8 @@ export interface CreatePredictorBacktestExportJobRequest {
PredictorArn: string | undefined;

/**
* <p>The destination for an export job, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
* to access the location and, optionally, an AWS Key Management Service (KMS) key. </p>
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
*/
Destination: DataDestination | undefined;

Expand Down Expand Up @@ -2014,9 +2064,23 @@ export interface DescribeDatasetImportJobResponse {
*/
TimestampFormat?: string;

/**
* <p>The single time zone applied to every item in the dataset</p>
*/
TimeZone?: string;

/**
* <p>Whether <code>TimeZone</code> is automatically derived from the geolocation
* attribute.</p>
*/
UseGeolocationForTimeZone?: boolean;

/**
* <p>The format of the geolocation attribute. Valid Values:<code>"LAT_LONG"</code> and
* <code>"CC_POSTALCODE"</code>.</p>
*/
GeolocationFormat?: string;

/**
* <p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast
* can assume to access the data.</p>
Expand Down Expand Up @@ -2559,8 +2623,8 @@ export interface DescribePredictorBacktestExportJobResponse {
PredictorArn?: string;

/**
* <p>The destination for an export job, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
* to access the location and, optionally, an AWS Key Management Service (KMS) key. </p>
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
*/
Destination?: DataDestination;

Expand Down Expand Up @@ -3560,8 +3624,8 @@ export interface PredictorBacktestExportJobSummary {
PredictorBacktestExportJobName?: string;

/**
* <p>The destination for an export job, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
* to access the location and, optionally, an AWS Key Management Service (KMS) key. </p>
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
*/
Destination?: DataDestination;

Expand Down
2 changes: 0 additions & 2 deletions clients/client-forecastquery/models/models_0.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,6 @@ export interface Forecast {
* <p>p90</p>
* </li>
* </ul>
* <p>The default setting is <code>["0.1", "0.5", "0.9"]</code>. Use the optional <code>ForecastTypes</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html">CreateForecast</a> operation to change the values. The values will vary depending on how this is set, with a minimum of <code>1</code> and a maximum of <code>5.</code>
* </p>
*/
Predictions?: { [key: string]: DataPoint[] };
}
Expand Down