forecast

package module
v1.34.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 10, 2024 License: Apache-2.0 Imports: 43 Imported by: 8

Documentation

Overview

Package forecast provides the API client, operations, and parameter types for Amazon Forecast Service.

Provides APIs for creating and managing Amazon Forecast resources.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-06-26"
View Source 
const ServiceID = "forecast"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.26.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.29.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.29.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.29.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.29.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Forecast Service.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateAutoPredictor added in v1.14.0 

func (c *Client) CreateAutoPredictor(ctx context.Context, params *CreateAutoPredictorInput, optFns ...func(*Options)) (*CreateAutoPredictorOutput, error)

Creates an Amazon Forecast predictor.

Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictorto create new predictors or upgrade/retrain existing predictors.

Creating new predictors

The following parameters are required when creating a new predictor:

  • PredictorName - A unique name for the predictor.

  • DatasetGroupArn - The ARN of the dataset group used to train the predictor.

  • ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc).

  • ForecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

When creating a new predictor, do not specify a value for ReferencePredictorArn .

Upgrading and retraining predictors

The following parameters are required when retraining or upgrading a predictor:

  • PredictorName - A unique name for the predictor.

  • ReferencePredictorArn - The ARN of the predictor to retrain or upgrade.

When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and PredictorName .

func (*Client) CreateDataset 

func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error)

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:

  • DataFrequency - How frequently your historical time-series data is collected.

  • Domain and DatasetType - 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.

  • Schema - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets.

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDatasetoperation to get the status.

func (*Client) CreateDatasetGroup 

func (c *Client) CreateDatasetGroup(ctx context.Context, params *CreateDatasetGroupInput, optFns ...func(*Options)) (*CreateDatasetGroupOutput, error)

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroupoperation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroupoperation.

func (*Client) CreateDatasetImportJob 

func (c *Client) CreateDatasetImportJob(ctx context.Context, params *CreateDatasetImportJobInput, optFns ...func(*Options)) (*CreateDatasetImportJobOutput, error)

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.

You must specify a DataSource object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal Amazon Web Services system. For more information, see Set up permissions.

The training data must be in CSV or Parquet format. The delimiter must be a comma (,).

You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.

Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobsoperation.

func (*Client) CreateExplainability added in v1.14.0 

func (c *Client) CreateExplainability(ctx context.Context, params *CreateExplainabilityInput, optFns ...func(*Options)) (*CreateExplainabilityOutput, error)

Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor )

Creates an Amazon Forecast Explainability.

Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they increase or decrease forecast values.

To enable Forecast Explainability, your predictor must include at least one of the following: related time series, item metadata, or additional datasets like Holidays and the Weather Index.

CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time series and time points, provide a Forecast ARN.

CreateExplainability with a Predictor ARN

You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor in CreateAutoPredictor, that predictor already has an Explainability resource.

The following parameters are required when providing a Predictor ARN:

  • ExplainabilityName - A unique name for the Explainability.

  • ResourceArn - The Arn of the predictor.

  • TimePointGranularity - Must be set to “ALL”.

  • TimeSeriesGranularity - Must be set to “ALL”.

Do not specify a value for the following parameters:

  • DataSource - Only valid when TimeSeriesGranularity is “SPECIFIC”.

  • Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”.

  • StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”.

  • EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”.

CreateExplainability with a Forecast ARN

You can specify a maximum of 50 time series and 500 time points.

The following parameters are required when providing a Predictor ARN:

  • ExplainabilityName - A unique name for the Explainability.

  • ResourceArn - The Arn of the forecast.

  • TimePointGranularity - Either “ALL” or “SPECIFIC”.

  • TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.

If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:

  • DataSource - The S3 location of the CSV file specifying your time series.

  • Schema - The Schema defines the attributes and attribute types listed in the Data Source.

If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:

  • StartDateTime - The first timestamp in the range of time points.

  • EndDateTime - The last timestamp in the range of time points.

func (*Client) CreateExplainabilityExport added in v1.14.0 

func (c *Client) CreateExplainabilityExport(ctx context.Context, params *CreateExplainabilityExportInput, optFns ...func(*Options)) (*CreateExplainabilityExportOutput, error)

Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.

You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExportoperation.

func (*Client) CreateForecast 

func (c *Client) CreateForecast(ctx context.Context, params *CreateForecastInput, optFns ...func(*Options)) (*CreateForecastOutput, error)

Creates a forecast for each item in the TARGET_TIME_SERIES 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) bucket, use the CreateForecastExportJoboperation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictorrequest. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecastoperation to get the status.

By default, a forecast includes predictions for every item ( item_id ) in the dataset group that was used to train the predictor. However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.

func (*Client) CreateForecastExportJob 

func (c *Client) CreateForecastExportJob(ctx context.Context, params *CreateForecastExportJobInput, optFns ...func(*Options)) (*CreateForecastExportJobOutput, error)

Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

__

where the component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJoboperation.

func (*Client) CreateMonitor added in v1.20.0 

func (c *Client) CreateMonitor(ctx context.Context, params *CreateMonitorInput, optFns ...func(*Options)) (*CreateMonitorOutput, error)

Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.

func (*Client) CreatePredictor 

func (c *Client) CreatePredictor(ctx context.Context, params *CreatePredictorInput, optFns ...func(*Options)) (*CreatePredictorOutput, error)
This operation creates a legacy predictor that does not include all the

predictor functionalities provided by Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use CreateAutoPredictor.

Creates an Amazon Forecast predictor.

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecastoperation.

To see the evaluation metrics, use the GetAccuracyMetrics operation.

You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency . TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes .

AutoML

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function , set PerformAutoML to true . The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.

When AutoML is enabled, the following properties are disallowed:

  • AlgorithmArn

  • HPOConfig

  • PerformHPO

  • TrainingParameters

To get a list of all of your predictors, use the ListPredictors operation.

Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE , signifying that training has completed. To get the status, use the DescribePredictoroperation.

func (*Client) CreatePredictorBacktestExportJob added in v0.31.0 

func (c *Client) CreatePredictorBacktestExportJob(ctx context.Context, params *CreatePredictorBacktestExportJobInput, optFns ...func(*Options)) (*CreatePredictorBacktestExportJobOutput, error)

Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket.

The export file names will match the following conventions: 

__.csv

The component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJoboperation.

func (*Client) CreateWhatIfAnalysis added in v1.23.0 

func (c *Client) CreateWhatIfAnalysis(ctx context.Context, params *CreateWhatIfAnalysisInput, optFns ...func(*Options)) (*CreateWhatIfAnalysisOutput, error)

What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.

For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals.

You could create a scenario where everything is given a 25% markdown, and another where everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and another where the sale lasts for one month. With a what-if analysis, you can compare many different scenarios against each other.

Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.

The TimeSeriesSelector object defines the items that you want in the what-if analysis.

func (*Client) CreateWhatIfForecast added in v1.23.0 

func (c *Client) CreateWhatIfForecast(ctx context.Context, params *CreateWhatIfForecastInput, optFns ...func(*Options)) (*CreateWhatIfForecastOutput, error)

A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset.

func (*Client) CreateWhatIfForecastExport added in v1.23.0 

func (c *Client) CreateWhatIfForecastExport(ctx context.Context, params *CreateWhatIfForecastExportInput, optFns ...func(*Options)) (*CreateWhatIfForecastExportOutput, error)

Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions: 

≈__

The component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExportoperation.

func (*Client) DeleteDataset 

func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error)

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED . To get the status use the DescribeDatasetoperation.

Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the UpdateDatasetGroupoperation, omitting the deleted dataset's ARN.

func (*Client) DeleteDatasetGroup 

func (c *Client) DeleteDatasetGroup(ctx context.Context, params *DeleteDatasetGroupInput, optFns ...func(*Options)) (*DeleteDatasetGroupOutput, error)

Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE , CREATE_FAILED , or UPDATE_FAILED . To get the status, use the DescribeDatasetGroupoperation.

This operation deletes only the dataset group, not the datasets in the group.

func (*Client) DeleteDatasetImportJob 

func (c *Client) DeleteDatasetImportJob(ctx context.Context, params *DeleteDatasetImportJobInput, optFns ...func(*Options)) (*DeleteDatasetImportJobOutput, error)

Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED . To get the status, use the DescribeDatasetImportJoboperation.

func (*Client) DeleteExplainability added in v1.14.0 

func (c *Client) DeleteExplainability(ctx context.Context, params *DeleteExplainabilityInput, optFns ...func(*Options)) (*DeleteExplainabilityOutput, error)

Deletes an Explainability resource.

You can delete only predictor that have a status of ACTIVE or CREATE_FAILED . To get the status, use the DescribeExplainabilityoperation.

func (*Client) DeleteExplainabilityExport added in v1.14.0 

func (c *Client) DeleteExplainabilityExport(ctx context.Context, params *DeleteExplainabilityExportInput, optFns ...func(*Options)) (*DeleteExplainabilityExportOutput, error)

Deletes an Explainability export.

func (*Client) DeleteForecast 

func (c *Client) DeleteForecast(ctx context.Context, params *DeleteForecastInput, optFns ...func(*Options)) (*DeleteForecastOutput, error)

Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED . To get the status, use the DescribeForecast operation.

You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.

func (*Client) DeleteForecastExportJob 

func (c *Client) DeleteForecastExportJob(ctx context.Context, params *DeleteForecastExportJobInput, optFns ...func(*Options)) (*DeleteForecastExportJobOutput, error)

Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED . To get the status, use the DescribeForecastExportJoboperation.

func (*Client) DeleteMonitor added in v1.20.0 

func (c *Client) DeleteMonitor(ctx context.Context, params *DeleteMonitorInput, optFns ...func(*Options)) (*DeleteMonitorOutput, error)

Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE , ACTIVE_STOPPED , CREATE_FAILED , or CREATE_STOPPED .

func (*Client) DeletePredictor 

func (c *Client) DeletePredictor(ctx context.Context, params *DeletePredictorInput, optFns ...func(*Options)) (*DeletePredictorOutput, error)

Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED . To get the status, use the DescribePredictoroperation.

func (*Client) DeletePredictorBacktestExportJob added in v0.31.0 

func (c *Client) DeletePredictorBacktestExportJob(ctx context.Context, params *DeletePredictorBacktestExportJobInput, optFns ...func(*Options)) (*DeletePredictorBacktestExportJobOutput, error)

Deletes a predictor backtest export job.

func (*Client) DeleteResourceTree added in v1.4.0 

func (c *Client) DeleteResourceTree(ctx context.Context, params *DeleteResourceTreeInput, optFns ...func(*Options)) (*DeleteResourceTreeOutput, error)

Deletes an entire resource tree. This operation will delete the parent resource and its child resources.

Child resources are resources that were created from another resource. For example, when a forecast is generated from a predictor, the forecast is the child resource and the predictor is the parent resource.

Amazon Forecast resources possess the following parent-child resource hierarchies:

  • Dataset: dataset import jobs

  • Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs

  • Predictor: predictor backtest export jobs, forecasts, forecast export jobs

  • Forecast: forecast export jobs

DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or exported files stored in Amazon S3.

func (*Client) DeleteWhatIfAnalysis added in v1.23.0 

func (c *Client) DeleteWhatIfAnalysis(ctx context.Context, params *DeleteWhatIfAnalysisInput, optFns ...func(*Options)) (*DeleteWhatIfAnalysisOutput, error)

Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if analyses that have a status of ACTIVE or CREATE_FAILED . To get the status, use the DescribeWhatIfAnalysisoperation.

You can't delete a what-if analysis while any of its forecasts are being exported.

func (*Client) DeleteWhatIfForecast added in v1.23.0 

func (c *Client) DeleteWhatIfForecast(ctx context.Context, params *DeleteWhatIfForecastInput, optFns ...func(*Options)) (*DeleteWhatIfForecastOutput, error)

Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if forecasts that have a status of ACTIVE or CREATE_FAILED . To get the status, use the DescribeWhatIfForecastoperation.

You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.

func (*Client) DeleteWhatIfForecastExport added in v1.23.0 

func (c *Client) DeleteWhatIfForecastExport(ctx context.Context, params *DeleteWhatIfForecastExportInput, optFns ...func(*Options)) (*DeleteWhatIfForecastExportOutput, error)

Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation. You can delete only what-if forecast exports that have a status of ACTIVE or CREATE_FAILED . To get the status, use the DescribeWhatIfForecastExportoperation.

func (*Client) DescribeAutoPredictor added in v1.14.0 

func (c *Client) DescribeAutoPredictor(ctx context.Context, params *DescribeAutoPredictorInput, optFns ...func(*Options)) (*DescribeAutoPredictorOutput, error)

Describes a predictor created using the CreateAutoPredictor operation.

func (*Client) DescribeDataset 

func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error)

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the parameters specified in the CreateDataset request, this operation includes the following dataset properties:

  • CreationTime

  • LastModificationTime

  • Status

func (*Client) DescribeDatasetGroup 

func (c *Client) DescribeDatasetGroup(ctx context.Context, params *DescribeDatasetGroupInput, optFns ...func(*Options)) (*DescribeDatasetGroupOutput, error)

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties:

  • DatasetArns - The datasets belonging to the group.

  • CreationTime

  • LastModificationTime

  • Status

func (*Client) DescribeDatasetImportJob 

func (c *Client) DescribeDatasetImportJob(ctx context.Context, params *DescribeDatasetImportJobInput, optFns ...func(*Options)) (*DescribeDatasetImportJobOutput, error)

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties:

  • CreationTime

  • LastModificationTime

  • DataSize

  • FieldStatistics

  • Status

  • Message - If an error occurred, information about the error.

func (*Client) DescribeExplainability added in v1.14.0 

func (c *Client) DescribeExplainability(ctx context.Context, params *DescribeExplainabilityInput, optFns ...func(*Options)) (*DescribeExplainabilityOutput, error)

Describes an Explainability resource created using the CreateExplainability operation.

func (*Client) DescribeExplainabilityExport added in v1.14.0 

func (c *Client) DescribeExplainabilityExport(ctx context.Context, params *DescribeExplainabilityExportInput, optFns ...func(*Options)) (*DescribeExplainabilityExportOutput, error)

Describes an Explainability export created using the CreateExplainabilityExport operation.

func (*Client) DescribeForecast 

func (c *Client) DescribeForecast(ctx context.Context, params *DescribeForecastInput, optFns ...func(*Options)) (*DescribeForecastOutput, error)

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties:

  • DatasetGroupArn - The dataset group that provided the training data.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

func (*Client) DescribeForecastExportJob 

func (c *Client) DescribeForecastExportJob(ctx context.Context, params *DescribeForecastExportJobInput, optFns ...func(*Options)) (*DescribeForecastExportJobOutput, error)

Describes a forecast export job created using the CreateForecastExportJob operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

func (*Client) DescribeMonitor added in v1.20.0 

func (c *Client) DescribeMonitor(ctx context.Context, params *DescribeMonitorInput, optFns ...func(*Options)) (*DescribeMonitorOutput, error)

Describes a monitor resource. In addition to listing the properties provided in the CreateMonitorrequest, this operation lists the following properties:

  • Baseline

  • CreationTime

  • LastEvaluationTime

  • LastEvaluationState

  • LastModificationTime

  • Message

  • Status

func (*Client) DescribePredictor 

func (c *Client) DescribePredictor(ctx context.Context, params *DescribePredictorInput, optFns ...func(*Options)) (*DescribePredictorOutput, error)
This operation is only valid for legacy predictors created with

CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor.

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties:

  • DatasetImportJobArns - The dataset import jobs used to import training data.

  • AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

func (*Client) DescribePredictorBacktestExportJob added in v0.31.0 

func (c *Client) DescribePredictorBacktestExportJob(ctx context.Context, params *DescribePredictorBacktestExportJobInput, optFns ...func(*Options)) (*DescribePredictorBacktestExportJobOutput, error)

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message (if an error occurred)

func (*Client) DescribeWhatIfAnalysis added in v1.23.0 

func (c *Client) DescribeWhatIfAnalysis(ctx context.Context, params *DescribeWhatIfAnalysisInput, optFns ...func(*Options)) (*DescribeWhatIfAnalysisOutput, error)

Describes the what-if analysis created using the CreateWhatIfAnalysis operation.

In addition to listing the properties provided in the CreateWhatIfAnalysis request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Message - If an error occurred, information about the error.

  • Status

func (*Client) DescribeWhatIfForecast added in v1.23.0 

func (c *Client) DescribeWhatIfForecast(ctx context.Context, params *DescribeWhatIfForecastInput, optFns ...func(*Options)) (*DescribeWhatIfForecastOutput, error)

Describes the what-if forecast created using the CreateWhatIfForecast operation.

In addition to listing the properties provided in the CreateWhatIfForecast request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Message - If an error occurred, information about the error.

  • Status

func (*Client) DescribeWhatIfForecastExport added in v1.23.0 

func (c *Client) DescribeWhatIfForecastExport(ctx context.Context, params *DescribeWhatIfForecastExportInput, optFns ...func(*Options)) (*DescribeWhatIfForecastExportOutput, error)

Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.

In addition to listing the properties provided in the CreateWhatIfForecastExport request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Message - If an error occurred, information about the error.

  • Status

func (*Client) GetAccuracyMetrics 

func (c *Client) GetAccuracyMetrics(ctx context.Context, params *GetAccuracyMetricsInput, optFns ...func(*Options)) (*GetAccuracyMetricsOutput, error)

Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast. For more information, see Predictor Metrics.

This operation generates metrics for each backtest window that was evaluated. The number of backtest windows ( NumberOfBacktestWindows ) is specified using the EvaluationParametersobject, which is optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't specified, the number defaults to one.

The parameters of the filling method determine which items contribute to the metrics. If you want all items to contribute, specify zero . If you want only those items that have complete data in the range being evaluated to contribute, specify nan . For more information, see FeaturizationMethod.

Before you can get accuracy metrics, the Status of the predictor must be ACTIVE , signifying that training has completed. To get the status, use the DescribePredictoroperation.

func (*Client) ListDatasetGroups 

func (c *Client) ListDatasetGroups(ctx context.Context, params *ListDatasetGroupsInput, optFns ...func(*Options)) (*ListDatasetGroupsOutput, error)

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroupoperation.

func (*Client) ListDatasetImportJobs 

func (c *Client) ListDatasetImportJobs(ctx context.Context, params *ListDatasetImportJobsInput, optFns ...func(*Options)) (*ListDatasetImportJobsOutput, error)

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJoboperation. You can filter the list by providing an array of Filterobjects.

func (*Client) ListDatasets 

func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error)

Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

func (*Client) ListExplainabilities added in v1.14.0 

func (c *Client) ListExplainabilities(ctx context.Context, params *ListExplainabilitiesInput, optFns ...func(*Options)) (*ListExplainabilitiesOutput, error)

Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for each Explainability. You can filter the list using an array of Filterobjects.

To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the DescribeExplainabilityoperation.

func (*Client) ListExplainabilityExports added in v1.14.0 

func (c *Client) ListExplainabilityExports(ctx context.Context, params *ListExplainabilityExportsInput, optFns ...func(*Options)) (*ListExplainabilityExportsOutput, error)

Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filterobjects.

To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainabilityoperation.

func (*Client) ListForecastExportJobs 

func (c *Client) ListForecastExportJobs(ctx context.Context, params *ListForecastExportJobsInput, optFns ...func(*Options)) (*ListForecastExportJobsOutput, error)

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJoboperation. You can filter the list using an array of Filterobjects.

func (*Client) ListForecasts 

func (c *Client) ListForecasts(ctx context.Context, params *ListForecastsInput, optFns ...func(*Options)) (*ListForecastsOutput, error)

Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecastoperation. You can filter the list using an array of Filter objects.

func (*Client) ListMonitorEvaluations added in v1.20.0 

func (c *Client) ListMonitorEvaluations(ctx context.Context, params *ListMonitorEvaluationsInput, optFns ...func(*Options)) (*ListMonitorEvaluationsOutput, error)

Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.

For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.

func (*Client) ListMonitors added in v1.20.0 

func (c *Client) ListMonitors(ctx context.Context, params *ListMonitorsInput, optFns ...func(*Options)) (*ListMonitorsOutput, error)

Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitoroperation.

func (*Client) ListPredictorBacktestExportJobs added in v0.31.0 

func (c *Client) ListPredictorBacktestExportJobs(ctx context.Context, params *ListPredictorBacktestExportJobsInput, optFns ...func(*Options)) (*ListPredictorBacktestExportJobsOutput, error)

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filterobjects.

To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJoboperation.

func (*Client) ListPredictors 

func (c *Client) ListPredictors(ctx context.Context, params *ListPredictorsInput, optFns ...func(*Options)) (*ListPredictorsOutput, error)

Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).

You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You can filter the list using an array of Filterobjects.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags for an Amazon Forecast resource.

func (*Client) ListWhatIfAnalyses added in v1.23.0 

func (c *Client) ListWhatIfAnalyses(ctx context.Context, params *ListWhatIfAnalysesInput, optFns ...func(*Options)) (*ListWhatIfAnalysesOutput, error)

Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysisoperation.

func (*Client) ListWhatIfForecastExports added in v1.23.0 

func (c *Client) ListWhatIfForecastExports(ctx context.Context, params *ListWhatIfForecastExportsInput, optFns ...func(*Options)) (*ListWhatIfForecastExportsOutput, error)

Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation.

func (*Client) ListWhatIfForecasts added in v1.23.0 

func (c *Client) ListWhatIfForecasts(ctx context.Context, params *ListWhatIfForecastsInput, optFns ...func(*Options)) (*ListWhatIfForecastsOutput, error)

Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the DescribeWhatIfForecastoperation.

func (*Client) Options added in v1.30.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) ResumeResource added in v1.20.0 

func (c *Client) ResumeResource(ctx context.Context, params *ResumeResourceInput, optFns ...func(*Options)) (*ResumeResourceOutput, error)

Resumes a stopped monitor resource.

func (*Client) StopResource added in v1.2.0 

func (c *Client) StopResource(ctx context.Context, params *StopResourceInput, optFns ...func(*Options)) (*StopResourceOutput, error)

Stops a resource.

The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED . You cannot resume a resource once it has been stopped.

This operation can be applied to the following resources (and their corresponding child resources):

  • Dataset Import Job

  • Predictor Job

  • Forecast Job

  • Forecast Export Job

  • Predictor Backtest Export Job

  • Explainability Job

  • Explainability Export Job

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Associates the specified tags to a resource with the specified resourceArn . If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Deletes the specified tags from a resource.

func (*Client) UpdateDatasetGroup 

func (c *Client) UpdateDatasetGroup(ctx context.Context, params *UpdateDatasetGroupInput, optFns ...func(*Options)) (*UpdateDatasetGroupOutput, error)

Replaces the datasets in a dataset group with the specified datasets.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroupoperation to get the status.

type CreateAutoPredictorInput added in v1.14.0 

type CreateAutoPredictorInput struct {

	// A unique name for the predictor
	//
	// This member is required.
	PredictorName *string

	// The data configuration for your dataset group and any additional datasets.
	DataConfig *types.DataConfig

	// An Key Management Service (KMS) key and an Identity and Access Management (IAM)
	// role that Amazon Forecast can assume to access the key. You can specify this
	// optional object in the CreateDatasetand CreatePredictor requests.
	EncryptionConfig *types.EncryptionConfig

	// Create an Explainability resource for the predictor.
	ExplainPredictor *bool

	// An array of dimension (field) names that specify how to group the generated
	// forecast.
	//
	// For example, if you are generating forecasts for item sales across all your
	// stores, and your dataset contains a store_id field, you would specify store_id
	// as a dimension to group sales forecasts for each store.
	ForecastDimensions []string

	// The frequency of predictions in a forecast.
	//
	// Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D
	// (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and
	// "15min" indicates every 15 minutes. You cannot specify a value that would
	// overlap with the next larger frequency. That means, for example, you cannot
	// specify a frequency of 60 minutes, because that is equivalent to 1 hour. The
	// valid values for each frequency are the following:
	//
	//   - Minute - 1-59
	//
	//   - Hour - 1-23
	//
	//   - Day - 1-6
	//
	//   - Week - 1-4
	//
	//   - Month - 1-11
	//
	//   - Year - 1
	//
	// Thus, if you want every other week forecasts, specify "2W". Or, if you want
	// quarterly forecasts, you specify "3M".
	//
	// The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset
	// frequency.
	//
	// When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to
	// the RELATED_TIME_SERIES dataset frequency.
	ForecastFrequency *string

	// The number of time-steps that the model predicts. The forecast horizon is also
	// called the prediction length.
	//
	// The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the
	// TARGET_TIME_SERIES dataset length. If you are retraining an existing
	// AutoPredictor, then the maximum forecast horizon is the lesser of 500 time-steps
	// or 1/3 of the TARGET_TIME_SERIES dataset length.
	//
	// If you are upgrading to an AutoPredictor or retraining an existing
	// AutoPredictor, you cannot update the forecast horizon parameter. You can meet
	// this requirement by providing longer time-series in the dataset.
	ForecastHorizon *int32

	// The forecast types used to train a predictor. You can specify up to five
	// forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments
	// of 0.01 or higher. You can also specify the mean forecast with mean .
	ForecastTypes []string

	// The configuration details for predictor monitoring. Provide a name for the
	// monitor resource to enable predictor monitoring.
	//
	// Predictor monitoring allows you to see how your predictor's performance changes
	// over time. For more information, see [Predictor Monitoring].
	//
	// [Predictor Monitoring]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
	MonitorConfig *types.MonitorConfig

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric types.OptimizationMetric

	// The ARN of the predictor to retrain or upgrade. This parameter is only used
	// when retraining or upgrading a predictor. When creating a new predictor, do not
	// specify a value for this parameter.
	//
	// When upgrading or retraining a predictor, only specify values for the
	// ReferencePredictorArn and PredictorName . The value for PredictorName must be a
	// unique predictor name.
	ReferencePredictorArn *string

	// Optional metadata to help you categorize and organize your predictors. Each tag
	// consists of a key and an optional value, both of which you define. Tag keys and
	// values are case sensitive.
	//
	// The following restrictions apply to tags:
	//
	//   - For each resource, each tag key must be unique and each tag key must have
	//   one value.
	//
	//   - Maximum number of tags per resource: 50.
	//
	//   - Maximum key length: 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length: 256 Unicode characters in UTF-8.
	//
	//   - Accepted characters: all letters and numbers, spaces representable in
	//   UTF-8, and + - = . _ : / @. If your tagging schema is used across other services
	//   and resources, the character restrictions of those services also apply.
	//
	//   - Key prefixes cannot include any upper or lowercase combination of aws: or
	//   AWS: . Values can have this prefix. If a tag value has aws as its prefix but
	//   the key does not, Forecast considers it to be a user tag and will count against
	//   the limit of 50 tags. Tags with only the key prefix of aws do not count
	//   against your tags per resource limit. You cannot edit or delete tag keys with
	//   this prefix.
	Tags []types.Tag

	// The time boundary Forecast uses to align and aggregate any data that doesn't
	// align with your forecast frequency. Provide the unit of time and the time
	// boundary as a key value pair. For more information on specifying a time
	// boundary, see [Specifying a Time Boundary]. If you don't provide a time boundary, Forecast uses a set of [Default Time Boundaries].
	//
	// [Specifying a Time Boundary]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
	// [Default Time Boundaries]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
	TimeAlignmentBoundary *types.TimeAlignmentBoundary
	// contains filtered or unexported fields
}

type CreateAutoPredictorOutput added in v1.14.0 

type CreateAutoPredictorOutput struct {

	// The Amazon Resource Name (ARN) of the predictor.
	PredictorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatasetGroupInput 

type CreateDatasetGroupInput struct {

	// A name for the dataset group.
	//
	// This member is required.
	DatasetGroupName *string

	// The domain associated with the dataset group. When you add a dataset to a
	// dataset group, this value and the value specified for the Domain parameter of
	// the [CreateDataset]operation must match.
	//
	// The Domain and DatasetType that you choose determine the fields that must be
	// present in training data that you import to a dataset. For example, if you
	// choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType , Amazon
	// Forecast requires that item_id , timestamp , and demand fields are present in
	// your data. For more information, see [Dataset groups].
	//
	// [CreateDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
	// [Dataset groups]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
	//
	// This member is required.
	Domain types.Domain

	// An array of Amazon Resource Names (ARNs) of the datasets that you want to
	// include in the dataset group.
	DatasetArns []string

	// The optional metadata that you apply to the dataset group to help you
	// categorize and organize them. Each tag consists of a key and an optional value,
	// both of which you define.
	//
	// The following basic restrictions apply to tags:
	//
	//   - Maximum number of tags per resource - 50.
	//
	//   - For each resource, each tag key must be unique, and each tag key can have
	//   only one value.
	//
	//   - Maximum key length - 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length - 256 Unicode characters in UTF-8.
	//
	//   - If your tagging schema is used across multiple services and resources,
	//   remember that other services may have restrictions on allowed characters.
	//   Generally allowed characters are: letters, numbers, and spaces representable in
	//   UTF-8, and the following characters: + - = . _ : / @.
	//
	//   - Tag keys and values are case sensitive.
	//
	//   - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
	//   prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
	//   or delete tag keys with this prefix. Values can have this prefix. If a tag value
	//   has aws as its prefix but the key does not, then Forecast considers it to be a
	//   user tag and will count against the limit of 50 tags. Tags with only the key
	//   prefix of aws do not count against your tags per resource limit.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDatasetGroupOutput 

type CreateDatasetGroupOutput struct {

	// The Amazon Resource Name (ARN) of the dataset group.
	DatasetGroupArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatasetImportJobInput 

type CreateDatasetImportJobInput struct {

	// The location of the training data to import and an Identity and Access
	// Management (IAM) role that Amazon Forecast can assume to access the data. The
	// training data must be stored in an Amazon S3 bucket.
	//
	// If encryption is used, DataSource must include an Key Management Service (KMS)
	// key and the IAM role must allow Amazon Forecast permission to access the key.
	// The KMS key and IAM role must match those specified in the EncryptionConfig
	// parameter of the [CreateDataset]operation.
	//
	// [CreateDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
	//
	// This member is required.
	DataSource *types.DataSource

	// The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to
	// import data to.
	//
	// This member is required.
	DatasetArn *string

	// The name for the dataset import job. We recommend including the current
	// timestamp in the name, for example, 20190721DatasetImport . This can help you
	// avoid getting a ResourceAlreadyExistsException exception.
	//
	// This member is required.
	DatasetImportJobName *string

	// The format of the imported data, CSV or PARQUET. The default value is CSV.
	Format *string

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

	// Specifies whether the dataset import job is a FULL or INCREMENTAL import. A FULL
	// dataset import replaces all of the existing data with the newly imported data.
	// An INCREMENTAL import appends the imported data to the existing data.
	ImportMode types.ImportMode

	// The optional metadata that you apply to the dataset import job to help you
	// categorize and organize them. Each tag consists of a key and an optional value,
	// both of which you define.
	//
	// The following basic restrictions apply to tags:
	//
	//   - Maximum number of tags per resource - 50.
	//
	//   - For each resource, each tag key must be unique, and each tag key can have
	//   only one value.
	//
	//   - Maximum key length - 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length - 256 Unicode characters in UTF-8.
	//
	//   - If your tagging schema is used across multiple services and resources,
	//   remember that other services may have restrictions on allowed characters.
	//   Generally allowed characters are: letters, numbers, and spaces representable in
	//   UTF-8, and the following characters: + - = . _ : / @.
	//
	//   - Tag keys and values are case sensitive.
	//
	//   - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
	//   prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
	//   or delete tag keys with this prefix. Values can have this prefix. If a tag value
	//   has aws as its prefix but the key does not, then Forecast considers it to be a
	//   user tag and will count against the limit of 50 tags. Tags with only the key
	//   prefix of aws do not count against your tags per resource limit.
	Tags []types.Tag

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

	// The format of timestamps in the dataset. The format that you specify depends on
	// the DataFrequency specified when the dataset was created. The following formats
	// are supported
	//
	//   - "yyyy-MM-dd"
	//
	// For the following data frequencies: Y, M, W, and D
	//
	//   - "yyyy-MM-dd HH:mm:ss"
	//
	// For the following data frequencies: H, 30min, 15min, and 1min; and optionally,
	//   for: Y, M, W, and D
	//
	// If the format isn't specified, Amazon Forecast expects the format to be
	// "yyyy-MM-dd HH:mm:ss".
	TimestampFormat *string

	// 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.
	UseGeolocationForTimeZone bool
	// contains filtered or unexported fields
}

type CreateDatasetImportJobOutput 

type CreateDatasetImportJobOutput struct {

	// The Amazon Resource Name (ARN) of the dataset import job.
	DatasetImportJobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatasetInput 

type CreateDatasetInput struct {

	// A name for the dataset.
	//
	// This member is required.
	DatasetName *string

	// The dataset type. Valid values depend on the chosen Domain .
	//
	// This member is required.
	DatasetType types.DatasetType

	// The domain associated with the dataset. When you add a dataset to a dataset
	// group, this value and the value specified for the Domain parameter of the [CreateDatasetGroup]
	// operation must match.
	//
	// The Domain and DatasetType that you choose determine the fields that must be
	// present in the training data that you import to the dataset. For example, if you
	// choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType , Amazon
	// Forecast requires item_id , timestamp , and demand fields to be present in your
	// data. For more information, see [Importing datasets].
	//
	// [CreateDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
	// [Importing datasets]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
	//
	// This member is required.
	Domain types.Domain

	// The schema for the dataset. The schema attributes and their order must match
	// the fields in your data. The dataset Domain and DatasetType that you choose
	// determine the minimum required fields in your training data. For information
	// about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types].
	//
	// [Dataset Domains and Dataset Types]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html
	//
	// This member is required.
	Schema *types.Schema

	// The frequency of data collection. This parameter is required for
	// RELATED_TIME_SERIES datasets.
	//
	// Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D
	// (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and
	// "15min" indicates every 15 minutes. You cannot specify a value that would
	// overlap with the next larger frequency. That means, for example, you cannot
	// specify a frequency of 60 minutes, because that is equivalent to 1 hour. The
	// valid values for each frequency are the following:
	//
	//   - Minute - 1-59
	//
	//   - Hour - 1-23
	//
	//   - Day - 1-6
	//
	//   - Week - 1-4
	//
	//   - Month - 1-11
	//
	//   - Year - 1
	//
	// Thus, if you want every other week forecasts, specify "2W". Or, if you want
	// quarterly forecasts, you specify "3M".
	DataFrequency *string

	// An Key Management Service (KMS) key and the Identity and Access Management
	// (IAM) role that Amazon Forecast can assume to access the key.
	EncryptionConfig *types.EncryptionConfig

	// The optional metadata that you apply to the dataset to help you categorize and
	// organize them. Each tag consists of a key and an optional value, both of which
	// you define.
	//
	// The following basic restrictions apply to tags:
	//
	//   - Maximum number of tags per resource - 50.
	//
	//   - For each resource, each tag key must be unique, and each tag key can have
	//   only one value.
	//
	//   - Maximum key length - 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length - 256 Unicode characters in UTF-8.
	//
	//   - If your tagging schema is used across multiple services and resources,
	//   remember that other services may have restrictions on allowed characters.
	//   Generally allowed characters are: letters, numbers, and spaces representable in
	//   UTF-8, and the following characters: + - = . _ : / @.
	//
	//   - Tag keys and values are case sensitive.
	//
	//   - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
	//   prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
	//   or delete tag keys with this prefix. Values can have this prefix. If a tag value
	//   has aws as its prefix but the key does not, then Forecast considers it to be a
	//   user tag and will count against the limit of 50 tags. Tags with only the key
	//   prefix of aws do not count against your tags per resource limit.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDatasetOutput 

type CreateDatasetOutput struct {

	// The Amazon Resource Name (ARN) of the dataset.
	DatasetArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateExplainabilityExportInput added in v1.14.0 

type CreateExplainabilityExportInput struct {

	// The destination for an export job. Provide an S3 path, an Identity and Access
	// Management (IAM) role that allows Amazon Forecast to access the location, and an
	// Key Management Service (KMS) key (optional).
	//
	// This member is required.
	Destination *types.DataDestination

	// The Amazon Resource Name (ARN) of the Explainability to export.
	//
	// This member is required.
	ExplainabilityArn *string

	// A unique name for the Explainability export.
	//
	// This member is required.
	ExplainabilityExportName *string

	// The format of the exported data, CSV or PARQUET.
	Format *string

	// Optional metadata to help you categorize and organize your resources. Each tag
	// consists of a key and an optional value, both of which you define. Tag keys and
	// values are case sensitive.
	//
	// The following restrictions apply to tags:
	//
	//   - For each resource, each tag key must be unique and each tag key must have
	//   one value.
	//
	//   - Maximum number of tags per resource: 50.
	//
	//   - Maximum key length: 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length: 256 Unicode characters in UTF-8.
	//
	//   - Accepted characters: all letters and numbers, spaces representable in
	//   UTF-8, and + - = . _ : / @. If your tagging schema is used across other services
	//   and resources, the character restrictions of those services also apply.
	//
	//   - Key prefixes cannot include any upper or lowercase combination of aws: or
	//   AWS: . Values can have this prefix. If a tag value has aws as its prefix but
	//   the key does not, Forecast considers it to be a user tag and will count against
	//   the limit of 50 tags. Tags with only the key prefix of aws do not count
	//   against your tags per resource limit. You cannot edit or delete tag keys with
	//   this prefix.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateExplainabilityExportOutput added in v1.14.0 

type CreateExplainabilityExportOutput struct {

	// The Amazon Resource Name (ARN) of the export.
	ExplainabilityExportArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateExplainabilityInput added in v1.14.0 

type CreateExplainabilityInput struct {

	// The configuration settings that define the granularity of time series and time
	// points for the Explainability.
	//
	// This member is required.
	ExplainabilityConfig *types.ExplainabilityConfig

	// A unique name for the Explainability.
	//
	// This member is required.
	ExplainabilityName *string

	// The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
	// Explainability.
	//
	// This member is required.
	ResourceArn *string

	// The source of your data, an Identity and Access Management (IAM) role that
	// allows Amazon Forecast to access the data and, optionally, an Key Management
	// Service (KMS) key.
	DataSource *types.DataSource

	// Create an Explainability visualization that is viewable within the Amazon Web
	// Services console.
	EnableVisualization *bool

	// If TimePointGranularity is set to SPECIFIC , define the last time point for the
	// Explainability.
	//
	// Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
	// 2015-01-01T20:00:00)
	EndDateTime *string

	// Defines the fields of a dataset.
	Schema *types.Schema

	// If TimePointGranularity is set to SPECIFIC , define the first point for the
	// Explainability.
	//
	// Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
	// 2015-01-01T20:00:00)
	StartDateTime *string

	// Optional metadata to help you categorize and organize your resources. Each tag
	// consists of a key and an optional value, both of which you define. Tag keys and
	// values are case sensitive.
	//
	// The following restrictions apply to tags:
	//
	//   - For each resource, each tag key must be unique and each tag key must have
	//   one value.
	//
	//   - Maximum number of tags per resource: 50.
	//
	//   - Maximum key length: 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length: 256 Unicode characters in UTF-8.
	//
	//   - Accepted characters: all letters and numbers, spaces representable in
	//   UTF-8, and + - = . _ : / @. If your tagging schema is used across other services
	//   and resources, the character restrictions of those services also apply.
	//
	//   - Key prefixes cannot include any upper or lowercase combination of aws: or
	//   AWS: . Values can have this prefix. If a tag value has aws as its prefix but
	//   the key does not, Forecast considers it to be a user tag and will count against
	//   the limit of 50 tags. Tags with only the key prefix of aws do not count
	//   against your tags per resource limit. You cannot edit or delete tag keys with
	//   this prefix.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateExplainabilityOutput added in v1.14.0 

type CreateExplainabilityOutput struct {

	// The Amazon Resource Name (ARN) of the Explainability.
	ExplainabilityArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateForecastExportJobInput 

type CreateForecastExportJobInput struct {

	// The location where you want to save the forecast and an Identity and Access
	// Management (IAM) role that Amazon Forecast can assume to access the location.
	// The forecast must be exported to an Amazon S3 bucket.
	//
	// If encryption is used, Destination must include an Key Management Service (KMS)
	// key. The IAM role must allow Amazon Forecast permission to access the key.
	//
	// This member is required.
	Destination *types.DataDestination

	// The Amazon Resource Name (ARN) of the forecast that you want to export.
	//
	// This member is required.
	ForecastArn *string

	// The name for the forecast export job.
	//
	// This member is required.
	ForecastExportJobName *string

	// The format of the exported data, CSV or PARQUET. The default value is CSV.
	Format *string

	// The optional metadata that you apply to the forecast export job to help you
	// categorize and organize them. Each tag consists of a key and an optional value,
	// both of which you define.
	//
	// The following basic restrictions apply to tags:
	//
	//   - Maximum number of tags per resource - 50.
	//
	//   - For each resource, each tag key must be unique, and each tag key can have
	//   only one value.
	//
	//   - Maximum key length - 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length - 256 Unicode characters in UTF-8.
	//
	//   - If your tagging schema is used across multiple services and resources,
	//   remember that other services may have restrictions on allowed characters.
	//   Generally allowed characters are: letters, numbers, and spaces representable in
	//   UTF-8, and the following characters: + - = . _ : / @.
	//
	//   - Tag keys and values are case sensitive.
	//
	//   - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
	//   prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
	//   or delete tag keys with this prefix. Values can have this prefix. If a tag value
	//   has aws as its prefix but the key does not, then Forecast considers it to be a
	//   user tag and will count against the limit of 50 tags. Tags with only the key
	//   prefix of aws do not count against your tags per resource limit.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateForecastExportJobOutput 

type CreateForecastExportJobOutput struct {

	// The Amazon Resource Name (ARN) of the export job.
	ForecastExportJobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateForecastInput 

type CreateForecastInput struct {

	// A name for the forecast.
	//
	// This member is required.
	ForecastName *string

	// The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
	//
	// This member is required.
	PredictorArn *string

	// The quantiles at which probabilistic forecasts are generated. You can currently
	// specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99
	// (increments of .01 only) and mean . The mean forecast is different from the
	// median (0.50) when the distribution is not symmetric (for example, Beta and
	// Negative Binomial).
	//
	// The default quantiles are the quantiles you specified during predictor
	// creation. If you didn't specify quantiles, the default values are ["0.1",
	// "0.5", "0.9"] .
	ForecastTypes []string

	// The optional metadata that you apply to the forecast to help you categorize and
	// organize them. Each tag consists of a key and an optional value, both of which
	// you define.
	//
	// The following basic restrictions apply to tags:
	//
	//   - Maximum number of tags per resource - 50.
	//
	//   - For each resource, each tag key must be unique, and each tag key can have
	//   only one value.
	//
	//   - Maximum key length - 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length - 256 Unicode characters in UTF-8.
	//
	//   - If your tagging schema is used across multiple services and resources,
	//   remember that other services may have restrictions on allowed characters.
	//   Generally allowed characters are: letters, numbers, and spaces representable in
	//   UTF-8, and the following characters: + - = . _ : / @.
	//
	//   - Tag keys and values are case sensitive.
	//
	//   - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
	//   prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
	//   or delete tag keys with this prefix. Values can have this prefix. If a tag value
	//   has aws as its prefix but the key does not, then Forecast considers it to be a
	//   user tag and will count against the limit of 50 tags. Tags with only the key
	//   prefix of aws do not count against your tags per resource limit.
	Tags []types.Tag

	// Defines the set of time series that are used to create the forecasts in a
	// TimeSeriesIdentifiers object.
	//
	// The TimeSeriesIdentifiers object needs the following information:
	//
	//   - DataSource
	//
	//   - Format
	//
	//   - Schema
	TimeSeriesSelector *types.TimeSeriesSelector
	// contains filtered or unexported fields
}

type CreateForecastOutput 

type CreateForecastOutput struct {

	// The Amazon Resource Name (ARN) of the forecast.
	ForecastArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMonitorInput added in v1.20.0 

type CreateMonitorInput struct {

	// The name of the monitor resource.
	//
	// This member is required.
	MonitorName *string

	// The Amazon Resource Name (ARN) of the predictor to monitor.
	//
	// This member is required.
	ResourceArn *string

	// A list of [tags] to apply to the monitor resource.
	//
	// [tags]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMonitorOutput added in v1.20.0 

type CreateMonitorOutput struct {

	// The Amazon Resource Name (ARN) of the monitor resource.
	MonitorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePredictorBacktestExportJobInput added in v0.31.0 

type CreatePredictorBacktestExportJobInput struct {

	// The destination for an export job. Provide an S3 path, an Identity and Access
	// Management (IAM) role that allows Amazon Forecast to access the location, and an
	// Key Management Service (KMS) key (optional).
	//
	// This member is required.
	Destination *types.DataDestination

	// The Amazon Resource Name (ARN) of the predictor that you want to export.
	//
	// This member is required.
	PredictorArn *string

	// The name for the backtest export job.
	//
	// This member is required.
	PredictorBacktestExportJobName *string

	// The format of the exported data, CSV or PARQUET. The default value is CSV.
	Format *string

	// Optional metadata to help you categorize and organize your backtests. Each tag
	// consists of a key and an optional value, both of which you define. Tag keys and
	// values are case sensitive.
	//
	// The following restrictions apply to tags:
	//
	//   - For each resource, each tag key must be unique and each tag key must have
	//   one value.
	//
	//   - Maximum number of tags per resource: 50.
	//
	//   - Maximum key length: 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length: 256 Unicode characters in UTF-8.
	//
	//   - Accepted characters: all letters and numbers, spaces representable in
	//   UTF-8, and + - = . _ : / @. If your tagging schema is used across other services
	//   and resources, the character restrictions of those services also apply.
	//
	//   - Key prefixes cannot include any upper or lowercase combination of aws: or
	//   AWS: . Values can have this prefix. If a tag value has aws as its prefix but
	//   the key does not, Forecast considers it to be a user tag and will count against
	//   the limit of 50 tags. Tags with only the key prefix of aws do not count
	//   against your tags per resource limit. You cannot edit or delete tag keys with
	//   this prefix.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreatePredictorBacktestExportJobOutput added in v0.31.0 

type CreatePredictorBacktestExportJobOutput struct {

	// The Amazon Resource Name (ARN) of the predictor backtest export job that you
	// want to export.
	PredictorBacktestExportJobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePredictorInput 

type CreatePredictorInput struct {

	// The featurization configuration.
	//
	// This member is required.
	FeaturizationConfig *types.FeaturizationConfig

	// Specifies the number of time-steps that the model is trained to predict. The
	// forecast horizon is also called the prediction length.
	//
	// For example, if you configure a dataset for daily data collection (using the
	// DataFrequency parameter of the CreateDataset operation) and set the forecast horizon to 10,
	// the model returns predictions for 10 days.
	//
	// The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the
	// TARGET_TIME_SERIES dataset length.
	//
	// This member is required.
	ForecastHorizon *int32

	// Describes the dataset group that contains the data to use to train the
	// predictor.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// A name for the predictor.
	//
	// This member is required.
	PredictorName *string

	// The Amazon Resource Name (ARN) of the algorithm to use for model training.
	// Required if PerformAutoML is not set to true .
	//
	// Supported algorithms:
	//
	//   - arn:aws:forecast:::algorithm/ARIMA
	//
	//   - arn:aws:forecast:::algorithm/CNN-QR
	//
	//   - arn:aws:forecast:::algorithm/Deep_AR_Plus
	//
	//   - arn:aws:forecast:::algorithm/ETS
	//
	//   - arn:aws:forecast:::algorithm/NPTS
	//
	//   - arn:aws:forecast:::algorithm/Prophet
	AlgorithmArn *string

	//  The LatencyOptimized AutoML override strategy is only available in private
	// beta. Contact Amazon Web Services Support or your account manager to learn more
	// about access privileges.
	//
	// Used to overide the default AutoML strategy, which is to optimize predictor
	// accuracy. To apply an AutoML strategy that minimizes training time, use
	// LatencyOptimized .
	//
	// This parameter is only valid for predictors trained using AutoML.
	AutoMLOverrideStrategy types.AutoMLOverrideStrategy

	// An Key Management Service (KMS) key and the Identity and Access Management
	// (IAM) role that Amazon Forecast can assume to access the key.
	EncryptionConfig *types.EncryptionConfig

	// Used to override the default evaluation parameters of the specified algorithm.
	// Amazon Forecast evaluates a predictor by splitting a dataset into training data
	// and testing data. The evaluation parameters define how to perform the split and
	// the number of iterations.
	EvaluationParameters *types.EvaluationParameters

	// Specifies the forecast types used to train a predictor. You can specify up to
	// five forecast types. Forecast types can be quantiles from 0.01 to 0.99, by
	// increments of 0.01 or higher. You can also specify the mean forecast with mean .
	//
	// The default value is ["0.10", "0.50", "0.9"] .
	ForecastTypes []string

	// Provides hyperparameter override values for the algorithm. If you don't provide
	// this parameter, Amazon Forecast uses default values. The individual algorithms
	// specify which hyperparameters support hyperparameter optimization (HPO). For
	// more information, see aws-forecast-choosing-recipes.
	//
	// If you included the HPOConfig object, you must set PerformHPO to true.
	HPOConfig *types.HyperParameterTuningJobConfig

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric types.OptimizationMetric

	// Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates
	// the algorithms it provides and chooses the best algorithm and configuration for
	// your training dataset.
	//
	// The default value is false . In this case, you are required to specify an
	// algorithm.
	//
	// Set PerformAutoML to true to have Amazon Forecast perform AutoML. This is a
	// good option if you aren't sure which algorithm is suitable for your training
	// data. In this case, PerformHPO must be false.
	PerformAutoML *bool

	// Whether to perform hyperparameter optimization (HPO). HPO finds optimal
	// hyperparameter values for your training data. The process of performing HPO is
	// known as running a hyperparameter tuning job.
	//
	// The default value is false . In this case, Amazon Forecast uses default
	// hyperparameter values from the chosen algorithm.
	//
	// To override the default values, set PerformHPO to true and, optionally, supply
	// the HyperParameterTuningJobConfigobject. The tuning job specifies a metric to optimize, which
	// hyperparameters participate in tuning, and the valid range for each tunable
	// hyperparameter. In this case, you are required to specify an algorithm and
	// PerformAutoML must be false.
	//
	// The following algorithms support HPO:
	//
	//   - DeepAR+
	//
	//   - CNN-QR
	PerformHPO *bool

	// The optional metadata that you apply to the predictor to help you categorize
	// and organize them. Each tag consists of a key and an optional value, both of
	// which you define.
	//
	// The following basic restrictions apply to tags:
	//
	//   - Maximum number of tags per resource - 50.
	//
	//   - For each resource, each tag key must be unique, and each tag key can have
	//   only one value.
	//
	//   - Maximum key length - 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length - 256 Unicode characters in UTF-8.
	//
	//   - If your tagging schema is used across multiple services and resources,
	//   remember that other services may have restrictions on allowed characters.
	//   Generally allowed characters are: letters, numbers, and spaces representable in
	//   UTF-8, and the following characters: + - = . _ : / @.
	//
	//   - Tag keys and values are case sensitive.
	//
	//   - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
	//   prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
	//   or delete tag keys with this prefix. Values can have this prefix. If a tag value
	//   has aws as its prefix but the key does not, then Forecast considers it to be a
	//   user tag and will count against the limit of 50 tags. Tags with only the key
	//   prefix of aws do not count against your tags per resource limit.
	Tags []types.Tag

	// The hyperparameters to override for model training. The hyperparameters that
	// you can override are listed in the individual algorithms. For the list of
	// supported algorithms, see aws-forecast-choosing-recipes.
	TrainingParameters map[string]string
	// contains filtered or unexported fields
}

type CreatePredictorOutput 

type CreatePredictorOutput struct {

	// The Amazon Resource Name (ARN) of the predictor.
	PredictorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWhatIfAnalysisInput added in v1.23.0 

type CreateWhatIfAnalysisInput struct {

	// The Amazon Resource Name (ARN) of the baseline forecast.
	//
	// This member is required.
	ForecastArn *string

	// The name of the what-if analysis. Each name must be unique.
	//
	// This member is required.
	WhatIfAnalysisName *string

	// A list of [tags] to apply to the what if forecast.
	//
	// [tags]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
	Tags []types.Tag

	// Defines the set of time series that are used in the what-if analysis with a
	// TimeSeriesIdentifiers object. What-if analyses are performed only for the time
	// series in this object.
	//
	// The TimeSeriesIdentifiers object needs the following information:
	//
	//   - DataSource
	//
	//   - Format
	//
	//   - Schema
	TimeSeriesSelector *types.TimeSeriesSelector
	// contains filtered or unexported fields
}

type CreateWhatIfAnalysisOutput added in v1.23.0 

type CreateWhatIfAnalysisOutput struct {

	// The Amazon Resource Name (ARN) of the what-if analysis.
	WhatIfAnalysisArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWhatIfForecastExportInput added in v1.23.0 

type CreateWhatIfForecastExportInput struct {

	// The location where you want to save the forecast and an Identity and Access
	// Management (IAM) role that Amazon Forecast can assume to access the location.
	// The forecast must be exported to an Amazon S3 bucket.
	//
	// If encryption is used, Destination must include an Key Management Service (KMS)
	// key. The IAM role must allow Amazon Forecast permission to access the key.
	//
	// This member is required.
	Destination *types.DataDestination

	// The list of what-if forecast Amazon Resource Names (ARNs) to export.
	//
	// This member is required.
	WhatIfForecastArns []string

	// The name of the what-if forecast to export.
	//
	// This member is required.
	WhatIfForecastExportName *string

	// The format of the exported data, CSV or PARQUET.
	Format *string

	// A list of [tags] to apply to the what if forecast.
	//
	// [tags]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateWhatIfForecastExportOutput added in v1.23.0 

type CreateWhatIfForecastExportOutput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast.
	WhatIfForecastExportArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWhatIfForecastInput added in v1.23.0 

type CreateWhatIfForecastInput struct {

	// The Amazon Resource Name (ARN) of the what-if analysis.
	//
	// This member is required.
	WhatIfAnalysisArn *string

	// The name of the what-if forecast. Names must be unique within each what-if
	// analysis.
	//
	// This member is required.
	WhatIfForecastName *string

	// A list of [tags] to apply to the what if forecast.
	//
	// [tags]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
	Tags []types.Tag

	// The replacement time series dataset, which contains the rows that you want to
	// change in the related time series dataset. A replacement time series does not
	// need to contain all rows that are in the baseline related time series. Include
	// only the rows (measure-dimension combinations) that you want to include in the
	// what-if forecast.
	//
	// This dataset is merged with the original time series to create a transformed
	// dataset that is used for the what-if analysis.
	//
	// This dataset should contain the items to modify (such as item_id or
	// workforce_type), any relevant dimensions, the timestamp column, and at least one
	// of the related time series columns. This file should not contain duplicate
	// timestamps for the same time series.
	//
	// Timestamps and item_ids not included in this dataset are not included in the
	// what-if analysis.
	TimeSeriesReplacementsDataSource *types.TimeSeriesReplacementsDataSource

	// The transformations that are applied to the baseline time series. Each
	// transformation contains an action and a set of conditions. An action is applied
	// only when all conditions are met. If no conditions are provided, the action is
	// applied to all items.
	TimeSeriesTransformations []types.TimeSeriesTransformation
	// contains filtered or unexported fields
}

type CreateWhatIfForecastOutput added in v1.23.0 

type CreateWhatIfForecastOutput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast.
	WhatIfForecastArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDatasetGroupInput 

type DeleteDatasetGroupInput struct {

	// The Amazon Resource Name (ARN) of the dataset group to delete.
	//
	// This member is required.
	DatasetGroupArn *string
	// contains filtered or unexported fields
}

type DeleteDatasetGroupOutput 

type DeleteDatasetGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDatasetImportJobInput 

type DeleteDatasetImportJobInput struct {

	// The Amazon Resource Name (ARN) of the dataset import job to delete.
	//
	// This member is required.
	DatasetImportJobArn *string
	// contains filtered or unexported fields
}

type DeleteDatasetImportJobOutput 

type DeleteDatasetImportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDatasetInput 

type DeleteDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset to delete.
	//
	// This member is required.
	DatasetArn *string
	// contains filtered or unexported fields
}

type DeleteDatasetOutput 

type DeleteDatasetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteExplainabilityExportInput added in v1.14.0 

type DeleteExplainabilityExportInput struct {

	// The Amazon Resource Name (ARN) of the Explainability export to delete.
	//
	// This member is required.
	ExplainabilityExportArn *string
	// contains filtered or unexported fields
}

type DeleteExplainabilityExportOutput added in v1.14.0 

type DeleteExplainabilityExportOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteExplainabilityInput added in v1.14.0 

type DeleteExplainabilityInput struct {

	// The Amazon Resource Name (ARN) of the Explainability resource to delete.
	//
	// This member is required.
	ExplainabilityArn *string
	// contains filtered or unexported fields
}

type DeleteExplainabilityOutput added in v1.14.0 

type DeleteExplainabilityOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteForecastExportJobInput 

type DeleteForecastExportJobInput struct {

	// The Amazon Resource Name (ARN) of the forecast export job to delete.
	//
	// This member is required.
	ForecastExportJobArn *string
	// contains filtered or unexported fields
}

type DeleteForecastExportJobOutput 

type DeleteForecastExportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteForecastInput 

type DeleteForecastInput struct {

	// The Amazon Resource Name (ARN) of the forecast to delete.
	//
	// This member is required.
	ForecastArn *string
	// contains filtered or unexported fields
}

type DeleteForecastOutput 

type DeleteForecastOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMonitorInput added in v1.20.0 

type DeleteMonitorInput struct {

	// The Amazon Resource Name (ARN) of the monitor resource to delete.
	//
	// This member is required.
	MonitorArn *string
	// contains filtered or unexported fields
}

type DeleteMonitorOutput added in v1.20.0 

type DeleteMonitorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePredictorBacktestExportJobInput added in v0.31.0 

type DeletePredictorBacktestExportJobInput struct {

	// The Amazon Resource Name (ARN) of the predictor backtest export job to delete.
	//
	// This member is required.
	PredictorBacktestExportJobArn *string
	// contains filtered or unexported fields
}

type DeletePredictorBacktestExportJobOutput added in v0.31.0 

type DeletePredictorBacktestExportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePredictorInput 

type DeletePredictorInput struct {

	// The Amazon Resource Name (ARN) of the predictor to delete.
	//
	// This member is required.
	PredictorArn *string
	// contains filtered or unexported fields
}

type DeletePredictorOutput 

type DeletePredictorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourceTreeInput added in v1.4.0 

type DeleteResourceTreeInput struct {

	// The Amazon Resource Name (ARN) of the parent resource to delete. All child
	// resources of the parent resource will also be deleted.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type DeleteResourceTreeOutput added in v1.4.0 

type DeleteResourceTreeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWhatIfAnalysisInput added in v1.23.0 

type DeleteWhatIfAnalysisInput struct {

	// The Amazon Resource Name (ARN) of the what-if analysis that you want to delete.
	//
	// This member is required.
	WhatIfAnalysisArn *string
	// contains filtered or unexported fields
}

type DeleteWhatIfAnalysisOutput added in v1.23.0 

type DeleteWhatIfAnalysisOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWhatIfForecastExportInput added in v1.23.0 

type DeleteWhatIfForecastExportInput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast export that you want to
	// delete.
	//
	// This member is required.
	WhatIfForecastExportArn *string
	// contains filtered or unexported fields
}

type DeleteWhatIfForecastExportOutput added in v1.23.0 

type DeleteWhatIfForecastExportOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWhatIfForecastInput added in v1.23.0 

type DeleteWhatIfForecastInput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.
	//
	// This member is required.
	WhatIfForecastArn *string
	// contains filtered or unexported fields
}

type DeleteWhatIfForecastOutput added in v1.23.0 

type DeleteWhatIfForecastOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAutoPredictorInput added in v1.14.0 

type DescribeAutoPredictorInput struct {

	// The Amazon Resource Name (ARN) of the predictor.
	//
	// This member is required.
	PredictorArn *string
	// contains filtered or unexported fields
}

type DescribeAutoPredictorOutput added in v1.14.0 

type DescribeAutoPredictorOutput struct {

	// The timestamp of the CreateAutoPredictor request.
	CreationTime *time.Time

	// The data configuration for your dataset group and any additional datasets.
	DataConfig *types.DataConfig

	// An array of the ARNs of the dataset import jobs used to import training data
	// for the predictor.
	DatasetImportJobArns []string

	// An Key Management Service (KMS) key and an Identity and Access Management (IAM)
	// role that Amazon Forecast can assume to access the key. You can specify this
	// optional object in the CreateDatasetand CreatePredictor requests.
	EncryptionConfig *types.EncryptionConfig

	// The estimated time remaining in minutes for the predictor training job to
	// complete.
	EstimatedTimeRemainingInMinutes *int64

	// Provides the status and ARN of the Predictor Explainability.
	ExplainabilityInfo *types.ExplainabilityInfo

	// An array of dimension (field) names that specify the attributes used to group
	// your time series.
	ForecastDimensions []string

	// The frequency of predictions in a forecast.
	//
	// Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30
	// minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1
	// minute). For example, "Y" indicates every year and "5min" indicates every five
	// minutes.
	ForecastFrequency *string

	// The number of time-steps that the model predicts. The forecast horizon is also
	// called the prediction length.
	ForecastHorizon *int32

	// The forecast types used during predictor training. Default value is
	// ["0.1","0.5","0.9"].
	ForecastTypes []string

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// In the event of an error, a message detailing the cause of the error.
	Message *string

	// A object with the Amazon Resource Name (ARN) and status of the monitor resource.
	MonitorInfo *types.MonitorInfo

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric types.OptimizationMetric

	// The Amazon Resource Name (ARN) of the predictor
	PredictorArn *string

	// The name of the predictor.
	PredictorName *string

	// The ARN and state of the reference predictor. This parameter is only valid for
	// retrained or upgraded predictors.
	ReferencePredictorSummary *types.ReferencePredictorSummary

	// The status of the predictor. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	Status *string

	// The time boundary Forecast uses when aggregating data.
	TimeAlignmentBoundary *types.TimeAlignmentBoundary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetGroupInput 

type DescribeDatasetGroupInput struct {

	// The Amazon Resource Name (ARN) of the dataset group.
	//
	// This member is required.
	DatasetGroupArn *string
	// contains filtered or unexported fields
}

type DescribeDatasetGroupOutput 

type DescribeDatasetGroupOutput struct {

	// When the dataset group was created.
	CreationTime *time.Time

	// An array of Amazon Resource Names (ARNs) of the datasets contained in the
	// dataset group.
	DatasetArns []string

	// The ARN of the dataset group.
	DatasetGroupArn *string

	// The name of the dataset group.
	DatasetGroupName *string

	// The domain associated with the dataset group.
	Domain types.Domain

	// When the dataset group was created or last updated from a call to the [UpdateDatasetGroup]
	// operation. While the dataset group is being updated, LastModificationTime is
	// the current time of the DescribeDatasetGroup call.
	//
	// [UpdateDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
	LastModificationTime *time.Time

	// The status of the dataset group. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	//
	//   - UPDATE_PENDING , UPDATE_IN_PROGRESS , UPDATE_FAILED
	//
	// The UPDATE states apply when you call the [UpdateDatasetGroup] operation.
	//
	// The Status of the dataset group must be ACTIVE before you can use the dataset
	// group to create a predictor.
	//
	// [UpdateDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetImportJobInput 

type DescribeDatasetImportJobInput struct {

	// The Amazon Resource Name (ARN) of the dataset import job.
	//
	// This member is required.
	DatasetImportJobArn *string
	// contains filtered or unexported fields
}

type DescribeDatasetImportJobOutput 

type DescribeDatasetImportJobOutput struct {

	// When the dataset import job was created.
	CreationTime *time.Time

	// The size of the dataset in gigabytes (GB) after the import job has finished.
	DataSize *float64

	// The location of the training data to import and an Identity and Access
	// Management (IAM) role that Amazon Forecast can assume to access the data.
	//
	// If encryption is used, DataSource includes an Key Management Service (KMS) key.
	DataSource *types.DataSource

	// The Amazon Resource Name (ARN) of the dataset that the training data was
	// imported to.
	DatasetArn *string

	// The ARN of the dataset import job.
	DatasetImportJobArn *string

	// The name of the dataset import job.
	DatasetImportJobName *string

	// The estimated time remaining in minutes for the dataset import job to complete.
	EstimatedTimeRemainingInMinutes *int64

	// Statistical information about each field in the input data.
	FieldStatistics map[string]types.Statistics

	// The format of the imported data, CSV or PARQUET.
	Format *string

	// The format of the geolocation attribute. Valid Values: "LAT_LONG" and
	// "CC_POSTALCODE" .
	GeolocationFormat *string

	// The import mode of the dataset import job, FULL or INCREMENTAL.
	ImportMode types.ImportMode

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// If an error occurred, an informational message about the error.
	Message *string

	// The status of the dataset import job. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	Status *string

	// The single time zone applied to every item in the dataset
	TimeZone *string

	// The format of timestamps in the dataset. The format that you specify depends on
	// the DataFrequency specified when the dataset was created. The following formats
	// are supported
	//
	//   - "yyyy-MM-dd"
	//
	// For the following data frequencies: Y, M, W, and D
	//
	//   - "yyyy-MM-dd HH:mm:ss"
	//
	// For the following data frequencies: H, 30min, 15min, and 1min; and optionally,
	//   for: Y, M, W, and D
	TimestampFormat *string

	// Whether TimeZone is automatically derived from the geolocation attribute.
	UseGeolocationForTimeZone bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetInput 

type DescribeDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset.
	//
	// This member is required.
	DatasetArn *string
	// contains filtered or unexported fields
}

type DescribeDatasetOutput 

type DescribeDatasetOutput struct {

	// When the dataset was created.
	CreationTime *time.Time

	// The frequency of data collection.
	//
	// 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, "M" indicates every month and "30min" indicates every 30
	// minutes.
	DataFrequency *string

	// The Amazon Resource Name (ARN) of the dataset.
	DatasetArn *string

	// The name of the dataset.
	DatasetName *string

	// The dataset type.
	DatasetType types.DatasetType

	// The domain associated with the dataset.
	Domain types.Domain

	// The Key Management Service (KMS) key and the Identity and Access Management
	// (IAM) role that Amazon Forecast can assume to access the key.
	EncryptionConfig *types.EncryptionConfig

	// When you create a dataset, LastModificationTime is the same as CreationTime .
	// While data is being imported to the dataset, LastModificationTime is the
	// current time of the DescribeDataset call. After a [CreateDatasetImportJob] operation has finished,
	// LastModificationTime is when the import job completed or failed.
	//
	// [CreateDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
	LastModificationTime *time.Time

	// An array of SchemaAttribute objects that specify the dataset fields. Each
	// SchemaAttribute specifies the name and data type of a field.
	Schema *types.Schema

	// The status of the dataset. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	//
	//   - UPDATE_PENDING , UPDATE_IN_PROGRESS , UPDATE_FAILED
	//
	// The UPDATE states apply while data is imported to the dataset from a call to
	// the [CreateDatasetImportJob]operation and reflect the status of the dataset import job. For example,
	// when the import job status is CREATE_IN_PROGRESS , the status of the dataset is
	// UPDATE_IN_PROGRESS .
	//
	// The Status of the dataset must be ACTIVE before you can import training data.
	//
	// [CreateDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeExplainabilityExportInput added in v1.14.0 

type DescribeExplainabilityExportInput struct {

	// The Amazon Resource Name (ARN) of the Explainability export.
	//
	// This member is required.
	ExplainabilityExportArn *string
	// contains filtered or unexported fields
}

type DescribeExplainabilityExportOutput added in v1.14.0 

type DescribeExplainabilityExportOutput struct {

	// When the Explainability export was created.
	CreationTime *time.Time

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

	// The Amazon Resource Name (ARN) of the Explainability export.
	ExplainabilityArn *string

	// The Amazon Resource Name (ARN) of the Explainability export.
	ExplainabilityExportArn *string

	// The name of the Explainability export.
	ExplainabilityExportName *string

	// The format of the exported data, CSV or PARQUET.
	Format *string

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// Information about any errors that occurred during the export.
	Message *string

	// The status of the Explainability export. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeExplainabilityInput added in v1.14.0 

type DescribeExplainabilityInput struct {

	// The Amazon Resource Name (ARN) of the Explaianability to describe.
	//
	// This member is required.
	ExplainabilityArn *string
	// contains filtered or unexported fields
}

type DescribeExplainabilityOutput added in v1.14.0 

type DescribeExplainabilityOutput struct {

	// When the Explainability resource was created.
	CreationTime *time.Time

	// The source of your data, an Identity and Access Management (IAM) role that
	// allows Amazon Forecast to access the data and, optionally, an Key Management
	// Service (KMS) key.
	DataSource *types.DataSource

	// Whether the visualization was enabled for the Explainability resource.
	EnableVisualization *bool

	// If TimePointGranularity is set to SPECIFIC , the last time point in the
	// Explainability.
	EndDateTime *string

	// The estimated time remaining in minutes for the CreateExplainability job to complete.
	EstimatedTimeRemainingInMinutes *int64

	// The Amazon Resource Name (ARN) of the Explainability.
	ExplainabilityArn *string

	// The configuration settings that define the granularity of time series and time
	// points for the Explainability.
	ExplainabilityConfig *types.ExplainabilityConfig

	// The name of the Explainability.
	ExplainabilityName *string

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// If an error occurred, a message about the error.
	Message *string

	// The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
	// Explainability resource.
	ResourceArn *string

	// Defines the fields of a dataset.
	Schema *types.Schema

	// If TimePointGranularity is set to SPECIFIC , the first time point in the
	// Explainability.
	StartDateTime *string

	// The status of the Explainability resource. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeForecastExportJobInput 

type DescribeForecastExportJobInput struct {

	// The Amazon Resource Name (ARN) of the forecast export job.
	//
	// This member is required.
	ForecastExportJobArn *string
	// contains filtered or unexported fields
}

type DescribeForecastExportJobOutput 

type DescribeForecastExportJobOutput struct {

	// When the forecast export job was created.
	CreationTime *time.Time

	// The path to the Amazon Simple Storage Service (Amazon S3) bucket where the
	// forecast is exported.
	Destination *types.DataDestination

	// The Amazon Resource Name (ARN) of the exported forecast.
	ForecastArn *string

	// The ARN of the forecast export job.
	ForecastExportJobArn *string

	// The name of the forecast export job.
	ForecastExportJobName *string

	// The format of the exported data, CSV or PARQUET.
	Format *string

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// If an error occurred, an informational message about the error.
	Message *string

	// The status of the forecast export job. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	//
	// The Status of the forecast export job must be ACTIVE before you can access the
	// forecast in your S3 bucket.
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeForecastInput 

type DescribeForecastInput struct {

	// The Amazon Resource Name (ARN) of the forecast.
	//
	// This member is required.
	ForecastArn *string
	// contains filtered or unexported fields
}

type DescribeForecastOutput 

type DescribeForecastOutput struct {

	// When the forecast creation task was created.
	CreationTime *time.Time

	// The ARN of the dataset group that provided the data used to train the predictor.
	DatasetGroupArn *string

	// The estimated time remaining in minutes for the forecast job to complete.
	EstimatedTimeRemainingInMinutes *int64

	// The forecast ARN as specified in the request.
	ForecastArn *string

	// The name of the forecast.
	ForecastName *string

	// The quantiles at which probabilistic forecasts were generated.
	ForecastTypes []string

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// If an error occurred, an informational message about the error.
	Message *string

	// The ARN of the predictor used to generate the forecast.
	PredictorArn *string

	// The status of the forecast. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	//
	// The Status of the forecast must be ACTIVE before you can query or export the
	// forecast.
	Status *string

	// The time series to include in the forecast.
	TimeSeriesSelector *types.TimeSeriesSelector

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeMonitorInput added in v1.20.0 

type DescribeMonitorInput struct {

	// The Amazon Resource Name (ARN) of the monitor resource to describe.
	//
	// This member is required.
	MonitorArn *string
	// contains filtered or unexported fields
}

type DescribeMonitorOutput added in v1.20.0 

type DescribeMonitorOutput struct {

	// Metrics you can use as a baseline for comparison purposes. Use these values you
	// interpret monitoring results for an auto predictor.
	Baseline *types.Baseline

	// The timestamp for when the monitor resource was created.
	CreationTime *time.Time

	// The estimated number of minutes remaining before the monitor resource finishes
	// its current evaluation.
	EstimatedEvaluationTimeRemainingInMinutes *int64

	// The state of the monitor's latest evaluation.
	LastEvaluationState *string

	// The timestamp of the latest evaluation completed by the monitor.
	LastEvaluationTime *time.Time

	// The timestamp of the latest modification to the monitor.
	LastModificationTime *time.Time

	// An error message, if any, for the monitor.
	Message *string

	// The Amazon Resource Name (ARN) of the monitor resource described.
	MonitorArn *string

	// The name of the monitor.
	MonitorName *string

	// The Amazon Resource Name (ARN) of the auto predictor being monitored.
	ResourceArn *string

	// The status of the monitor resource.
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribePredictorBacktestExportJobInput added in v0.31.0 

type DescribePredictorBacktestExportJobInput struct {

	// The Amazon Resource Name (ARN) of the predictor backtest export job.
	//
	// This member is required.
	PredictorBacktestExportJobArn *string
	// contains filtered or unexported fields
}

type DescribePredictorBacktestExportJobOutput added in v0.31.0 

type DescribePredictorBacktestExportJobOutput struct {

	// When the predictor backtest export job was created.
	CreationTime *time.Time

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

	// The format of the exported data, CSV or PARQUET.
	Format *string

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// Information about any errors that may have occurred during the backtest export.
	Message *string

	// The Amazon Resource Name (ARN) of the predictor.
	PredictorArn *string

	// The Amazon Resource Name (ARN) of the predictor backtest export job.
	PredictorBacktestExportJobArn *string

	// The name of the predictor backtest export job.
	PredictorBacktestExportJobName *string

	// The status of the predictor backtest export job. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribePredictorInput 

type DescribePredictorInput struct {

	// The Amazon Resource Name (ARN) of the predictor that you want information about.
	//
	// This member is required.
	PredictorArn *string
	// contains filtered or unexported fields
}

type DescribePredictorOutput 

type DescribePredictorOutput struct {

	// The Amazon Resource Name (ARN) of the algorithm used for model training.
	AlgorithmArn *string

	// When PerformAutoML is specified, the ARN of the chosen algorithm.
	AutoMLAlgorithmArns []string

	//  The LatencyOptimized AutoML override strategy is only available in private
	// beta. Contact Amazon Web Services Support or your account manager to learn more
	// about access privileges.
	//
	// The AutoML strategy used to train the predictor. Unless LatencyOptimized is
	// specified, the AutoML strategy optimizes predictor accuracy.
	//
	// This parameter is only valid for predictors trained using AutoML.
	AutoMLOverrideStrategy types.AutoMLOverrideStrategy

	// When the model training task was created.
	CreationTime *time.Time

	// An array of the ARNs of the dataset import jobs used to import training data
	// for the predictor.
	DatasetImportJobArns []string

	// An Key Management Service (KMS) key and the Identity and Access Management
	// (IAM) role that Amazon Forecast can assume to access the key.
	EncryptionConfig *types.EncryptionConfig

	// The estimated time remaining in minutes for the predictor training job to
	// complete.
	EstimatedTimeRemainingInMinutes *int64

	// Used to override the default evaluation parameters of the specified algorithm.
	// Amazon Forecast evaluates a predictor by splitting a dataset into training data
	// and testing data. The evaluation parameters define how to perform the split and
	// the number of iterations.
	EvaluationParameters *types.EvaluationParameters

	// The featurization configuration.
	FeaturizationConfig *types.FeaturizationConfig

	// The number of time-steps of the forecast. The forecast horizon is also called
	// the prediction length.
	ForecastHorizon *int32

	// The forecast types used during predictor training. Default value is
	// ["0.1","0.5","0.9"]
	ForecastTypes []string

	// The hyperparameter override values for the algorithm.
	HPOConfig *types.HyperParameterTuningJobConfig

	// Describes the dataset group that contains the data to use to train the
	// predictor.
	InputDataConfig *types.InputDataConfig

	// Whether the predictor was created with CreateAutoPredictor.
	IsAutoPredictor *bool

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// If an error occurred, an informational message about the error.
	Message *string

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric types.OptimizationMetric

	// Whether the predictor is set to perform AutoML.
	PerformAutoML *bool

	// Whether the predictor is set to perform hyperparameter optimization (HPO).
	PerformHPO *bool

	// The ARN of the predictor.
	PredictorArn *string

	// Details on the the status and results of the backtests performed to evaluate
	// the accuracy of the predictor. You specify the number of backtests to perform
	// when you call the operation.
	PredictorExecutionDetails *types.PredictorExecutionDetails

	// The name of the predictor.
	PredictorName *string

	// The status of the predictor. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	// The Status of the predictor must be ACTIVE before you can use the predictor to
	// create a forecast.
	Status *string

	// The default training parameters or overrides selected during model training.
	// When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values
	// for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.
	TrainingParameters map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeWhatIfAnalysisInput added in v1.23.0 

type DescribeWhatIfAnalysisInput struct {

	// The Amazon Resource Name (ARN) of the what-if analysis that you are interested
	// in.
	//
	// This member is required.
	WhatIfAnalysisArn *string
	// contains filtered or unexported fields
}

type DescribeWhatIfAnalysisOutput added in v1.23.0 

type DescribeWhatIfAnalysisOutput struct {

	// When the what-if analysis was created.
	CreationTime *time.Time

	// The approximate time remaining to complete the what-if analysis, in minutes.
	EstimatedTimeRemainingInMinutes *int64

	// The Amazon Resource Name (ARN) of the what-if forecast.
	ForecastArn *string

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// If an error occurred, an informational message about the error.
	Message *string

	// The status of the what-if analysis. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	//
	// The Status of the what-if analysis must be ACTIVE before you can access the
	// analysis.
	Status *string

	// Defines the set of time series that are used to create the forecasts in a
	// TimeSeriesIdentifiers object.
	//
	// The TimeSeriesIdentifiers object needs the following information:
	//
	//   - DataSource
	//
	//   - Format
	//
	//   - Schema
	TimeSeriesSelector *types.TimeSeriesSelector

	// The Amazon Resource Name (ARN) of the what-if analysis.
	WhatIfAnalysisArn *string

	// The name of the what-if analysis.
	WhatIfAnalysisName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeWhatIfForecastExportInput added in v1.23.0 

type DescribeWhatIfForecastExportInput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast export that you are
	// interested in.
	//
	// This member is required.
	WhatIfForecastExportArn *string
	// contains filtered or unexported fields
}

type DescribeWhatIfForecastExportOutput added in v1.23.0 

type DescribeWhatIfForecastExportOutput struct {

	// When the what-if forecast export was created.
	CreationTime *time.Time

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

	// The approximate time remaining to complete the what-if forecast export, in
	// minutes.
	EstimatedTimeRemainingInMinutes *int64

	// The format of the exported data, CSV or PARQUET.
	Format *string

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// If an error occurred, an informational message about the error.
	Message *string

	// The status of the what-if forecast. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	//
	// The Status of the what-if forecast export must be ACTIVE before you can access
	// the forecast export.
	Status *string

	// An array of Amazon Resource Names (ARNs) that represent all of the what-if
	// forecasts exported in this resource.
	WhatIfForecastArns []string

	// The Amazon Resource Name (ARN) of the what-if forecast export.
	WhatIfForecastExportArn *string

	// The name of the what-if forecast export.
	WhatIfForecastExportName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeWhatIfForecastInput added in v1.23.0 

type DescribeWhatIfForecastInput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast that you are interested
	// in.
	//
	// This member is required.
	WhatIfForecastArn *string
	// contains filtered or unexported fields
}

type DescribeWhatIfForecastOutput added in v1.23.0 

type DescribeWhatIfForecastOutput struct {

	// When the what-if forecast was created.
	CreationTime *time.Time

	// The approximate time remaining to complete the what-if forecast, in minutes.
	EstimatedTimeRemainingInMinutes *int64

	// The quantiles at which probabilistic forecasts are generated. You can specify
	// up to five quantiles per what-if forecast in the CreateWhatIfForecastoperation. If you didn't
	// specify quantiles, the default values are ["0.1", "0.5", "0.9"] .
	ForecastTypes []string

	// The last time the resource was modified. The timestamp depends on the status of
	// the job:
	//
	//   - CREATE_PENDING - The CreationTime .
	//
	//   - CREATE_IN_PROGRESS - The current timestamp.
	//
	//   - CREATE_STOPPING - The current timestamp.
	//
	//   - CREATE_STOPPED - When the job stopped.
	//
	//   - ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time

	// If an error occurred, an informational message about the error.
	Message *string

	// The status of the what-if forecast. States include:
	//
	//   - ACTIVE
	//
	//   - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
	//
	//   - CREATE_STOPPING , CREATE_STOPPED
	//
	//   - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED
	//
	// The Status of the what-if forecast must be ACTIVE before you can access the
	// forecast.
	Status *string

	// An array of S3Config , Schema , and Format elements that describe the
	// replacement time series.
	TimeSeriesReplacementsDataSource *types.TimeSeriesReplacementsDataSource

	// An array of Action and TimeSeriesConditions elements that describe what
	// transformations were applied to which time series.
	TimeSeriesTransformations []types.TimeSeriesTransformation

	// The Amazon Resource Name (ARN) of the what-if analysis that contains this
	// forecast.
	WhatIfAnalysisArn *string

	// The Amazon Resource Name (ARN) of the what-if forecast.
	WhatIfForecastArn *string

	// The name of the what-if forecast.
	WhatIfForecastName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.26.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.26.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.26.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.26.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.26.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccuracyMetricsInput 

type GetAccuracyMetricsInput struct {

	// The Amazon Resource Name (ARN) of the predictor to get metrics for.
	//
	// This member is required.
	PredictorArn *string
	// contains filtered or unexported fields
}

type GetAccuracyMetricsOutput 

type GetAccuracyMetricsOutput struct {

	//  The LatencyOptimized AutoML override strategy is only available in private
	// beta. Contact Amazon Web Services Support or your account manager to learn more
	// about access privileges.
	//
	// The AutoML strategy used to train the predictor. Unless LatencyOptimized is
	// specified, the AutoML strategy optimizes predictor accuracy.
	//
	// This parameter is only valid for predictors trained using AutoML.
	AutoMLOverrideStrategy types.AutoMLOverrideStrategy

	// Whether the predictor was created with CreateAutoPredictor.
	IsAutoPredictor *bool

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric types.OptimizationMetric

	// An array of results from evaluating the predictor.
	PredictorEvaluationResults []types.EvaluationResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListDatasetGroupsAPIClient added in v0.30.0 

type ListDatasetGroupsAPIClient interface {
	ListDatasetGroups(context.Context, *ListDatasetGroupsInput, ...func(*Options)) (*ListDatasetGroupsOutput, error)
}

ListDatasetGroupsAPIClient is a client that implements the ListDatasetGroups operation.

type ListDatasetGroupsInput 

type ListDatasetGroupsInput struct {

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDatasetGroupsOutput 

type ListDatasetGroupsOutput struct {

	// An array of objects that summarize each dataset group's properties.
	DatasetGroups []types.DatasetGroupSummary

	// If the response is truncated, Amazon Forecast returns this token. To retrieve
	// the next set of results, use the token in the next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetGroupsPaginator added in v0.30.0 

type ListDatasetGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListDatasetGroupsPaginator is a paginator for ListDatasetGroups

func NewListDatasetGroupsPaginator added in v0.30.0 

func NewListDatasetGroupsPaginator(client ListDatasetGroupsAPIClient, params *ListDatasetGroupsInput, optFns ...func(*ListDatasetGroupsPaginatorOptions)) *ListDatasetGroupsPaginator

NewListDatasetGroupsPaginator returns a new ListDatasetGroupsPaginator

func (*ListDatasetGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListDatasetGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetGroupsPaginator) NextPage added in v0.30.0 

func (p *ListDatasetGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetGroupsOutput, error)

NextPage retrieves the next ListDatasetGroups page.

type ListDatasetGroupsPaginatorOptions added in v0.30.0 

type ListDatasetGroupsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetGroupsPaginatorOptions is the paginator options for ListDatasetGroups

type ListDatasetImportJobsAPIClient added in v0.30.0 

type ListDatasetImportJobsAPIClient interface {
	ListDatasetImportJobs(context.Context, *ListDatasetImportJobsInput, ...func(*Options)) (*ListDatasetImportJobsOutput, error)
}

ListDatasetImportJobsAPIClient is a client that implements the ListDatasetImportJobs operation.

type ListDatasetImportJobsInput 

type ListDatasetImportJobsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the datasets that match the statement from the list,
	// respectively. The match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT . To
	//   include the datasets that match the statement, specify IS . To exclude
	//   matching datasets, specify IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are DatasetArn
	//   and Status .
	//
	//   - Value - The value to match.
	//
	// For example, to list all dataset import jobs whose status is ACTIVE, you
	// specify the following filter:
	//
	//     "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
	Filters []types.Filter

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDatasetImportJobsOutput 

type ListDatasetImportJobsOutput struct {

	// An array of objects that summarize each dataset import job's properties.
	DatasetImportJobs []types.DatasetImportJobSummary

	// If the response is truncated, Amazon Forecast returns this token. To retrieve
	// the next set of results, use the token in the next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetImportJobsPaginator added in v0.30.0 

type ListDatasetImportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListDatasetImportJobsPaginator is a paginator for ListDatasetImportJobs

func NewListDatasetImportJobsPaginator added in v0.30.0 

func NewListDatasetImportJobsPaginator(client ListDatasetImportJobsAPIClient, params *ListDatasetImportJobsInput, optFns ...func(*ListDatasetImportJobsPaginatorOptions)) *ListDatasetImportJobsPaginator

NewListDatasetImportJobsPaginator returns a new ListDatasetImportJobsPaginator

func (*ListDatasetImportJobsPaginator) HasMorePages added in v0.30.0 

func (p *ListDatasetImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetImportJobsPaginator) NextPage added in v0.30.0 

func (p *ListDatasetImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetImportJobsOutput, error)

NextPage retrieves the next ListDatasetImportJobs page.

type ListDatasetImportJobsPaginatorOptions added in v0.30.0 

type ListDatasetImportJobsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetImportJobsPaginatorOptions is the paginator options for ListDatasetImportJobs

type ListDatasetsAPIClient added in v0.30.0 

type ListDatasetsAPIClient interface {
	ListDatasets(context.Context, *ListDatasetsInput, ...func(*Options)) (*ListDatasetsOutput, error)
}

ListDatasetsAPIClient is a client that implements the ListDatasets operation.

type ListDatasetsInput 

type ListDatasetsInput struct {

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDatasetsOutput 

type ListDatasetsOutput struct {

	// An array of objects that summarize each dataset's properties.
	Datasets []types.DatasetSummary

	// If the response is truncated, Amazon Forecast returns this token. To retrieve
	// the next set of results, use the token in the next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetsPaginator added in v0.30.0 

type ListDatasetsPaginator struct {
	// contains filtered or unexported fields
}

ListDatasetsPaginator is a paginator for ListDatasets

func NewListDatasetsPaginator added in v0.30.0 

func NewListDatasetsPaginator(client ListDatasetsAPIClient, params *ListDatasetsInput, optFns ...func(*ListDatasetsPaginatorOptions)) *ListDatasetsPaginator

NewListDatasetsPaginator returns a new ListDatasetsPaginator

func (*ListDatasetsPaginator) HasMorePages added in v0.30.0 

func (p *ListDatasetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetsPaginator) NextPage added in v0.30.0 

func (p *ListDatasetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetsOutput, error)

NextPage retrieves the next ListDatasets page.

type ListDatasetsPaginatorOptions added in v0.30.0 

type ListDatasetsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetsPaginatorOptions is the paginator options for ListDatasets

type ListExplainabilitiesAPIClient added in v1.20.0 

type ListExplainabilitiesAPIClient interface {
	ListExplainabilities(context.Context, *ListExplainabilitiesInput, ...func(*Options)) (*ListExplainabilitiesOutput, error)
}

ListExplainabilitiesAPIClient is a client that implements the ListExplainabilities operation.

type ListExplainabilitiesInput added in v1.14.0 

type ListExplainabilitiesInput struct {

	// An array of filters. For each filter, provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the resources that match the statement from the list. The
	// match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are ResourceArn
	//   and Status .
	//
	//   - Value - The value to match.
	Filters []types.Filter

	// The number of items returned in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken. To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListExplainabilitiesOutput added in v1.14.0 

type ListExplainabilitiesOutput struct {

	// An array of objects that summarize the properties of each Explainability
	// resource.
	Explainabilities []types.ExplainabilitySummary

	// Returns this token if the response is truncated. To retrieve the next set of
	// results, use the token in the next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListExplainabilitiesPaginator added in v1.20.0 

type ListExplainabilitiesPaginator struct {
	// contains filtered or unexported fields
}

ListExplainabilitiesPaginator is a paginator for ListExplainabilities

func NewListExplainabilitiesPaginator added in v1.20.0 

func NewListExplainabilitiesPaginator(client ListExplainabilitiesAPIClient, params *ListExplainabilitiesInput, optFns ...func(*ListExplainabilitiesPaginatorOptions)) *ListExplainabilitiesPaginator

NewListExplainabilitiesPaginator returns a new ListExplainabilitiesPaginator

func (*ListExplainabilitiesPaginator) HasMorePages added in v1.20.0 

func (p *ListExplainabilitiesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExplainabilitiesPaginator) NextPage added in v1.20.0 

func (p *ListExplainabilitiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExplainabilitiesOutput, error)

NextPage retrieves the next ListExplainabilities page.

type ListExplainabilitiesPaginatorOptions added in v1.20.0 

type ListExplainabilitiesPaginatorOptions struct {
	// The number of items returned in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListExplainabilitiesPaginatorOptions is the paginator options for ListExplainabilities

type ListExplainabilityExportsAPIClient added in v1.20.0 

type ListExplainabilityExportsAPIClient interface {
	ListExplainabilityExports(context.Context, *ListExplainabilityExportsInput, ...func(*Options)) (*ListExplainabilityExportsOutput, error)
}

ListExplainabilityExportsAPIClient is a client that implements the ListExplainabilityExports operation.

type ListExplainabilityExportsInput added in v1.14.0 

type ListExplainabilityExportsInput struct {

	// An array of filters. For each filter, provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude resources that match the statement from the list. The match
	// statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are ResourceArn
	//   and Status .
	//
	//   - Value - The value to match.
	Filters []types.Filter

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken. To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListExplainabilityExportsOutput added in v1.14.0 

type ListExplainabilityExportsOutput struct {

	// An array of objects that summarize the properties of each Explainability export.
	ExplainabilityExports []types.ExplainabilityExportSummary

	// Returns this token if the response is truncated. To retrieve the next set of
	// results, use the token in the next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListExplainabilityExportsPaginator added in v1.20.0 

type ListExplainabilityExportsPaginator struct {
	// contains filtered or unexported fields
}

ListExplainabilityExportsPaginator is a paginator for ListExplainabilityExports

func NewListExplainabilityExportsPaginator added in v1.20.0 

func NewListExplainabilityExportsPaginator(client ListExplainabilityExportsAPIClient, params *ListExplainabilityExportsInput, optFns ...func(*ListExplainabilityExportsPaginatorOptions)) *ListExplainabilityExportsPaginator

NewListExplainabilityExportsPaginator returns a new ListExplainabilityExportsPaginator

func (*ListExplainabilityExportsPaginator) HasMorePages added in v1.20.0 

func (p *ListExplainabilityExportsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExplainabilityExportsPaginator) NextPage added in v1.20.0 

func (p *ListExplainabilityExportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExplainabilityExportsOutput, error)

NextPage retrieves the next ListExplainabilityExports page.

type ListExplainabilityExportsPaginatorOptions added in v1.20.0 

type ListExplainabilityExportsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListExplainabilityExportsPaginatorOptions is the paginator options for ListExplainabilityExports

type ListForecastExportJobsAPIClient added in v0.30.0 

type ListForecastExportJobsAPIClient interface {
	ListForecastExportJobs(context.Context, *ListForecastExportJobsInput, ...func(*Options)) (*ListForecastExportJobsOutput, error)
}

ListForecastExportJobsAPIClient is a client that implements the ListForecastExportJobs operation.

type ListForecastExportJobsInput 

type ListForecastExportJobsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the forecast export jobs that match the statement from the
	// list, respectively. The match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT . To
	//   include the forecast export jobs that match the statement, specify IS . To
	//   exclude matching forecast export jobs, specify IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are ForecastArn
	//   and Status .
	//
	//   - Value - The value to match.
	//
	// For example, to list all jobs that export a forecast named electricityforecast,
	// specify the following filter:
	//
	//     "Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value":
	//     "arn:aws:forecast:us-west-2::forecast/electricityforecast" } ]
	Filters []types.Filter

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListForecastExportJobsOutput 

type ListForecastExportJobsOutput struct {

	// An array of objects that summarize each export job's properties.
	ForecastExportJobs []types.ForecastExportJobSummary

	// If the response is truncated, Amazon Forecast returns this token. To retrieve
	// the next set of results, use the token in the next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListForecastExportJobsPaginator added in v0.30.0 

type ListForecastExportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListForecastExportJobsPaginator is a paginator for ListForecastExportJobs

func NewListForecastExportJobsPaginator added in v0.30.0 

func NewListForecastExportJobsPaginator(client ListForecastExportJobsAPIClient, params *ListForecastExportJobsInput, optFns ...func(*ListForecastExportJobsPaginatorOptions)) *ListForecastExportJobsPaginator

NewListForecastExportJobsPaginator returns a new ListForecastExportJobsPaginator

func (*ListForecastExportJobsPaginator) HasMorePages added in v0.30.0 

func (p *ListForecastExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListForecastExportJobsPaginator) NextPage added in v0.30.0 

func (p *ListForecastExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListForecastExportJobsOutput, error)

NextPage retrieves the next ListForecastExportJobs page.

type ListForecastExportJobsPaginatorOptions added in v0.30.0 

type ListForecastExportJobsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListForecastExportJobsPaginatorOptions is the paginator options for ListForecastExportJobs

type ListForecastsAPIClient added in v0.30.0 

type ListForecastsAPIClient interface {
	ListForecasts(context.Context, *ListForecastsInput, ...func(*Options)) (*ListForecastsOutput, error)
}

ListForecastsAPIClient is a client that implements the ListForecasts operation.

type ListForecastsInput 

type ListForecastsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the forecasts that match the statement from the list,
	// respectively. The match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT . To
	//   include the forecasts that match the statement, specify IS . To exclude
	//   matching forecasts, specify IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are
	//   DatasetGroupArn , PredictorArn , and Status .
	//
	//   - Value - The value to match.
	//
	// For example, to list all forecasts whose status is not ACTIVE, you would
	// specify:
	//
	//     "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
	Filters []types.Filter

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListForecastsOutput 

type ListForecastsOutput struct {

	// An array of objects that summarize each forecast's properties.
	Forecasts []types.ForecastSummary

	// If the response is truncated, Amazon Forecast returns this token. To retrieve
	// the next set of results, use the token in the next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListForecastsPaginator added in v0.30.0 

type ListForecastsPaginator struct {
	// contains filtered or unexported fields
}

ListForecastsPaginator is a paginator for ListForecasts

func NewListForecastsPaginator added in v0.30.0 

func NewListForecastsPaginator(client ListForecastsAPIClient, params *ListForecastsInput, optFns ...func(*ListForecastsPaginatorOptions)) *ListForecastsPaginator

NewListForecastsPaginator returns a new ListForecastsPaginator

func (*ListForecastsPaginator) HasMorePages added in v0.30.0 

func (p *ListForecastsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListForecastsPaginator) NextPage added in v0.30.0 

func (p *ListForecastsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListForecastsOutput, error)

NextPage retrieves the next ListForecasts page.

type ListForecastsPaginatorOptions added in v0.30.0 

type ListForecastsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListForecastsPaginatorOptions is the paginator options for ListForecasts

type ListMonitorEvaluationsAPIClient added in v1.20.0 

type ListMonitorEvaluationsAPIClient interface {
	ListMonitorEvaluations(context.Context, *ListMonitorEvaluationsInput, ...func(*Options)) (*ListMonitorEvaluationsOutput, error)
}

ListMonitorEvaluationsAPIClient is a client that implements the ListMonitorEvaluations operation.

type ListMonitorEvaluationsInput added in v1.20.0 

type ListMonitorEvaluationsInput struct {

	// The Amazon Resource Name (ARN) of the monitor resource to get results from.
	//
	// This member is required.
	MonitorArn *string

	// An array of filters. For each filter, provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the resources that match the statement from the list. The
	// match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. The only valid value is
	//   EvaluationState .
	//
	//   - Value - The value to match. Valid values are only SUCCESS or FAILURE .
	//
	// For example, to list only successful monitor evaluations, you would specify:
	//
	//     "Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS"
	//     } ]
	Filters []types.Filter

	// The maximum number of monitoring results to return.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMonitorEvaluationsOutput added in v1.20.0 

type ListMonitorEvaluationsOutput struct {

	// If the response is truncated, Amazon Forecast returns this token. To retrieve
	// the next set of results, use the token in the next request. Tokens expire after
	// 24 hours.
	NextToken *string

	// The monitoring results and predictor events collected by the monitor resource
	// during different windows of time.
	//
	// For information about monitoring see [Viewing Monitoring Results]. For more information about retrieving
	// monitoring results see [Viewing Monitoring Results].
	//
	// [Viewing Monitoring Results]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html
	PredictorMonitorEvaluations []types.PredictorMonitorEvaluation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMonitorEvaluationsPaginator added in v1.20.0 

type ListMonitorEvaluationsPaginator struct {
	// contains filtered or unexported fields
}

ListMonitorEvaluationsPaginator is a paginator for ListMonitorEvaluations

func NewListMonitorEvaluationsPaginator added in v1.20.0 

func NewListMonitorEvaluationsPaginator(client ListMonitorEvaluationsAPIClient, params *ListMonitorEvaluationsInput, optFns ...func(*ListMonitorEvaluationsPaginatorOptions)) *ListMonitorEvaluationsPaginator

NewListMonitorEvaluationsPaginator returns a new ListMonitorEvaluationsPaginator

func (*ListMonitorEvaluationsPaginator) HasMorePages added in v1.20.0 

func (p *ListMonitorEvaluationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMonitorEvaluationsPaginator) NextPage added in v1.20.0 

func (p *ListMonitorEvaluationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMonitorEvaluationsOutput, error)

NextPage retrieves the next ListMonitorEvaluations page.

type ListMonitorEvaluationsPaginatorOptions added in v1.20.0 

type ListMonitorEvaluationsPaginatorOptions struct {
	// The maximum number of monitoring results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMonitorEvaluationsPaginatorOptions is the paginator options for ListMonitorEvaluations

type ListMonitorsAPIClient added in v1.20.0 

type ListMonitorsAPIClient interface {
	ListMonitors(context.Context, *ListMonitorsInput, ...func(*Options)) (*ListMonitorsOutput, error)
}

ListMonitorsAPIClient is a client that implements the ListMonitors operation.

type ListMonitorsInput added in v1.20.0 

type ListMonitorsInput struct {

	// An array of filters. For each filter, provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the resources that match the statement from the list. The
	// match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. The only valid value is Status
	//   .
	//
	//   - Value - The value to match.
	//
	// For example, to list all monitors who's status is ACTIVE, you would specify:
	//
	//     "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
	Filters []types.Filter

	// The maximum number of monitors to include in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMonitorsOutput added in v1.20.0 

type ListMonitorsOutput struct {

	// An array of objects that summarize each monitor's properties.
	Monitors []types.MonitorSummary

	// If the response is truncated, Amazon Forecast returns this token. To retrieve
	// the next set of results, use the token in the next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMonitorsPaginator added in v1.20.0 

type ListMonitorsPaginator struct {
	// contains filtered or unexported fields
}

ListMonitorsPaginator is a paginator for ListMonitors

func NewListMonitorsPaginator added in v1.20.0 

func NewListMonitorsPaginator(client ListMonitorsAPIClient, params *ListMonitorsInput, optFns ...func(*ListMonitorsPaginatorOptions)) *ListMonitorsPaginator

NewListMonitorsPaginator returns a new ListMonitorsPaginator

func (*ListMonitorsPaginator) HasMorePages added in v1.20.0 

func (p *ListMonitorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMonitorsPaginator) NextPage added in v1.20.0 

func (p *ListMonitorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMonitorsOutput, error)

NextPage retrieves the next ListMonitors page.

type ListMonitorsPaginatorOptions added in v1.20.0 

type ListMonitorsPaginatorOptions struct {
	// The maximum number of monitors to include in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMonitorsPaginatorOptions is the paginator options for ListMonitors

type ListPredictorBacktestExportJobsAPIClient added in v0.31.0 

type ListPredictorBacktestExportJobsAPIClient interface {
	ListPredictorBacktestExportJobs(context.Context, *ListPredictorBacktestExportJobsInput, ...func(*Options)) (*ListPredictorBacktestExportJobsOutput, error)
}

ListPredictorBacktestExportJobsAPIClient is a client that implements the ListPredictorBacktestExportJobs operation.

type ListPredictorBacktestExportJobsInput added in v0.31.0 

type ListPredictorBacktestExportJobsInput struct {

	// An array of filters. For each filter, provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the predictor backtest export jobs that match the statement
	// from the list. The match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT . To
	//   include the predictor backtest export jobs that match the statement, specify
	//   IS . To exclude matching predictor backtest export jobs, specify IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are PredictorArn
	//   and Status .
	//
	//   - Value - The value to match.
	Filters []types.Filter

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken. To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPredictorBacktestExportJobsOutput added in v0.31.0 

type ListPredictorBacktestExportJobsOutput struct {

	// Returns this token if the response is truncated. To retrieve the next set of
	// results, use the token in the next request.
	NextToken *string

	// An array of objects that summarize the properties of each predictor backtest
	// export job.
	PredictorBacktestExportJobs []types.PredictorBacktestExportJobSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPredictorBacktestExportJobsPaginator added in v0.31.0 

type ListPredictorBacktestExportJobsPaginator struct {
	// contains filtered or unexported fields
}

ListPredictorBacktestExportJobsPaginator is a paginator for ListPredictorBacktestExportJobs

func NewListPredictorBacktestExportJobsPaginator added in v0.31.0 

func NewListPredictorBacktestExportJobsPaginator(client ListPredictorBacktestExportJobsAPIClient, params *ListPredictorBacktestExportJobsInput, optFns ...func(*ListPredictorBacktestExportJobsPaginatorOptions)) *ListPredictorBacktestExportJobsPaginator

NewListPredictorBacktestExportJobsPaginator returns a new ListPredictorBacktestExportJobsPaginator

func (*ListPredictorBacktestExportJobsPaginator) HasMorePages added in v0.31.0 

func (p *ListPredictorBacktestExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPredictorBacktestExportJobsPaginator) NextPage added in v0.31.0 

func (p *ListPredictorBacktestExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPredictorBacktestExportJobsOutput, error)

NextPage retrieves the next ListPredictorBacktestExportJobs page.

type ListPredictorBacktestExportJobsPaginatorOptions added in v0.31.0 

type ListPredictorBacktestExportJobsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPredictorBacktestExportJobsPaginatorOptions is the paginator options for ListPredictorBacktestExportJobs

type ListPredictorsAPIClient added in v0.30.0 

type ListPredictorsAPIClient interface {
	ListPredictors(context.Context, *ListPredictorsInput, ...func(*Options)) (*ListPredictorsOutput, error)
}

ListPredictorsAPIClient is a client that implements the ListPredictors operation.

type ListPredictorsInput 

type ListPredictorsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the predictors that match the statement from the list,
	// respectively. The match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT . To
	//   include the predictors that match the statement, specify IS . To exclude
	//   matching predictors, specify IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are
	//   DatasetGroupArn and Status .
	//
	//   - Value - The value to match.
	//
	// For example, to list all predictors whose status is ACTIVE, you would specify:
	//
	//     "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
	Filters []types.Filter

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPredictorsOutput 

type ListPredictorsOutput struct {

	// If the response is truncated, Amazon Forecast returns this token. To retrieve
	// the next set of results, use the token in the next request.
	NextToken *string

	// An array of objects that summarize each predictor's properties.
	Predictors []types.PredictorSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPredictorsPaginator added in v0.30.0 

type ListPredictorsPaginator struct {
	// contains filtered or unexported fields
}

ListPredictorsPaginator is a paginator for ListPredictors

func NewListPredictorsPaginator added in v0.30.0 

func NewListPredictorsPaginator(client ListPredictorsAPIClient, params *ListPredictorsInput, optFns ...func(*ListPredictorsPaginatorOptions)) *ListPredictorsPaginator

NewListPredictorsPaginator returns a new ListPredictorsPaginator

func (*ListPredictorsPaginator) HasMorePages added in v0.30.0 

func (p *ListPredictorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPredictorsPaginator) NextPage added in v0.30.0 

func (p *ListPredictorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPredictorsOutput, error)

NextPage retrieves the next ListPredictors page.

type ListPredictorsPaginatorOptions added in v0.30.0 

type ListPredictorsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPredictorsPaginatorOptions is the paginator options for ListPredictors

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource for which to list
	// the tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags for the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWhatIfAnalysesAPIClient added in v1.23.0 

type ListWhatIfAnalysesAPIClient interface {
	ListWhatIfAnalyses(context.Context, *ListWhatIfAnalysesInput, ...func(*Options)) (*ListWhatIfAnalysesOutput, error)
}

ListWhatIfAnalysesAPIClient is a client that implements the ListWhatIfAnalyses operation.

type ListWhatIfAnalysesInput added in v1.23.0 

type ListWhatIfAnalysesInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the what-if analysis jobs that match the statement from the
	// list, respectively. The match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT . To
	//   include the what-if analysis jobs that match the statement, specify IS . To
	//   exclude matching what-if analysis jobs, specify IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are
	//   WhatIfAnalysisArn and Status .
	//
	//   - Value - The value to match.
	//
	// For example, to list all jobs that export a forecast named electricityWhatIf,
	// specify the following filter:
	//
	//     "Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value":
	//     "arn:aws:forecast:us-west-2::forecast/electricityWhatIf" } ]
	Filters []types.Filter

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWhatIfAnalysesOutput added in v1.23.0 

type ListWhatIfAnalysesOutput struct {

	// If the response is truncated, Forecast returns this token. To retrieve the next
	// set of results, use the token in the next request.
	NextToken *string

	// An array of WhatIfAnalysisSummary objects that describe the matched analyses.
	WhatIfAnalyses []types.WhatIfAnalysisSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWhatIfAnalysesPaginator added in v1.23.0 

type ListWhatIfAnalysesPaginator struct {
	// contains filtered or unexported fields
}

ListWhatIfAnalysesPaginator is a paginator for ListWhatIfAnalyses

func NewListWhatIfAnalysesPaginator added in v1.23.0 

func NewListWhatIfAnalysesPaginator(client ListWhatIfAnalysesAPIClient, params *ListWhatIfAnalysesInput, optFns ...func(*ListWhatIfAnalysesPaginatorOptions)) *ListWhatIfAnalysesPaginator

NewListWhatIfAnalysesPaginator returns a new ListWhatIfAnalysesPaginator

func (*ListWhatIfAnalysesPaginator) HasMorePages added in v1.23.0 

func (p *ListWhatIfAnalysesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWhatIfAnalysesPaginator) NextPage added in v1.23.0 

func (p *ListWhatIfAnalysesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWhatIfAnalysesOutput, error)

NextPage retrieves the next ListWhatIfAnalyses page.

type ListWhatIfAnalysesPaginatorOptions added in v1.23.0 

type ListWhatIfAnalysesPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWhatIfAnalysesPaginatorOptions is the paginator options for ListWhatIfAnalyses

type ListWhatIfForecastExportsAPIClient added in v1.23.0 

type ListWhatIfForecastExportsAPIClient interface {
	ListWhatIfForecastExports(context.Context, *ListWhatIfForecastExportsInput, ...func(*Options)) (*ListWhatIfForecastExportsOutput, error)
}

ListWhatIfForecastExportsAPIClient is a client that implements the ListWhatIfForecastExports operation.

type ListWhatIfForecastExportsInput added in v1.23.0 

type ListWhatIfForecastExportsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the what-if forecast export jobs that match the statement
	// from the list, respectively. The match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT . To
	//   include the forecast export jobs that match the statement, specify IS . To
	//   exclude matching forecast export jobs, specify IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are
	//   WhatIfForecastExportArn and Status .
	//
	//   - Value - The value to match.
	//
	// For example, to list all jobs that export a forecast named
	// electricityWIFExport, specify the following filter:
	//
	//     "Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value":
	//     "arn:aws:forecast:us-west-2::forecast/electricityWIFExport" } ]
	Filters []types.Filter

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWhatIfForecastExportsOutput added in v1.23.0 

type ListWhatIfForecastExportsOutput struct {

	// If the response is truncated, Forecast returns this token. To retrieve the next
	// set of results, use the token in the next request.
	NextToken *string

	// An array of WhatIfForecastExports objects that describe the matched forecast
	// exports.
	WhatIfForecastExports []types.WhatIfForecastExportSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWhatIfForecastExportsPaginator added in v1.23.0 

type ListWhatIfForecastExportsPaginator struct {
	// contains filtered or unexported fields
}

ListWhatIfForecastExportsPaginator is a paginator for ListWhatIfForecastExports

func NewListWhatIfForecastExportsPaginator added in v1.23.0 

func NewListWhatIfForecastExportsPaginator(client ListWhatIfForecastExportsAPIClient, params *ListWhatIfForecastExportsInput, optFns ...func(*ListWhatIfForecastExportsPaginatorOptions)) *ListWhatIfForecastExportsPaginator

NewListWhatIfForecastExportsPaginator returns a new ListWhatIfForecastExportsPaginator

func (*ListWhatIfForecastExportsPaginator) HasMorePages added in v1.23.0 

func (p *ListWhatIfForecastExportsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWhatIfForecastExportsPaginator) NextPage added in v1.23.0 

func (p *ListWhatIfForecastExportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWhatIfForecastExportsOutput, error)

NextPage retrieves the next ListWhatIfForecastExports page.

type ListWhatIfForecastExportsPaginatorOptions added in v1.23.0 

type ListWhatIfForecastExportsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWhatIfForecastExportsPaginatorOptions is the paginator options for ListWhatIfForecastExports

type ListWhatIfForecastsAPIClient added in v1.23.0 

type ListWhatIfForecastsAPIClient interface {
	ListWhatIfForecasts(context.Context, *ListWhatIfForecastsInput, ...func(*Options)) (*ListWhatIfForecastsOutput, error)
}

ListWhatIfForecastsAPIClient is a client that implements the ListWhatIfForecasts operation.

type ListWhatIfForecastsInput added in v1.23.0 

type ListWhatIfForecastsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT , which specifies whether to
	// include or exclude the what-if forecast export jobs that match the statement
	// from the list, respectively. The match statement consists of a key and a value.
	//
	// Filter properties
	//
	//   - Condition - The condition to apply. Valid values are IS and IS_NOT . To
	//   include the forecast export jobs that match the statement, specify IS . To
	//   exclude matching forecast export jobs, specify IS_NOT .
	//
	//   - Key - The name of the parameter to filter on. Valid values are
	//   WhatIfForecastArn and Status .
	//
	//   - Value - The value to match.
	//
	// For example, to list all jobs that export a forecast named
	// electricityWhatIfForecast, specify the following filter:
	//
	//     "Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value":
	//     "arn:aws:forecast:us-west-2::forecast/electricityWhatIfForecast" } ]
	Filters []types.Filter

	// The number of items to return in the response.
	MaxResults *int32

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWhatIfForecastsOutput added in v1.23.0 

type ListWhatIfForecastsOutput struct {

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string

	// An array of WhatIfForecasts objects that describe the matched forecasts.
	WhatIfForecasts []types.WhatIfForecastSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWhatIfForecastsPaginator added in v1.23.0 

type ListWhatIfForecastsPaginator struct {
	// contains filtered or unexported fields
}

ListWhatIfForecastsPaginator is a paginator for ListWhatIfForecasts

func NewListWhatIfForecastsPaginator added in v1.23.0 

func NewListWhatIfForecastsPaginator(client ListWhatIfForecastsAPIClient, params *ListWhatIfForecastsInput, optFns ...func(*ListWhatIfForecastsPaginatorOptions)) *ListWhatIfForecastsPaginator

NewListWhatIfForecastsPaginator returns a new ListWhatIfForecastsPaginator

func (*ListWhatIfForecastsPaginator) HasMorePages added in v1.23.0 

func (p *ListWhatIfForecastsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWhatIfForecastsPaginator) NextPage added in v1.23.0 

func (p *ListWhatIfForecastsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWhatIfForecastsOutput, error)

NextPage retrieves the next ListWhatIfForecasts page.

type ListWhatIfForecastsPaginatorOptions added in v1.23.0 

type ListWhatIfForecastsPaginatorOptions struct {
	// The number of items to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWhatIfForecastsPaginatorOptions is the paginator options for ListWhatIfForecasts

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Indicates how aws account ID is applied in endpoint2.0 routing
	AccountIDEndpointMode aws.AccountIDEndpointMode

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.29.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type ResumeResourceInput added in v1.20.0 

type ResumeResourceInput struct {

	// The Amazon Resource Name (ARN) of the monitor resource to resume.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ResumeResourceOutput added in v1.20.0 

type ResumeResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopResourceInput added in v1.2.0 

type StopResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource to stop. The
	// supported ARNs are DatasetImportJobArn , PredictorArn ,
	// PredictorBacktestExportJobArn , ForecastArn , ForecastExportJobArn ,
	// ExplainabilityArn , and ExplainabilityExportArn .
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type StopResourceOutput added in v1.2.0 

type StopResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource for which to list
	// the tags.
	//
	// This member is required.
	ResourceArn *string

	// The tags to add to the resource. A tag is an array of key-value pairs.
	//
	// The following basic restrictions apply to tags:
	//
	//   - Maximum number of tags per resource - 50.
	//
	//   - For each resource, each tag key must be unique, and each tag key can have
	//   only one value.
	//
	//   - Maximum key length - 128 Unicode characters in UTF-8.
	//
	//   - Maximum value length - 256 Unicode characters in UTF-8.
	//
	//   - If your tagging schema is used across multiple services and resources,
	//   remember that other services may have restrictions on allowed characters.
	//   Generally allowed characters are: letters, numbers, and spaces representable in
	//   UTF-8, and the following characters: + - = . _ : / @.
	//
	//   - Tag keys and values are case sensitive.
	//
	//   - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
	//   prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
	//   or delete tag keys with this prefix. Values can have this prefix. If a tag value
	//   has aws as its prefix but the key does not, then Forecast considers it to be a
	//   user tag and will count against the limit of 50 tags. Tags with only the key
	//   prefix of aws do not count against your tags per resource limit.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource for which to list
	// the tags.
	//
	// This member is required.
	ResourceArn *string

	// The keys of the tags to be removed.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDatasetGroupInput 

type UpdateDatasetGroupInput struct {

	// An array of the Amazon Resource Names (ARNs) of the datasets to add to the
	// dataset group.
	//
	// This member is required.
	DatasetArns []string

	// The ARN of the dataset group.
	//
	// This member is required.
	DatasetGroupArn *string
	// contains filtered or unexported fields
}

type UpdateDatasetGroupOutput 

type UpdateDatasetGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.