| Server IP : 91.108.119.130 / Your IP : 216.73.217.109 Web Server : LiteSpeed System : Linux id-dci-web1986.main-hosting.eu 5.14.0-611.26.1.el9_7.x86_64 #1 SMP PREEMPT_DYNAMIC Thu Jan 29 05:24:47 EST 2026 x86_64 User : u686484674 ( 686484674) PHP Version : 8.0.30 Disable Function : system, exec, shell_exec, passthru, mysql_list_dbs, ini_alter, dl, symlink, link, chgrp, leak, popen, apache_child_terminate, virtual, mb_send_mail MySQL : OFF | cURL : ON | WGET : ON | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : /proc/./self/root/opt/go/pkg/mod/github.com/aws/aws-sdk-go@v1.55.5/service/forecastservice/ |
Upload File : |
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package forecastservice
import (
"fmt"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/private/protocol"
"github.com/aws/aws-sdk-go/private/protocol/jsonrpc"
)
const opCreateAutoPredictor = "CreateAutoPredictor"
// CreateAutoPredictorRequest generates a "aws/request.Request" representing the
// client's request for the CreateAutoPredictor operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateAutoPredictor for more information on using the CreateAutoPredictor
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateAutoPredictorRequest method.
// req, resp := client.CreateAutoPredictorRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictor
func (c *ForecastService) CreateAutoPredictorRequest(input *CreateAutoPredictorInput) (req *request.Request, output *CreateAutoPredictorOutput) {
op := &request.Operation{
Name: opCreateAutoPredictor,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateAutoPredictorInput{}
}
output = &CreateAutoPredictorOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateAutoPredictor API operation for Amazon Forecast Service.
//
// Creates an Amazon Forecast predictor.
//
// Amazon Forecast creates predictors with AutoPredictor, which involves applying
// the optimal combination of algorithms to each time series in your datasets.
// You can use CreateAutoPredictor to create new predictors or upgrade/retrain
// existing predictors.
//
// # Creating new predictors
//
// The following parameters are required when creating a new predictor:
//
// - PredictorName - A unique name for the predictor.
//
// - DatasetGroupArn - The ARN of the dataset group used to train the predictor.
//
// - ForecastFrequency - The granularity of your forecasts (hourly, daily,
// weekly, etc).
//
// - ForecastHorizon - The number of time-steps that the model predicts.
// The forecast horizon is also called the prediction length.
//
// When creating a new predictor, do not specify a value for ReferencePredictorArn.
//
// # Upgrading and retraining predictors
//
// The following parameters are required when retraining or upgrading a predictor:
//
// - PredictorName - A unique name for the predictor.
//
// - ReferencePredictorArn - The ARN of the predictor to retrain or upgrade.
//
// When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn
// and PredictorName.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateAutoPredictor for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictor
func (c *ForecastService) CreateAutoPredictor(input *CreateAutoPredictorInput) (*CreateAutoPredictorOutput, error) {
req, out := c.CreateAutoPredictorRequest(input)
return out, req.Send()
}
// CreateAutoPredictorWithContext is the same as CreateAutoPredictor with the addition of
// the ability to pass a context and additional request options.
//
// See CreateAutoPredictor for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateAutoPredictorWithContext(ctx aws.Context, input *CreateAutoPredictorInput, opts ...request.Option) (*CreateAutoPredictorOutput, error) {
req, out := c.CreateAutoPredictorRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateDataset = "CreateDataset"
// CreateDatasetRequest generates a "aws/request.Request" representing the
// client's request for the CreateDataset operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateDataset for more information on using the CreateDataset
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateDatasetRequest method.
// req, resp := client.CreateDatasetRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDataset
func (c *ForecastService) CreateDatasetRequest(input *CreateDatasetInput) (req *request.Request, output *CreateDatasetOutput) {
op := &request.Operation{
Name: opCreateDataset,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateDatasetInput{}
}
output = &CreateDatasetOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateDataset API operation for Amazon Forecast Service.
//
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).
//
// To get a list of all your datasets, use the ListDatasets (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html)
// operation.
//
// For example Forecast datasets, see the Amazon Forecast Sample GitHub repository
// (https://github.com/aws-samples/amazon-forecast-samples).
//
// The Status of a dataset must be ACTIVE before you can import training data.
// Use the DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)
// operation to get the status.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateDataset for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDataset
func (c *ForecastService) CreateDataset(input *CreateDatasetInput) (*CreateDatasetOutput, error) {
req, out := c.CreateDatasetRequest(input)
return out, req.Send()
}
// CreateDatasetWithContext is the same as CreateDataset with the addition of
// the ability to pass a context and additional request options.
//
// See CreateDataset for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateDatasetWithContext(ctx aws.Context, input *CreateDatasetInput, opts ...request.Option) (*CreateDatasetOutput, error) {
req, out := c.CreateDatasetRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateDatasetGroup = "CreateDatasetGroup"
// CreateDatasetGroupRequest generates a "aws/request.Request" representing the
// client's request for the CreateDatasetGroup operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateDatasetGroup for more information on using the CreateDatasetGroup
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateDatasetGroupRequest method.
// req, resp := client.CreateDatasetGroupRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetGroup
func (c *ForecastService) CreateDatasetGroupRequest(input *CreateDatasetGroupInput) (req *request.Request, output *CreateDatasetGroupOutput) {
op := &request.Operation{
Name: opCreateDatasetGroup,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateDatasetGroupInput{}
}
output = &CreateDatasetGroupOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateDatasetGroup API operation for Amazon Forecast Service.
//
// 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 UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)
// operation.
//
// After creating a dataset group and adding datasets, you use the dataset group
// when you create a predictor. For more information, see Dataset groups (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).
//
// To get a list of all your datasets groups, use the ListDatasetGroups (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html)
// 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 DescribeDatasetGroup
// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateDatasetGroup for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetGroup
func (c *ForecastService) CreateDatasetGroup(input *CreateDatasetGroupInput) (*CreateDatasetGroupOutput, error) {
req, out := c.CreateDatasetGroupRequest(input)
return out, req.Send()
}
// CreateDatasetGroupWithContext is the same as CreateDatasetGroup with the addition of
// the ability to pass a context and additional request options.
//
// See CreateDatasetGroup for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateDatasetGroupWithContext(ctx aws.Context, input *CreateDatasetGroupInput, opts ...request.Option) (*CreateDatasetGroupOutput, error) {
req, out := c.CreateDatasetGroupRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateDatasetImportJob = "CreateDatasetImportJob"
// CreateDatasetImportJobRequest generates a "aws/request.Request" representing the
// client's request for the CreateDatasetImportJob operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateDatasetImportJob for more information on using the CreateDatasetImportJob
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateDatasetImportJobRequest method.
// req, resp := client.CreateDatasetImportJobRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJob
func (c *ForecastService) CreateDatasetImportJobRequest(input *CreateDatasetImportJobInput) (req *request.Request, output *CreateDatasetImportJobOutput) {
op := &request.Operation{
Name: opCreateDatasetImportJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateDatasetImportJobInput{}
}
output = &CreateDatasetImportJobOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateDatasetImportJob API operation for Amazon Forecast Service.
//
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html)
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html).
//
// 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 ListDatasetImportJobs (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html)
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateDatasetImportJob for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJob
func (c *ForecastService) CreateDatasetImportJob(input *CreateDatasetImportJobInput) (*CreateDatasetImportJobOutput, error) {
req, out := c.CreateDatasetImportJobRequest(input)
return out, req.Send()
}
// CreateDatasetImportJobWithContext is the same as CreateDatasetImportJob with the addition of
// the ability to pass a context and additional request options.
//
// See CreateDatasetImportJob for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateDatasetImportJobWithContext(ctx aws.Context, input *CreateDatasetImportJobInput, opts ...request.Option) (*CreateDatasetImportJobOutput, error) {
req, out := c.CreateDatasetImportJobRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateExplainability = "CreateExplainability"
// CreateExplainabilityRequest generates a "aws/request.Request" representing the
// client's request for the CreateExplainability operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateExplainability for more information on using the CreateExplainability
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateExplainabilityRequest method.
// req, resp := client.CreateExplainabilityRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainability
func (c *ForecastService) CreateExplainabilityRequest(input *CreateExplainabilityInput) (req *request.Request, output *CreateExplainabilityOutput) {
op := &request.Operation{
Name: opCreateExplainability,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateExplainabilityInput{}
}
output = &CreateExplainabilityOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateExplainability API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateExplainability for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainability
func (c *ForecastService) CreateExplainability(input *CreateExplainabilityInput) (*CreateExplainabilityOutput, error) {
req, out := c.CreateExplainabilityRequest(input)
return out, req.Send()
}
// CreateExplainabilityWithContext is the same as CreateExplainability with the addition of
// the ability to pass a context and additional request options.
//
// See CreateExplainability for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateExplainabilityWithContext(ctx aws.Context, input *CreateExplainabilityInput, opts ...request.Option) (*CreateExplainabilityOutput, error) {
req, out := c.CreateExplainabilityRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateExplainabilityExport = "CreateExplainabilityExport"
// CreateExplainabilityExportRequest generates a "aws/request.Request" representing the
// client's request for the CreateExplainabilityExport operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateExplainabilityExport for more information on using the CreateExplainabilityExport
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateExplainabilityExportRequest method.
// req, resp := client.CreateExplainabilityExportRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExport
func (c *ForecastService) CreateExplainabilityExportRequest(input *CreateExplainabilityExportInput) (req *request.Request, output *CreateExplainabilityExportOutput) {
op := &request.Operation{
Name: opCreateExplainabilityExport,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateExplainabilityExportInput{}
}
output = &CreateExplainabilityExportOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateExplainabilityExport API operation for Amazon Forecast Service.
//
// 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 DescribeExplainabilityExport
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateExplainabilityExport for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExport
func (c *ForecastService) CreateExplainabilityExport(input *CreateExplainabilityExportInput) (*CreateExplainabilityExportOutput, error) {
req, out := c.CreateExplainabilityExportRequest(input)
return out, req.Send()
}
// CreateExplainabilityExportWithContext is the same as CreateExplainabilityExport with the addition of
// the ability to pass a context and additional request options.
//
// See CreateExplainabilityExport for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateExplainabilityExportWithContext(ctx aws.Context, input *CreateExplainabilityExportInput, opts ...request.Option) (*CreateExplainabilityExportOutput, error) {
req, out := c.CreateExplainabilityExportRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateForecast = "CreateForecast"
// CreateForecastRequest generates a "aws/request.Request" representing the
// client's request for the CreateForecast operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateForecast for more information on using the CreateForecast
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateForecastRequest method.
// req, resp := client.CreateForecastRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecast
func (c *ForecastService) CreateForecastRequest(input *CreateForecastInput) (req *request.Request, output *CreateForecastOutput) {
op := &request.Operation{
Name: opCreateForecast,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateForecastInput{}
}
output = &CreateForecastOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateForecast API operation for Amazon Forecast Service.
//
// 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 CreateForecastExportJob operation.
//
// The range of the forecast is determined by the ForecastHorizon value, which
// you specify in the CreatePredictor request. 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 DescribeForecast operation 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateForecast for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecast
func (c *ForecastService) CreateForecast(input *CreateForecastInput) (*CreateForecastOutput, error) {
req, out := c.CreateForecastRequest(input)
return out, req.Send()
}
// CreateForecastWithContext is the same as CreateForecast with the addition of
// the ability to pass a context and additional request options.
//
// See CreateForecast for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateForecastWithContext(ctx aws.Context, input *CreateForecastInput, opts ...request.Option) (*CreateForecastOutput, error) {
req, out := c.CreateForecastRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateForecastExportJob = "CreateForecastExportJob"
// CreateForecastExportJobRequest generates a "aws/request.Request" representing the
// client's request for the CreateForecastExportJob operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateForecastExportJob for more information on using the CreateForecastExportJob
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateForecastExportJobRequest method.
// req, resp := client.CreateForecastExportJobRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJob
func (c *ForecastService) CreateForecastExportJobRequest(input *CreateForecastExportJobInput) (req *request.Request, output *CreateForecastExportJobOutput) {
op := &request.Operation{
Name: opCreateForecastExportJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateForecastExportJobInput{}
}
output = &CreateForecastExportJobOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateForecastExportJob API operation for Amazon Forecast Service.
//
// 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:
//
// <ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
//
// where the <ExportTimestamp> 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 DescribeForecastExportJob
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateForecastExportJob for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJob
func (c *ForecastService) CreateForecastExportJob(input *CreateForecastExportJobInput) (*CreateForecastExportJobOutput, error) {
req, out := c.CreateForecastExportJobRequest(input)
return out, req.Send()
}
// CreateForecastExportJobWithContext is the same as CreateForecastExportJob with the addition of
// the ability to pass a context and additional request options.
//
// See CreateForecastExportJob for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateForecastExportJobWithContext(ctx aws.Context, input *CreateForecastExportJobInput, opts ...request.Option) (*CreateForecastExportJobOutput, error) {
req, out := c.CreateForecastExportJobRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateMonitor = "CreateMonitor"
// CreateMonitorRequest generates a "aws/request.Request" representing the
// client's request for the CreateMonitor operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateMonitor for more information on using the CreateMonitor
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateMonitorRequest method.
// req, resp := client.CreateMonitorRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitor
func (c *ForecastService) CreateMonitorRequest(input *CreateMonitorInput) (req *request.Request, output *CreateMonitorOutput) {
op := &request.Operation{
Name: opCreateMonitor,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateMonitorInput{}
}
output = &CreateMonitorOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateMonitor API operation for Amazon Forecast Service.
//
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateMonitor for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitor
func (c *ForecastService) CreateMonitor(input *CreateMonitorInput) (*CreateMonitorOutput, error) {
req, out := c.CreateMonitorRequest(input)
return out, req.Send()
}
// CreateMonitorWithContext is the same as CreateMonitor with the addition of
// the ability to pass a context and additional request options.
//
// See CreateMonitor for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateMonitorWithContext(ctx aws.Context, input *CreateMonitorInput, opts ...request.Option) (*CreateMonitorOutput, error) {
req, out := c.CreateMonitorRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreatePredictor = "CreatePredictor"
// CreatePredictorRequest generates a "aws/request.Request" representing the
// client's request for the CreatePredictor operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreatePredictor for more information on using the CreatePredictor
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreatePredictorRequest method.
// req, resp := client.CreatePredictorRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictor
func (c *ForecastService) CreatePredictorRequest(input *CreatePredictorInput) (req *request.Request, output *CreatePredictorOutput) {
op := &request.Operation{
Name: opCreatePredictor,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreatePredictorInput{}
}
output = &CreatePredictorOutput{}
req = c.newRequest(op, input, output)
return
}
// CreatePredictor API operation for Amazon Forecast Service.
//
// 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 CreateForecast operation.
//
// 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 DescribePredictor operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreatePredictor for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictor
func (c *ForecastService) CreatePredictor(input *CreatePredictorInput) (*CreatePredictorOutput, error) {
req, out := c.CreatePredictorRequest(input)
return out, req.Send()
}
// CreatePredictorWithContext is the same as CreatePredictor with the addition of
// the ability to pass a context and additional request options.
//
// See CreatePredictor for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreatePredictorWithContext(ctx aws.Context, input *CreatePredictorInput, opts ...request.Option) (*CreatePredictorOutput, error) {
req, out := c.CreatePredictorRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreatePredictorBacktestExportJob = "CreatePredictorBacktestExportJob"
// CreatePredictorBacktestExportJobRequest generates a "aws/request.Request" representing the
// client's request for the CreatePredictorBacktestExportJob operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreatePredictorBacktestExportJob for more information on using the CreatePredictorBacktestExportJob
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreatePredictorBacktestExportJobRequest method.
// req, resp := client.CreatePredictorBacktestExportJobRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJob
func (c *ForecastService) CreatePredictorBacktestExportJobRequest(input *CreatePredictorBacktestExportJobInput) (req *request.Request, output *CreatePredictorBacktestExportJobOutput) {
op := &request.Operation{
Name: opCreatePredictorBacktestExportJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreatePredictorBacktestExportJobInput{}
}
output = &CreatePredictorBacktestExportJobOutput{}
req = c.newRequest(op, input, output)
return
}
// CreatePredictorBacktestExportJob API operation for Amazon Forecast Service.
//
// 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:
//
// <ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
//
// The <ExportTimestamp> 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 DescribePredictorBacktestExportJob
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreatePredictorBacktestExportJob for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJob
func (c *ForecastService) CreatePredictorBacktestExportJob(input *CreatePredictorBacktestExportJobInput) (*CreatePredictorBacktestExportJobOutput, error) {
req, out := c.CreatePredictorBacktestExportJobRequest(input)
return out, req.Send()
}
// CreatePredictorBacktestExportJobWithContext is the same as CreatePredictorBacktestExportJob with the addition of
// the ability to pass a context and additional request options.
//
// See CreatePredictorBacktestExportJob for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreatePredictorBacktestExportJobWithContext(ctx aws.Context, input *CreatePredictorBacktestExportJobInput, opts ...request.Option) (*CreatePredictorBacktestExportJobOutput, error) {
req, out := c.CreatePredictorBacktestExportJobRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateWhatIfAnalysis = "CreateWhatIfAnalysis"
// CreateWhatIfAnalysisRequest generates a "aws/request.Request" representing the
// client's request for the CreateWhatIfAnalysis operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateWhatIfAnalysis for more information on using the CreateWhatIfAnalysis
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateWhatIfAnalysisRequest method.
// req, resp := client.CreateWhatIfAnalysisRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfAnalysis
func (c *ForecastService) CreateWhatIfAnalysisRequest(input *CreateWhatIfAnalysisInput) (req *request.Request, output *CreateWhatIfAnalysisOutput) {
op := &request.Operation{
Name: opCreateWhatIfAnalysis,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateWhatIfAnalysisInput{}
}
output = &CreateWhatIfAnalysisOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateWhatIfAnalysis API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateWhatIfAnalysis for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfAnalysis
func (c *ForecastService) CreateWhatIfAnalysis(input *CreateWhatIfAnalysisInput) (*CreateWhatIfAnalysisOutput, error) {
req, out := c.CreateWhatIfAnalysisRequest(input)
return out, req.Send()
}
// CreateWhatIfAnalysisWithContext is the same as CreateWhatIfAnalysis with the addition of
// the ability to pass a context and additional request options.
//
// See CreateWhatIfAnalysis for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateWhatIfAnalysisWithContext(ctx aws.Context, input *CreateWhatIfAnalysisInput, opts ...request.Option) (*CreateWhatIfAnalysisOutput, error) {
req, out := c.CreateWhatIfAnalysisRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateWhatIfForecast = "CreateWhatIfForecast"
// CreateWhatIfForecastRequest generates a "aws/request.Request" representing the
// client's request for the CreateWhatIfForecast operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateWhatIfForecast for more information on using the CreateWhatIfForecast
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateWhatIfForecastRequest method.
// req, resp := client.CreateWhatIfForecastRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecast
func (c *ForecastService) CreateWhatIfForecastRequest(input *CreateWhatIfForecastInput) (req *request.Request, output *CreateWhatIfForecastOutput) {
op := &request.Operation{
Name: opCreateWhatIfForecast,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateWhatIfForecastInput{}
}
output = &CreateWhatIfForecastOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateWhatIfForecast API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateWhatIfForecast for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecast
func (c *ForecastService) CreateWhatIfForecast(input *CreateWhatIfForecastInput) (*CreateWhatIfForecastOutput, error) {
req, out := c.CreateWhatIfForecastRequest(input)
return out, req.Send()
}
// CreateWhatIfForecastWithContext is the same as CreateWhatIfForecast with the addition of
// the ability to pass a context and additional request options.
//
// See CreateWhatIfForecast for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateWhatIfForecastWithContext(ctx aws.Context, input *CreateWhatIfForecastInput, opts ...request.Option) (*CreateWhatIfForecastOutput, error) {
req, out := c.CreateWhatIfForecastRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opCreateWhatIfForecastExport = "CreateWhatIfForecastExport"
// CreateWhatIfForecastExportRequest generates a "aws/request.Request" representing the
// client's request for the CreateWhatIfForecastExport operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See CreateWhatIfForecastExport for more information on using the CreateWhatIfForecastExport
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the CreateWhatIfForecastExportRequest method.
// req, resp := client.CreateWhatIfForecastExportRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecastExport
func (c *ForecastService) CreateWhatIfForecastExportRequest(input *CreateWhatIfForecastExportInput) (req *request.Request, output *CreateWhatIfForecastExportOutput) {
op := &request.Operation{
Name: opCreateWhatIfForecastExport,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateWhatIfForecastExportInput{}
}
output = &CreateWhatIfForecastExportOutput{}
req = c.newRequest(op, input, output)
return
}
// CreateWhatIfForecastExport API operation for Amazon Forecast Service.
//
// 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:
//
// ≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
//
// The <ExportTimestamp> 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 DescribeWhatIfForecastExport
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation CreateWhatIfForecastExport for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceAlreadyExistsException
// There is already a resource with this name. Try again with a different name.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecastExport
func (c *ForecastService) CreateWhatIfForecastExport(input *CreateWhatIfForecastExportInput) (*CreateWhatIfForecastExportOutput, error) {
req, out := c.CreateWhatIfForecastExportRequest(input)
return out, req.Send()
}
// CreateWhatIfForecastExportWithContext is the same as CreateWhatIfForecastExport with the addition of
// the ability to pass a context and additional request options.
//
// See CreateWhatIfForecastExport for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) CreateWhatIfForecastExportWithContext(ctx aws.Context, input *CreateWhatIfForecastExportInput, opts ...request.Option) (*CreateWhatIfForecastExportOutput, error) {
req, out := c.CreateWhatIfForecastExportRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteDataset = "DeleteDataset"
// DeleteDatasetRequest generates a "aws/request.Request" representing the
// client's request for the DeleteDataset operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteDataset for more information on using the DeleteDataset
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteDatasetRequest method.
// req, resp := client.DeleteDatasetRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDataset
func (c *ForecastService) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput) {
op := &request.Operation{
Name: opDeleteDataset,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteDatasetInput{}
}
output = &DeleteDatasetOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteDataset API operation for Amazon Forecast Service.
//
// Deletes an Amazon Forecast dataset that was created using the CreateDataset
// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation.
// You can only delete datasets that have a status of ACTIVE or CREATE_FAILED.
// To get the status use the DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)
// operation.
//
// Forecast does not automatically update any dataset groups that contain the
// deleted dataset. In order to update the dataset group, use the UpdateDatasetGroup
// (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)
// operation, omitting the deleted dataset's ARN.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteDataset for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDataset
func (c *ForecastService) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error) {
req, out := c.DeleteDatasetRequest(input)
return out, req.Send()
}
// DeleteDatasetWithContext is the same as DeleteDataset with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteDataset for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteDatasetWithContext(ctx aws.Context, input *DeleteDatasetInput, opts ...request.Option) (*DeleteDatasetOutput, error) {
req, out := c.DeleteDatasetRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteDatasetGroup = "DeleteDatasetGroup"
// DeleteDatasetGroupRequest generates a "aws/request.Request" representing the
// client's request for the DeleteDatasetGroup operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteDatasetGroup for more information on using the DeleteDatasetGroup
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteDatasetGroupRequest method.
// req, resp := client.DeleteDatasetGroupRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetGroup
func (c *ForecastService) DeleteDatasetGroupRequest(input *DeleteDatasetGroupInput) (req *request.Request, output *DeleteDatasetGroupOutput) {
op := &request.Operation{
Name: opDeleteDatasetGroup,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteDatasetGroupInput{}
}
output = &DeleteDatasetGroupOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteDatasetGroup API operation for Amazon Forecast Service.
//
// Deletes a dataset group created using the CreateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)
// operation. You can only delete dataset groups that have a status of ACTIVE,
// CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup
// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)
// operation.
//
// This operation deletes only the dataset group, not the datasets in the group.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteDatasetGroup for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetGroup
func (c *ForecastService) DeleteDatasetGroup(input *DeleteDatasetGroupInput) (*DeleteDatasetGroupOutput, error) {
req, out := c.DeleteDatasetGroupRequest(input)
return out, req.Send()
}
// DeleteDatasetGroupWithContext is the same as DeleteDatasetGroup with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteDatasetGroup for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteDatasetGroupWithContext(ctx aws.Context, input *DeleteDatasetGroupInput, opts ...request.Option) (*DeleteDatasetGroupOutput, error) {
req, out := c.DeleteDatasetGroupRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteDatasetImportJob = "DeleteDatasetImportJob"
// DeleteDatasetImportJobRequest generates a "aws/request.Request" representing the
// client's request for the DeleteDatasetImportJob operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteDatasetImportJob for more information on using the DeleteDatasetImportJob
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteDatasetImportJobRequest method.
// req, resp := client.DeleteDatasetImportJobRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetImportJob
func (c *ForecastService) DeleteDatasetImportJobRequest(input *DeleteDatasetImportJobInput) (req *request.Request, output *DeleteDatasetImportJobOutput) {
op := &request.Operation{
Name: opDeleteDatasetImportJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteDatasetImportJobInput{}
}
output = &DeleteDatasetImportJobOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteDatasetImportJob API operation for Amazon Forecast Service.
//
// Deletes a dataset import job created using the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)
// operation. You can delete only dataset import jobs that have a status of
// ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob
// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html)
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteDatasetImportJob for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetImportJob
func (c *ForecastService) DeleteDatasetImportJob(input *DeleteDatasetImportJobInput) (*DeleteDatasetImportJobOutput, error) {
req, out := c.DeleteDatasetImportJobRequest(input)
return out, req.Send()
}
// DeleteDatasetImportJobWithContext is the same as DeleteDatasetImportJob with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteDatasetImportJob for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteDatasetImportJobWithContext(ctx aws.Context, input *DeleteDatasetImportJobInput, opts ...request.Option) (*DeleteDatasetImportJobOutput, error) {
req, out := c.DeleteDatasetImportJobRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteExplainability = "DeleteExplainability"
// DeleteExplainabilityRequest generates a "aws/request.Request" representing the
// client's request for the DeleteExplainability operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteExplainability for more information on using the DeleteExplainability
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteExplainabilityRequest method.
// req, resp := client.DeleteExplainabilityRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainability
func (c *ForecastService) DeleteExplainabilityRequest(input *DeleteExplainabilityInput) (req *request.Request, output *DeleteExplainabilityOutput) {
op := &request.Operation{
Name: opDeleteExplainability,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteExplainabilityInput{}
}
output = &DeleteExplainabilityOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteExplainability API operation for Amazon Forecast Service.
//
// Deletes an Explainability resource.
//
// You can delete only predictor that have a status of ACTIVE or CREATE_FAILED.
// To get the status, use the DescribeExplainability operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteExplainability for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainability
func (c *ForecastService) DeleteExplainability(input *DeleteExplainabilityInput) (*DeleteExplainabilityOutput, error) {
req, out := c.DeleteExplainabilityRequest(input)
return out, req.Send()
}
// DeleteExplainabilityWithContext is the same as DeleteExplainability with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteExplainability for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteExplainabilityWithContext(ctx aws.Context, input *DeleteExplainabilityInput, opts ...request.Option) (*DeleteExplainabilityOutput, error) {
req, out := c.DeleteExplainabilityRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteExplainabilityExport = "DeleteExplainabilityExport"
// DeleteExplainabilityExportRequest generates a "aws/request.Request" representing the
// client's request for the DeleteExplainabilityExport operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteExplainabilityExport for more information on using the DeleteExplainabilityExport
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteExplainabilityExportRequest method.
// req, resp := client.DeleteExplainabilityExportRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExport
func (c *ForecastService) DeleteExplainabilityExportRequest(input *DeleteExplainabilityExportInput) (req *request.Request, output *DeleteExplainabilityExportOutput) {
op := &request.Operation{
Name: opDeleteExplainabilityExport,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteExplainabilityExportInput{}
}
output = &DeleteExplainabilityExportOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteExplainabilityExport API operation for Amazon Forecast Service.
//
// Deletes an Explainability export.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteExplainabilityExport for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExport
func (c *ForecastService) DeleteExplainabilityExport(input *DeleteExplainabilityExportInput) (*DeleteExplainabilityExportOutput, error) {
req, out := c.DeleteExplainabilityExportRequest(input)
return out, req.Send()
}
// DeleteExplainabilityExportWithContext is the same as DeleteExplainabilityExport with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteExplainabilityExport for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteExplainabilityExportWithContext(ctx aws.Context, input *DeleteExplainabilityExportInput, opts ...request.Option) (*DeleteExplainabilityExportOutput, error) {
req, out := c.DeleteExplainabilityExportRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteForecast = "DeleteForecast"
// DeleteForecastRequest generates a "aws/request.Request" representing the
// client's request for the DeleteForecast operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteForecast for more information on using the DeleteForecast
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteForecastRequest method.
// req, resp := client.DeleteForecastRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecast
func (c *ForecastService) DeleteForecastRequest(input *DeleteForecastInput) (req *request.Request, output *DeleteForecastOutput) {
op := &request.Operation{
Name: opDeleteForecast,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteForecastInput{}
}
output = &DeleteForecastOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteForecast API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteForecast for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecast
func (c *ForecastService) DeleteForecast(input *DeleteForecastInput) (*DeleteForecastOutput, error) {
req, out := c.DeleteForecastRequest(input)
return out, req.Send()
}
// DeleteForecastWithContext is the same as DeleteForecast with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteForecast for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteForecastWithContext(ctx aws.Context, input *DeleteForecastInput, opts ...request.Option) (*DeleteForecastOutput, error) {
req, out := c.DeleteForecastRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteForecastExportJob = "DeleteForecastExportJob"
// DeleteForecastExportJobRequest generates a "aws/request.Request" representing the
// client's request for the DeleteForecastExportJob operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteForecastExportJob for more information on using the DeleteForecastExportJob
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteForecastExportJobRequest method.
// req, resp := client.DeleteForecastExportJobRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastExportJob
func (c *ForecastService) DeleteForecastExportJobRequest(input *DeleteForecastExportJobInput) (req *request.Request, output *DeleteForecastExportJobOutput) {
op := &request.Operation{
Name: opDeleteForecastExportJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteForecastExportJobInput{}
}
output = &DeleteForecastExportJobOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteForecastExportJob API operation for Amazon Forecast Service.
//
// 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 DescribeForecastExportJob operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteForecastExportJob for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastExportJob
func (c *ForecastService) DeleteForecastExportJob(input *DeleteForecastExportJobInput) (*DeleteForecastExportJobOutput, error) {
req, out := c.DeleteForecastExportJobRequest(input)
return out, req.Send()
}
// DeleteForecastExportJobWithContext is the same as DeleteForecastExportJob with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteForecastExportJob for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteForecastExportJobWithContext(ctx aws.Context, input *DeleteForecastExportJobInput, opts ...request.Option) (*DeleteForecastExportJobOutput, error) {
req, out := c.DeleteForecastExportJobRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteMonitor = "DeleteMonitor"
// DeleteMonitorRequest generates a "aws/request.Request" representing the
// client's request for the DeleteMonitor operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteMonitor for more information on using the DeleteMonitor
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteMonitorRequest method.
// req, resp := client.DeleteMonitorRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteMonitor
func (c *ForecastService) DeleteMonitorRequest(input *DeleteMonitorInput) (req *request.Request, output *DeleteMonitorOutput) {
op := &request.Operation{
Name: opDeleteMonitor,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteMonitorInput{}
}
output = &DeleteMonitorOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteMonitor API operation for Amazon Forecast Service.
//
// Deletes a monitor resource. You can only delete a monitor resource with a
// status of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteMonitor for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteMonitor
func (c *ForecastService) DeleteMonitor(input *DeleteMonitorInput) (*DeleteMonitorOutput, error) {
req, out := c.DeleteMonitorRequest(input)
return out, req.Send()
}
// DeleteMonitorWithContext is the same as DeleteMonitor with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteMonitor for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteMonitorWithContext(ctx aws.Context, input *DeleteMonitorInput, opts ...request.Option) (*DeleteMonitorOutput, error) {
req, out := c.DeleteMonitorRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeletePredictor = "DeletePredictor"
// DeletePredictorRequest generates a "aws/request.Request" representing the
// client's request for the DeletePredictor operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeletePredictor for more information on using the DeletePredictor
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeletePredictorRequest method.
// req, resp := client.DeletePredictorRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictor
func (c *ForecastService) DeletePredictorRequest(input *DeletePredictorInput) (req *request.Request, output *DeletePredictorOutput) {
op := &request.Operation{
Name: opDeletePredictor,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeletePredictorInput{}
}
output = &DeletePredictorOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeletePredictor API operation for Amazon Forecast Service.
//
// 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 DescribePredictor operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeletePredictor for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictor
func (c *ForecastService) DeletePredictor(input *DeletePredictorInput) (*DeletePredictorOutput, error) {
req, out := c.DeletePredictorRequest(input)
return out, req.Send()
}
// DeletePredictorWithContext is the same as DeletePredictor with the addition of
// the ability to pass a context and additional request options.
//
// See DeletePredictor for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeletePredictorWithContext(ctx aws.Context, input *DeletePredictorInput, opts ...request.Option) (*DeletePredictorOutput, error) {
req, out := c.DeletePredictorRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeletePredictorBacktestExportJob = "DeletePredictorBacktestExportJob"
// DeletePredictorBacktestExportJobRequest generates a "aws/request.Request" representing the
// client's request for the DeletePredictorBacktestExportJob operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeletePredictorBacktestExportJob for more information on using the DeletePredictorBacktestExportJob
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeletePredictorBacktestExportJobRequest method.
// req, resp := client.DeletePredictorBacktestExportJobRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJob
func (c *ForecastService) DeletePredictorBacktestExportJobRequest(input *DeletePredictorBacktestExportJobInput) (req *request.Request, output *DeletePredictorBacktestExportJobOutput) {
op := &request.Operation{
Name: opDeletePredictorBacktestExportJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeletePredictorBacktestExportJobInput{}
}
output = &DeletePredictorBacktestExportJobOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeletePredictorBacktestExportJob API operation for Amazon Forecast Service.
//
// Deletes a predictor backtest export job.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeletePredictorBacktestExportJob for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJob
func (c *ForecastService) DeletePredictorBacktestExportJob(input *DeletePredictorBacktestExportJobInput) (*DeletePredictorBacktestExportJobOutput, error) {
req, out := c.DeletePredictorBacktestExportJobRequest(input)
return out, req.Send()
}
// DeletePredictorBacktestExportJobWithContext is the same as DeletePredictorBacktestExportJob with the addition of
// the ability to pass a context and additional request options.
//
// See DeletePredictorBacktestExportJob for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeletePredictorBacktestExportJobWithContext(ctx aws.Context, input *DeletePredictorBacktestExportJobInput, opts ...request.Option) (*DeletePredictorBacktestExportJobOutput, error) {
req, out := c.DeletePredictorBacktestExportJobRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteResourceTree = "DeleteResourceTree"
// DeleteResourceTreeRequest generates a "aws/request.Request" representing the
// client's request for the DeleteResourceTree operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteResourceTree for more information on using the DeleteResourceTree
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteResourceTreeRequest method.
// req, resp := client.DeleteResourceTreeRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteResourceTree
func (c *ForecastService) DeleteResourceTreeRequest(input *DeleteResourceTreeInput) (req *request.Request, output *DeleteResourceTreeOutput) {
op := &request.Operation{
Name: opDeleteResourceTree,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteResourceTreeInput{}
}
output = &DeleteResourceTreeOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteResourceTree API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteResourceTree for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteResourceTree
func (c *ForecastService) DeleteResourceTree(input *DeleteResourceTreeInput) (*DeleteResourceTreeOutput, error) {
req, out := c.DeleteResourceTreeRequest(input)
return out, req.Send()
}
// DeleteResourceTreeWithContext is the same as DeleteResourceTree with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteResourceTree for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteResourceTreeWithContext(ctx aws.Context, input *DeleteResourceTreeInput, opts ...request.Option) (*DeleteResourceTreeOutput, error) {
req, out := c.DeleteResourceTreeRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteWhatIfAnalysis = "DeleteWhatIfAnalysis"
// DeleteWhatIfAnalysisRequest generates a "aws/request.Request" representing the
// client's request for the DeleteWhatIfAnalysis operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteWhatIfAnalysis for more information on using the DeleteWhatIfAnalysis
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteWhatIfAnalysisRequest method.
// req, resp := client.DeleteWhatIfAnalysisRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfAnalysis
func (c *ForecastService) DeleteWhatIfAnalysisRequest(input *DeleteWhatIfAnalysisInput) (req *request.Request, output *DeleteWhatIfAnalysisOutput) {
op := &request.Operation{
Name: opDeleteWhatIfAnalysis,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteWhatIfAnalysisInput{}
}
output = &DeleteWhatIfAnalysisOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteWhatIfAnalysis API operation for Amazon Forecast Service.
//
// 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 DescribeWhatIfAnalysis operation.
//
// You can't delete a what-if analysis while any of its forecasts are being
// exported.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteWhatIfAnalysis for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfAnalysis
func (c *ForecastService) DeleteWhatIfAnalysis(input *DeleteWhatIfAnalysisInput) (*DeleteWhatIfAnalysisOutput, error) {
req, out := c.DeleteWhatIfAnalysisRequest(input)
return out, req.Send()
}
// DeleteWhatIfAnalysisWithContext is the same as DeleteWhatIfAnalysis with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteWhatIfAnalysis for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteWhatIfAnalysisWithContext(ctx aws.Context, input *DeleteWhatIfAnalysisInput, opts ...request.Option) (*DeleteWhatIfAnalysisOutput, error) {
req, out := c.DeleteWhatIfAnalysisRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteWhatIfForecast = "DeleteWhatIfForecast"
// DeleteWhatIfForecastRequest generates a "aws/request.Request" representing the
// client's request for the DeleteWhatIfForecast operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteWhatIfForecast for more information on using the DeleteWhatIfForecast
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteWhatIfForecastRequest method.
// req, resp := client.DeleteWhatIfForecastRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfForecast
func (c *ForecastService) DeleteWhatIfForecastRequest(input *DeleteWhatIfForecastInput) (req *request.Request, output *DeleteWhatIfForecastOutput) {
op := &request.Operation{
Name: opDeleteWhatIfForecast,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteWhatIfForecastInput{}
}
output = &DeleteWhatIfForecastOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteWhatIfForecast API operation for Amazon Forecast Service.
//
// 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 DescribeWhatIfForecast operation.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteWhatIfForecast for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfForecast
func (c *ForecastService) DeleteWhatIfForecast(input *DeleteWhatIfForecastInput) (*DeleteWhatIfForecastOutput, error) {
req, out := c.DeleteWhatIfForecastRequest(input)
return out, req.Send()
}
// DeleteWhatIfForecastWithContext is the same as DeleteWhatIfForecast with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteWhatIfForecast for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteWhatIfForecastWithContext(ctx aws.Context, input *DeleteWhatIfForecastInput, opts ...request.Option) (*DeleteWhatIfForecastOutput, error) {
req, out := c.DeleteWhatIfForecastRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDeleteWhatIfForecastExport = "DeleteWhatIfForecastExport"
// DeleteWhatIfForecastExportRequest generates a "aws/request.Request" representing the
// client's request for the DeleteWhatIfForecastExport operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DeleteWhatIfForecastExport for more information on using the DeleteWhatIfForecastExport
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DeleteWhatIfForecastExportRequest method.
// req, resp := client.DeleteWhatIfForecastExportRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfForecastExport
func (c *ForecastService) DeleteWhatIfForecastExportRequest(input *DeleteWhatIfForecastExportInput) (req *request.Request, output *DeleteWhatIfForecastExportOutput) {
op := &request.Operation{
Name: opDeleteWhatIfForecastExport,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteWhatIfForecastExportInput{}
}
output = &DeleteWhatIfForecastExportOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// DeleteWhatIfForecastExport API operation for Amazon Forecast Service.
//
// 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 DescribeWhatIfForecastExport
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DeleteWhatIfForecastExport for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfForecastExport
func (c *ForecastService) DeleteWhatIfForecastExport(input *DeleteWhatIfForecastExportInput) (*DeleteWhatIfForecastExportOutput, error) {
req, out := c.DeleteWhatIfForecastExportRequest(input)
return out, req.Send()
}
// DeleteWhatIfForecastExportWithContext is the same as DeleteWhatIfForecastExport with the addition of
// the ability to pass a context and additional request options.
//
// See DeleteWhatIfForecastExport for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DeleteWhatIfForecastExportWithContext(ctx aws.Context, input *DeleteWhatIfForecastExportInput, opts ...request.Option) (*DeleteWhatIfForecastExportOutput, error) {
req, out := c.DeleteWhatIfForecastExportRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeAutoPredictor = "DescribeAutoPredictor"
// DescribeAutoPredictorRequest generates a "aws/request.Request" representing the
// client's request for the DescribeAutoPredictor operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeAutoPredictor for more information on using the DescribeAutoPredictor
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeAutoPredictorRequest method.
// req, resp := client.DescribeAutoPredictorRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor
func (c *ForecastService) DescribeAutoPredictorRequest(input *DescribeAutoPredictorInput) (req *request.Request, output *DescribeAutoPredictorOutput) {
op := &request.Operation{
Name: opDescribeAutoPredictor,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeAutoPredictorInput{}
}
output = &DescribeAutoPredictorOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeAutoPredictor API operation for Amazon Forecast Service.
//
// Describes a predictor created using the CreateAutoPredictor operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeAutoPredictor for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor
func (c *ForecastService) DescribeAutoPredictor(input *DescribeAutoPredictorInput) (*DescribeAutoPredictorOutput, error) {
req, out := c.DescribeAutoPredictorRequest(input)
return out, req.Send()
}
// DescribeAutoPredictorWithContext is the same as DescribeAutoPredictor with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeAutoPredictor for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeAutoPredictorWithContext(ctx aws.Context, input *DescribeAutoPredictorInput, opts ...request.Option) (*DescribeAutoPredictorOutput, error) {
req, out := c.DescribeAutoPredictorRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeDataset = "DescribeDataset"
// DescribeDatasetRequest generates a "aws/request.Request" representing the
// client's request for the DescribeDataset operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeDataset for more information on using the DescribeDataset
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeDatasetRequest method.
// req, resp := client.DescribeDatasetRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDataset
func (c *ForecastService) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput) {
op := &request.Operation{
Name: opDescribeDataset,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeDatasetInput{}
}
output = &DescribeDatasetOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeDataset API operation for Amazon Forecast Service.
//
// Describes an Amazon Forecast dataset created using the CreateDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)
// operation.
//
// In addition to listing the parameters specified in the CreateDataset request,
// this operation includes the following dataset properties:
//
// - CreationTime
//
// - LastModificationTime
//
// - Status
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeDataset for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDataset
func (c *ForecastService) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error) {
req, out := c.DescribeDatasetRequest(input)
return out, req.Send()
}
// DescribeDatasetWithContext is the same as DescribeDataset with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeDataset for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeDatasetWithContext(ctx aws.Context, input *DescribeDatasetInput, opts ...request.Option) (*DescribeDatasetOutput, error) {
req, out := c.DescribeDatasetRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeDatasetGroup = "DescribeDatasetGroup"
// DescribeDatasetGroupRequest generates a "aws/request.Request" representing the
// client's request for the DescribeDatasetGroup operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeDatasetGroup for more information on using the DescribeDatasetGroup
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeDatasetGroupRequest method.
// req, resp := client.DescribeDatasetGroupRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetGroup
func (c *ForecastService) DescribeDatasetGroupRequest(input *DescribeDatasetGroupInput) (req *request.Request, output *DescribeDatasetGroupOutput) {
op := &request.Operation{
Name: opDescribeDatasetGroup,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeDatasetGroupInput{}
}
output = &DescribeDatasetGroupOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeDatasetGroup API operation for Amazon Forecast Service.
//
// Describes a dataset group created using the CreateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)
// 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
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeDatasetGroup for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetGroup
func (c *ForecastService) DescribeDatasetGroup(input *DescribeDatasetGroupInput) (*DescribeDatasetGroupOutput, error) {
req, out := c.DescribeDatasetGroupRequest(input)
return out, req.Send()
}
// DescribeDatasetGroupWithContext is the same as DescribeDatasetGroup with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeDatasetGroup for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeDatasetGroupWithContext(ctx aws.Context, input *DescribeDatasetGroupInput, opts ...request.Option) (*DescribeDatasetGroupOutput, error) {
req, out := c.DescribeDatasetGroupRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeDatasetImportJob = "DescribeDatasetImportJob"
// DescribeDatasetImportJobRequest generates a "aws/request.Request" representing the
// client's request for the DescribeDatasetImportJob operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeDatasetImportJob for more information on using the DescribeDatasetImportJob
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeDatasetImportJobRequest method.
// req, resp := client.DescribeDatasetImportJobRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJob
func (c *ForecastService) DescribeDatasetImportJobRequest(input *DescribeDatasetImportJobInput) (req *request.Request, output *DescribeDatasetImportJobOutput) {
op := &request.Operation{
Name: opDescribeDatasetImportJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeDatasetImportJobInput{}
}
output = &DescribeDatasetImportJobOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeDatasetImportJob API operation for Amazon Forecast Service.
//
// Describes a dataset import job created using the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeDatasetImportJob for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJob
func (c *ForecastService) DescribeDatasetImportJob(input *DescribeDatasetImportJobInput) (*DescribeDatasetImportJobOutput, error) {
req, out := c.DescribeDatasetImportJobRequest(input)
return out, req.Send()
}
// DescribeDatasetImportJobWithContext is the same as DescribeDatasetImportJob with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeDatasetImportJob for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeDatasetImportJobWithContext(ctx aws.Context, input *DescribeDatasetImportJobInput, opts ...request.Option) (*DescribeDatasetImportJobOutput, error) {
req, out := c.DescribeDatasetImportJobRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeExplainability = "DescribeExplainability"
// DescribeExplainabilityRequest generates a "aws/request.Request" representing the
// client's request for the DescribeExplainability operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeExplainability for more information on using the DescribeExplainability
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeExplainabilityRequest method.
// req, resp := client.DescribeExplainabilityRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainability
func (c *ForecastService) DescribeExplainabilityRequest(input *DescribeExplainabilityInput) (req *request.Request, output *DescribeExplainabilityOutput) {
op := &request.Operation{
Name: opDescribeExplainability,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeExplainabilityInput{}
}
output = &DescribeExplainabilityOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeExplainability API operation for Amazon Forecast Service.
//
// Describes an Explainability resource created using the CreateExplainability
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeExplainability for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainability
func (c *ForecastService) DescribeExplainability(input *DescribeExplainabilityInput) (*DescribeExplainabilityOutput, error) {
req, out := c.DescribeExplainabilityRequest(input)
return out, req.Send()
}
// DescribeExplainabilityWithContext is the same as DescribeExplainability with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeExplainability for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeExplainabilityWithContext(ctx aws.Context, input *DescribeExplainabilityInput, opts ...request.Option) (*DescribeExplainabilityOutput, error) {
req, out := c.DescribeExplainabilityRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeExplainabilityExport = "DescribeExplainabilityExport"
// DescribeExplainabilityExportRequest generates a "aws/request.Request" representing the
// client's request for the DescribeExplainabilityExport operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeExplainabilityExport for more information on using the DescribeExplainabilityExport
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeExplainabilityExportRequest method.
// req, resp := client.DescribeExplainabilityExportRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExport
func (c *ForecastService) DescribeExplainabilityExportRequest(input *DescribeExplainabilityExportInput) (req *request.Request, output *DescribeExplainabilityExportOutput) {
op := &request.Operation{
Name: opDescribeExplainabilityExport,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeExplainabilityExportInput{}
}
output = &DescribeExplainabilityExportOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeExplainabilityExport API operation for Amazon Forecast Service.
//
// Describes an Explainability export created using the CreateExplainabilityExport
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeExplainabilityExport for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExport
func (c *ForecastService) DescribeExplainabilityExport(input *DescribeExplainabilityExportInput) (*DescribeExplainabilityExportOutput, error) {
req, out := c.DescribeExplainabilityExportRequest(input)
return out, req.Send()
}
// DescribeExplainabilityExportWithContext is the same as DescribeExplainabilityExport with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeExplainabilityExport for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeExplainabilityExportWithContext(ctx aws.Context, input *DescribeExplainabilityExportInput, opts ...request.Option) (*DescribeExplainabilityExportOutput, error) {
req, out := c.DescribeExplainabilityExportRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeForecast = "DescribeForecast"
// DescribeForecastRequest generates a "aws/request.Request" representing the
// client's request for the DescribeForecast operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeForecast for more information on using the DescribeForecast
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeForecastRequest method.
// req, resp := client.DescribeForecastRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecast
func (c *ForecastService) DescribeForecastRequest(input *DescribeForecastInput) (req *request.Request, output *DescribeForecastOutput) {
op := &request.Operation{
Name: opDescribeForecast,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeForecastInput{}
}
output = &DescribeForecastOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeForecast API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeForecast for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecast
func (c *ForecastService) DescribeForecast(input *DescribeForecastInput) (*DescribeForecastOutput, error) {
req, out := c.DescribeForecastRequest(input)
return out, req.Send()
}
// DescribeForecastWithContext is the same as DescribeForecast with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeForecast for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeForecastWithContext(ctx aws.Context, input *DescribeForecastInput, opts ...request.Option) (*DescribeForecastOutput, error) {
req, out := c.DescribeForecastRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeForecastExportJob = "DescribeForecastExportJob"
// DescribeForecastExportJobRequest generates a "aws/request.Request" representing the
// client's request for the DescribeForecastExportJob operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeForecastExportJob for more information on using the DescribeForecastExportJob
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeForecastExportJobRequest method.
// req, resp := client.DescribeForecastExportJobRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJob
func (c *ForecastService) DescribeForecastExportJobRequest(input *DescribeForecastExportJobInput) (req *request.Request, output *DescribeForecastExportJobOutput) {
op := &request.Operation{
Name: opDescribeForecastExportJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeForecastExportJobInput{}
}
output = &DescribeForecastExportJobOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeForecastExportJob API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeForecastExportJob for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJob
func (c *ForecastService) DescribeForecastExportJob(input *DescribeForecastExportJobInput) (*DescribeForecastExportJobOutput, error) {
req, out := c.DescribeForecastExportJobRequest(input)
return out, req.Send()
}
// DescribeForecastExportJobWithContext is the same as DescribeForecastExportJob with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeForecastExportJob for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeForecastExportJobWithContext(ctx aws.Context, input *DescribeForecastExportJobInput, opts ...request.Option) (*DescribeForecastExportJobOutput, error) {
req, out := c.DescribeForecastExportJobRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeMonitor = "DescribeMonitor"
// DescribeMonitorRequest generates a "aws/request.Request" representing the
// client's request for the DescribeMonitor operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeMonitor for more information on using the DescribeMonitor
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeMonitorRequest method.
// req, resp := client.DescribeMonitorRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitor
func (c *ForecastService) DescribeMonitorRequest(input *DescribeMonitorInput) (req *request.Request, output *DescribeMonitorOutput) {
op := &request.Operation{
Name: opDescribeMonitor,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeMonitorInput{}
}
output = &DescribeMonitorOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeMonitor API operation for Amazon Forecast Service.
//
// Describes a monitor resource. In addition to listing the properties provided
// in the CreateMonitor request, this operation lists the following properties:
//
// - Baseline
//
// - CreationTime
//
// - LastEvaluationTime
//
// - LastEvaluationState
//
// - LastModificationTime
//
// - Message
//
// - Status
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeMonitor for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitor
func (c *ForecastService) DescribeMonitor(input *DescribeMonitorInput) (*DescribeMonitorOutput, error) {
req, out := c.DescribeMonitorRequest(input)
return out, req.Send()
}
// DescribeMonitorWithContext is the same as DescribeMonitor with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeMonitor for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeMonitorWithContext(ctx aws.Context, input *DescribeMonitorInput, opts ...request.Option) (*DescribeMonitorOutput, error) {
req, out := c.DescribeMonitorRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribePredictor = "DescribePredictor"
// DescribePredictorRequest generates a "aws/request.Request" representing the
// client's request for the DescribePredictor operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribePredictor for more information on using the DescribePredictor
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribePredictorRequest method.
// req, resp := client.DescribePredictorRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictor
func (c *ForecastService) DescribePredictorRequest(input *DescribePredictorInput) (req *request.Request, output *DescribePredictorOutput) {
op := &request.Operation{
Name: opDescribePredictor,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribePredictorInput{}
}
output = &DescribePredictorOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribePredictor API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribePredictor for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictor
func (c *ForecastService) DescribePredictor(input *DescribePredictorInput) (*DescribePredictorOutput, error) {
req, out := c.DescribePredictorRequest(input)
return out, req.Send()
}
// DescribePredictorWithContext is the same as DescribePredictor with the addition of
// the ability to pass a context and additional request options.
//
// See DescribePredictor for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribePredictorWithContext(ctx aws.Context, input *DescribePredictorInput, opts ...request.Option) (*DescribePredictorOutput, error) {
req, out := c.DescribePredictorRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribePredictorBacktestExportJob = "DescribePredictorBacktestExportJob"
// DescribePredictorBacktestExportJobRequest generates a "aws/request.Request" representing the
// client's request for the DescribePredictorBacktestExportJob operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribePredictorBacktestExportJob for more information on using the DescribePredictorBacktestExportJob
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribePredictorBacktestExportJobRequest method.
// req, resp := client.DescribePredictorBacktestExportJobRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJob
func (c *ForecastService) DescribePredictorBacktestExportJobRequest(input *DescribePredictorBacktestExportJobInput) (req *request.Request, output *DescribePredictorBacktestExportJobOutput) {
op := &request.Operation{
Name: opDescribePredictorBacktestExportJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribePredictorBacktestExportJobInput{}
}
output = &DescribePredictorBacktestExportJobOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribePredictorBacktestExportJob API operation for Amazon Forecast Service.
//
// 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)
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribePredictorBacktestExportJob for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJob
func (c *ForecastService) DescribePredictorBacktestExportJob(input *DescribePredictorBacktestExportJobInput) (*DescribePredictorBacktestExportJobOutput, error) {
req, out := c.DescribePredictorBacktestExportJobRequest(input)
return out, req.Send()
}
// DescribePredictorBacktestExportJobWithContext is the same as DescribePredictorBacktestExportJob with the addition of
// the ability to pass a context and additional request options.
//
// See DescribePredictorBacktestExportJob for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribePredictorBacktestExportJobWithContext(ctx aws.Context, input *DescribePredictorBacktestExportJobInput, opts ...request.Option) (*DescribePredictorBacktestExportJobOutput, error) {
req, out := c.DescribePredictorBacktestExportJobRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeWhatIfAnalysis = "DescribeWhatIfAnalysis"
// DescribeWhatIfAnalysisRequest generates a "aws/request.Request" representing the
// client's request for the DescribeWhatIfAnalysis operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeWhatIfAnalysis for more information on using the DescribeWhatIfAnalysis
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeWhatIfAnalysisRequest method.
// req, resp := client.DescribeWhatIfAnalysisRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfAnalysis
func (c *ForecastService) DescribeWhatIfAnalysisRequest(input *DescribeWhatIfAnalysisInput) (req *request.Request, output *DescribeWhatIfAnalysisOutput) {
op := &request.Operation{
Name: opDescribeWhatIfAnalysis,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeWhatIfAnalysisInput{}
}
output = &DescribeWhatIfAnalysisOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeWhatIfAnalysis API operation for Amazon Forecast Service.
//
// 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
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeWhatIfAnalysis for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfAnalysis
func (c *ForecastService) DescribeWhatIfAnalysis(input *DescribeWhatIfAnalysisInput) (*DescribeWhatIfAnalysisOutput, error) {
req, out := c.DescribeWhatIfAnalysisRequest(input)
return out, req.Send()
}
// DescribeWhatIfAnalysisWithContext is the same as DescribeWhatIfAnalysis with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeWhatIfAnalysis for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeWhatIfAnalysisWithContext(ctx aws.Context, input *DescribeWhatIfAnalysisInput, opts ...request.Option) (*DescribeWhatIfAnalysisOutput, error) {
req, out := c.DescribeWhatIfAnalysisRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeWhatIfForecast = "DescribeWhatIfForecast"
// DescribeWhatIfForecastRequest generates a "aws/request.Request" representing the
// client's request for the DescribeWhatIfForecast operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeWhatIfForecast for more information on using the DescribeWhatIfForecast
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeWhatIfForecastRequest method.
// req, resp := client.DescribeWhatIfForecastRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecast
func (c *ForecastService) DescribeWhatIfForecastRequest(input *DescribeWhatIfForecastInput) (req *request.Request, output *DescribeWhatIfForecastOutput) {
op := &request.Operation{
Name: opDescribeWhatIfForecast,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeWhatIfForecastInput{}
}
output = &DescribeWhatIfForecastOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeWhatIfForecast API operation for Amazon Forecast Service.
//
// 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
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeWhatIfForecast for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecast
func (c *ForecastService) DescribeWhatIfForecast(input *DescribeWhatIfForecastInput) (*DescribeWhatIfForecastOutput, error) {
req, out := c.DescribeWhatIfForecastRequest(input)
return out, req.Send()
}
// DescribeWhatIfForecastWithContext is the same as DescribeWhatIfForecast with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeWhatIfForecast for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeWhatIfForecastWithContext(ctx aws.Context, input *DescribeWhatIfForecastInput, opts ...request.Option) (*DescribeWhatIfForecastOutput, error) {
req, out := c.DescribeWhatIfForecastRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opDescribeWhatIfForecastExport = "DescribeWhatIfForecastExport"
// DescribeWhatIfForecastExportRequest generates a "aws/request.Request" representing the
// client's request for the DescribeWhatIfForecastExport operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See DescribeWhatIfForecastExport for more information on using the DescribeWhatIfForecastExport
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the DescribeWhatIfForecastExportRequest method.
// req, resp := client.DescribeWhatIfForecastExportRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecastExport
func (c *ForecastService) DescribeWhatIfForecastExportRequest(input *DescribeWhatIfForecastExportInput) (req *request.Request, output *DescribeWhatIfForecastExportOutput) {
op := &request.Operation{
Name: opDescribeWhatIfForecastExport,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeWhatIfForecastExportInput{}
}
output = &DescribeWhatIfForecastExportOutput{}
req = c.newRequest(op, input, output)
return
}
// DescribeWhatIfForecastExport API operation for Amazon Forecast Service.
//
// 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
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation DescribeWhatIfForecastExport for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecastExport
func (c *ForecastService) DescribeWhatIfForecastExport(input *DescribeWhatIfForecastExportInput) (*DescribeWhatIfForecastExportOutput, error) {
req, out := c.DescribeWhatIfForecastExportRequest(input)
return out, req.Send()
}
// DescribeWhatIfForecastExportWithContext is the same as DescribeWhatIfForecastExport with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeWhatIfForecastExport for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) DescribeWhatIfForecastExportWithContext(ctx aws.Context, input *DescribeWhatIfForecastExportInput, opts ...request.Option) (*DescribeWhatIfForecastExportOutput, error) {
req, out := c.DescribeWhatIfForecastExportRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opGetAccuracyMetrics = "GetAccuracyMetrics"
// GetAccuracyMetricsRequest generates a "aws/request.Request" representing the
// client's request for the GetAccuracyMetrics operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See GetAccuracyMetrics for more information on using the GetAccuracyMetrics
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the GetAccuracyMetricsRequest method.
// req, resp := client.GetAccuracyMetricsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics
func (c *ForecastService) GetAccuracyMetricsRequest(input *GetAccuracyMetricsInput) (req *request.Request, output *GetAccuracyMetricsOutput) {
op := &request.Operation{
Name: opGetAccuracyMetrics,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetAccuracyMetricsInput{}
}
output = &GetAccuracyMetricsOutput{}
req = c.newRequest(op, input, output)
return
}
// GetAccuracyMetrics API operation for Amazon Forecast Service.
//
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html).
//
// This operation generates metrics for each backtest window that was evaluated.
// The number of backtest windows (NumberOfBacktestWindows) is specified using
// the EvaluationParameters object, 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
// DescribePredictor operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation GetAccuracyMetrics for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics
func (c *ForecastService) GetAccuracyMetrics(input *GetAccuracyMetricsInput) (*GetAccuracyMetricsOutput, error) {
req, out := c.GetAccuracyMetricsRequest(input)
return out, req.Send()
}
// GetAccuracyMetricsWithContext is the same as GetAccuracyMetrics with the addition of
// the ability to pass a context and additional request options.
//
// See GetAccuracyMetrics for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) GetAccuracyMetricsWithContext(ctx aws.Context, input *GetAccuracyMetricsInput, opts ...request.Option) (*GetAccuracyMetricsOutput, error) {
req, out := c.GetAccuracyMetricsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opListDatasetGroups = "ListDatasetGroups"
// ListDatasetGroupsRequest generates a "aws/request.Request" representing the
// client's request for the ListDatasetGroups operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListDatasetGroups for more information on using the ListDatasetGroups
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListDatasetGroupsRequest method.
// req, resp := client.ListDatasetGroupsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetGroups
func (c *ForecastService) ListDatasetGroupsRequest(input *ListDatasetGroupsInput) (req *request.Request, output *ListDatasetGroupsOutput) {
op := &request.Operation{
Name: opListDatasetGroups,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListDatasetGroupsInput{}
}
output = &ListDatasetGroupsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListDatasetGroups API operation for Amazon Forecast Service.
//
// Returns a list of dataset groups created using the CreateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)
// 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 DescribeDatasetGroup
// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListDatasetGroups for usage and error information.
//
// Returned Error Types:
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetGroups
func (c *ForecastService) ListDatasetGroups(input *ListDatasetGroupsInput) (*ListDatasetGroupsOutput, error) {
req, out := c.ListDatasetGroupsRequest(input)
return out, req.Send()
}
// ListDatasetGroupsWithContext is the same as ListDatasetGroups with the addition of
// the ability to pass a context and additional request options.
//
// See ListDatasetGroups for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListDatasetGroupsWithContext(ctx aws.Context, input *ListDatasetGroupsInput, opts ...request.Option) (*ListDatasetGroupsOutput, error) {
req, out := c.ListDatasetGroupsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListDatasetGroupsPages iterates over the pages of a ListDatasetGroups operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListDatasetGroups method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListDatasetGroups operation.
// pageNum := 0
// err := client.ListDatasetGroupsPages(params,
// func(page *forecastservice.ListDatasetGroupsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListDatasetGroupsPages(input *ListDatasetGroupsInput, fn func(*ListDatasetGroupsOutput, bool) bool) error {
return c.ListDatasetGroupsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListDatasetGroupsPagesWithContext same as ListDatasetGroupsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListDatasetGroupsPagesWithContext(ctx aws.Context, input *ListDatasetGroupsInput, fn func(*ListDatasetGroupsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListDatasetGroupsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListDatasetGroupsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListDatasetGroupsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListDatasetImportJobs = "ListDatasetImportJobs"
// ListDatasetImportJobsRequest generates a "aws/request.Request" representing the
// client's request for the ListDatasetImportJobs operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListDatasetImportJobs for more information on using the ListDatasetImportJobs
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListDatasetImportJobsRequest method.
// req, resp := client.ListDatasetImportJobsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetImportJobs
func (c *ForecastService) ListDatasetImportJobsRequest(input *ListDatasetImportJobsInput) (req *request.Request, output *ListDatasetImportJobsOutput) {
op := &request.Operation{
Name: opListDatasetImportJobs,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListDatasetImportJobsInput{}
}
output = &ListDatasetImportJobsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListDatasetImportJobs API operation for Amazon Forecast Service.
//
// Returns a list of dataset import jobs created using the CreateDatasetImportJob
// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)
// 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 DescribeDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html)
// operation. You can filter the list by providing an array of Filter (https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html)
// objects.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListDatasetImportJobs for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetImportJobs
func (c *ForecastService) ListDatasetImportJobs(input *ListDatasetImportJobsInput) (*ListDatasetImportJobsOutput, error) {
req, out := c.ListDatasetImportJobsRequest(input)
return out, req.Send()
}
// ListDatasetImportJobsWithContext is the same as ListDatasetImportJobs with the addition of
// the ability to pass a context and additional request options.
//
// See ListDatasetImportJobs for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListDatasetImportJobsWithContext(ctx aws.Context, input *ListDatasetImportJobsInput, opts ...request.Option) (*ListDatasetImportJobsOutput, error) {
req, out := c.ListDatasetImportJobsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListDatasetImportJobsPages iterates over the pages of a ListDatasetImportJobs operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListDatasetImportJobs method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListDatasetImportJobs operation.
// pageNum := 0
// err := client.ListDatasetImportJobsPages(params,
// func(page *forecastservice.ListDatasetImportJobsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListDatasetImportJobsPages(input *ListDatasetImportJobsInput, fn func(*ListDatasetImportJobsOutput, bool) bool) error {
return c.ListDatasetImportJobsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListDatasetImportJobsPagesWithContext same as ListDatasetImportJobsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListDatasetImportJobsPagesWithContext(ctx aws.Context, input *ListDatasetImportJobsInput, fn func(*ListDatasetImportJobsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListDatasetImportJobsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListDatasetImportJobsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListDatasetImportJobsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListDatasets = "ListDatasets"
// ListDatasetsRequest generates a "aws/request.Request" representing the
// client's request for the ListDatasets operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListDatasets for more information on using the ListDatasets
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListDatasetsRequest method.
// req, resp := client.ListDatasetsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasets
func (c *ForecastService) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput) {
op := &request.Operation{
Name: opListDatasets,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListDatasetsInput{}
}
output = &ListDatasetsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListDatasets API operation for Amazon Forecast Service.
//
// Returns a list of datasets created using the CreateDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)
// operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListDatasets for usage and error information.
//
// Returned Error Types:
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasets
func (c *ForecastService) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error) {
req, out := c.ListDatasetsRequest(input)
return out, req.Send()
}
// ListDatasetsWithContext is the same as ListDatasets with the addition of
// the ability to pass a context and additional request options.
//
// See ListDatasets for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error) {
req, out := c.ListDatasetsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListDatasetsPages iterates over the pages of a ListDatasets operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListDatasets method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListDatasets operation.
// pageNum := 0
// err := client.ListDatasetsPages(params,
// func(page *forecastservice.ListDatasetsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error {
return c.ListDatasetsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListDatasetsPagesWithContext same as ListDatasetsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListDatasetsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListDatasetsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListDatasetsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListExplainabilities = "ListExplainabilities"
// ListExplainabilitiesRequest generates a "aws/request.Request" representing the
// client's request for the ListExplainabilities operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListExplainabilities for more information on using the ListExplainabilities
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListExplainabilitiesRequest method.
// req, resp := client.ListExplainabilitiesRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilities
func (c *ForecastService) ListExplainabilitiesRequest(input *ListExplainabilitiesInput) (req *request.Request, output *ListExplainabilitiesOutput) {
op := &request.Operation{
Name: opListExplainabilities,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListExplainabilitiesInput{}
}
output = &ListExplainabilitiesOutput{}
req = c.newRequest(op, input, output)
return
}
// ListExplainabilities API operation for Amazon Forecast Service.
//
// 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 Filter objects.
//
// To retrieve the complete set of properties for a particular Explainability
// resource, use the ARN with the DescribeExplainability operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListExplainabilities for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilities
func (c *ForecastService) ListExplainabilities(input *ListExplainabilitiesInput) (*ListExplainabilitiesOutput, error) {
req, out := c.ListExplainabilitiesRequest(input)
return out, req.Send()
}
// ListExplainabilitiesWithContext is the same as ListExplainabilities with the addition of
// the ability to pass a context and additional request options.
//
// See ListExplainabilities for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListExplainabilitiesWithContext(ctx aws.Context, input *ListExplainabilitiesInput, opts ...request.Option) (*ListExplainabilitiesOutput, error) {
req, out := c.ListExplainabilitiesRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListExplainabilitiesPages iterates over the pages of a ListExplainabilities operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListExplainabilities method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListExplainabilities operation.
// pageNum := 0
// err := client.ListExplainabilitiesPages(params,
// func(page *forecastservice.ListExplainabilitiesOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListExplainabilitiesPages(input *ListExplainabilitiesInput, fn func(*ListExplainabilitiesOutput, bool) bool) error {
return c.ListExplainabilitiesPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListExplainabilitiesPagesWithContext same as ListExplainabilitiesPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListExplainabilitiesPagesWithContext(ctx aws.Context, input *ListExplainabilitiesInput, fn func(*ListExplainabilitiesOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListExplainabilitiesInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListExplainabilitiesRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListExplainabilitiesOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListExplainabilityExports = "ListExplainabilityExports"
// ListExplainabilityExportsRequest generates a "aws/request.Request" representing the
// client's request for the ListExplainabilityExports operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListExplainabilityExports for more information on using the ListExplainabilityExports
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListExplainabilityExportsRequest method.
// req, resp := client.ListExplainabilityExportsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExports
func (c *ForecastService) ListExplainabilityExportsRequest(input *ListExplainabilityExportsInput) (req *request.Request, output *ListExplainabilityExportsOutput) {
op := &request.Operation{
Name: opListExplainabilityExports,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListExplainabilityExportsInput{}
}
output = &ListExplainabilityExportsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListExplainabilityExports API operation for Amazon Forecast Service.
//
// 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 Filter objects.
//
// To retrieve the complete set of properties for a particular Explainability
// export, use the ARN with the DescribeExplainability operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListExplainabilityExports for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExports
func (c *ForecastService) ListExplainabilityExports(input *ListExplainabilityExportsInput) (*ListExplainabilityExportsOutput, error) {
req, out := c.ListExplainabilityExportsRequest(input)
return out, req.Send()
}
// ListExplainabilityExportsWithContext is the same as ListExplainabilityExports with the addition of
// the ability to pass a context and additional request options.
//
// See ListExplainabilityExports for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListExplainabilityExportsWithContext(ctx aws.Context, input *ListExplainabilityExportsInput, opts ...request.Option) (*ListExplainabilityExportsOutput, error) {
req, out := c.ListExplainabilityExportsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListExplainabilityExportsPages iterates over the pages of a ListExplainabilityExports operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListExplainabilityExports method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListExplainabilityExports operation.
// pageNum := 0
// err := client.ListExplainabilityExportsPages(params,
// func(page *forecastservice.ListExplainabilityExportsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListExplainabilityExportsPages(input *ListExplainabilityExportsInput, fn func(*ListExplainabilityExportsOutput, bool) bool) error {
return c.ListExplainabilityExportsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListExplainabilityExportsPagesWithContext same as ListExplainabilityExportsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListExplainabilityExportsPagesWithContext(ctx aws.Context, input *ListExplainabilityExportsInput, fn func(*ListExplainabilityExportsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListExplainabilityExportsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListExplainabilityExportsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListExplainabilityExportsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListForecastExportJobs = "ListForecastExportJobs"
// ListForecastExportJobsRequest generates a "aws/request.Request" representing the
// client's request for the ListForecastExportJobs operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListForecastExportJobs for more information on using the ListForecastExportJobs
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListForecastExportJobsRequest method.
// req, resp := client.ListForecastExportJobsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobs
func (c *ForecastService) ListForecastExportJobsRequest(input *ListForecastExportJobsInput) (req *request.Request, output *ListForecastExportJobsOutput) {
op := &request.Operation{
Name: opListForecastExportJobs,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListForecastExportJobsInput{}
}
output = &ListForecastExportJobsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListForecastExportJobs API operation for Amazon Forecast Service.
//
// 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 DescribeForecastExportJob
// operation. You can filter the list using an array of Filter objects.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListForecastExportJobs for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobs
func (c *ForecastService) ListForecastExportJobs(input *ListForecastExportJobsInput) (*ListForecastExportJobsOutput, error) {
req, out := c.ListForecastExportJobsRequest(input)
return out, req.Send()
}
// ListForecastExportJobsWithContext is the same as ListForecastExportJobs with the addition of
// the ability to pass a context and additional request options.
//
// See ListForecastExportJobs for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListForecastExportJobsWithContext(ctx aws.Context, input *ListForecastExportJobsInput, opts ...request.Option) (*ListForecastExportJobsOutput, error) {
req, out := c.ListForecastExportJobsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListForecastExportJobsPages iterates over the pages of a ListForecastExportJobs operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListForecastExportJobs method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListForecastExportJobs operation.
// pageNum := 0
// err := client.ListForecastExportJobsPages(params,
// func(page *forecastservice.ListForecastExportJobsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListForecastExportJobsPages(input *ListForecastExportJobsInput, fn func(*ListForecastExportJobsOutput, bool) bool) error {
return c.ListForecastExportJobsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListForecastExportJobsPagesWithContext same as ListForecastExportJobsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListForecastExportJobsPagesWithContext(ctx aws.Context, input *ListForecastExportJobsInput, fn func(*ListForecastExportJobsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListForecastExportJobsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListForecastExportJobsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListForecastExportJobsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListForecasts = "ListForecasts"
// ListForecastsRequest generates a "aws/request.Request" representing the
// client's request for the ListForecasts operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListForecasts for more information on using the ListForecasts
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListForecastsRequest method.
// req, resp := client.ListForecastsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecasts
func (c *ForecastService) ListForecastsRequest(input *ListForecastsInput) (req *request.Request, output *ListForecastsOutput) {
op := &request.Operation{
Name: opListForecasts,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListForecastsInput{}
}
output = &ListForecastsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListForecasts API operation for Amazon Forecast Service.
//
// 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 DescribeForecast operation. You can filter the list
// using an array of Filter objects.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListForecasts for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecasts
func (c *ForecastService) ListForecasts(input *ListForecastsInput) (*ListForecastsOutput, error) {
req, out := c.ListForecastsRequest(input)
return out, req.Send()
}
// ListForecastsWithContext is the same as ListForecasts with the addition of
// the ability to pass a context and additional request options.
//
// See ListForecasts for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListForecastsWithContext(ctx aws.Context, input *ListForecastsInput, opts ...request.Option) (*ListForecastsOutput, error) {
req, out := c.ListForecastsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListForecastsPages iterates over the pages of a ListForecasts operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListForecasts method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListForecasts operation.
// pageNum := 0
// err := client.ListForecastsPages(params,
// func(page *forecastservice.ListForecastsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListForecastsPages(input *ListForecastsInput, fn func(*ListForecastsOutput, bool) bool) error {
return c.ListForecastsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListForecastsPagesWithContext same as ListForecastsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListForecastsPagesWithContext(ctx aws.Context, input *ListForecastsInput, fn func(*ListForecastsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListForecastsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListForecastsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListForecastsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListMonitorEvaluations = "ListMonitorEvaluations"
// ListMonitorEvaluationsRequest generates a "aws/request.Request" representing the
// client's request for the ListMonitorEvaluations operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListMonitorEvaluations for more information on using the ListMonitorEvaluations
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListMonitorEvaluationsRequest method.
// req, resp := client.ListMonitorEvaluationsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluations
func (c *ForecastService) ListMonitorEvaluationsRequest(input *ListMonitorEvaluationsInput) (req *request.Request, output *ListMonitorEvaluationsOutput) {
op := &request.Operation{
Name: opListMonitorEvaluations,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListMonitorEvaluationsInput{}
}
output = &ListMonitorEvaluationsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListMonitorEvaluations API operation for Amazon Forecast Service.
//
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListMonitorEvaluations for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluations
func (c *ForecastService) ListMonitorEvaluations(input *ListMonitorEvaluationsInput) (*ListMonitorEvaluationsOutput, error) {
req, out := c.ListMonitorEvaluationsRequest(input)
return out, req.Send()
}
// ListMonitorEvaluationsWithContext is the same as ListMonitorEvaluations with the addition of
// the ability to pass a context and additional request options.
//
// See ListMonitorEvaluations for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListMonitorEvaluationsWithContext(ctx aws.Context, input *ListMonitorEvaluationsInput, opts ...request.Option) (*ListMonitorEvaluationsOutput, error) {
req, out := c.ListMonitorEvaluationsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListMonitorEvaluationsPages iterates over the pages of a ListMonitorEvaluations operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListMonitorEvaluations method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListMonitorEvaluations operation.
// pageNum := 0
// err := client.ListMonitorEvaluationsPages(params,
// func(page *forecastservice.ListMonitorEvaluationsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListMonitorEvaluationsPages(input *ListMonitorEvaluationsInput, fn func(*ListMonitorEvaluationsOutput, bool) bool) error {
return c.ListMonitorEvaluationsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListMonitorEvaluationsPagesWithContext same as ListMonitorEvaluationsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListMonitorEvaluationsPagesWithContext(ctx aws.Context, input *ListMonitorEvaluationsInput, fn func(*ListMonitorEvaluationsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListMonitorEvaluationsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListMonitorEvaluationsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListMonitorEvaluationsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListMonitors = "ListMonitors"
// ListMonitorsRequest generates a "aws/request.Request" representing the
// client's request for the ListMonitors operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListMonitors for more information on using the ListMonitors
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListMonitorsRequest method.
// req, resp := client.ListMonitorsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitors
func (c *ForecastService) ListMonitorsRequest(input *ListMonitorsInput) (req *request.Request, output *ListMonitorsOutput) {
op := &request.Operation{
Name: opListMonitors,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListMonitorsInput{}
}
output = &ListMonitorsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListMonitors API operation for Amazon Forecast Service.
//
// 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 DescribeMonitor operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListMonitors for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitors
func (c *ForecastService) ListMonitors(input *ListMonitorsInput) (*ListMonitorsOutput, error) {
req, out := c.ListMonitorsRequest(input)
return out, req.Send()
}
// ListMonitorsWithContext is the same as ListMonitors with the addition of
// the ability to pass a context and additional request options.
//
// See ListMonitors for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListMonitorsWithContext(ctx aws.Context, input *ListMonitorsInput, opts ...request.Option) (*ListMonitorsOutput, error) {
req, out := c.ListMonitorsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListMonitorsPages iterates over the pages of a ListMonitors operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListMonitors method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListMonitors operation.
// pageNum := 0
// err := client.ListMonitorsPages(params,
// func(page *forecastservice.ListMonitorsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListMonitorsPages(input *ListMonitorsInput, fn func(*ListMonitorsOutput, bool) bool) error {
return c.ListMonitorsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListMonitorsPagesWithContext same as ListMonitorsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListMonitorsPagesWithContext(ctx aws.Context, input *ListMonitorsInput, fn func(*ListMonitorsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListMonitorsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListMonitorsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListMonitorsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListPredictorBacktestExportJobs = "ListPredictorBacktestExportJobs"
// ListPredictorBacktestExportJobsRequest generates a "aws/request.Request" representing the
// client's request for the ListPredictorBacktestExportJobs operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListPredictorBacktestExportJobs for more information on using the ListPredictorBacktestExportJobs
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListPredictorBacktestExportJobsRequest method.
// req, resp := client.ListPredictorBacktestExportJobsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobs
func (c *ForecastService) ListPredictorBacktestExportJobsRequest(input *ListPredictorBacktestExportJobsInput) (req *request.Request, output *ListPredictorBacktestExportJobsOutput) {
op := &request.Operation{
Name: opListPredictorBacktestExportJobs,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListPredictorBacktestExportJobsInput{}
}
output = &ListPredictorBacktestExportJobsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListPredictorBacktestExportJobs API operation for Amazon Forecast Service.
//
// 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 Filter objects.
//
// To retrieve the complete set of properties for a particular backtest export
// job, use the ARN with the DescribePredictorBacktestExportJob operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListPredictorBacktestExportJobs for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobs
func (c *ForecastService) ListPredictorBacktestExportJobs(input *ListPredictorBacktestExportJobsInput) (*ListPredictorBacktestExportJobsOutput, error) {
req, out := c.ListPredictorBacktestExportJobsRequest(input)
return out, req.Send()
}
// ListPredictorBacktestExportJobsWithContext is the same as ListPredictorBacktestExportJobs with the addition of
// the ability to pass a context and additional request options.
//
// See ListPredictorBacktestExportJobs for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListPredictorBacktestExportJobsWithContext(ctx aws.Context, input *ListPredictorBacktestExportJobsInput, opts ...request.Option) (*ListPredictorBacktestExportJobsOutput, error) {
req, out := c.ListPredictorBacktestExportJobsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListPredictorBacktestExportJobsPages iterates over the pages of a ListPredictorBacktestExportJobs operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListPredictorBacktestExportJobs method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListPredictorBacktestExportJobs operation.
// pageNum := 0
// err := client.ListPredictorBacktestExportJobsPages(params,
// func(page *forecastservice.ListPredictorBacktestExportJobsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListPredictorBacktestExportJobsPages(input *ListPredictorBacktestExportJobsInput, fn func(*ListPredictorBacktestExportJobsOutput, bool) bool) error {
return c.ListPredictorBacktestExportJobsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListPredictorBacktestExportJobsPagesWithContext same as ListPredictorBacktestExportJobsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListPredictorBacktestExportJobsPagesWithContext(ctx aws.Context, input *ListPredictorBacktestExportJobsInput, fn func(*ListPredictorBacktestExportJobsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListPredictorBacktestExportJobsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListPredictorBacktestExportJobsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListPredictorBacktestExportJobsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListPredictors = "ListPredictors"
// ListPredictorsRequest generates a "aws/request.Request" representing the
// client's request for the ListPredictors operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListPredictors for more information on using the ListPredictors
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListPredictorsRequest method.
// req, resp := client.ListPredictorsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictors
func (c *ForecastService) ListPredictorsRequest(input *ListPredictorsInput) (req *request.Request, output *ListPredictorsOutput) {
op := &request.Operation{
Name: opListPredictors,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListPredictorsInput{}
}
output = &ListPredictorsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListPredictors API operation for Amazon Forecast Service.
//
// 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 Filter objects.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListPredictors for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictors
func (c *ForecastService) ListPredictors(input *ListPredictorsInput) (*ListPredictorsOutput, error) {
req, out := c.ListPredictorsRequest(input)
return out, req.Send()
}
// ListPredictorsWithContext is the same as ListPredictors with the addition of
// the ability to pass a context and additional request options.
//
// See ListPredictors for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListPredictorsWithContext(ctx aws.Context, input *ListPredictorsInput, opts ...request.Option) (*ListPredictorsOutput, error) {
req, out := c.ListPredictorsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListPredictorsPages iterates over the pages of a ListPredictors operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListPredictors method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListPredictors operation.
// pageNum := 0
// err := client.ListPredictorsPages(params,
// func(page *forecastservice.ListPredictorsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListPredictorsPages(input *ListPredictorsInput, fn func(*ListPredictorsOutput, bool) bool) error {
return c.ListPredictorsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListPredictorsPagesWithContext same as ListPredictorsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListPredictorsPagesWithContext(ctx aws.Context, input *ListPredictorsInput, fn func(*ListPredictorsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListPredictorsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListPredictorsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListPredictorsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListTagsForResource = "ListTagsForResource"
// ListTagsForResourceRequest generates a "aws/request.Request" representing the
// client's request for the ListTagsForResource operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListTagsForResource for more information on using the ListTagsForResource
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListTagsForResourceRequest method.
// req, resp := client.ListTagsForResourceRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResource
func (c *ForecastService) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) {
op := &request.Operation{
Name: opListTagsForResource,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ListTagsForResourceInput{}
}
output = &ListTagsForResourceOutput{}
req = c.newRequest(op, input, output)
return
}
// ListTagsForResource API operation for Amazon Forecast Service.
//
// Lists the tags for an Amazon Forecast resource.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListTagsForResource for usage and error information.
//
// Returned Error Types:
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResource
func (c *ForecastService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) {
req, out := c.ListTagsForResourceRequest(input)
return out, req.Send()
}
// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of
// the ability to pass a context and additional request options.
//
// See ListTagsForResource for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) {
req, out := c.ListTagsForResourceRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opListWhatIfAnalyses = "ListWhatIfAnalyses"
// ListWhatIfAnalysesRequest generates a "aws/request.Request" representing the
// client's request for the ListWhatIfAnalyses operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListWhatIfAnalyses for more information on using the ListWhatIfAnalyses
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListWhatIfAnalysesRequest method.
// req, resp := client.ListWhatIfAnalysesRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfAnalyses
func (c *ForecastService) ListWhatIfAnalysesRequest(input *ListWhatIfAnalysesInput) (req *request.Request, output *ListWhatIfAnalysesOutput) {
op := &request.Operation{
Name: opListWhatIfAnalyses,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListWhatIfAnalysesInput{}
}
output = &ListWhatIfAnalysesOutput{}
req = c.newRequest(op, input, output)
return
}
// ListWhatIfAnalyses API operation for Amazon Forecast Service.
//
// 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
// DescribeWhatIfAnalysis operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListWhatIfAnalyses for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfAnalyses
func (c *ForecastService) ListWhatIfAnalyses(input *ListWhatIfAnalysesInput) (*ListWhatIfAnalysesOutput, error) {
req, out := c.ListWhatIfAnalysesRequest(input)
return out, req.Send()
}
// ListWhatIfAnalysesWithContext is the same as ListWhatIfAnalyses with the addition of
// the ability to pass a context and additional request options.
//
// See ListWhatIfAnalyses for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListWhatIfAnalysesWithContext(ctx aws.Context, input *ListWhatIfAnalysesInput, opts ...request.Option) (*ListWhatIfAnalysesOutput, error) {
req, out := c.ListWhatIfAnalysesRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListWhatIfAnalysesPages iterates over the pages of a ListWhatIfAnalyses operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListWhatIfAnalyses method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListWhatIfAnalyses operation.
// pageNum := 0
// err := client.ListWhatIfAnalysesPages(params,
// func(page *forecastservice.ListWhatIfAnalysesOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListWhatIfAnalysesPages(input *ListWhatIfAnalysesInput, fn func(*ListWhatIfAnalysesOutput, bool) bool) error {
return c.ListWhatIfAnalysesPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListWhatIfAnalysesPagesWithContext same as ListWhatIfAnalysesPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListWhatIfAnalysesPagesWithContext(ctx aws.Context, input *ListWhatIfAnalysesInput, fn func(*ListWhatIfAnalysesOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListWhatIfAnalysesInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListWhatIfAnalysesRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListWhatIfAnalysesOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListWhatIfForecastExports = "ListWhatIfForecastExports"
// ListWhatIfForecastExportsRequest generates a "aws/request.Request" representing the
// client's request for the ListWhatIfForecastExports operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListWhatIfForecastExports for more information on using the ListWhatIfForecastExports
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListWhatIfForecastExportsRequest method.
// req, resp := client.ListWhatIfForecastExportsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecastExports
func (c *ForecastService) ListWhatIfForecastExportsRequest(input *ListWhatIfForecastExportsInput) (req *request.Request, output *ListWhatIfForecastExportsOutput) {
op := &request.Operation{
Name: opListWhatIfForecastExports,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListWhatIfForecastExportsInput{}
}
output = &ListWhatIfForecastExportsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListWhatIfForecastExports API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListWhatIfForecastExports for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecastExports
func (c *ForecastService) ListWhatIfForecastExports(input *ListWhatIfForecastExportsInput) (*ListWhatIfForecastExportsOutput, error) {
req, out := c.ListWhatIfForecastExportsRequest(input)
return out, req.Send()
}
// ListWhatIfForecastExportsWithContext is the same as ListWhatIfForecastExports with the addition of
// the ability to pass a context and additional request options.
//
// See ListWhatIfForecastExports for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListWhatIfForecastExportsWithContext(ctx aws.Context, input *ListWhatIfForecastExportsInput, opts ...request.Option) (*ListWhatIfForecastExportsOutput, error) {
req, out := c.ListWhatIfForecastExportsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListWhatIfForecastExportsPages iterates over the pages of a ListWhatIfForecastExports operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListWhatIfForecastExports method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListWhatIfForecastExports operation.
// pageNum := 0
// err := client.ListWhatIfForecastExportsPages(params,
// func(page *forecastservice.ListWhatIfForecastExportsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListWhatIfForecastExportsPages(input *ListWhatIfForecastExportsInput, fn func(*ListWhatIfForecastExportsOutput, bool) bool) error {
return c.ListWhatIfForecastExportsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListWhatIfForecastExportsPagesWithContext same as ListWhatIfForecastExportsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListWhatIfForecastExportsPagesWithContext(ctx aws.Context, input *ListWhatIfForecastExportsInput, fn func(*ListWhatIfForecastExportsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListWhatIfForecastExportsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListWhatIfForecastExportsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListWhatIfForecastExportsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opListWhatIfForecasts = "ListWhatIfForecasts"
// ListWhatIfForecastsRequest generates a "aws/request.Request" representing the
// client's request for the ListWhatIfForecasts operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ListWhatIfForecasts for more information on using the ListWhatIfForecasts
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ListWhatIfForecastsRequest method.
// req, resp := client.ListWhatIfForecastsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecasts
func (c *ForecastService) ListWhatIfForecastsRequest(input *ListWhatIfForecastsInput) (req *request.Request, output *ListWhatIfForecastsOutput) {
op := &request.Operation{
Name: opListWhatIfForecasts,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListWhatIfForecastsInput{}
}
output = &ListWhatIfForecastsOutput{}
req = c.newRequest(op, input, output)
return
}
// ListWhatIfForecasts API operation for Amazon Forecast Service.
//
// 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
// DescribeWhatIfForecast operation.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ListWhatIfForecasts for usage and error information.
//
// Returned Error Types:
//
// - InvalidNextTokenException
// The token is not valid. Tokens expire after 24 hours.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecasts
func (c *ForecastService) ListWhatIfForecasts(input *ListWhatIfForecastsInput) (*ListWhatIfForecastsOutput, error) {
req, out := c.ListWhatIfForecastsRequest(input)
return out, req.Send()
}
// ListWhatIfForecastsWithContext is the same as ListWhatIfForecasts with the addition of
// the ability to pass a context and additional request options.
//
// See ListWhatIfForecasts for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListWhatIfForecastsWithContext(ctx aws.Context, input *ListWhatIfForecastsInput, opts ...request.Option) (*ListWhatIfForecastsOutput, error) {
req, out := c.ListWhatIfForecastsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// ListWhatIfForecastsPages iterates over the pages of a ListWhatIfForecasts operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See ListWhatIfForecasts method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a ListWhatIfForecasts operation.
// pageNum := 0
// err := client.ListWhatIfForecastsPages(params,
// func(page *forecastservice.ListWhatIfForecastsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
func (c *ForecastService) ListWhatIfForecastsPages(input *ListWhatIfForecastsInput, fn func(*ListWhatIfForecastsOutput, bool) bool) error {
return c.ListWhatIfForecastsPagesWithContext(aws.BackgroundContext(), input, fn)
}
// ListWhatIfForecastsPagesWithContext same as ListWhatIfForecastsPages except
// it takes a Context and allows setting request options on the pages.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ListWhatIfForecastsPagesWithContext(ctx aws.Context, input *ListWhatIfForecastsInput, fn func(*ListWhatIfForecastsOutput, bool) bool, opts ...request.Option) error {
p := request.Pagination{
NewRequest: func() (*request.Request, error) {
var inCpy *ListWhatIfForecastsInput
if input != nil {
tmp := *input
inCpy = &tmp
}
req, _ := c.ListWhatIfForecastsRequest(inCpy)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return req, nil
},
}
for p.Next() {
if !fn(p.Page().(*ListWhatIfForecastsOutput), !p.HasNextPage()) {
break
}
}
return p.Err()
}
const opResumeResource = "ResumeResource"
// ResumeResourceRequest generates a "aws/request.Request" representing the
// client's request for the ResumeResource operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See ResumeResource for more information on using the ResumeResource
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the ResumeResourceRequest method.
// req, resp := client.ResumeResourceRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResource
func (c *ForecastService) ResumeResourceRequest(input *ResumeResourceInput) (req *request.Request, output *ResumeResourceOutput) {
op := &request.Operation{
Name: opResumeResource,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ResumeResourceInput{}
}
output = &ResumeResourceOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// ResumeResource API operation for Amazon Forecast Service.
//
// Resumes a stopped monitor resource.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation ResumeResource for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResource
func (c *ForecastService) ResumeResource(input *ResumeResourceInput) (*ResumeResourceOutput, error) {
req, out := c.ResumeResourceRequest(input)
return out, req.Send()
}
// ResumeResourceWithContext is the same as ResumeResource with the addition of
// the ability to pass a context and additional request options.
//
// See ResumeResource for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) ResumeResourceWithContext(ctx aws.Context, input *ResumeResourceInput, opts ...request.Option) (*ResumeResourceOutput, error) {
req, out := c.ResumeResourceRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opStopResource = "StopResource"
// StopResourceRequest generates a "aws/request.Request" representing the
// client's request for the StopResource operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See StopResource for more information on using the StopResource
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the StopResourceRequest method.
// req, resp := client.StopResourceRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/StopResource
func (c *ForecastService) StopResourceRequest(input *StopResourceInput) (req *request.Request, output *StopResourceOutput) {
op := &request.Operation{
Name: opStopResource,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &StopResourceInput{}
}
output = &StopResourceOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// StopResource API operation for Amazon Forecast Service.
//
// 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
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation StopResource for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/StopResource
func (c *ForecastService) StopResource(input *StopResourceInput) (*StopResourceOutput, error) {
req, out := c.StopResourceRequest(input)
return out, req.Send()
}
// StopResourceWithContext is the same as StopResource with the addition of
// the ability to pass a context and additional request options.
//
// See StopResource for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) StopResourceWithContext(ctx aws.Context, input *StopResourceInput, opts ...request.Option) (*StopResourceOutput, error) {
req, out := c.StopResourceRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opTagResource = "TagResource"
// TagResourceRequest generates a "aws/request.Request" representing the
// client's request for the TagResource operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See TagResource for more information on using the TagResource
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the TagResourceRequest method.
// req, resp := client.TagResourceRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResource
func (c *ForecastService) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) {
op := &request.Operation{
Name: opTagResource,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &TagResourceInput{}
}
output = &TagResourceOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// TagResource API operation for Amazon Forecast Service.
//
// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation TagResource for usage and error information.
//
// Returned Error Types:
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - LimitExceededException
// The limit on the number of resources per account has been exceeded.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResource
func (c *ForecastService) TagResource(input *TagResourceInput) (*TagResourceOutput, error) {
req, out := c.TagResourceRequest(input)
return out, req.Send()
}
// TagResourceWithContext is the same as TagResource with the addition of
// the ability to pass a context and additional request options.
//
// See TagResource for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) {
req, out := c.TagResourceRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opUntagResource = "UntagResource"
// UntagResourceRequest generates a "aws/request.Request" representing the
// client's request for the UntagResource operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See UntagResource for more information on using the UntagResource
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the UntagResourceRequest method.
// req, resp := client.UntagResourceRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UntagResource
func (c *ForecastService) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) {
op := &request.Operation{
Name: opUntagResource,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &UntagResourceInput{}
}
output = &UntagResourceOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// UntagResource API operation for Amazon Forecast Service.
//
// Deletes the specified tags from a resource.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation UntagResource for usage and error information.
//
// Returned Error Types:
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UntagResource
func (c *ForecastService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) {
req, out := c.UntagResourceRequest(input)
return out, req.Send()
}
// UntagResourceWithContext is the same as UntagResource with the addition of
// the ability to pass a context and additional request options.
//
// See UntagResource for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) {
req, out := c.UntagResourceRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
const opUpdateDatasetGroup = "UpdateDatasetGroup"
// UpdateDatasetGroupRequest generates a "aws/request.Request" representing the
// client's request for the UpdateDatasetGroup operation. The "output" return
// value will be populated with the request's response once the request completes
// successfully.
//
// Use "Send" method on the returned Request to send the API call to the service.
// the "output" return value is not valid until after Send returns without error.
//
// See UpdateDatasetGroup for more information on using the UpdateDatasetGroup
// API call, and error handling.
//
// This method is useful when you want to inject custom logic or configuration
// into the SDK's request lifecycle. Such as custom headers, or retry logic.
//
// // Example sending a request using the UpdateDatasetGroupRequest method.
// req, resp := client.UpdateDatasetGroupRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UpdateDatasetGroup
func (c *ForecastService) UpdateDatasetGroupRequest(input *UpdateDatasetGroupInput) (req *request.Request, output *UpdateDatasetGroupOutput) {
op := &request.Operation{
Name: opUpdateDatasetGroup,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &UpdateDatasetGroupInput{}
}
output = &UpdateDatasetGroupOutput{}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
return
}
// UpdateDatasetGroup API operation for Amazon Forecast Service.
//
// 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 DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)
// operation to get the status.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Amazon Forecast Service's
// API operation UpdateDatasetGroup for usage and error information.
//
// Returned Error Types:
//
// - InvalidInputException
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
//
// - ResourceNotFoundException
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
//
// - ResourceInUseException
// The specified resource is in use.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UpdateDatasetGroup
func (c *ForecastService) UpdateDatasetGroup(input *UpdateDatasetGroupInput) (*UpdateDatasetGroupOutput, error) {
req, out := c.UpdateDatasetGroupRequest(input)
return out, req.Send()
}
// UpdateDatasetGroupWithContext is the same as UpdateDatasetGroup with the addition of
// the ability to pass a context and additional request options.
//
// See UpdateDatasetGroup for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If
// the context is nil a panic will occur. In the future the SDK may create
// sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *ForecastService) UpdateDatasetGroupWithContext(ctx aws.Context, input *UpdateDatasetGroupInput, opts ...request.Option) (*UpdateDatasetGroupOutput, error) {
req, out := c.UpdateDatasetGroupRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// Defines the modifications that you are making to an attribute for a what-if
// forecast. For example, you can use this operation to create a what-if forecast
// that investigates a 10% off sale on all shoes. To do this, you specify "AttributeName":
// "shoes", "Operation": "MULTIPLY", and "Value": "0.90". Pair this operation
// with the TimeSeriesCondition operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations
// operation to define a subset of attribute items that are modified.
type Action struct {
_ struct{} `type:"structure"`
// The related time series that you are modifying. This value is case insensitive.
//
// AttributeName is a required field
AttributeName *string `min:"1" type:"string" required:"true"`
// The operation that is applied to the provided attribute. Operations include:
//
// * ADD - adds Value to all rows of AttributeName.
//
// * SUBTRACT - subtracts Value from all rows of AttributeName.
//
// * MULTIPLY - multiplies all rows of AttributeName by Value.
//
// * DIVIDE - divides all rows of AttributeName by Value.
//
// Operation is a required field
Operation *string `type:"string" required:"true" enum:"Operation"`
// The value that is applied for the chosen Operation.
//
// Value is a required field
Value *float64 `type:"double" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Action) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Action) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Action) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "Action"}
if s.AttributeName == nil {
invalidParams.Add(request.NewErrParamRequired("AttributeName"))
}
if s.AttributeName != nil && len(*s.AttributeName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1))
}
if s.Operation == nil {
invalidParams.Add(request.NewErrParamRequired("Operation"))
}
if s.Value == nil {
invalidParams.Add(request.NewErrParamRequired("Value"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAttributeName sets the AttributeName field's value.
func (s *Action) SetAttributeName(v string) *Action {
s.AttributeName = &v
return s
}
// SetOperation sets the Operation field's value.
func (s *Action) SetOperation(v string) *Action {
s.Operation = &v
return s
}
// SetValue sets the Value field's value.
func (s *Action) SetValue(v float64) *Action {
s.Value = &v
return s
}
// Describes an additional dataset. This object is part of the DataConfig object.
// Forecast supports the Weather Index and Holidays additional datasets.
//
// # Weather Index
//
// The Amazon Forecast Weather Index is a built-in dataset that incorporates
// historical and projected weather information into your model. The Weather
// Index supplements your datasets with over two years of historical weather
// data and up to 14 days of projected weather data. For more information, see
// Amazon Forecast Weather Index (https://docs.aws.amazon.com/forecast/latest/dg/weather.html).
//
// # Holidays
//
// Holidays is a built-in dataset that incorporates national holiday information
// into your model. It provides native support for the holiday calendars of
// 66 countries. To view the holiday calendars, refer to the Jollyday (http://jollyday.sourceforge.net/data.html)
// library. For more information, see Holidays Featurization (https://docs.aws.amazon.com/forecast/latest/dg/holidays.html).
type AdditionalDataset struct {
_ struct{} `type:"structure"`
// Weather Index
//
// To enable the Weather Index, do not specify a value for Configuration.
//
// Holidays
//
// Holidays
//
// To enable Holidays, set CountryCode to one of the following two-letter country
// codes:
//
// * "AL" - ALBANIA
//
// * "AR" - ARGENTINA
//
// * "AT" - AUSTRIA
//
// * "AU" - AUSTRALIA
//
// * "BA" - BOSNIA HERZEGOVINA
//
// * "BE" - BELGIUM
//
// * "BG" - BULGARIA
//
// * "BO" - BOLIVIA
//
// * "BR" - BRAZIL
//
// * "BY" - BELARUS
//
// * "CA" - CANADA
//
// * "CL" - CHILE
//
// * "CO" - COLOMBIA
//
// * "CR" - COSTA RICA
//
// * "HR" - CROATIA
//
// * "CZ" - CZECH REPUBLIC
//
// * "DK" - DENMARK
//
// * "EC" - ECUADOR
//
// * "EE" - ESTONIA
//
// * "ET" - ETHIOPIA
//
// * "FI" - FINLAND
//
// * "FR" - FRANCE
//
// * "DE" - GERMANY
//
// * "GR" - GREECE
//
// * "HU" - HUNGARY
//
// * "IS" - ICELAND
//
// * "IN" - INDIA
//
// * "IE" - IRELAND
//
// * "IT" - ITALY
//
// * "JP" - JAPAN
//
// * "KZ" - KAZAKHSTAN
//
// * "KR" - KOREA
//
// * "LV" - LATVIA
//
// * "LI" - LIECHTENSTEIN
//
// * "LT" - LITHUANIA
//
// * "LU" - LUXEMBOURG
//
// * "MK" - MACEDONIA
//
// * "MT" - MALTA
//
// * "MX" - MEXICO
//
// * "MD" - MOLDOVA
//
// * "ME" - MONTENEGRO
//
// * "NL" - NETHERLANDS
//
// * "NZ" - NEW ZEALAND
//
// * "NI" - NICARAGUA
//
// * "NG" - NIGERIA
//
// * "NO" - NORWAY
//
// * "PA" - PANAMA
//
// * "PY" - PARAGUAY
//
// * "PE" - PERU
//
// * "PL" - POLAND
//
// * "PT" - PORTUGAL
//
// * "RO" - ROMANIA
//
// * "RU" - RUSSIA
//
// * "RS" - SERBIA
//
// * "SK" - SLOVAKIA
//
// * "SI" - SLOVENIA
//
// * "ZA" - SOUTH AFRICA
//
// * "ES" - SPAIN
//
// * "SE" - SWEDEN
//
// * "CH" - SWITZERLAND
//
// * "UA" - UKRAINE
//
// * "AE" - UNITED ARAB EMIRATES
//
// * "US" - UNITED STATES
//
// * "UK" - UNITED KINGDOM
//
// * "UY" - URUGUAY
//
// * "VE" - VENEZUELA
Configuration map[string][]*string `type:"map"`
// The name of the additional dataset. Valid names: "holiday" and "weather".
//
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s AdditionalDataset) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s AdditionalDataset) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *AdditionalDataset) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "AdditionalDataset"}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Name", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetConfiguration sets the Configuration field's value.
func (s *AdditionalDataset) SetConfiguration(v map[string][]*string) *AdditionalDataset {
s.Configuration = v
return s
}
// SetName sets the Name field's value.
func (s *AdditionalDataset) SetName(v string) *AdditionalDataset {
s.Name = &v
return s
}
// Provides information about the method used to transform attributes.
//
// The following is an example using the RETAIL domain:
//
// {
//
// "AttributeName": "demand",
//
// "Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill":
// "zero"}
//
// }
type AttributeConfig struct {
_ struct{} `type:"structure"`
// The name of the attribute as specified in the schema. Amazon Forecast supports
// the target field of the target time series and the related time series datasets.
// For example, for the RETAIL domain, the target is demand.
//
// AttributeName is a required field
AttributeName *string `min:"1" type:"string" required:"true"`
// The method parameters (key-value pairs), which are a map of override parameters.
// Specify these parameters to override the default values. Related Time Series
// attributes do not accept aggregation parameters.
//
// The following list shows the parameters and their valid values for the "filling"
// featurization method for a Target Time Series dataset. Default values are
// bolded.
//
// * aggregation: sum, avg, first, min, max
//
// * frontfill: none
//
// * middlefill: zero, nan (not a number), value, median, mean, min, max
//
// * backfill: zero, nan, value, median, mean, min, max
//
// The following list shows the parameters and their valid values for a Related
// Time Series featurization method (there are no defaults):
//
// * middlefill: zero, value, median, mean, min, max
//
// * backfill: zero, value, median, mean, min, max
//
// * futurefill: zero, value, median, mean, min, max
//
// To set a filling method to a specific value, set the fill parameter to value
// and define the value in a corresponding _value parameter. For example, to
// set backfilling to a value of 2, include the following: "backfill": "value"
// and "backfill_value":"2".
//
// Transformations is a required field
Transformations map[string]*string `min:"1" type:"map" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s AttributeConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s AttributeConfig) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *AttributeConfig) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "AttributeConfig"}
if s.AttributeName == nil {
invalidParams.Add(request.NewErrParamRequired("AttributeName"))
}
if s.AttributeName != nil && len(*s.AttributeName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1))
}
if s.Transformations == nil {
invalidParams.Add(request.NewErrParamRequired("Transformations"))
}
if s.Transformations != nil && len(s.Transformations) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Transformations", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAttributeName sets the AttributeName field's value.
func (s *AttributeConfig) SetAttributeName(v string) *AttributeConfig {
s.AttributeName = &v
return s
}
// SetTransformations sets the Transformations field's value.
func (s *AttributeConfig) SetTransformations(v map[string]*string) *AttributeConfig {
s.Transformations = v
return s
}
// Metrics you can use as a baseline for comparison purposes. Use these metrics
// when you interpret monitoring results for an auto predictor.
type Baseline struct {
_ struct{} `type:"structure"`
// The initial accuracy metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)
// for the predictor you are monitoring. Use these metrics as a baseline for
// comparison purposes as you use your predictor and the metrics change.
PredictorBaseline *PredictorBaseline `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Baseline) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Baseline) GoString() string {
return s.String()
}
// SetPredictorBaseline sets the PredictorBaseline field's value.
func (s *Baseline) SetPredictorBaseline(v *PredictorBaseline) *Baseline {
s.PredictorBaseline = v
return s
}
// An individual metric that you can use for comparison as you evaluate your
// monitoring results.
type BaselineMetric struct {
_ struct{} `type:"structure"`
// The name of the metric.
Name *string `min:"1" type:"string"`
// The value for the metric.
Value *float64 `type:"double"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s BaselineMetric) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s BaselineMetric) GoString() string {
return s.String()
}
// SetName sets the Name field's value.
func (s *BaselineMetric) SetName(v string) *BaselineMetric {
s.Name = &v
return s
}
// SetValue sets the Value field's value.
func (s *BaselineMetric) SetValue(v float64) *BaselineMetric {
s.Value = &v
return s
}
// Specifies a categorical hyperparameter and it's range of tunable values.
// This object is part of the ParameterRanges object.
type CategoricalParameterRange struct {
_ struct{} `type:"structure"`
// The name of the categorical hyperparameter to tune.
//
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
// A list of the tunable categories for the hyperparameter.
//
// Values is a required field
Values []*string `min:"1" type:"list" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CategoricalParameterRange) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CategoricalParameterRange) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CategoricalParameterRange) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CategoricalParameterRange"}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Name", 1))
}
if s.Values == nil {
invalidParams.Add(request.NewErrParamRequired("Values"))
}
if s.Values != nil && len(s.Values) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Values", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetName sets the Name field's value.
func (s *CategoricalParameterRange) SetName(v string) *CategoricalParameterRange {
s.Name = &v
return s
}
// SetValues sets the Values field's value.
func (s *CategoricalParameterRange) SetValues(v []*string) *CategoricalParameterRange {
s.Values = v
return s
}
// Specifies a continuous hyperparameter and it's range of tunable values. This
// object is part of the ParameterRanges object.
type ContinuousParameterRange struct {
_ struct{} `type:"structure"`
// The maximum tunable value of the hyperparameter.
//
// MaxValue is a required field
MaxValue *float64 `type:"double" required:"true"`
// The minimum tunable value of the hyperparameter.
//
// MinValue is a required field
MinValue *float64 `type:"double" required:"true"`
// The name of the hyperparameter to tune.
//
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
// The scale that hyperparameter tuning uses to search the hyperparameter range.
// Valid values:
//
// Auto
//
// Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
//
// Linear
//
// Hyperparameter tuning searches the values in the hyperparameter range by
// using a linear scale.
//
// Logarithmic
//
// Hyperparameter tuning searches the values in the hyperparameter range by
// using a logarithmic scale.
//
// Logarithmic scaling works only for ranges that have values greater than 0.
//
// ReverseLogarithmic
//
// hyperparameter tuning searches the values in the hyperparameter range by
// using a reverse logarithmic scale.
//
// Reverse logarithmic scaling works only for ranges that are entirely within
// the range 0 <= x < 1.0.
//
// For information about choosing a hyperparameter scale, see Hyperparameter
// Scaling (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type).
// One of the following values:
ScalingType *string `type:"string" enum:"ScalingType"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ContinuousParameterRange) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ContinuousParameterRange) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ContinuousParameterRange) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ContinuousParameterRange"}
if s.MaxValue == nil {
invalidParams.Add(request.NewErrParamRequired("MaxValue"))
}
if s.MinValue == nil {
invalidParams.Add(request.NewErrParamRequired("MinValue"))
}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Name", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMaxValue sets the MaxValue field's value.
func (s *ContinuousParameterRange) SetMaxValue(v float64) *ContinuousParameterRange {
s.MaxValue = &v
return s
}
// SetMinValue sets the MinValue field's value.
func (s *ContinuousParameterRange) SetMinValue(v float64) *ContinuousParameterRange {
s.MinValue = &v
return s
}
// SetName sets the Name field's value.
func (s *ContinuousParameterRange) SetName(v string) *ContinuousParameterRange {
s.Name = &v
return s
}
// SetScalingType sets the ScalingType field's value.
func (s *ContinuousParameterRange) SetScalingType(v string) *ContinuousParameterRange {
s.ScalingType = &v
return s
}
type CreateAutoPredictorInput struct {
_ struct{} `type:"structure"`
// The data configuration for your dataset group and any additional datasets.
DataConfig *DataConfig `type:"structure"`
// 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 CreateDataset and CreatePredictor requests.
EncryptionConfig *EncryptionConfig `type:"structure"`
// Create an Explainability resource for the predictor.
ExplainPredictor *bool `type:"boolean"`
// 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 `min:"1" type:"list"`
// 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 `min:"1" type:"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 *int64 `type:"integer"`
// 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 `min:"1" type:"list"`
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html).
MonitorConfig *MonitorConfig `type:"structure"`
// The accuracy metric used to optimize the predictor.
OptimizationMetric *string `type:"string" enum:"OptimizationMetric"`
// A unique name for the predictor
//
// PredictorName is a required field
PredictorName *string `min:"1" type:"string" required:"true"`
// 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 `type:"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 []*Tag `type:"list"`
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary).
// If you don't provide a time boundary, Forecast uses a set of Default Time
// Boundaries (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries).
TimeAlignmentBoundary *TimeAlignmentBoundary `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateAutoPredictorInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateAutoPredictorInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateAutoPredictorInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateAutoPredictorInput"}
if s.ForecastDimensions != nil && len(s.ForecastDimensions) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ForecastDimensions", 1))
}
if s.ForecastFrequency != nil && len(*s.ForecastFrequency) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ForecastFrequency", 1))
}
if s.ForecastTypes != nil && len(s.ForecastTypes) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ForecastTypes", 1))
}
if s.PredictorName == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorName"))
}
if s.PredictorName != nil && len(*s.PredictorName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("PredictorName", 1))
}
if s.DataConfig != nil {
if err := s.DataConfig.Validate(); err != nil {
invalidParams.AddNested("DataConfig", err.(request.ErrInvalidParams))
}
}
if s.EncryptionConfig != nil {
if err := s.EncryptionConfig.Validate(); err != nil {
invalidParams.AddNested("EncryptionConfig", err.(request.ErrInvalidParams))
}
}
if s.MonitorConfig != nil {
if err := s.MonitorConfig.Validate(); err != nil {
invalidParams.AddNested("MonitorConfig", err.(request.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if s.TimeAlignmentBoundary != nil {
if err := s.TimeAlignmentBoundary.Validate(); err != nil {
invalidParams.AddNested("TimeAlignmentBoundary", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDataConfig sets the DataConfig field's value.
func (s *CreateAutoPredictorInput) SetDataConfig(v *DataConfig) *CreateAutoPredictorInput {
s.DataConfig = v
return s
}
// SetEncryptionConfig sets the EncryptionConfig field's value.
func (s *CreateAutoPredictorInput) SetEncryptionConfig(v *EncryptionConfig) *CreateAutoPredictorInput {
s.EncryptionConfig = v
return s
}
// SetExplainPredictor sets the ExplainPredictor field's value.
func (s *CreateAutoPredictorInput) SetExplainPredictor(v bool) *CreateAutoPredictorInput {
s.ExplainPredictor = &v
return s
}
// SetForecastDimensions sets the ForecastDimensions field's value.
func (s *CreateAutoPredictorInput) SetForecastDimensions(v []*string) *CreateAutoPredictorInput {
s.ForecastDimensions = v
return s
}
// SetForecastFrequency sets the ForecastFrequency field's value.
func (s *CreateAutoPredictorInput) SetForecastFrequency(v string) *CreateAutoPredictorInput {
s.ForecastFrequency = &v
return s
}
// SetForecastHorizon sets the ForecastHorizon field's value.
func (s *CreateAutoPredictorInput) SetForecastHorizon(v int64) *CreateAutoPredictorInput {
s.ForecastHorizon = &v
return s
}
// SetForecastTypes sets the ForecastTypes field's value.
func (s *CreateAutoPredictorInput) SetForecastTypes(v []*string) *CreateAutoPredictorInput {
s.ForecastTypes = v
return s
}
// SetMonitorConfig sets the MonitorConfig field's value.
func (s *CreateAutoPredictorInput) SetMonitorConfig(v *MonitorConfig) *CreateAutoPredictorInput {
s.MonitorConfig = v
return s
}
// SetOptimizationMetric sets the OptimizationMetric field's value.
func (s *CreateAutoPredictorInput) SetOptimizationMetric(v string) *CreateAutoPredictorInput {
s.OptimizationMetric = &v
return s
}
// SetPredictorName sets the PredictorName field's value.
func (s *CreateAutoPredictorInput) SetPredictorName(v string) *CreateAutoPredictorInput {
s.PredictorName = &v
return s
}
// SetReferencePredictorArn sets the ReferencePredictorArn field's value.
func (s *CreateAutoPredictorInput) SetReferencePredictorArn(v string) *CreateAutoPredictorInput {
s.ReferencePredictorArn = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateAutoPredictorInput) SetTags(v []*Tag) *CreateAutoPredictorInput {
s.Tags = v
return s
}
// SetTimeAlignmentBoundary sets the TimeAlignmentBoundary field's value.
func (s *CreateAutoPredictorInput) SetTimeAlignmentBoundary(v *TimeAlignmentBoundary) *CreateAutoPredictorInput {
s.TimeAlignmentBoundary = v
return s
}
type CreateAutoPredictorOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the predictor.
PredictorArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateAutoPredictorOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateAutoPredictorOutput) GoString() string {
return s.String()
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *CreateAutoPredictorOutput) SetPredictorArn(v string) *CreateAutoPredictorOutput {
s.PredictorArn = &v
return s
}
type CreateDatasetGroupInput struct {
_ struct{} `type:"structure"`
// An array of Amazon Resource Names (ARNs) of the datasets that you want to
// include in the dataset group.
DatasetArns []*string `type:"list"`
// A name for the dataset group.
//
// DatasetGroupName is a required field
DatasetGroupName *string `min:"1" type:"string" required:"true"`
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).
//
// Domain is a required field
Domain *string `type:"string" required:"true" enum:"Domain"`
// 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 []*Tag `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetGroupInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetGroupInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateDatasetGroupInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateDatasetGroupInput"}
if s.DatasetGroupName == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetGroupName"))
}
if s.DatasetGroupName != nil && len(*s.DatasetGroupName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("DatasetGroupName", 1))
}
if s.Domain == nil {
invalidParams.Add(request.NewErrParamRequired("Domain"))
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDatasetArns sets the DatasetArns field's value.
func (s *CreateDatasetGroupInput) SetDatasetArns(v []*string) *CreateDatasetGroupInput {
s.DatasetArns = v
return s
}
// SetDatasetGroupName sets the DatasetGroupName field's value.
func (s *CreateDatasetGroupInput) SetDatasetGroupName(v string) *CreateDatasetGroupInput {
s.DatasetGroupName = &v
return s
}
// SetDomain sets the Domain field's value.
func (s *CreateDatasetGroupInput) SetDomain(v string) *CreateDatasetGroupInput {
s.Domain = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateDatasetGroupInput) SetTags(v []*Tag) *CreateDatasetGroupInput {
s.Tags = v
return s
}
type CreateDatasetGroupOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset group.
DatasetGroupArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetGroupOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetGroupOutput) GoString() string {
return s.String()
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *CreateDatasetGroupOutput) SetDatasetGroupArn(v string) *CreateDatasetGroupOutput {
s.DatasetGroupArn = &v
return s
}
type CreateDatasetImportJobInput struct {
_ struct{} `type:"structure"`
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)
// operation.
//
// DataSource is a required field
DataSource *DataSource `type:"structure" required:"true"`
// The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want
// to import data to.
//
// DatasetArn is a required field
DatasetArn *string `type:"string" required:"true"`
// 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.
//
// DatasetImportJobName is a required field
DatasetImportJobName *string `min:"1" type:"string" required:"true"`
// The format of the imported data, CSV or PARQUET. The default value is CSV.
Format *string `type:"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 `type:"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 *string `type:"string" enum:"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 []*Tag `type:"list"`
// 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 (http://joda-time.sourceforge.net/timezones.html)
// for a complete list of valid time zone names.
TimeZone *string `type:"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 `type:"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 `type:"boolean"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetImportJobInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetImportJobInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateDatasetImportJobInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateDatasetImportJobInput"}
if s.DataSource == nil {
invalidParams.Add(request.NewErrParamRequired("DataSource"))
}
if s.DatasetArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetArn"))
}
if s.DatasetImportJobName == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetImportJobName"))
}
if s.DatasetImportJobName != nil && len(*s.DatasetImportJobName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("DatasetImportJobName", 1))
}
if s.DataSource != nil {
if err := s.DataSource.Validate(); err != nil {
invalidParams.AddNested("DataSource", err.(request.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDataSource sets the DataSource field's value.
func (s *CreateDatasetImportJobInput) SetDataSource(v *DataSource) *CreateDatasetImportJobInput {
s.DataSource = v
return s
}
// SetDatasetArn sets the DatasetArn field's value.
func (s *CreateDatasetImportJobInput) SetDatasetArn(v string) *CreateDatasetImportJobInput {
s.DatasetArn = &v
return s
}
// SetDatasetImportJobName sets the DatasetImportJobName field's value.
func (s *CreateDatasetImportJobInput) SetDatasetImportJobName(v string) *CreateDatasetImportJobInput {
s.DatasetImportJobName = &v
return s
}
// SetFormat sets the Format field's value.
func (s *CreateDatasetImportJobInput) SetFormat(v string) *CreateDatasetImportJobInput {
s.Format = &v
return s
}
// SetGeolocationFormat sets the GeolocationFormat field's value.
func (s *CreateDatasetImportJobInput) SetGeolocationFormat(v string) *CreateDatasetImportJobInput {
s.GeolocationFormat = &v
return s
}
// SetImportMode sets the ImportMode field's value.
func (s *CreateDatasetImportJobInput) SetImportMode(v string) *CreateDatasetImportJobInput {
s.ImportMode = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateDatasetImportJobInput) SetTags(v []*Tag) *CreateDatasetImportJobInput {
s.Tags = v
return s
}
// SetTimeZone sets the TimeZone field's value.
func (s *CreateDatasetImportJobInput) SetTimeZone(v string) *CreateDatasetImportJobInput {
s.TimeZone = &v
return s
}
// SetTimestampFormat sets the TimestampFormat field's value.
func (s *CreateDatasetImportJobInput) SetTimestampFormat(v string) *CreateDatasetImportJobInput {
s.TimestampFormat = &v
return s
}
// SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value.
func (s *CreateDatasetImportJobInput) SetUseGeolocationForTimeZone(v bool) *CreateDatasetImportJobInput {
s.UseGeolocationForTimeZone = &v
return s
}
type CreateDatasetImportJobOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset import job.
DatasetImportJobArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetImportJobOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetImportJobOutput) GoString() string {
return s.String()
}
// SetDatasetImportJobArn sets the DatasetImportJobArn field's value.
func (s *CreateDatasetImportJobOutput) SetDatasetImportJobArn(v string) *CreateDatasetImportJobOutput {
s.DatasetImportJobArn = &v
return s
}
type CreateDatasetInput struct {
_ struct{} `type:"structure"`
// 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 `min:"1" type:"string"`
// A name for the dataset.
//
// DatasetName is a required field
DatasetName *string `min:"1" type:"string" required:"true"`
// The dataset type. Valid values depend on the chosen Domain.
//
// DatasetType is a required field
DatasetType *string `type:"string" required:"true" enum:"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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html)
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).
//
// Domain is a required field
Domain *string `type:"string" required:"true" enum:"Domain"`
// An Key Management Service (KMS) key and the Identity and Access Management
// (IAM) role that Amazon Forecast can assume to access the key.
EncryptionConfig *EncryptionConfig `type:"structure"`
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html).
//
// Schema is a required field
Schema *Schema `type:"structure" required:"true"`
// 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 []*Tag `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateDatasetInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateDatasetInput"}
if s.DataFrequency != nil && len(*s.DataFrequency) < 1 {
invalidParams.Add(request.NewErrParamMinLen("DataFrequency", 1))
}
if s.DatasetName == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetName"))
}
if s.DatasetName != nil && len(*s.DatasetName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("DatasetName", 1))
}
if s.DatasetType == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetType"))
}
if s.Domain == nil {
invalidParams.Add(request.NewErrParamRequired("Domain"))
}
if s.Schema == nil {
invalidParams.Add(request.NewErrParamRequired("Schema"))
}
if s.EncryptionConfig != nil {
if err := s.EncryptionConfig.Validate(); err != nil {
invalidParams.AddNested("EncryptionConfig", err.(request.ErrInvalidParams))
}
}
if s.Schema != nil {
if err := s.Schema.Validate(); err != nil {
invalidParams.AddNested("Schema", err.(request.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDataFrequency sets the DataFrequency field's value.
func (s *CreateDatasetInput) SetDataFrequency(v string) *CreateDatasetInput {
s.DataFrequency = &v
return s
}
// SetDatasetName sets the DatasetName field's value.
func (s *CreateDatasetInput) SetDatasetName(v string) *CreateDatasetInput {
s.DatasetName = &v
return s
}
// SetDatasetType sets the DatasetType field's value.
func (s *CreateDatasetInput) SetDatasetType(v string) *CreateDatasetInput {
s.DatasetType = &v
return s
}
// SetDomain sets the Domain field's value.
func (s *CreateDatasetInput) SetDomain(v string) *CreateDatasetInput {
s.Domain = &v
return s
}
// SetEncryptionConfig sets the EncryptionConfig field's value.
func (s *CreateDatasetInput) SetEncryptionConfig(v *EncryptionConfig) *CreateDatasetInput {
s.EncryptionConfig = v
return s
}
// SetSchema sets the Schema field's value.
func (s *CreateDatasetInput) SetSchema(v *Schema) *CreateDatasetInput {
s.Schema = v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateDatasetInput) SetTags(v []*Tag) *CreateDatasetInput {
s.Tags = v
return s
}
type CreateDatasetOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateDatasetOutput) GoString() string {
return s.String()
}
// SetDatasetArn sets the DatasetArn field's value.
func (s *CreateDatasetOutput) SetDatasetArn(v string) *CreateDatasetOutput {
s.DatasetArn = &v
return s
}
type CreateExplainabilityExportInput struct {
_ struct{} `type:"structure"`
// 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 is a required field
Destination *DataDestination `type:"structure" required:"true"`
// The Amazon Resource Name (ARN) of the Explainability to export.
//
// ExplainabilityArn is a required field
ExplainabilityArn *string `type:"string" required:"true"`
// A unique name for the Explainability export.
//
// ExplainabilityExportName is a required field
ExplainabilityExportName *string `min:"1" type:"string" required:"true"`
// The format of the exported data, CSV or PARQUET.
Format *string `type:"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 []*Tag `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateExplainabilityExportInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateExplainabilityExportInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateExplainabilityExportInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateExplainabilityExportInput"}
if s.Destination == nil {
invalidParams.Add(request.NewErrParamRequired("Destination"))
}
if s.ExplainabilityArn == nil {
invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn"))
}
if s.ExplainabilityExportName == nil {
invalidParams.Add(request.NewErrParamRequired("ExplainabilityExportName"))
}
if s.ExplainabilityExportName != nil && len(*s.ExplainabilityExportName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ExplainabilityExportName", 1))
}
if s.Destination != nil {
if err := s.Destination.Validate(); err != nil {
invalidParams.AddNested("Destination", err.(request.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDestination sets the Destination field's value.
func (s *CreateExplainabilityExportInput) SetDestination(v *DataDestination) *CreateExplainabilityExportInput {
s.Destination = v
return s
}
// SetExplainabilityArn sets the ExplainabilityArn field's value.
func (s *CreateExplainabilityExportInput) SetExplainabilityArn(v string) *CreateExplainabilityExportInput {
s.ExplainabilityArn = &v
return s
}
// SetExplainabilityExportName sets the ExplainabilityExportName field's value.
func (s *CreateExplainabilityExportInput) SetExplainabilityExportName(v string) *CreateExplainabilityExportInput {
s.ExplainabilityExportName = &v
return s
}
// SetFormat sets the Format field's value.
func (s *CreateExplainabilityExportInput) SetFormat(v string) *CreateExplainabilityExportInput {
s.Format = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateExplainabilityExportInput) SetTags(v []*Tag) *CreateExplainabilityExportInput {
s.Tags = v
return s
}
type CreateExplainabilityExportOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the export.
ExplainabilityExportArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateExplainabilityExportOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateExplainabilityExportOutput) GoString() string {
return s.String()
}
// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.
func (s *CreateExplainabilityExportOutput) SetExplainabilityExportArn(v string) *CreateExplainabilityExportOutput {
s.ExplainabilityExportArn = &v
return s
}
type CreateExplainabilityInput struct {
_ struct{} `type:"structure"`
// 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 *DataSource `type:"structure"`
// Create an Explainability visualization that is viewable within the Amazon
// Web Services console.
EnableVisualization *bool `type:"boolean"`
// 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 `type:"string"`
// The configuration settings that define the granularity of time series and
// time points for the Explainability.
//
// ExplainabilityConfig is a required field
ExplainabilityConfig *ExplainabilityConfig `type:"structure" required:"true"`
// A unique name for the Explainability.
//
// ExplainabilityName is a required field
ExplainabilityName *string `min:"1" type:"string" required:"true"`
// The Amazon Resource Name (ARN) of the Predictor or Forecast used to create
// the Explainability.
//
// ResourceArn is a required field
ResourceArn *string `type:"string" required:"true"`
// Defines the fields of a dataset.
Schema *Schema `type:"structure"`
// 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 `type:"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 []*Tag `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateExplainabilityInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateExplainabilityInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateExplainabilityInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateExplainabilityInput"}
if s.ExplainabilityConfig == nil {
invalidParams.Add(request.NewErrParamRequired("ExplainabilityConfig"))
}
if s.ExplainabilityName == nil {
invalidParams.Add(request.NewErrParamRequired("ExplainabilityName"))
}
if s.ExplainabilityName != nil && len(*s.ExplainabilityName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ExplainabilityName", 1))
}
if s.ResourceArn == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
}
if s.DataSource != nil {
if err := s.DataSource.Validate(); err != nil {
invalidParams.AddNested("DataSource", err.(request.ErrInvalidParams))
}
}
if s.ExplainabilityConfig != nil {
if err := s.ExplainabilityConfig.Validate(); err != nil {
invalidParams.AddNested("ExplainabilityConfig", err.(request.ErrInvalidParams))
}
}
if s.Schema != nil {
if err := s.Schema.Validate(); err != nil {
invalidParams.AddNested("Schema", err.(request.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDataSource sets the DataSource field's value.
func (s *CreateExplainabilityInput) SetDataSource(v *DataSource) *CreateExplainabilityInput {
s.DataSource = v
return s
}
// SetEnableVisualization sets the EnableVisualization field's value.
func (s *CreateExplainabilityInput) SetEnableVisualization(v bool) *CreateExplainabilityInput {
s.EnableVisualization = &v
return s
}
// SetEndDateTime sets the EndDateTime field's value.
func (s *CreateExplainabilityInput) SetEndDateTime(v string) *CreateExplainabilityInput {
s.EndDateTime = &v
return s
}
// SetExplainabilityConfig sets the ExplainabilityConfig field's value.
func (s *CreateExplainabilityInput) SetExplainabilityConfig(v *ExplainabilityConfig) *CreateExplainabilityInput {
s.ExplainabilityConfig = v
return s
}
// SetExplainabilityName sets the ExplainabilityName field's value.
func (s *CreateExplainabilityInput) SetExplainabilityName(v string) *CreateExplainabilityInput {
s.ExplainabilityName = &v
return s
}
// SetResourceArn sets the ResourceArn field's value.
func (s *CreateExplainabilityInput) SetResourceArn(v string) *CreateExplainabilityInput {
s.ResourceArn = &v
return s
}
// SetSchema sets the Schema field's value.
func (s *CreateExplainabilityInput) SetSchema(v *Schema) *CreateExplainabilityInput {
s.Schema = v
return s
}
// SetStartDateTime sets the StartDateTime field's value.
func (s *CreateExplainabilityInput) SetStartDateTime(v string) *CreateExplainabilityInput {
s.StartDateTime = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateExplainabilityInput) SetTags(v []*Tag) *CreateExplainabilityInput {
s.Tags = v
return s
}
type CreateExplainabilityOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the Explainability.
ExplainabilityArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateExplainabilityOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateExplainabilityOutput) GoString() string {
return s.String()
}
// SetExplainabilityArn sets the ExplainabilityArn field's value.
func (s *CreateExplainabilityOutput) SetExplainabilityArn(v string) *CreateExplainabilityOutput {
s.ExplainabilityArn = &v
return s
}
type CreateForecastExportJobInput struct {
_ struct{} `type:"structure"`
// 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.
//
// Destination is a required field
Destination *DataDestination `type:"structure" required:"true"`
// The Amazon Resource Name (ARN) of the forecast that you want to export.
//
// ForecastArn is a required field
ForecastArn *string `type:"string" required:"true"`
// The name for the forecast export job.
//
// ForecastExportJobName is a required field
ForecastExportJobName *string `min:"1" type:"string" required:"true"`
// The format of the exported data, CSV or PARQUET. The default value is CSV.
Format *string `type:"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 []*Tag `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateForecastExportJobInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateForecastExportJobInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateForecastExportJobInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateForecastExportJobInput"}
if s.Destination == nil {
invalidParams.Add(request.NewErrParamRequired("Destination"))
}
if s.ForecastArn == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastArn"))
}
if s.ForecastExportJobName == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastExportJobName"))
}
if s.ForecastExportJobName != nil && len(*s.ForecastExportJobName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ForecastExportJobName", 1))
}
if s.Destination != nil {
if err := s.Destination.Validate(); err != nil {
invalidParams.AddNested("Destination", err.(request.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDestination sets the Destination field's value.
func (s *CreateForecastExportJobInput) SetDestination(v *DataDestination) *CreateForecastExportJobInput {
s.Destination = v
return s
}
// SetForecastArn sets the ForecastArn field's value.
func (s *CreateForecastExportJobInput) SetForecastArn(v string) *CreateForecastExportJobInput {
s.ForecastArn = &v
return s
}
// SetForecastExportJobName sets the ForecastExportJobName field's value.
func (s *CreateForecastExportJobInput) SetForecastExportJobName(v string) *CreateForecastExportJobInput {
s.ForecastExportJobName = &v
return s
}
// SetFormat sets the Format field's value.
func (s *CreateForecastExportJobInput) SetFormat(v string) *CreateForecastExportJobInput {
s.Format = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateForecastExportJobInput) SetTags(v []*Tag) *CreateForecastExportJobInput {
s.Tags = v
return s
}
type CreateForecastExportJobOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the export job.
ForecastExportJobArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateForecastExportJobOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateForecastExportJobOutput) GoString() string {
return s.String()
}
// SetForecastExportJobArn sets the ForecastExportJobArn field's value.
func (s *CreateForecastExportJobOutput) SetForecastExportJobArn(v string) *CreateForecastExportJobOutput {
s.ForecastExportJobArn = &v
return s
}
type CreateForecastInput struct {
_ struct{} `type:"structure"`
// A name for the forecast.
//
// ForecastName is a required field
ForecastName *string `min:"1" type:"string" required:"true"`
// 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 `min:"1" type:"list"`
// The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
//
// PredictorArn is a required field
PredictorArn *string `type:"string" required:"true"`
// 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 []*Tag `type:"list"`
// 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 *TimeSeriesSelector `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateForecastInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateForecastInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateForecastInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateForecastInput"}
if s.ForecastName == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastName"))
}
if s.ForecastName != nil && len(*s.ForecastName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ForecastName", 1))
}
if s.ForecastTypes != nil && len(s.ForecastTypes) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ForecastTypes", 1))
}
if s.PredictorArn == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorArn"))
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if s.TimeSeriesSelector != nil {
if err := s.TimeSeriesSelector.Validate(); err != nil {
invalidParams.AddNested("TimeSeriesSelector", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetForecastName sets the ForecastName field's value.
func (s *CreateForecastInput) SetForecastName(v string) *CreateForecastInput {
s.ForecastName = &v
return s
}
// SetForecastTypes sets the ForecastTypes field's value.
func (s *CreateForecastInput) SetForecastTypes(v []*string) *CreateForecastInput {
s.ForecastTypes = v
return s
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *CreateForecastInput) SetPredictorArn(v string) *CreateForecastInput {
s.PredictorArn = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateForecastInput) SetTags(v []*Tag) *CreateForecastInput {
s.Tags = v
return s
}
// SetTimeSeriesSelector sets the TimeSeriesSelector field's value.
func (s *CreateForecastInput) SetTimeSeriesSelector(v *TimeSeriesSelector) *CreateForecastInput {
s.TimeSeriesSelector = v
return s
}
type CreateForecastOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the forecast.
ForecastArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateForecastOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateForecastOutput) GoString() string {
return s.String()
}
// SetForecastArn sets the ForecastArn field's value.
func (s *CreateForecastOutput) SetForecastArn(v string) *CreateForecastOutput {
s.ForecastArn = &v
return s
}
type CreateMonitorInput struct {
_ struct{} `type:"structure"`
// The name of the monitor resource.
//
// MonitorName is a required field
MonitorName *string `min:"1" type:"string" required:"true"`
// The Amazon Resource Name (ARN) of the predictor to monitor.
//
// ResourceArn is a required field
ResourceArn *string `type:"string" required:"true"`
// A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)
// to apply to the monitor resource.
Tags []*Tag `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateMonitorInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateMonitorInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateMonitorInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateMonitorInput"}
if s.MonitorName == nil {
invalidParams.Add(request.NewErrParamRequired("MonitorName"))
}
if s.MonitorName != nil && len(*s.MonitorName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("MonitorName", 1))
}
if s.ResourceArn == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMonitorName sets the MonitorName field's value.
func (s *CreateMonitorInput) SetMonitorName(v string) *CreateMonitorInput {
s.MonitorName = &v
return s
}
// SetResourceArn sets the ResourceArn field's value.
func (s *CreateMonitorInput) SetResourceArn(v string) *CreateMonitorInput {
s.ResourceArn = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateMonitorInput) SetTags(v []*Tag) *CreateMonitorInput {
s.Tags = v
return s
}
type CreateMonitorOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the monitor resource.
MonitorArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateMonitorOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateMonitorOutput) GoString() string {
return s.String()
}
// SetMonitorArn sets the MonitorArn field's value.
func (s *CreateMonitorOutput) SetMonitorArn(v string) *CreateMonitorOutput {
s.MonitorArn = &v
return s
}
type CreatePredictorBacktestExportJobInput struct {
_ struct{} `type:"structure"`
// 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 is a required field
Destination *DataDestination `type:"structure" required:"true"`
// The format of the exported data, CSV or PARQUET. The default value is CSV.
Format *string `type:"string"`
// The Amazon Resource Name (ARN) of the predictor that you want to export.
//
// PredictorArn is a required field
PredictorArn *string `type:"string" required:"true"`
// The name for the backtest export job.
//
// PredictorBacktestExportJobName is a required field
PredictorBacktestExportJobName *string `min:"1" type:"string" required:"true"`
// 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 []*Tag `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreatePredictorBacktestExportJobInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreatePredictorBacktestExportJobInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreatePredictorBacktestExportJobInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreatePredictorBacktestExportJobInput"}
if s.Destination == nil {
invalidParams.Add(request.NewErrParamRequired("Destination"))
}
if s.PredictorArn == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorArn"))
}
if s.PredictorBacktestExportJobName == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorBacktestExportJobName"))
}
if s.PredictorBacktestExportJobName != nil && len(*s.PredictorBacktestExportJobName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("PredictorBacktestExportJobName", 1))
}
if s.Destination != nil {
if err := s.Destination.Validate(); err != nil {
invalidParams.AddNested("Destination", err.(request.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDestination sets the Destination field's value.
func (s *CreatePredictorBacktestExportJobInput) SetDestination(v *DataDestination) *CreatePredictorBacktestExportJobInput {
s.Destination = v
return s
}
// SetFormat sets the Format field's value.
func (s *CreatePredictorBacktestExportJobInput) SetFormat(v string) *CreatePredictorBacktestExportJobInput {
s.Format = &v
return s
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *CreatePredictorBacktestExportJobInput) SetPredictorArn(v string) *CreatePredictorBacktestExportJobInput {
s.PredictorArn = &v
return s
}
// SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value.
func (s *CreatePredictorBacktestExportJobInput) SetPredictorBacktestExportJobName(v string) *CreatePredictorBacktestExportJobInput {
s.PredictorBacktestExportJobName = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreatePredictorBacktestExportJobInput) SetTags(v []*Tag) *CreatePredictorBacktestExportJobInput {
s.Tags = v
return s
}
type CreatePredictorBacktestExportJobOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the predictor backtest export job that
// you want to export.
PredictorBacktestExportJobArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreatePredictorBacktestExportJobOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreatePredictorBacktestExportJobOutput) GoString() string {
return s.String()
}
// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.
func (s *CreatePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn(v string) *CreatePredictorBacktestExportJobOutput {
s.PredictorBacktestExportJobArn = &v
return s
}
type CreatePredictorInput struct {
_ struct{} `type:"structure"`
// 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 `type:"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 *string `type:"string" enum:"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 *EncryptionConfig `type:"structure"`
// 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 *EvaluationParameters `type:"structure"`
// The featurization configuration.
//
// FeaturizationConfig is a required field
FeaturizationConfig *FeaturizationConfig `type:"structure" required:"true"`
// 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.
//
// ForecastHorizon is a required field
ForecastHorizon *int64 `type:"integer" required:"true"`
// 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 `min:"1" type:"list"`
// 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 *HyperParameterTuningJobConfig `type:"structure"`
// Describes the dataset group that contains the data to use to train the predictor.
//
// InputDataConfig is a required field
InputDataConfig *InputDataConfig `type:"structure" required:"true"`
// The accuracy metric used to optimize the predictor.
OptimizationMetric *string `type:"string" enum:"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 `type:"boolean"`
// 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 HyperParameterTuningJobConfig object. 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 `type:"boolean"`
// A name for the predictor.
//
// PredictorName is a required field
PredictorName *string `min:"1" type:"string" required:"true"`
// 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 []*Tag `type:"list"`
// 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 `type:"map"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreatePredictorInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreatePredictorInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreatePredictorInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreatePredictorInput"}
if s.FeaturizationConfig == nil {
invalidParams.Add(request.NewErrParamRequired("FeaturizationConfig"))
}
if s.ForecastHorizon == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastHorizon"))
}
if s.ForecastTypes != nil && len(s.ForecastTypes) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ForecastTypes", 1))
}
if s.InputDataConfig == nil {
invalidParams.Add(request.NewErrParamRequired("InputDataConfig"))
}
if s.PredictorName == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorName"))
}
if s.PredictorName != nil && len(*s.PredictorName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("PredictorName", 1))
}
if s.EncryptionConfig != nil {
if err := s.EncryptionConfig.Validate(); err != nil {
invalidParams.AddNested("EncryptionConfig", err.(request.ErrInvalidParams))
}
}
if s.FeaturizationConfig != nil {
if err := s.FeaturizationConfig.Validate(); err != nil {
invalidParams.AddNested("FeaturizationConfig", err.(request.ErrInvalidParams))
}
}
if s.HPOConfig != nil {
if err := s.HPOConfig.Validate(); err != nil {
invalidParams.AddNested("HPOConfig", err.(request.ErrInvalidParams))
}
}
if s.InputDataConfig != nil {
if err := s.InputDataConfig.Validate(); err != nil {
invalidParams.AddNested("InputDataConfig", err.(request.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAlgorithmArn sets the AlgorithmArn field's value.
func (s *CreatePredictorInput) SetAlgorithmArn(v string) *CreatePredictorInput {
s.AlgorithmArn = &v
return s
}
// SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value.
func (s *CreatePredictorInput) SetAutoMLOverrideStrategy(v string) *CreatePredictorInput {
s.AutoMLOverrideStrategy = &v
return s
}
// SetEncryptionConfig sets the EncryptionConfig field's value.
func (s *CreatePredictorInput) SetEncryptionConfig(v *EncryptionConfig) *CreatePredictorInput {
s.EncryptionConfig = v
return s
}
// SetEvaluationParameters sets the EvaluationParameters field's value.
func (s *CreatePredictorInput) SetEvaluationParameters(v *EvaluationParameters) *CreatePredictorInput {
s.EvaluationParameters = v
return s
}
// SetFeaturizationConfig sets the FeaturizationConfig field's value.
func (s *CreatePredictorInput) SetFeaturizationConfig(v *FeaturizationConfig) *CreatePredictorInput {
s.FeaturizationConfig = v
return s
}
// SetForecastHorizon sets the ForecastHorizon field's value.
func (s *CreatePredictorInput) SetForecastHorizon(v int64) *CreatePredictorInput {
s.ForecastHorizon = &v
return s
}
// SetForecastTypes sets the ForecastTypes field's value.
func (s *CreatePredictorInput) SetForecastTypes(v []*string) *CreatePredictorInput {
s.ForecastTypes = v
return s
}
// SetHPOConfig sets the HPOConfig field's value.
func (s *CreatePredictorInput) SetHPOConfig(v *HyperParameterTuningJobConfig) *CreatePredictorInput {
s.HPOConfig = v
return s
}
// SetInputDataConfig sets the InputDataConfig field's value.
func (s *CreatePredictorInput) SetInputDataConfig(v *InputDataConfig) *CreatePredictorInput {
s.InputDataConfig = v
return s
}
// SetOptimizationMetric sets the OptimizationMetric field's value.
func (s *CreatePredictorInput) SetOptimizationMetric(v string) *CreatePredictorInput {
s.OptimizationMetric = &v
return s
}
// SetPerformAutoML sets the PerformAutoML field's value.
func (s *CreatePredictorInput) SetPerformAutoML(v bool) *CreatePredictorInput {
s.PerformAutoML = &v
return s
}
// SetPerformHPO sets the PerformHPO field's value.
func (s *CreatePredictorInput) SetPerformHPO(v bool) *CreatePredictorInput {
s.PerformHPO = &v
return s
}
// SetPredictorName sets the PredictorName field's value.
func (s *CreatePredictorInput) SetPredictorName(v string) *CreatePredictorInput {
s.PredictorName = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreatePredictorInput) SetTags(v []*Tag) *CreatePredictorInput {
s.Tags = v
return s
}
// SetTrainingParameters sets the TrainingParameters field's value.
func (s *CreatePredictorInput) SetTrainingParameters(v map[string]*string) *CreatePredictorInput {
s.TrainingParameters = v
return s
}
type CreatePredictorOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the predictor.
PredictorArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreatePredictorOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreatePredictorOutput) GoString() string {
return s.String()
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *CreatePredictorOutput) SetPredictorArn(v string) *CreatePredictorOutput {
s.PredictorArn = &v
return s
}
type CreateWhatIfAnalysisInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the baseline forecast.
//
// ForecastArn is a required field
ForecastArn *string `type:"string" required:"true"`
// A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)
// to apply to the what if forecast.
Tags []*Tag `type:"list"`
// 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 *TimeSeriesSelector `type:"structure"`
// The name of the what-if analysis. Each name must be unique.
//
// WhatIfAnalysisName is a required field
WhatIfAnalysisName *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfAnalysisInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfAnalysisInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateWhatIfAnalysisInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateWhatIfAnalysisInput"}
if s.ForecastArn == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastArn"))
}
if s.WhatIfAnalysisName == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfAnalysisName"))
}
if s.WhatIfAnalysisName != nil && len(*s.WhatIfAnalysisName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("WhatIfAnalysisName", 1))
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if s.TimeSeriesSelector != nil {
if err := s.TimeSeriesSelector.Validate(); err != nil {
invalidParams.AddNested("TimeSeriesSelector", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetForecastArn sets the ForecastArn field's value.
func (s *CreateWhatIfAnalysisInput) SetForecastArn(v string) *CreateWhatIfAnalysisInput {
s.ForecastArn = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateWhatIfAnalysisInput) SetTags(v []*Tag) *CreateWhatIfAnalysisInput {
s.Tags = v
return s
}
// SetTimeSeriesSelector sets the TimeSeriesSelector field's value.
func (s *CreateWhatIfAnalysisInput) SetTimeSeriesSelector(v *TimeSeriesSelector) *CreateWhatIfAnalysisInput {
s.TimeSeriesSelector = v
return s
}
// SetWhatIfAnalysisName sets the WhatIfAnalysisName field's value.
func (s *CreateWhatIfAnalysisInput) SetWhatIfAnalysisName(v string) *CreateWhatIfAnalysisInput {
s.WhatIfAnalysisName = &v
return s
}
type CreateWhatIfAnalysisOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if analysis.
WhatIfAnalysisArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfAnalysisOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfAnalysisOutput) GoString() string {
return s.String()
}
// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.
func (s *CreateWhatIfAnalysisOutput) SetWhatIfAnalysisArn(v string) *CreateWhatIfAnalysisOutput {
s.WhatIfAnalysisArn = &v
return s
}
type CreateWhatIfForecastExportInput struct {
_ struct{} `type:"structure"`
// 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.
//
// Destination is a required field
Destination *DataDestination `type:"structure" required:"true"`
// The format of the exported data, CSV or PARQUET.
Format *string `type:"string"`
// A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)
// to apply to the what if forecast.
Tags []*Tag `type:"list"`
// The list of what-if forecast Amazon Resource Names (ARNs) to export.
//
// WhatIfForecastArns is a required field
WhatIfForecastArns []*string `min:"1" type:"list" required:"true"`
// The name of the what-if forecast to export.
//
// WhatIfForecastExportName is a required field
WhatIfForecastExportName *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfForecastExportInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfForecastExportInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateWhatIfForecastExportInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateWhatIfForecastExportInput"}
if s.Destination == nil {
invalidParams.Add(request.NewErrParamRequired("Destination"))
}
if s.WhatIfForecastArns == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfForecastArns"))
}
if s.WhatIfForecastArns != nil && len(s.WhatIfForecastArns) < 1 {
invalidParams.Add(request.NewErrParamMinLen("WhatIfForecastArns", 1))
}
if s.WhatIfForecastExportName == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfForecastExportName"))
}
if s.WhatIfForecastExportName != nil && len(*s.WhatIfForecastExportName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("WhatIfForecastExportName", 1))
}
if s.Destination != nil {
if err := s.Destination.Validate(); err != nil {
invalidParams.AddNested("Destination", err.(request.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDestination sets the Destination field's value.
func (s *CreateWhatIfForecastExportInput) SetDestination(v *DataDestination) *CreateWhatIfForecastExportInput {
s.Destination = v
return s
}
// SetFormat sets the Format field's value.
func (s *CreateWhatIfForecastExportInput) SetFormat(v string) *CreateWhatIfForecastExportInput {
s.Format = &v
return s
}
// SetTags sets the Tags field's value.
func (s *CreateWhatIfForecastExportInput) SetTags(v []*Tag) *CreateWhatIfForecastExportInput {
s.Tags = v
return s
}
// SetWhatIfForecastArns sets the WhatIfForecastArns field's value.
func (s *CreateWhatIfForecastExportInput) SetWhatIfForecastArns(v []*string) *CreateWhatIfForecastExportInput {
s.WhatIfForecastArns = v
return s
}
// SetWhatIfForecastExportName sets the WhatIfForecastExportName field's value.
func (s *CreateWhatIfForecastExportInput) SetWhatIfForecastExportName(v string) *CreateWhatIfForecastExportInput {
s.WhatIfForecastExportName = &v
return s
}
type CreateWhatIfForecastExportOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if forecast.
WhatIfForecastExportArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfForecastExportOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfForecastExportOutput) GoString() string {
return s.String()
}
// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.
func (s *CreateWhatIfForecastExportOutput) SetWhatIfForecastExportArn(v string) *CreateWhatIfForecastExportOutput {
s.WhatIfForecastExportArn = &v
return s
}
type CreateWhatIfForecastInput struct {
_ struct{} `type:"structure"`
// A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html)
// to apply to the what if forecast.
Tags []*Tag `type:"list"`
// 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 *TimeSeriesReplacementsDataSource `type:"structure"`
// 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 []*TimeSeriesTransformation `type:"list"`
// The Amazon Resource Name (ARN) of the what-if analysis.
//
// WhatIfAnalysisArn is a required field
WhatIfAnalysisArn *string `type:"string" required:"true"`
// The name of the what-if forecast. Names must be unique within each what-if
// analysis.
//
// WhatIfForecastName is a required field
WhatIfForecastName *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfForecastInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfForecastInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateWhatIfForecastInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateWhatIfForecastInput"}
if s.WhatIfAnalysisArn == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfAnalysisArn"))
}
if s.WhatIfForecastName == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfForecastName"))
}
if s.WhatIfForecastName != nil && len(*s.WhatIfForecastName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("WhatIfForecastName", 1))
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if s.TimeSeriesReplacementsDataSource != nil {
if err := s.TimeSeriesReplacementsDataSource.Validate(); err != nil {
invalidParams.AddNested("TimeSeriesReplacementsDataSource", err.(request.ErrInvalidParams))
}
}
if s.TimeSeriesTransformations != nil {
for i, v := range s.TimeSeriesTransformations {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "TimeSeriesTransformations", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetTags sets the Tags field's value.
func (s *CreateWhatIfForecastInput) SetTags(v []*Tag) *CreateWhatIfForecastInput {
s.Tags = v
return s
}
// SetTimeSeriesReplacementsDataSource sets the TimeSeriesReplacementsDataSource field's value.
func (s *CreateWhatIfForecastInput) SetTimeSeriesReplacementsDataSource(v *TimeSeriesReplacementsDataSource) *CreateWhatIfForecastInput {
s.TimeSeriesReplacementsDataSource = v
return s
}
// SetTimeSeriesTransformations sets the TimeSeriesTransformations field's value.
func (s *CreateWhatIfForecastInput) SetTimeSeriesTransformations(v []*TimeSeriesTransformation) *CreateWhatIfForecastInput {
s.TimeSeriesTransformations = v
return s
}
// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.
func (s *CreateWhatIfForecastInput) SetWhatIfAnalysisArn(v string) *CreateWhatIfForecastInput {
s.WhatIfAnalysisArn = &v
return s
}
// SetWhatIfForecastName sets the WhatIfForecastName field's value.
func (s *CreateWhatIfForecastInput) SetWhatIfForecastName(v string) *CreateWhatIfForecastInput {
s.WhatIfForecastName = &v
return s
}
type CreateWhatIfForecastOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if forecast.
WhatIfForecastArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfForecastOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s CreateWhatIfForecastOutput) GoString() string {
return s.String()
}
// SetWhatIfForecastArn sets the WhatIfForecastArn field's value.
func (s *CreateWhatIfForecastOutput) SetWhatIfForecastArn(v string) *CreateWhatIfForecastOutput {
s.WhatIfForecastArn = &v
return s
}
// The data configuration for your dataset group and any additional datasets.
type DataConfig struct {
_ struct{} `type:"structure"`
// Additional built-in datasets like Holidays and the Weather Index.
AdditionalDatasets []*AdditionalDataset `min:"1" type:"list"`
// Aggregation and filling options for attributes in your dataset group.
AttributeConfigs []*AttributeConfig `min:"1" type:"list"`
// The ARN of the dataset group used to train the predictor.
//
// DatasetGroupArn is a required field
DatasetGroupArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DataConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DataConfig) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DataConfig) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DataConfig"}
if s.AdditionalDatasets != nil && len(s.AdditionalDatasets) < 1 {
invalidParams.Add(request.NewErrParamMinLen("AdditionalDatasets", 1))
}
if s.AttributeConfigs != nil && len(s.AttributeConfigs) < 1 {
invalidParams.Add(request.NewErrParamMinLen("AttributeConfigs", 1))
}
if s.DatasetGroupArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn"))
}
if s.AdditionalDatasets != nil {
for i, v := range s.AdditionalDatasets {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AdditionalDatasets", i), err.(request.ErrInvalidParams))
}
}
}
if s.AttributeConfigs != nil {
for i, v := range s.AttributeConfigs {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AttributeConfigs", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAdditionalDatasets sets the AdditionalDatasets field's value.
func (s *DataConfig) SetAdditionalDatasets(v []*AdditionalDataset) *DataConfig {
s.AdditionalDatasets = v
return s
}
// SetAttributeConfigs sets the AttributeConfigs field's value.
func (s *DataConfig) SetAttributeConfigs(v []*AttributeConfig) *DataConfig {
s.AttributeConfigs = v
return s
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *DataConfig) SetDatasetGroupArn(v string) *DataConfig {
s.DatasetGroupArn = &v
return s
}
// 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).
type DataDestination struct {
_ struct{} `type:"structure"`
// The path to an Amazon Simple Storage Service (Amazon S3) bucket along with
// the credentials to access the bucket.
//
// S3Config is a required field
S3Config *S3Config `type:"structure" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DataDestination) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DataDestination) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DataDestination) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DataDestination"}
if s.S3Config == nil {
invalidParams.Add(request.NewErrParamRequired("S3Config"))
}
if s.S3Config != nil {
if err := s.S3Config.Validate(); err != nil {
invalidParams.AddNested("S3Config", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetS3Config sets the S3Config field's value.
func (s *DataDestination) SetS3Config(v *S3Config) *DataDestination {
s.S3Config = v
return s
}
// 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.
type DataSource struct {
_ struct{} `type:"structure"`
// The path to the data stored in an Amazon Simple Storage Service (Amazon S3)
// bucket along with the credentials to access the data.
//
// S3Config is a required field
S3Config *S3Config `type:"structure" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DataSource) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DataSource) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DataSource) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DataSource"}
if s.S3Config == nil {
invalidParams.Add(request.NewErrParamRequired("S3Config"))
}
if s.S3Config != nil {
if err := s.S3Config.Validate(); err != nil {
invalidParams.AddNested("S3Config", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetS3Config sets the S3Config field's value.
func (s *DataSource) SetS3Config(v *S3Config) *DataSource {
s.S3Config = v
return s
}
// Provides a summary of the dataset group properties used in the ListDatasetGroups
// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html)
// operation. To get the complete set of properties, call the DescribeDatasetGroup
// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html)
// operation, and provide the DatasetGroupArn.
type DatasetGroupSummary struct {
_ struct{} `type:"structure"`
// When the dataset group was created.
CreationTime *time.Time `type:"timestamp"`
// The Amazon Resource Name (ARN) of the dataset group.
DatasetGroupArn *string `type:"string"`
// The name of the dataset group.
DatasetGroupName *string `min:"1" type:"string"`
// When the dataset group was created or last updated from a call to the UpdateDatasetGroup
// (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)
// operation. While the dataset group is being updated, LastModificationTime
// is the current time of the ListDatasetGroups call.
LastModificationTime *time.Time `type:"timestamp"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DatasetGroupSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DatasetGroupSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DatasetGroupSummary) SetCreationTime(v time.Time) *DatasetGroupSummary {
s.CreationTime = &v
return s
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *DatasetGroupSummary) SetDatasetGroupArn(v string) *DatasetGroupSummary {
s.DatasetGroupArn = &v
return s
}
// SetDatasetGroupName sets the DatasetGroupName field's value.
func (s *DatasetGroupSummary) SetDatasetGroupName(v string) *DatasetGroupSummary {
s.DatasetGroupName = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DatasetGroupSummary) SetLastModificationTime(v time.Time) *DatasetGroupSummary {
s.LastModificationTime = &v
return s
}
// Provides a summary of the dataset import job properties used in the ListDatasetImportJobs
// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html)
// operation. To get the complete set of properties, call the DescribeDatasetImportJob
// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html)
// operation, and provide the DatasetImportJobArn.
type DatasetImportJobSummary struct {
_ struct{} `type:"structure"`
// When the dataset import job was created.
CreationTime *time.Time `type:"timestamp"`
// 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 includes an Key Management Service (KMS)
// key.
DataSource *DataSource `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset import job.
DatasetImportJobArn *string `type:"string"`
// The name of the dataset import job.
DatasetImportJobName *string `min:"1" type:"string"`
// The import mode of the dataset import job, FULL or INCREMENTAL.
ImportMode *string `type:"string" enum:"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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DatasetImportJobSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DatasetImportJobSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DatasetImportJobSummary) SetCreationTime(v time.Time) *DatasetImportJobSummary {
s.CreationTime = &v
return s
}
// SetDataSource sets the DataSource field's value.
func (s *DatasetImportJobSummary) SetDataSource(v *DataSource) *DatasetImportJobSummary {
s.DataSource = v
return s
}
// SetDatasetImportJobArn sets the DatasetImportJobArn field's value.
func (s *DatasetImportJobSummary) SetDatasetImportJobArn(v string) *DatasetImportJobSummary {
s.DatasetImportJobArn = &v
return s
}
// SetDatasetImportJobName sets the DatasetImportJobName field's value.
func (s *DatasetImportJobSummary) SetDatasetImportJobName(v string) *DatasetImportJobSummary {
s.DatasetImportJobName = &v
return s
}
// SetImportMode sets the ImportMode field's value.
func (s *DatasetImportJobSummary) SetImportMode(v string) *DatasetImportJobSummary {
s.ImportMode = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DatasetImportJobSummary) SetLastModificationTime(v time.Time) *DatasetImportJobSummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DatasetImportJobSummary) SetMessage(v string) *DatasetImportJobSummary {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DatasetImportJobSummary) SetStatus(v string) *DatasetImportJobSummary {
s.Status = &v
return s
}
// Provides a summary of the dataset properties used in the ListDatasets (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html)
// operation. To get the complete set of properties, call the DescribeDataset
// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html)
// operation, and provide the DatasetArn.
type DatasetSummary struct {
_ struct{} `type:"structure"`
// When the dataset was created.
CreationTime *time.Time `type:"timestamp"`
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string `type:"string"`
// The name of the dataset.
DatasetName *string `min:"1" type:"string"`
// The dataset type.
DatasetType *string `type:"string" enum:"DatasetType"`
// The domain associated with the dataset.
Domain *string `type:"string" enum:"Domain"`
// 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 ListDatasets call. After a CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)
// operation has finished, LastModificationTime is when the import job completed
// or failed.
LastModificationTime *time.Time `type:"timestamp"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DatasetSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DatasetSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DatasetSummary) SetCreationTime(v time.Time) *DatasetSummary {
s.CreationTime = &v
return s
}
// SetDatasetArn sets the DatasetArn field's value.
func (s *DatasetSummary) SetDatasetArn(v string) *DatasetSummary {
s.DatasetArn = &v
return s
}
// SetDatasetName sets the DatasetName field's value.
func (s *DatasetSummary) SetDatasetName(v string) *DatasetSummary {
s.DatasetName = &v
return s
}
// SetDatasetType sets the DatasetType field's value.
func (s *DatasetSummary) SetDatasetType(v string) *DatasetSummary {
s.DatasetType = &v
return s
}
// SetDomain sets the Domain field's value.
func (s *DatasetSummary) SetDomain(v string) *DatasetSummary {
s.Domain = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DatasetSummary) SetLastModificationTime(v time.Time) *DatasetSummary {
s.LastModificationTime = &v
return s
}
type DeleteDatasetGroupInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset group to delete.
//
// DatasetGroupArn is a required field
DatasetGroupArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetGroupInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetGroupInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteDatasetGroupInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetGroupInput"}
if s.DatasetGroupArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *DeleteDatasetGroupInput) SetDatasetGroupArn(v string) *DeleteDatasetGroupInput {
s.DatasetGroupArn = &v
return s
}
type DeleteDatasetGroupOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetGroupOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetGroupOutput) GoString() string {
return s.String()
}
type DeleteDatasetImportJobInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset import job to delete.
//
// DatasetImportJobArn is a required field
DatasetImportJobArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetImportJobInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetImportJobInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteDatasetImportJobInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetImportJobInput"}
if s.DatasetImportJobArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetImportJobArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDatasetImportJobArn sets the DatasetImportJobArn field's value.
func (s *DeleteDatasetImportJobInput) SetDatasetImportJobArn(v string) *DeleteDatasetImportJobInput {
s.DatasetImportJobArn = &v
return s
}
type DeleteDatasetImportJobOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetImportJobOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetImportJobOutput) GoString() string {
return s.String()
}
type DeleteDatasetInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset to delete.
//
// DatasetArn is a required field
DatasetArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteDatasetInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetInput"}
if s.DatasetArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDatasetArn sets the DatasetArn field's value.
func (s *DeleteDatasetInput) SetDatasetArn(v string) *DeleteDatasetInput {
s.DatasetArn = &v
return s
}
type DeleteDatasetOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteDatasetOutput) GoString() string {
return s.String()
}
type DeleteExplainabilityExportInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the Explainability export to delete.
//
// ExplainabilityExportArn is a required field
ExplainabilityExportArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteExplainabilityExportInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteExplainabilityExportInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteExplainabilityExportInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteExplainabilityExportInput"}
if s.ExplainabilityExportArn == nil {
invalidParams.Add(request.NewErrParamRequired("ExplainabilityExportArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.
func (s *DeleteExplainabilityExportInput) SetExplainabilityExportArn(v string) *DeleteExplainabilityExportInput {
s.ExplainabilityExportArn = &v
return s
}
type DeleteExplainabilityExportOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteExplainabilityExportOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteExplainabilityExportOutput) GoString() string {
return s.String()
}
type DeleteExplainabilityInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the Explainability resource to delete.
//
// ExplainabilityArn is a required field
ExplainabilityArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteExplainabilityInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteExplainabilityInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteExplainabilityInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteExplainabilityInput"}
if s.ExplainabilityArn == nil {
invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetExplainabilityArn sets the ExplainabilityArn field's value.
func (s *DeleteExplainabilityInput) SetExplainabilityArn(v string) *DeleteExplainabilityInput {
s.ExplainabilityArn = &v
return s
}
type DeleteExplainabilityOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteExplainabilityOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteExplainabilityOutput) GoString() string {
return s.String()
}
type DeleteForecastExportJobInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the forecast export job to delete.
//
// ForecastExportJobArn is a required field
ForecastExportJobArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteForecastExportJobInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteForecastExportJobInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteForecastExportJobInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteForecastExportJobInput"}
if s.ForecastExportJobArn == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastExportJobArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetForecastExportJobArn sets the ForecastExportJobArn field's value.
func (s *DeleteForecastExportJobInput) SetForecastExportJobArn(v string) *DeleteForecastExportJobInput {
s.ForecastExportJobArn = &v
return s
}
type DeleteForecastExportJobOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteForecastExportJobOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteForecastExportJobOutput) GoString() string {
return s.String()
}
type DeleteForecastInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the forecast to delete.
//
// ForecastArn is a required field
ForecastArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteForecastInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteForecastInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteForecastInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteForecastInput"}
if s.ForecastArn == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetForecastArn sets the ForecastArn field's value.
func (s *DeleteForecastInput) SetForecastArn(v string) *DeleteForecastInput {
s.ForecastArn = &v
return s
}
type DeleteForecastOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteForecastOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteForecastOutput) GoString() string {
return s.String()
}
type DeleteMonitorInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the monitor resource to delete.
//
// MonitorArn is a required field
MonitorArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteMonitorInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteMonitorInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteMonitorInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteMonitorInput"}
if s.MonitorArn == nil {
invalidParams.Add(request.NewErrParamRequired("MonitorArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMonitorArn sets the MonitorArn field's value.
func (s *DeleteMonitorInput) SetMonitorArn(v string) *DeleteMonitorInput {
s.MonitorArn = &v
return s
}
type DeleteMonitorOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteMonitorOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteMonitorOutput) GoString() string {
return s.String()
}
type DeletePredictorBacktestExportJobInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the predictor backtest export job to delete.
//
// PredictorBacktestExportJobArn is a required field
PredictorBacktestExportJobArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeletePredictorBacktestExportJobInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeletePredictorBacktestExportJobInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeletePredictorBacktestExportJobInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeletePredictorBacktestExportJobInput"}
if s.PredictorBacktestExportJobArn == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorBacktestExportJobArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.
func (s *DeletePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn(v string) *DeletePredictorBacktestExportJobInput {
s.PredictorBacktestExportJobArn = &v
return s
}
type DeletePredictorBacktestExportJobOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeletePredictorBacktestExportJobOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeletePredictorBacktestExportJobOutput) GoString() string {
return s.String()
}
type DeletePredictorInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the predictor to delete.
//
// PredictorArn is a required field
PredictorArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeletePredictorInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeletePredictorInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeletePredictorInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeletePredictorInput"}
if s.PredictorArn == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *DeletePredictorInput) SetPredictorArn(v string) *DeletePredictorInput {
s.PredictorArn = &v
return s
}
type DeletePredictorOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeletePredictorOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeletePredictorOutput) GoString() string {
return s.String()
}
type DeleteResourceTreeInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the parent resource to delete. All child
// resources of the parent resource will also be deleted.
//
// ResourceArn is a required field
ResourceArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteResourceTreeInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteResourceTreeInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteResourceTreeInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteResourceTreeInput"}
if s.ResourceArn == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetResourceArn sets the ResourceArn field's value.
func (s *DeleteResourceTreeInput) SetResourceArn(v string) *DeleteResourceTreeInput {
s.ResourceArn = &v
return s
}
type DeleteResourceTreeOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteResourceTreeOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteResourceTreeOutput) GoString() string {
return s.String()
}
type DeleteWhatIfAnalysisInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if analysis that you want to delete.
//
// WhatIfAnalysisArn is a required field
WhatIfAnalysisArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfAnalysisInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfAnalysisInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteWhatIfAnalysisInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteWhatIfAnalysisInput"}
if s.WhatIfAnalysisArn == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfAnalysisArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.
func (s *DeleteWhatIfAnalysisInput) SetWhatIfAnalysisArn(v string) *DeleteWhatIfAnalysisInput {
s.WhatIfAnalysisArn = &v
return s
}
type DeleteWhatIfAnalysisOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfAnalysisOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfAnalysisOutput) GoString() string {
return s.String()
}
type DeleteWhatIfForecastExportInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if forecast export that you want
// to delete.
//
// WhatIfForecastExportArn is a required field
WhatIfForecastExportArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfForecastExportInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfForecastExportInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteWhatIfForecastExportInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteWhatIfForecastExportInput"}
if s.WhatIfForecastExportArn == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfForecastExportArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.
func (s *DeleteWhatIfForecastExportInput) SetWhatIfForecastExportArn(v string) *DeleteWhatIfForecastExportInput {
s.WhatIfForecastExportArn = &v
return s
}
type DeleteWhatIfForecastExportOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfForecastExportOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfForecastExportOutput) GoString() string {
return s.String()
}
type DeleteWhatIfForecastInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.
//
// WhatIfForecastArn is a required field
WhatIfForecastArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfForecastInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfForecastInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteWhatIfForecastInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteWhatIfForecastInput"}
if s.WhatIfForecastArn == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfForecastArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetWhatIfForecastArn sets the WhatIfForecastArn field's value.
func (s *DeleteWhatIfForecastInput) SetWhatIfForecastArn(v string) *DeleteWhatIfForecastInput {
s.WhatIfForecastArn = &v
return s
}
type DeleteWhatIfForecastOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfForecastOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DeleteWhatIfForecastOutput) GoString() string {
return s.String()
}
type DescribeAutoPredictorInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the predictor.
//
// PredictorArn is a required field
PredictorArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeAutoPredictorInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeAutoPredictorInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeAutoPredictorInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeAutoPredictorInput"}
if s.PredictorArn == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *DescribeAutoPredictorInput) SetPredictorArn(v string) *DescribeAutoPredictorInput {
s.PredictorArn = &v
return s
}
type DescribeAutoPredictorOutput struct {
_ struct{} `type:"structure"`
// The timestamp of the CreateAutoPredictor request.
CreationTime *time.Time `type:"timestamp"`
// The data configuration for your dataset group and any additional datasets.
DataConfig *DataConfig `type:"structure"`
// An array of the ARNs of the dataset import jobs used to import training data
// for the predictor.
DatasetImportJobArns []*string `type:"list"`
// 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 CreateDataset and CreatePredictor requests.
EncryptionConfig *EncryptionConfig `type:"structure"`
// The estimated time remaining in minutes for the predictor training job to
// complete.
EstimatedTimeRemainingInMinutes *int64 `type:"long"`
// Provides the status and ARN of the Predictor Explainability.
ExplainabilityInfo *ExplainabilityInfo `type:"structure"`
// An array of dimension (field) names that specify the attributes used to group
// your time series.
ForecastDimensions []*string `min:"1" type:"list"`
// 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 `min:"1" type:"string"`
// The number of time-steps that the model predicts. The forecast horizon is
// also called the prediction length.
ForecastHorizon *int64 `type:"integer"`
// The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
ForecastTypes []*string `min:"1" type:"list"`
// 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 `type:"timestamp"`
// In the event of an error, a message detailing the cause of the error.
Message *string `type:"string"`
// A object with the Amazon Resource Name (ARN) and status of the monitor resource.
MonitorInfo *MonitorInfo `type:"structure"`
// The accuracy metric used to optimize the predictor.
OptimizationMetric *string `type:"string" enum:"OptimizationMetric"`
// The Amazon Resource Name (ARN) of the predictor
PredictorArn *string `type:"string"`
// The name of the predictor.
PredictorName *string `min:"1" type:"string"`
// The ARN and state of the reference predictor. This parameter is only valid
// for retrained or upgraded predictors.
ReferencePredictorSummary *ReferencePredictorSummary `type:"structure"`
// 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 `type:"string"`
// The time boundary Forecast uses when aggregating data.
TimeAlignmentBoundary *TimeAlignmentBoundary `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeAutoPredictorOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeAutoPredictorOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeAutoPredictorOutput) SetCreationTime(v time.Time) *DescribeAutoPredictorOutput {
s.CreationTime = &v
return s
}
// SetDataConfig sets the DataConfig field's value.
func (s *DescribeAutoPredictorOutput) SetDataConfig(v *DataConfig) *DescribeAutoPredictorOutput {
s.DataConfig = v
return s
}
// SetDatasetImportJobArns sets the DatasetImportJobArns field's value.
func (s *DescribeAutoPredictorOutput) SetDatasetImportJobArns(v []*string) *DescribeAutoPredictorOutput {
s.DatasetImportJobArns = v
return s
}
// SetEncryptionConfig sets the EncryptionConfig field's value.
func (s *DescribeAutoPredictorOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribeAutoPredictorOutput {
s.EncryptionConfig = v
return s
}
// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.
func (s *DescribeAutoPredictorOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeAutoPredictorOutput {
s.EstimatedTimeRemainingInMinutes = &v
return s
}
// SetExplainabilityInfo sets the ExplainabilityInfo field's value.
func (s *DescribeAutoPredictorOutput) SetExplainabilityInfo(v *ExplainabilityInfo) *DescribeAutoPredictorOutput {
s.ExplainabilityInfo = v
return s
}
// SetForecastDimensions sets the ForecastDimensions field's value.
func (s *DescribeAutoPredictorOutput) SetForecastDimensions(v []*string) *DescribeAutoPredictorOutput {
s.ForecastDimensions = v
return s
}
// SetForecastFrequency sets the ForecastFrequency field's value.
func (s *DescribeAutoPredictorOutput) SetForecastFrequency(v string) *DescribeAutoPredictorOutput {
s.ForecastFrequency = &v
return s
}
// SetForecastHorizon sets the ForecastHorizon field's value.
func (s *DescribeAutoPredictorOutput) SetForecastHorizon(v int64) *DescribeAutoPredictorOutput {
s.ForecastHorizon = &v
return s
}
// SetForecastTypes sets the ForecastTypes field's value.
func (s *DescribeAutoPredictorOutput) SetForecastTypes(v []*string) *DescribeAutoPredictorOutput {
s.ForecastTypes = v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeAutoPredictorOutput) SetLastModificationTime(v time.Time) *DescribeAutoPredictorOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeAutoPredictorOutput) SetMessage(v string) *DescribeAutoPredictorOutput {
s.Message = &v
return s
}
// SetMonitorInfo sets the MonitorInfo field's value.
func (s *DescribeAutoPredictorOutput) SetMonitorInfo(v *MonitorInfo) *DescribeAutoPredictorOutput {
s.MonitorInfo = v
return s
}
// SetOptimizationMetric sets the OptimizationMetric field's value.
func (s *DescribeAutoPredictorOutput) SetOptimizationMetric(v string) *DescribeAutoPredictorOutput {
s.OptimizationMetric = &v
return s
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *DescribeAutoPredictorOutput) SetPredictorArn(v string) *DescribeAutoPredictorOutput {
s.PredictorArn = &v
return s
}
// SetPredictorName sets the PredictorName field's value.
func (s *DescribeAutoPredictorOutput) SetPredictorName(v string) *DescribeAutoPredictorOutput {
s.PredictorName = &v
return s
}
// SetReferencePredictorSummary sets the ReferencePredictorSummary field's value.
func (s *DescribeAutoPredictorOutput) SetReferencePredictorSummary(v *ReferencePredictorSummary) *DescribeAutoPredictorOutput {
s.ReferencePredictorSummary = v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeAutoPredictorOutput) SetStatus(v string) *DescribeAutoPredictorOutput {
s.Status = &v
return s
}
// SetTimeAlignmentBoundary sets the TimeAlignmentBoundary field's value.
func (s *DescribeAutoPredictorOutput) SetTimeAlignmentBoundary(v *TimeAlignmentBoundary) *DescribeAutoPredictorOutput {
s.TimeAlignmentBoundary = v
return s
}
type DescribeDatasetGroupInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset group.
//
// DatasetGroupArn is a required field
DatasetGroupArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetGroupInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetGroupInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeDatasetGroupInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetGroupInput"}
if s.DatasetGroupArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *DescribeDatasetGroupInput) SetDatasetGroupArn(v string) *DescribeDatasetGroupInput {
s.DatasetGroupArn = &v
return s
}
type DescribeDatasetGroupOutput struct {
_ struct{} `type:"structure"`
// When the dataset group was created.
CreationTime *time.Time `type:"timestamp"`
// An array of Amazon Resource Names (ARNs) of the datasets contained in the
// dataset group.
DatasetArns []*string `type:"list"`
// The ARN of the dataset group.
DatasetGroupArn *string `type:"string"`
// The name of the dataset group.
DatasetGroupName *string `min:"1" type:"string"`
// The domain associated with the dataset group.
Domain *string `type:"string" enum:"Domain"`
// When the dataset group was created or last updated from a call to the UpdateDatasetGroup
// (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)
// operation. While the dataset group is being updated, LastModificationTime
// is the current time of the DescribeDatasetGroup call.
LastModificationTime *time.Time `type:"timestamp"`
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)
// operation.
//
// The Status of the dataset group must be ACTIVE before you can use the dataset
// group to create a predictor.
Status *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetGroupOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetGroupOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeDatasetGroupOutput) SetCreationTime(v time.Time) *DescribeDatasetGroupOutput {
s.CreationTime = &v
return s
}
// SetDatasetArns sets the DatasetArns field's value.
func (s *DescribeDatasetGroupOutput) SetDatasetArns(v []*string) *DescribeDatasetGroupOutput {
s.DatasetArns = v
return s
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *DescribeDatasetGroupOutput) SetDatasetGroupArn(v string) *DescribeDatasetGroupOutput {
s.DatasetGroupArn = &v
return s
}
// SetDatasetGroupName sets the DatasetGroupName field's value.
func (s *DescribeDatasetGroupOutput) SetDatasetGroupName(v string) *DescribeDatasetGroupOutput {
s.DatasetGroupName = &v
return s
}
// SetDomain sets the Domain field's value.
func (s *DescribeDatasetGroupOutput) SetDomain(v string) *DescribeDatasetGroupOutput {
s.Domain = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeDatasetGroupOutput) SetLastModificationTime(v time.Time) *DescribeDatasetGroupOutput {
s.LastModificationTime = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeDatasetGroupOutput) SetStatus(v string) *DescribeDatasetGroupOutput {
s.Status = &v
return s
}
type DescribeDatasetImportJobInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset import job.
//
// DatasetImportJobArn is a required field
DatasetImportJobArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetImportJobInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetImportJobInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeDatasetImportJobInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetImportJobInput"}
if s.DatasetImportJobArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetImportJobArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDatasetImportJobArn sets the DatasetImportJobArn field's value.
func (s *DescribeDatasetImportJobInput) SetDatasetImportJobArn(v string) *DescribeDatasetImportJobInput {
s.DatasetImportJobArn = &v
return s
}
type DescribeDatasetImportJobOutput struct {
_ struct{} `type:"structure"`
// When the dataset import job was created.
CreationTime *time.Time `type:"timestamp"`
// The size of the dataset in gigabytes (GB) after the import job has finished.
DataSize *float64 `type:"double"`
// 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 *DataSource `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset that the training data was
// imported to.
DatasetArn *string `type:"string"`
// The ARN of the dataset import job.
DatasetImportJobArn *string `type:"string"`
// The name of the dataset import job.
DatasetImportJobName *string `min:"1" type:"string"`
// The estimated time remaining in minutes for the dataset import job to complete.
EstimatedTimeRemainingInMinutes *int64 `type:"long"`
// Statistical information about each field in the input data.
FieldStatistics map[string]*Statistics `type:"map"`
// The format of the imported data, CSV or PARQUET.
Format *string `type:"string"`
// The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".
GeolocationFormat *string `type:"string"`
// The import mode of the dataset import job, FULL or INCREMENTAL.
ImportMode *string `type:"string" enum:"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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"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 `type:"string"`
// The single time zone applied to every item in the dataset
TimeZone *string `type:"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 `type:"string"`
// Whether TimeZone is automatically derived from the geolocation attribute.
UseGeolocationForTimeZone *bool `type:"boolean"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetImportJobOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetImportJobOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeDatasetImportJobOutput) SetCreationTime(v time.Time) *DescribeDatasetImportJobOutput {
s.CreationTime = &v
return s
}
// SetDataSize sets the DataSize field's value.
func (s *DescribeDatasetImportJobOutput) SetDataSize(v float64) *DescribeDatasetImportJobOutput {
s.DataSize = &v
return s
}
// SetDataSource sets the DataSource field's value.
func (s *DescribeDatasetImportJobOutput) SetDataSource(v *DataSource) *DescribeDatasetImportJobOutput {
s.DataSource = v
return s
}
// SetDatasetArn sets the DatasetArn field's value.
func (s *DescribeDatasetImportJobOutput) SetDatasetArn(v string) *DescribeDatasetImportJobOutput {
s.DatasetArn = &v
return s
}
// SetDatasetImportJobArn sets the DatasetImportJobArn field's value.
func (s *DescribeDatasetImportJobOutput) SetDatasetImportJobArn(v string) *DescribeDatasetImportJobOutput {
s.DatasetImportJobArn = &v
return s
}
// SetDatasetImportJobName sets the DatasetImportJobName field's value.
func (s *DescribeDatasetImportJobOutput) SetDatasetImportJobName(v string) *DescribeDatasetImportJobOutput {
s.DatasetImportJobName = &v
return s
}
// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.
func (s *DescribeDatasetImportJobOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeDatasetImportJobOutput {
s.EstimatedTimeRemainingInMinutes = &v
return s
}
// SetFieldStatistics sets the FieldStatistics field's value.
func (s *DescribeDatasetImportJobOutput) SetFieldStatistics(v map[string]*Statistics) *DescribeDatasetImportJobOutput {
s.FieldStatistics = v
return s
}
// SetFormat sets the Format field's value.
func (s *DescribeDatasetImportJobOutput) SetFormat(v string) *DescribeDatasetImportJobOutput {
s.Format = &v
return s
}
// SetGeolocationFormat sets the GeolocationFormat field's value.
func (s *DescribeDatasetImportJobOutput) SetGeolocationFormat(v string) *DescribeDatasetImportJobOutput {
s.GeolocationFormat = &v
return s
}
// SetImportMode sets the ImportMode field's value.
func (s *DescribeDatasetImportJobOutput) SetImportMode(v string) *DescribeDatasetImportJobOutput {
s.ImportMode = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeDatasetImportJobOutput) SetLastModificationTime(v time.Time) *DescribeDatasetImportJobOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeDatasetImportJobOutput) SetMessage(v string) *DescribeDatasetImportJobOutput {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeDatasetImportJobOutput) SetStatus(v string) *DescribeDatasetImportJobOutput {
s.Status = &v
return s
}
// SetTimeZone sets the TimeZone field's value.
func (s *DescribeDatasetImportJobOutput) SetTimeZone(v string) *DescribeDatasetImportJobOutput {
s.TimeZone = &v
return s
}
// SetTimestampFormat sets the TimestampFormat field's value.
func (s *DescribeDatasetImportJobOutput) SetTimestampFormat(v string) *DescribeDatasetImportJobOutput {
s.TimestampFormat = &v
return s
}
// SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value.
func (s *DescribeDatasetImportJobOutput) SetUseGeolocationForTimeZone(v bool) *DescribeDatasetImportJobOutput {
s.UseGeolocationForTimeZone = &v
return s
}
type DescribeDatasetInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset.
//
// DatasetArn is a required field
DatasetArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeDatasetInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetInput"}
if s.DatasetArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDatasetArn sets the DatasetArn field's value.
func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput {
s.DatasetArn = &v
return s
}
type DescribeDatasetOutput struct {
_ struct{} `type:"structure"`
// When the dataset was created.
CreationTime *time.Time `type:"timestamp"`
// 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 `min:"1" type:"string"`
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string `type:"string"`
// The name of the dataset.
DatasetName *string `min:"1" type:"string"`
// The dataset type.
DatasetType *string `type:"string" enum:"DatasetType"`
// The domain associated with the dataset.
Domain *string `type:"string" enum:"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 *EncryptionConfig `type:"structure"`
// 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
// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)
// operation has finished, LastModificationTime is when the import job completed
// or failed.
LastModificationTime *time.Time `type:"timestamp"`
// An array of SchemaAttribute objects that specify the dataset fields. Each
// SchemaAttribute specifies the name and data type of a field.
Schema *Schema `type:"structure"`
// 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)
// 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.
Status *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeDatasetOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeDatasetOutput) SetCreationTime(v time.Time) *DescribeDatasetOutput {
s.CreationTime = &v
return s
}
// SetDataFrequency sets the DataFrequency field's value.
func (s *DescribeDatasetOutput) SetDataFrequency(v string) *DescribeDatasetOutput {
s.DataFrequency = &v
return s
}
// SetDatasetArn sets the DatasetArn field's value.
func (s *DescribeDatasetOutput) SetDatasetArn(v string) *DescribeDatasetOutput {
s.DatasetArn = &v
return s
}
// SetDatasetName sets the DatasetName field's value.
func (s *DescribeDatasetOutput) SetDatasetName(v string) *DescribeDatasetOutput {
s.DatasetName = &v
return s
}
// SetDatasetType sets the DatasetType field's value.
func (s *DescribeDatasetOutput) SetDatasetType(v string) *DescribeDatasetOutput {
s.DatasetType = &v
return s
}
// SetDomain sets the Domain field's value.
func (s *DescribeDatasetOutput) SetDomain(v string) *DescribeDatasetOutput {
s.Domain = &v
return s
}
// SetEncryptionConfig sets the EncryptionConfig field's value.
func (s *DescribeDatasetOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribeDatasetOutput {
s.EncryptionConfig = v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeDatasetOutput) SetLastModificationTime(v time.Time) *DescribeDatasetOutput {
s.LastModificationTime = &v
return s
}
// SetSchema sets the Schema field's value.
func (s *DescribeDatasetOutput) SetSchema(v *Schema) *DescribeDatasetOutput {
s.Schema = v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeDatasetOutput) SetStatus(v string) *DescribeDatasetOutput {
s.Status = &v
return s
}
type DescribeExplainabilityExportInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the Explainability export.
//
// ExplainabilityExportArn is a required field
ExplainabilityExportArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeExplainabilityExportInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeExplainabilityExportInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeExplainabilityExportInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeExplainabilityExportInput"}
if s.ExplainabilityExportArn == nil {
invalidParams.Add(request.NewErrParamRequired("ExplainabilityExportArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.
func (s *DescribeExplainabilityExportInput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportInput {
s.ExplainabilityExportArn = &v
return s
}
type DescribeExplainabilityExportOutput struct {
_ struct{} `type:"structure"`
// When the Explainability export was created.
CreationTime *time.Time `type:"timestamp"`
// 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 *DataDestination `type:"structure"`
// The Amazon Resource Name (ARN) of the Explainability export.
ExplainabilityArn *string `type:"string"`
// The Amazon Resource Name (ARN) of the Explainability export.
ExplainabilityExportArn *string `type:"string"`
// The name of the Explainability export.
ExplainabilityExportName *string `min:"1" type:"string"`
// The format of the exported data, CSV or PARQUET.
Format *string `type:"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 `type:"timestamp"`
// Information about any errors that occurred during the export.
Message *string `type:"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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeExplainabilityExportOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeExplainabilityExportOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeExplainabilityExportOutput) SetCreationTime(v time.Time) *DescribeExplainabilityExportOutput {
s.CreationTime = &v
return s
}
// SetDestination sets the Destination field's value.
func (s *DescribeExplainabilityExportOutput) SetDestination(v *DataDestination) *DescribeExplainabilityExportOutput {
s.Destination = v
return s
}
// SetExplainabilityArn sets the ExplainabilityArn field's value.
func (s *DescribeExplainabilityExportOutput) SetExplainabilityArn(v string) *DescribeExplainabilityExportOutput {
s.ExplainabilityArn = &v
return s
}
// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.
func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportOutput {
s.ExplainabilityExportArn = &v
return s
}
// SetExplainabilityExportName sets the ExplainabilityExportName field's value.
func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportName(v string) *DescribeExplainabilityExportOutput {
s.ExplainabilityExportName = &v
return s
}
// SetFormat sets the Format field's value.
func (s *DescribeExplainabilityExportOutput) SetFormat(v string) *DescribeExplainabilityExportOutput {
s.Format = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeExplainabilityExportOutput) SetLastModificationTime(v time.Time) *DescribeExplainabilityExportOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeExplainabilityExportOutput) SetMessage(v string) *DescribeExplainabilityExportOutput {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeExplainabilityExportOutput) SetStatus(v string) *DescribeExplainabilityExportOutput {
s.Status = &v
return s
}
type DescribeExplainabilityInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the Explaianability to describe.
//
// ExplainabilityArn is a required field
ExplainabilityArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeExplainabilityInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeExplainabilityInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeExplainabilityInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeExplainabilityInput"}
if s.ExplainabilityArn == nil {
invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetExplainabilityArn sets the ExplainabilityArn field's value.
func (s *DescribeExplainabilityInput) SetExplainabilityArn(v string) *DescribeExplainabilityInput {
s.ExplainabilityArn = &v
return s
}
type DescribeExplainabilityOutput struct {
_ struct{} `type:"structure"`
// When the Explainability resource was created.
CreationTime *time.Time `type:"timestamp"`
// 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 *DataSource `type:"structure"`
// Whether the visualization was enabled for the Explainability resource.
EnableVisualization *bool `type:"boolean"`
// If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
EndDateTime *string `type:"string"`
// The estimated time remaining in minutes for the CreateExplainability job
// to complete.
EstimatedTimeRemainingInMinutes *int64 `type:"long"`
// The Amazon Resource Name (ARN) of the Explainability.
ExplainabilityArn *string `type:"string"`
// The configuration settings that define the granularity of time series and
// time points for the Explainability.
ExplainabilityConfig *ExplainabilityConfig `type:"structure"`
// The name of the Explainability.
ExplainabilityName *string `min:"1" type:"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 `type:"timestamp"`
// If an error occurred, a message about the error.
Message *string `type:"string"`
// The Amazon Resource Name (ARN) of the Predictor or Forecast used to create
// the Explainability resource.
ResourceArn *string `type:"string"`
// Defines the fields of a dataset.
Schema *Schema `type:"structure"`
// If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
StartDateTime *string `type:"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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeExplainabilityOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeExplainabilityOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeExplainabilityOutput) SetCreationTime(v time.Time) *DescribeExplainabilityOutput {
s.CreationTime = &v
return s
}
// SetDataSource sets the DataSource field's value.
func (s *DescribeExplainabilityOutput) SetDataSource(v *DataSource) *DescribeExplainabilityOutput {
s.DataSource = v
return s
}
// SetEnableVisualization sets the EnableVisualization field's value.
func (s *DescribeExplainabilityOutput) SetEnableVisualization(v bool) *DescribeExplainabilityOutput {
s.EnableVisualization = &v
return s
}
// SetEndDateTime sets the EndDateTime field's value.
func (s *DescribeExplainabilityOutput) SetEndDateTime(v string) *DescribeExplainabilityOutput {
s.EndDateTime = &v
return s
}
// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.
func (s *DescribeExplainabilityOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeExplainabilityOutput {
s.EstimatedTimeRemainingInMinutes = &v
return s
}
// SetExplainabilityArn sets the ExplainabilityArn field's value.
func (s *DescribeExplainabilityOutput) SetExplainabilityArn(v string) *DescribeExplainabilityOutput {
s.ExplainabilityArn = &v
return s
}
// SetExplainabilityConfig sets the ExplainabilityConfig field's value.
func (s *DescribeExplainabilityOutput) SetExplainabilityConfig(v *ExplainabilityConfig) *DescribeExplainabilityOutput {
s.ExplainabilityConfig = v
return s
}
// SetExplainabilityName sets the ExplainabilityName field's value.
func (s *DescribeExplainabilityOutput) SetExplainabilityName(v string) *DescribeExplainabilityOutput {
s.ExplainabilityName = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeExplainabilityOutput) SetLastModificationTime(v time.Time) *DescribeExplainabilityOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeExplainabilityOutput) SetMessage(v string) *DescribeExplainabilityOutput {
s.Message = &v
return s
}
// SetResourceArn sets the ResourceArn field's value.
func (s *DescribeExplainabilityOutput) SetResourceArn(v string) *DescribeExplainabilityOutput {
s.ResourceArn = &v
return s
}
// SetSchema sets the Schema field's value.
func (s *DescribeExplainabilityOutput) SetSchema(v *Schema) *DescribeExplainabilityOutput {
s.Schema = v
return s
}
// SetStartDateTime sets the StartDateTime field's value.
func (s *DescribeExplainabilityOutput) SetStartDateTime(v string) *DescribeExplainabilityOutput {
s.StartDateTime = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeExplainabilityOutput) SetStatus(v string) *DescribeExplainabilityOutput {
s.Status = &v
return s
}
type DescribeForecastExportJobInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the forecast export job.
//
// ForecastExportJobArn is a required field
ForecastExportJobArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeForecastExportJobInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeForecastExportJobInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeForecastExportJobInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeForecastExportJobInput"}
if s.ForecastExportJobArn == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastExportJobArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetForecastExportJobArn sets the ForecastExportJobArn field's value.
func (s *DescribeForecastExportJobInput) SetForecastExportJobArn(v string) *DescribeForecastExportJobInput {
s.ForecastExportJobArn = &v
return s
}
type DescribeForecastExportJobOutput struct {
_ struct{} `type:"structure"`
// When the forecast export job was created.
CreationTime *time.Time `type:"timestamp"`
// The path to the Amazon Simple Storage Service (Amazon S3) bucket where the
// forecast is exported.
Destination *DataDestination `type:"structure"`
// The Amazon Resource Name (ARN) of the exported forecast.
ForecastArn *string `type:"string"`
// The ARN of the forecast export job.
ForecastExportJobArn *string `type:"string"`
// The name of the forecast export job.
ForecastExportJobName *string `min:"1" type:"string"`
// The format of the exported data, CSV or PARQUET.
Format *string `type:"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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeForecastExportJobOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeForecastExportJobOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeForecastExportJobOutput) SetCreationTime(v time.Time) *DescribeForecastExportJobOutput {
s.CreationTime = &v
return s
}
// SetDestination sets the Destination field's value.
func (s *DescribeForecastExportJobOutput) SetDestination(v *DataDestination) *DescribeForecastExportJobOutput {
s.Destination = v
return s
}
// SetForecastArn sets the ForecastArn field's value.
func (s *DescribeForecastExportJobOutput) SetForecastArn(v string) *DescribeForecastExportJobOutput {
s.ForecastArn = &v
return s
}
// SetForecastExportJobArn sets the ForecastExportJobArn field's value.
func (s *DescribeForecastExportJobOutput) SetForecastExportJobArn(v string) *DescribeForecastExportJobOutput {
s.ForecastExportJobArn = &v
return s
}
// SetForecastExportJobName sets the ForecastExportJobName field's value.
func (s *DescribeForecastExportJobOutput) SetForecastExportJobName(v string) *DescribeForecastExportJobOutput {
s.ForecastExportJobName = &v
return s
}
// SetFormat sets the Format field's value.
func (s *DescribeForecastExportJobOutput) SetFormat(v string) *DescribeForecastExportJobOutput {
s.Format = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeForecastExportJobOutput) SetLastModificationTime(v time.Time) *DescribeForecastExportJobOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeForecastExportJobOutput) SetMessage(v string) *DescribeForecastExportJobOutput {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeForecastExportJobOutput) SetStatus(v string) *DescribeForecastExportJobOutput {
s.Status = &v
return s
}
type DescribeForecastInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the forecast.
//
// ForecastArn is a required field
ForecastArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeForecastInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeForecastInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeForecastInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeForecastInput"}
if s.ForecastArn == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetForecastArn sets the ForecastArn field's value.
func (s *DescribeForecastInput) SetForecastArn(v string) *DescribeForecastInput {
s.ForecastArn = &v
return s
}
type DescribeForecastOutput struct {
_ struct{} `type:"structure"`
// When the forecast creation task was created.
CreationTime *time.Time `type:"timestamp"`
// The ARN of the dataset group that provided the data used to train the predictor.
DatasetGroupArn *string `type:"string"`
// The estimated time remaining in minutes for the forecast job to complete.
EstimatedTimeRemainingInMinutes *int64 `type:"long"`
// The forecast ARN as specified in the request.
ForecastArn *string `type:"string"`
// The name of the forecast.
ForecastName *string `min:"1" type:"string"`
// The quantiles at which probabilistic forecasts were generated.
ForecastTypes []*string `min:"1" type:"list"`
// 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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"string"`
// The ARN of the predictor used to generate the forecast.
PredictorArn *string `type:"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 `type:"string"`
// The time series to include in the forecast.
TimeSeriesSelector *TimeSeriesSelector `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeForecastOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeForecastOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeForecastOutput) SetCreationTime(v time.Time) *DescribeForecastOutput {
s.CreationTime = &v
return s
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *DescribeForecastOutput) SetDatasetGroupArn(v string) *DescribeForecastOutput {
s.DatasetGroupArn = &v
return s
}
// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.
func (s *DescribeForecastOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeForecastOutput {
s.EstimatedTimeRemainingInMinutes = &v
return s
}
// SetForecastArn sets the ForecastArn field's value.
func (s *DescribeForecastOutput) SetForecastArn(v string) *DescribeForecastOutput {
s.ForecastArn = &v
return s
}
// SetForecastName sets the ForecastName field's value.
func (s *DescribeForecastOutput) SetForecastName(v string) *DescribeForecastOutput {
s.ForecastName = &v
return s
}
// SetForecastTypes sets the ForecastTypes field's value.
func (s *DescribeForecastOutput) SetForecastTypes(v []*string) *DescribeForecastOutput {
s.ForecastTypes = v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeForecastOutput) SetLastModificationTime(v time.Time) *DescribeForecastOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeForecastOutput) SetMessage(v string) *DescribeForecastOutput {
s.Message = &v
return s
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *DescribeForecastOutput) SetPredictorArn(v string) *DescribeForecastOutput {
s.PredictorArn = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeForecastOutput) SetStatus(v string) *DescribeForecastOutput {
s.Status = &v
return s
}
// SetTimeSeriesSelector sets the TimeSeriesSelector field's value.
func (s *DescribeForecastOutput) SetTimeSeriesSelector(v *TimeSeriesSelector) *DescribeForecastOutput {
s.TimeSeriesSelector = v
return s
}
type DescribeMonitorInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the monitor resource to describe.
//
// MonitorArn is a required field
MonitorArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeMonitorInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeMonitorInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeMonitorInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeMonitorInput"}
if s.MonitorArn == nil {
invalidParams.Add(request.NewErrParamRequired("MonitorArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMonitorArn sets the MonitorArn field's value.
func (s *DescribeMonitorInput) SetMonitorArn(v string) *DescribeMonitorInput {
s.MonitorArn = &v
return s
}
type DescribeMonitorOutput struct {
_ struct{} `type:"structure"`
// Metrics you can use as a baseline for comparison purposes. Use these values
// you interpret monitoring results for an auto predictor.
Baseline *Baseline `type:"structure"`
// The timestamp for when the monitor resource was created.
CreationTime *time.Time `type:"timestamp"`
// The estimated number of minutes remaining before the monitor resource finishes
// its current evaluation.
EstimatedEvaluationTimeRemainingInMinutes *int64 `type:"long"`
// The state of the monitor's latest evaluation.
LastEvaluationState *string `type:"string"`
// The timestamp of the latest evaluation completed by the monitor.
LastEvaluationTime *time.Time `type:"timestamp"`
// The timestamp of the latest modification to the monitor.
LastModificationTime *time.Time `type:"timestamp"`
// An error message, if any, for the monitor.
Message *string `type:"string"`
// The Amazon Resource Name (ARN) of the monitor resource described.
MonitorArn *string `type:"string"`
// The name of the monitor.
MonitorName *string `min:"1" type:"string"`
// The Amazon Resource Name (ARN) of the auto predictor being monitored.
ResourceArn *string `type:"string"`
// The status of the monitor resource.
Status *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeMonitorOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeMonitorOutput) GoString() string {
return s.String()
}
// SetBaseline sets the Baseline field's value.
func (s *DescribeMonitorOutput) SetBaseline(v *Baseline) *DescribeMonitorOutput {
s.Baseline = v
return s
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeMonitorOutput) SetCreationTime(v time.Time) *DescribeMonitorOutput {
s.CreationTime = &v
return s
}
// SetEstimatedEvaluationTimeRemainingInMinutes sets the EstimatedEvaluationTimeRemainingInMinutes field's value.
func (s *DescribeMonitorOutput) SetEstimatedEvaluationTimeRemainingInMinutes(v int64) *DescribeMonitorOutput {
s.EstimatedEvaluationTimeRemainingInMinutes = &v
return s
}
// SetLastEvaluationState sets the LastEvaluationState field's value.
func (s *DescribeMonitorOutput) SetLastEvaluationState(v string) *DescribeMonitorOutput {
s.LastEvaluationState = &v
return s
}
// SetLastEvaluationTime sets the LastEvaluationTime field's value.
func (s *DescribeMonitorOutput) SetLastEvaluationTime(v time.Time) *DescribeMonitorOutput {
s.LastEvaluationTime = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeMonitorOutput) SetLastModificationTime(v time.Time) *DescribeMonitorOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeMonitorOutput) SetMessage(v string) *DescribeMonitorOutput {
s.Message = &v
return s
}
// SetMonitorArn sets the MonitorArn field's value.
func (s *DescribeMonitorOutput) SetMonitorArn(v string) *DescribeMonitorOutput {
s.MonitorArn = &v
return s
}
// SetMonitorName sets the MonitorName field's value.
func (s *DescribeMonitorOutput) SetMonitorName(v string) *DescribeMonitorOutput {
s.MonitorName = &v
return s
}
// SetResourceArn sets the ResourceArn field's value.
func (s *DescribeMonitorOutput) SetResourceArn(v string) *DescribeMonitorOutput {
s.ResourceArn = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeMonitorOutput) SetStatus(v string) *DescribeMonitorOutput {
s.Status = &v
return s
}
type DescribePredictorBacktestExportJobInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the predictor backtest export job.
//
// PredictorBacktestExportJobArn is a required field
PredictorBacktestExportJobArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribePredictorBacktestExportJobInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribePredictorBacktestExportJobInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribePredictorBacktestExportJobInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribePredictorBacktestExportJobInput"}
if s.PredictorBacktestExportJobArn == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorBacktestExportJobArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.
func (s *DescribePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn(v string) *DescribePredictorBacktestExportJobInput {
s.PredictorBacktestExportJobArn = &v
return s
}
type DescribePredictorBacktestExportJobOutput struct {
_ struct{} `type:"structure"`
// When the predictor backtest export job was created.
CreationTime *time.Time `type:"timestamp"`
// 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 *DataDestination `type:"structure"`
// The format of the exported data, CSV or PARQUET.
Format *string `type:"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 `type:"timestamp"`
// Information about any errors that may have occurred during the backtest export.
Message *string `type:"string"`
// The Amazon Resource Name (ARN) of the predictor.
PredictorArn *string `type:"string"`
// The Amazon Resource Name (ARN) of the predictor backtest export job.
PredictorBacktestExportJobArn *string `type:"string"`
// The name of the predictor backtest export job.
PredictorBacktestExportJobName *string `min:"1" type:"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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribePredictorBacktestExportJobOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribePredictorBacktestExportJobOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribePredictorBacktestExportJobOutput) SetCreationTime(v time.Time) *DescribePredictorBacktestExportJobOutput {
s.CreationTime = &v
return s
}
// SetDestination sets the Destination field's value.
func (s *DescribePredictorBacktestExportJobOutput) SetDestination(v *DataDestination) *DescribePredictorBacktestExportJobOutput {
s.Destination = v
return s
}
// SetFormat sets the Format field's value.
func (s *DescribePredictorBacktestExportJobOutput) SetFormat(v string) *DescribePredictorBacktestExportJobOutput {
s.Format = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribePredictorBacktestExportJobOutput) SetLastModificationTime(v time.Time) *DescribePredictorBacktestExportJobOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribePredictorBacktestExportJobOutput) SetMessage(v string) *DescribePredictorBacktestExportJobOutput {
s.Message = &v
return s
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *DescribePredictorBacktestExportJobOutput) SetPredictorArn(v string) *DescribePredictorBacktestExportJobOutput {
s.PredictorArn = &v
return s
}
// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.
func (s *DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn(v string) *DescribePredictorBacktestExportJobOutput {
s.PredictorBacktestExportJobArn = &v
return s
}
// SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value.
func (s *DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobName(v string) *DescribePredictorBacktestExportJobOutput {
s.PredictorBacktestExportJobName = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribePredictorBacktestExportJobOutput) SetStatus(v string) *DescribePredictorBacktestExportJobOutput {
s.Status = &v
return s
}
type DescribePredictorInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the predictor that you want information
// about.
//
// PredictorArn is a required field
PredictorArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribePredictorInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribePredictorInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribePredictorInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribePredictorInput"}
if s.PredictorArn == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *DescribePredictorInput) SetPredictorArn(v string) *DescribePredictorInput {
s.PredictorArn = &v
return s
}
type DescribePredictorOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the algorithm used for model training.
AlgorithmArn *string `type:"string"`
// When PerformAutoML is specified, the ARN of the chosen algorithm.
AutoMLAlgorithmArns []*string `type:"list"`
//
// 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 *string `type:"string" enum:"AutoMLOverrideStrategy"`
// When the model training task was created.
CreationTime *time.Time `type:"timestamp"`
// An array of the ARNs of the dataset import jobs used to import training data
// for the predictor.
DatasetImportJobArns []*string `type:"list"`
// An Key Management Service (KMS) key and the Identity and Access Management
// (IAM) role that Amazon Forecast can assume to access the key.
EncryptionConfig *EncryptionConfig `type:"structure"`
// The estimated time remaining in minutes for the predictor training job to
// complete.
EstimatedTimeRemainingInMinutes *int64 `type:"long"`
// 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 *EvaluationParameters `type:"structure"`
// The featurization configuration.
FeaturizationConfig *FeaturizationConfig `type:"structure"`
// The number of time-steps of the forecast. The forecast horizon is also called
// the prediction length.
ForecastHorizon *int64 `type:"integer"`
// The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]
ForecastTypes []*string `min:"1" type:"list"`
// The hyperparameter override values for the algorithm.
HPOConfig *HyperParameterTuningJobConfig `type:"structure"`
// Describes the dataset group that contains the data to use to train the predictor.
InputDataConfig *InputDataConfig `type:"structure"`
// Whether the predictor was created with CreateAutoPredictor.
IsAutoPredictor *bool `type:"boolean"`
// 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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"string"`
// The accuracy metric used to optimize the predictor.
OptimizationMetric *string `type:"string" enum:"OptimizationMetric"`
// Whether the predictor is set to perform AutoML.
PerformAutoML *bool `type:"boolean"`
// Whether the predictor is set to perform hyperparameter optimization (HPO).
PerformHPO *bool `type:"boolean"`
// The ARN of the predictor.
PredictorArn *string `min:"1" type:"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 *PredictorExecutionDetails `type:"structure"`
// The name of the predictor.
PredictorName *string `min:"1" type:"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 `type:"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 `type:"map"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribePredictorOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribePredictorOutput) GoString() string {
return s.String()
}
// SetAlgorithmArn sets the AlgorithmArn field's value.
func (s *DescribePredictorOutput) SetAlgorithmArn(v string) *DescribePredictorOutput {
s.AlgorithmArn = &v
return s
}
// SetAutoMLAlgorithmArns sets the AutoMLAlgorithmArns field's value.
func (s *DescribePredictorOutput) SetAutoMLAlgorithmArns(v []*string) *DescribePredictorOutput {
s.AutoMLAlgorithmArns = v
return s
}
// SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value.
func (s *DescribePredictorOutput) SetAutoMLOverrideStrategy(v string) *DescribePredictorOutput {
s.AutoMLOverrideStrategy = &v
return s
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribePredictorOutput) SetCreationTime(v time.Time) *DescribePredictorOutput {
s.CreationTime = &v
return s
}
// SetDatasetImportJobArns sets the DatasetImportJobArns field's value.
func (s *DescribePredictorOutput) SetDatasetImportJobArns(v []*string) *DescribePredictorOutput {
s.DatasetImportJobArns = v
return s
}
// SetEncryptionConfig sets the EncryptionConfig field's value.
func (s *DescribePredictorOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribePredictorOutput {
s.EncryptionConfig = v
return s
}
// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.
func (s *DescribePredictorOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribePredictorOutput {
s.EstimatedTimeRemainingInMinutes = &v
return s
}
// SetEvaluationParameters sets the EvaluationParameters field's value.
func (s *DescribePredictorOutput) SetEvaluationParameters(v *EvaluationParameters) *DescribePredictorOutput {
s.EvaluationParameters = v
return s
}
// SetFeaturizationConfig sets the FeaturizationConfig field's value.
func (s *DescribePredictorOutput) SetFeaturizationConfig(v *FeaturizationConfig) *DescribePredictorOutput {
s.FeaturizationConfig = v
return s
}
// SetForecastHorizon sets the ForecastHorizon field's value.
func (s *DescribePredictorOutput) SetForecastHorizon(v int64) *DescribePredictorOutput {
s.ForecastHorizon = &v
return s
}
// SetForecastTypes sets the ForecastTypes field's value.
func (s *DescribePredictorOutput) SetForecastTypes(v []*string) *DescribePredictorOutput {
s.ForecastTypes = v
return s
}
// SetHPOConfig sets the HPOConfig field's value.
func (s *DescribePredictorOutput) SetHPOConfig(v *HyperParameterTuningJobConfig) *DescribePredictorOutput {
s.HPOConfig = v
return s
}
// SetInputDataConfig sets the InputDataConfig field's value.
func (s *DescribePredictorOutput) SetInputDataConfig(v *InputDataConfig) *DescribePredictorOutput {
s.InputDataConfig = v
return s
}
// SetIsAutoPredictor sets the IsAutoPredictor field's value.
func (s *DescribePredictorOutput) SetIsAutoPredictor(v bool) *DescribePredictorOutput {
s.IsAutoPredictor = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribePredictorOutput) SetLastModificationTime(v time.Time) *DescribePredictorOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribePredictorOutput) SetMessage(v string) *DescribePredictorOutput {
s.Message = &v
return s
}
// SetOptimizationMetric sets the OptimizationMetric field's value.
func (s *DescribePredictorOutput) SetOptimizationMetric(v string) *DescribePredictorOutput {
s.OptimizationMetric = &v
return s
}
// SetPerformAutoML sets the PerformAutoML field's value.
func (s *DescribePredictorOutput) SetPerformAutoML(v bool) *DescribePredictorOutput {
s.PerformAutoML = &v
return s
}
// SetPerformHPO sets the PerformHPO field's value.
func (s *DescribePredictorOutput) SetPerformHPO(v bool) *DescribePredictorOutput {
s.PerformHPO = &v
return s
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *DescribePredictorOutput) SetPredictorArn(v string) *DescribePredictorOutput {
s.PredictorArn = &v
return s
}
// SetPredictorExecutionDetails sets the PredictorExecutionDetails field's value.
func (s *DescribePredictorOutput) SetPredictorExecutionDetails(v *PredictorExecutionDetails) *DescribePredictorOutput {
s.PredictorExecutionDetails = v
return s
}
// SetPredictorName sets the PredictorName field's value.
func (s *DescribePredictorOutput) SetPredictorName(v string) *DescribePredictorOutput {
s.PredictorName = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribePredictorOutput) SetStatus(v string) *DescribePredictorOutput {
s.Status = &v
return s
}
// SetTrainingParameters sets the TrainingParameters field's value.
func (s *DescribePredictorOutput) SetTrainingParameters(v map[string]*string) *DescribePredictorOutput {
s.TrainingParameters = v
return s
}
type DescribeWhatIfAnalysisInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if analysis that you are interested
// in.
//
// WhatIfAnalysisArn is a required field
WhatIfAnalysisArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfAnalysisInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfAnalysisInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeWhatIfAnalysisInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeWhatIfAnalysisInput"}
if s.WhatIfAnalysisArn == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfAnalysisArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.
func (s *DescribeWhatIfAnalysisInput) SetWhatIfAnalysisArn(v string) *DescribeWhatIfAnalysisInput {
s.WhatIfAnalysisArn = &v
return s
}
type DescribeWhatIfAnalysisOutput struct {
_ struct{} `type:"structure"`
// When the what-if analysis was created.
CreationTime *time.Time `type:"timestamp"`
// The approximate time remaining to complete the what-if analysis, in minutes.
EstimatedTimeRemainingInMinutes *int64 `type:"long"`
// The Amazon Resource Name (ARN) of the what-if forecast.
ForecastArn *string `type:"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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"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 `type:"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 *TimeSeriesSelector `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if analysis.
WhatIfAnalysisArn *string `type:"string"`
// The name of the what-if analysis.
WhatIfAnalysisName *string `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfAnalysisOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfAnalysisOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeWhatIfAnalysisOutput) SetCreationTime(v time.Time) *DescribeWhatIfAnalysisOutput {
s.CreationTime = &v
return s
}
// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.
func (s *DescribeWhatIfAnalysisOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeWhatIfAnalysisOutput {
s.EstimatedTimeRemainingInMinutes = &v
return s
}
// SetForecastArn sets the ForecastArn field's value.
func (s *DescribeWhatIfAnalysisOutput) SetForecastArn(v string) *DescribeWhatIfAnalysisOutput {
s.ForecastArn = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeWhatIfAnalysisOutput) SetLastModificationTime(v time.Time) *DescribeWhatIfAnalysisOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeWhatIfAnalysisOutput) SetMessage(v string) *DescribeWhatIfAnalysisOutput {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeWhatIfAnalysisOutput) SetStatus(v string) *DescribeWhatIfAnalysisOutput {
s.Status = &v
return s
}
// SetTimeSeriesSelector sets the TimeSeriesSelector field's value.
func (s *DescribeWhatIfAnalysisOutput) SetTimeSeriesSelector(v *TimeSeriesSelector) *DescribeWhatIfAnalysisOutput {
s.TimeSeriesSelector = v
return s
}
// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.
func (s *DescribeWhatIfAnalysisOutput) SetWhatIfAnalysisArn(v string) *DescribeWhatIfAnalysisOutput {
s.WhatIfAnalysisArn = &v
return s
}
// SetWhatIfAnalysisName sets the WhatIfAnalysisName field's value.
func (s *DescribeWhatIfAnalysisOutput) SetWhatIfAnalysisName(v string) *DescribeWhatIfAnalysisOutput {
s.WhatIfAnalysisName = &v
return s
}
type DescribeWhatIfForecastExportInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if forecast export that you are
// interested in.
//
// WhatIfForecastExportArn is a required field
WhatIfForecastExportArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfForecastExportInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfForecastExportInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeWhatIfForecastExportInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeWhatIfForecastExportInput"}
if s.WhatIfForecastExportArn == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfForecastExportArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.
func (s *DescribeWhatIfForecastExportInput) SetWhatIfForecastExportArn(v string) *DescribeWhatIfForecastExportInput {
s.WhatIfForecastExportArn = &v
return s
}
type DescribeWhatIfForecastExportOutput struct {
_ struct{} `type:"structure"`
// When the what-if forecast export was created.
CreationTime *time.Time `type:"timestamp"`
// 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 *DataDestination `type:"structure"`
// The approximate time remaining to complete the what-if forecast export, in
// minutes.
EstimatedTimeRemainingInMinutes *int64 `type:"long"`
// The format of the exported data, CSV or PARQUET.
Format *string `type:"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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"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 `type:"string"`
// An array of Amazon Resource Names (ARNs) that represent all of the what-if
// forecasts exported in this resource.
WhatIfForecastArns []*string `type:"list"`
// The Amazon Resource Name (ARN) of the what-if forecast export.
WhatIfForecastExportArn *string `type:"string"`
// The name of the what-if forecast export.
WhatIfForecastExportName *string `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfForecastExportOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfForecastExportOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeWhatIfForecastExportOutput) SetCreationTime(v time.Time) *DescribeWhatIfForecastExportOutput {
s.CreationTime = &v
return s
}
// SetDestination sets the Destination field's value.
func (s *DescribeWhatIfForecastExportOutput) SetDestination(v *DataDestination) *DescribeWhatIfForecastExportOutput {
s.Destination = v
return s
}
// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.
func (s *DescribeWhatIfForecastExportOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeWhatIfForecastExportOutput {
s.EstimatedTimeRemainingInMinutes = &v
return s
}
// SetFormat sets the Format field's value.
func (s *DescribeWhatIfForecastExportOutput) SetFormat(v string) *DescribeWhatIfForecastExportOutput {
s.Format = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeWhatIfForecastExportOutput) SetLastModificationTime(v time.Time) *DescribeWhatIfForecastExportOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeWhatIfForecastExportOutput) SetMessage(v string) *DescribeWhatIfForecastExportOutput {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeWhatIfForecastExportOutput) SetStatus(v string) *DescribeWhatIfForecastExportOutput {
s.Status = &v
return s
}
// SetWhatIfForecastArns sets the WhatIfForecastArns field's value.
func (s *DescribeWhatIfForecastExportOutput) SetWhatIfForecastArns(v []*string) *DescribeWhatIfForecastExportOutput {
s.WhatIfForecastArns = v
return s
}
// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.
func (s *DescribeWhatIfForecastExportOutput) SetWhatIfForecastExportArn(v string) *DescribeWhatIfForecastExportOutput {
s.WhatIfForecastExportArn = &v
return s
}
// SetWhatIfForecastExportName sets the WhatIfForecastExportName field's value.
func (s *DescribeWhatIfForecastExportOutput) SetWhatIfForecastExportName(v string) *DescribeWhatIfForecastExportOutput {
s.WhatIfForecastExportName = &v
return s
}
type DescribeWhatIfForecastInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the what-if forecast that you are interested
// in.
//
// WhatIfForecastArn is a required field
WhatIfForecastArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfForecastInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfForecastInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeWhatIfForecastInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeWhatIfForecastInput"}
if s.WhatIfForecastArn == nil {
invalidParams.Add(request.NewErrParamRequired("WhatIfForecastArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetWhatIfForecastArn sets the WhatIfForecastArn field's value.
func (s *DescribeWhatIfForecastInput) SetWhatIfForecastArn(v string) *DescribeWhatIfForecastInput {
s.WhatIfForecastArn = &v
return s
}
type DescribeWhatIfForecastOutput struct {
_ struct{} `type:"structure"`
// When the what-if forecast was created.
CreationTime *time.Time `type:"timestamp"`
// The approximate time remaining to complete the what-if forecast, in minutes.
EstimatedTimeRemainingInMinutes *int64 `type:"long"`
// The quantiles at which probabilistic forecasts are generated. You can specify
// up to five quantiles per what-if forecast in the CreateWhatIfForecast operation.
// If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
ForecastTypes []*string `min:"1" type:"list"`
// 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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"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 `type:"string"`
// An array of S3Config, Schema, and Format elements that describe the replacement
// time series.
TimeSeriesReplacementsDataSource *TimeSeriesReplacementsDataSource `type:"structure"`
// An array of Action and TimeSeriesConditions elements that describe what transformations
// were applied to which time series.
TimeSeriesTransformations []*TimeSeriesTransformation `type:"list"`
// The Amazon Resource Name (ARN) of the what-if analysis that contains this
// forecast.
WhatIfAnalysisArn *string `type:"string"`
// The Amazon Resource Name (ARN) of the what-if forecast.
WhatIfForecastArn *string `type:"string"`
// The name of the what-if forecast.
WhatIfForecastName *string `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfForecastOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s DescribeWhatIfForecastOutput) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *DescribeWhatIfForecastOutput) SetCreationTime(v time.Time) *DescribeWhatIfForecastOutput {
s.CreationTime = &v
return s
}
// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.
func (s *DescribeWhatIfForecastOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeWhatIfForecastOutput {
s.EstimatedTimeRemainingInMinutes = &v
return s
}
// SetForecastTypes sets the ForecastTypes field's value.
func (s *DescribeWhatIfForecastOutput) SetForecastTypes(v []*string) *DescribeWhatIfForecastOutput {
s.ForecastTypes = v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *DescribeWhatIfForecastOutput) SetLastModificationTime(v time.Time) *DescribeWhatIfForecastOutput {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *DescribeWhatIfForecastOutput) SetMessage(v string) *DescribeWhatIfForecastOutput {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *DescribeWhatIfForecastOutput) SetStatus(v string) *DescribeWhatIfForecastOutput {
s.Status = &v
return s
}
// SetTimeSeriesReplacementsDataSource sets the TimeSeriesReplacementsDataSource field's value.
func (s *DescribeWhatIfForecastOutput) SetTimeSeriesReplacementsDataSource(v *TimeSeriesReplacementsDataSource) *DescribeWhatIfForecastOutput {
s.TimeSeriesReplacementsDataSource = v
return s
}
// SetTimeSeriesTransformations sets the TimeSeriesTransformations field's value.
func (s *DescribeWhatIfForecastOutput) SetTimeSeriesTransformations(v []*TimeSeriesTransformation) *DescribeWhatIfForecastOutput {
s.TimeSeriesTransformations = v
return s
}
// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.
func (s *DescribeWhatIfForecastOutput) SetWhatIfAnalysisArn(v string) *DescribeWhatIfForecastOutput {
s.WhatIfAnalysisArn = &v
return s
}
// SetWhatIfForecastArn sets the WhatIfForecastArn field's value.
func (s *DescribeWhatIfForecastOutput) SetWhatIfForecastArn(v string) *DescribeWhatIfForecastOutput {
s.WhatIfForecastArn = &v
return s
}
// SetWhatIfForecastName sets the WhatIfForecastName field's value.
func (s *DescribeWhatIfForecastOutput) SetWhatIfForecastName(v string) *DescribeWhatIfForecastOutput {
s.WhatIfForecastName = &v
return s
}
// 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 CreateDataset and CreatePredictor requests.
type EncryptionConfig struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the KMS key.
//
// KMSKeyArn is a required field
KMSKeyArn *string `type:"string" required:"true"`
// The ARN of the IAM role that Amazon Forecast can assume to access the KMS
// key.
//
// Passing a role across Amazon Web Services accounts is not allowed. If you
// pass a role that isn't in your account, you get an InvalidInputException
// error.
//
// RoleArn is a required field
RoleArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s EncryptionConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s EncryptionConfig) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *EncryptionConfig) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "EncryptionConfig"}
if s.KMSKeyArn == nil {
invalidParams.Add(request.NewErrParamRequired("KMSKeyArn"))
}
if s.RoleArn == nil {
invalidParams.Add(request.NewErrParamRequired("RoleArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetKMSKeyArn sets the KMSKeyArn field's value.
func (s *EncryptionConfig) SetKMSKeyArn(v string) *EncryptionConfig {
s.KMSKeyArn = &v
return s
}
// SetRoleArn sets the RoleArn field's value.
func (s *EncryptionConfig) SetRoleArn(v string) *EncryptionConfig {
s.RoleArn = &v
return s
}
// Provides detailed error metrics to evaluate the performance of a predictor.
// This object is part of the Metrics object.
type ErrorMetric struct {
_ struct{} `type:"structure"`
// The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
ForecastType *string `min:"2" type:"string"`
// The Mean Absolute Percentage Error (MAPE)
MAPE *float64 `type:"double"`
// The Mean Absolute Scaled Error (MASE)
MASE *float64 `type:"double"`
// The root-mean-square error (RMSE).
RMSE *float64 `type:"double"`
// The weighted absolute percentage error (WAPE).
WAPE *float64 `type:"double"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ErrorMetric) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ErrorMetric) GoString() string {
return s.String()
}
// SetForecastType sets the ForecastType field's value.
func (s *ErrorMetric) SetForecastType(v string) *ErrorMetric {
s.ForecastType = &v
return s
}
// SetMAPE sets the MAPE field's value.
func (s *ErrorMetric) SetMAPE(v float64) *ErrorMetric {
s.MAPE = &v
return s
}
// SetMASE sets the MASE field's value.
func (s *ErrorMetric) SetMASE(v float64) *ErrorMetric {
s.MASE = &v
return s
}
// SetRMSE sets the RMSE field's value.
func (s *ErrorMetric) SetRMSE(v float64) *ErrorMetric {
s.RMSE = &v
return s
}
// SetWAPE sets the WAPE field's value.
func (s *ErrorMetric) SetWAPE(v float64) *ErrorMetric {
s.WAPE = &v
return s
}
// Parameters that define how to split a dataset into training data and testing
// data, and the number of iterations to perform. These parameters are specified
// in the predefined algorithms but you can override them in the CreatePredictor
// request.
type EvaluationParameters struct {
_ struct{} `type:"structure"`
// The point from the end of the dataset where you want to split the data for
// model training and testing (evaluation). Specify the value as the number
// of data points. The default is the value of the forecast horizon. BackTestWindowOffset
// can be used to mimic a past virtual forecast start date. This value must
// be greater than or equal to the forecast horizon and less than half of the
// TARGET_TIME_SERIES dataset length.
//
// ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset
// length
BackTestWindowOffset *int64 `type:"integer"`
// The number of times to split the input data. The default is 1. Valid values
// are 1 through 5.
NumberOfBacktestWindows *int64 `type:"integer"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s EvaluationParameters) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s EvaluationParameters) GoString() string {
return s.String()
}
// SetBackTestWindowOffset sets the BackTestWindowOffset field's value.
func (s *EvaluationParameters) SetBackTestWindowOffset(v int64) *EvaluationParameters {
s.BackTestWindowOffset = &v
return s
}
// SetNumberOfBacktestWindows sets the NumberOfBacktestWindows field's value.
func (s *EvaluationParameters) SetNumberOfBacktestWindows(v int64) *EvaluationParameters {
s.NumberOfBacktestWindows = &v
return s
}
// The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics
// response.
type EvaluationResult struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the algorithm that was evaluated.
AlgorithmArn *string `type:"string"`
// The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows
// from the EvaluationParameters object determines the number of windows in
// the array.
TestWindows []*WindowSummary `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s EvaluationResult) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s EvaluationResult) GoString() string {
return s.String()
}
// SetAlgorithmArn sets the AlgorithmArn field's value.
func (s *EvaluationResult) SetAlgorithmArn(v string) *EvaluationResult {
s.AlgorithmArn = &v
return s
}
// SetTestWindows sets the TestWindows field's value.
func (s *EvaluationResult) SetTestWindows(v []*WindowSummary) *EvaluationResult {
s.TestWindows = v
return s
}
// The ExplainabilityConfig data type defines the number of time series and
// time points included in CreateExplainability.
//
// If you provide a predictor ARN for ResourceArn, you must set both TimePointGranularity
// and TimeSeriesGranularity to “ALL”. When creating Predictor Explainability,
// Amazon Forecast considers all time series and time points.
//
// If you provide a forecast ARN for ResourceArn, you can set TimePointGranularity
// and TimeSeriesGranularity to either “ALL” or “Specific”.
type ExplainabilityConfig struct {
_ struct{} `type:"structure"`
// To create an Explainability for all time points in your forecast horizon,
// use ALL. To create an Explainability for specific time points in your forecast
// horizon, use SPECIFIC.
//
// Specify time points with the StartDateTime and EndDateTime parameters within
// the CreateExplainability operation.
//
// TimePointGranularity is a required field
TimePointGranularity *string `type:"string" required:"true" enum:"TimePointGranularity"`
// To create an Explainability for all time series in your datasets, use ALL.
// To create an Explainability for specific time series in your datasets, use
// SPECIFIC.
//
// Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket
// and set the location within the DataDestination data type.
//
// TimeSeriesGranularity is a required field
TimeSeriesGranularity *string `type:"string" required:"true" enum:"TimeSeriesGranularity"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ExplainabilityConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ExplainabilityConfig) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ExplainabilityConfig) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ExplainabilityConfig"}
if s.TimePointGranularity == nil {
invalidParams.Add(request.NewErrParamRequired("TimePointGranularity"))
}
if s.TimeSeriesGranularity == nil {
invalidParams.Add(request.NewErrParamRequired("TimeSeriesGranularity"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetTimePointGranularity sets the TimePointGranularity field's value.
func (s *ExplainabilityConfig) SetTimePointGranularity(v string) *ExplainabilityConfig {
s.TimePointGranularity = &v
return s
}
// SetTimeSeriesGranularity sets the TimeSeriesGranularity field's value.
func (s *ExplainabilityConfig) SetTimeSeriesGranularity(v string) *ExplainabilityConfig {
s.TimeSeriesGranularity = &v
return s
}
// Provides a summary of the Explainability export properties used in the ListExplainabilityExports
// operation. To get a complete set of properties, call the DescribeExplainabilityExport
// operation, and provide the ExplainabilityExportArn.
type ExplainabilityExportSummary struct {
_ struct{} `type:"structure"`
// When the Explainability was created.
CreationTime *time.Time `type:"timestamp"`
// 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 *DataDestination `type:"structure"`
// The Amazon Resource Name (ARN) of the Explainability export.
ExplainabilityExportArn *string `type:"string"`
// The name of the Explainability export
ExplainabilityExportName *string `min:"1" type:"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 `type:"timestamp"`
// Information about any errors that may have occurred during the Explainability
// export.
Message *string `type:"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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ExplainabilityExportSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ExplainabilityExportSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *ExplainabilityExportSummary) SetCreationTime(v time.Time) *ExplainabilityExportSummary {
s.CreationTime = &v
return s
}
// SetDestination sets the Destination field's value.
func (s *ExplainabilityExportSummary) SetDestination(v *DataDestination) *ExplainabilityExportSummary {
s.Destination = v
return s
}
// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.
func (s *ExplainabilityExportSummary) SetExplainabilityExportArn(v string) *ExplainabilityExportSummary {
s.ExplainabilityExportArn = &v
return s
}
// SetExplainabilityExportName sets the ExplainabilityExportName field's value.
func (s *ExplainabilityExportSummary) SetExplainabilityExportName(v string) *ExplainabilityExportSummary {
s.ExplainabilityExportName = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *ExplainabilityExportSummary) SetLastModificationTime(v time.Time) *ExplainabilityExportSummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *ExplainabilityExportSummary) SetMessage(v string) *ExplainabilityExportSummary {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *ExplainabilityExportSummary) SetStatus(v string) *ExplainabilityExportSummary {
s.Status = &v
return s
}
// Provides information about the Explainability resource.
type ExplainabilityInfo struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the Explainability.
ExplainabilityArn *string `type:"string"`
// The status of the Explainability. States include:
//
// * ACTIVE
//
// * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
//
// * CREATE_STOPPING, CREATE_STOPPED
//
// * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
Status *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ExplainabilityInfo) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ExplainabilityInfo) GoString() string {
return s.String()
}
// SetExplainabilityArn sets the ExplainabilityArn field's value.
func (s *ExplainabilityInfo) SetExplainabilityArn(v string) *ExplainabilityInfo {
s.ExplainabilityArn = &v
return s
}
// SetStatus sets the Status field's value.
func (s *ExplainabilityInfo) SetStatus(v string) *ExplainabilityInfo {
s.Status = &v
return s
}
// Provides a summary of the Explainability properties used in the ListExplainabilities
// operation. To get a complete set of properties, call the DescribeExplainability
// operation, and provide the listed ExplainabilityArn.
type ExplainabilitySummary struct {
_ struct{} `type:"structure"`
// When the Explainability was created.
CreationTime *time.Time `type:"timestamp"`
// The Amazon Resource Name (ARN) of the Explainability.
ExplainabilityArn *string `type:"string"`
// The configuration settings that define the granularity of time series and
// time points for the Explainability.
ExplainabilityConfig *ExplainabilityConfig `type:"structure"`
// The name of the Explainability.
ExplainabilityName *string `min:"1" type:"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 `type:"timestamp"`
// Information about any errors that may have occurred during the Explainability
// creation process.
Message *string `type:"string"`
// The Amazon Resource Name (ARN) of the Predictor or Forecast used to create
// the Explainability.
ResourceArn *string `type:"string"`
// The status of the Explainability. States include:
//
// * ACTIVE
//
// * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
//
// * CREATE_STOPPING, CREATE_STOPPED
//
// * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
Status *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ExplainabilitySummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ExplainabilitySummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *ExplainabilitySummary) SetCreationTime(v time.Time) *ExplainabilitySummary {
s.CreationTime = &v
return s
}
// SetExplainabilityArn sets the ExplainabilityArn field's value.
func (s *ExplainabilitySummary) SetExplainabilityArn(v string) *ExplainabilitySummary {
s.ExplainabilityArn = &v
return s
}
// SetExplainabilityConfig sets the ExplainabilityConfig field's value.
func (s *ExplainabilitySummary) SetExplainabilityConfig(v *ExplainabilityConfig) *ExplainabilitySummary {
s.ExplainabilityConfig = v
return s
}
// SetExplainabilityName sets the ExplainabilityName field's value.
func (s *ExplainabilitySummary) SetExplainabilityName(v string) *ExplainabilitySummary {
s.ExplainabilityName = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *ExplainabilitySummary) SetLastModificationTime(v time.Time) *ExplainabilitySummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *ExplainabilitySummary) SetMessage(v string) *ExplainabilitySummary {
s.Message = &v
return s
}
// SetResourceArn sets the ResourceArn field's value.
func (s *ExplainabilitySummary) SetResourceArn(v string) *ExplainabilitySummary {
s.ResourceArn = &v
return s
}
// SetStatus sets the Status field's value.
func (s *ExplainabilitySummary) SetStatus(v string) *ExplainabilitySummary {
s.Status = &v
return s
}
// This object belongs to the CreatePredictor operation. If you created your
// predictor with CreateAutoPredictor, see AttributeConfig.
//
// Provides featurization (transformation) information for a dataset field.
// This object is part of the FeaturizationConfig object.
//
// For example:
//
// {
//
// "AttributeName": "demand",
//
// FeaturizationPipeline [ {
//
// "FeaturizationMethodName": "filling",
//
// "FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}
//
// } ]
//
// }
type Featurization struct {
_ struct{} `type:"structure"`
// The name of the schema attribute that specifies the data field to be featurized.
// Amazon Forecast supports the target field of the TARGET_TIME_SERIES and the
// RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target
// is demand, and for the CUSTOM domain, the target is target_value. For more
// information, see howitworks-missing-values.
//
// AttributeName is a required field
AttributeName *string `min:"1" type:"string" required:"true"`
// An array of one FeaturizationMethod object that specifies the feature transformation
// method.
FeaturizationPipeline []*FeaturizationMethod `min:"1" type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Featurization) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Featurization) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Featurization) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "Featurization"}
if s.AttributeName == nil {
invalidParams.Add(request.NewErrParamRequired("AttributeName"))
}
if s.AttributeName != nil && len(*s.AttributeName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1))
}
if s.FeaturizationPipeline != nil && len(s.FeaturizationPipeline) < 1 {
invalidParams.Add(request.NewErrParamMinLen("FeaturizationPipeline", 1))
}
if s.FeaturizationPipeline != nil {
for i, v := range s.FeaturizationPipeline {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "FeaturizationPipeline", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAttributeName sets the AttributeName field's value.
func (s *Featurization) SetAttributeName(v string) *Featurization {
s.AttributeName = &v
return s
}
// SetFeaturizationPipeline sets the FeaturizationPipeline field's value.
func (s *Featurization) SetFeaturizationPipeline(v []*FeaturizationMethod) *Featurization {
s.FeaturizationPipeline = v
return s
}
// This object belongs to the CreatePredictor operation. If you created your
// predictor with CreateAutoPredictor, see AttributeConfig.
//
// In a CreatePredictor operation, the specified algorithm trains a model using
// the specified dataset group. You can optionally tell the operation to modify
// data fields prior to training a model. These modifications are referred to
// as featurization.
//
// You define featurization using the FeaturizationConfig object. You specify
// an array of transformations, one for each field that you want to featurize.
// You then include the FeaturizationConfig object in your CreatePredictor request.
// Amazon Forecast applies the featurization to the TARGET_TIME_SERIES and RELATED_TIME_SERIES
// datasets before model training.
//
// You can create multiple featurization configurations. For example, you might
// call the CreatePredictor operation twice by specifying different featurization
// configurations.
type FeaturizationConfig struct {
_ struct{} `type:"structure"`
// An array of featurization (transformation) information for the fields of
// a dataset.
Featurizations []*Featurization `min:"1" type:"list"`
// An array of dimension (field) names that specify how to group the generated
// forecast.
//
// For example, suppose that you are generating a forecast for item sales across
// all of your stores, and your dataset contains a store_id field. If you want
// the sales forecast for each item by store, you would specify store_id as
// the dimension.
//
// All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't
// need to be specified in the CreatePredictor request. All forecast dimensions
// specified in the RELATED_TIME_SERIES dataset must be specified in the CreatePredictor
// request.
ForecastDimensions []*string `min:"1" type:"list"`
// 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 TARGET_TIME_SERIES dataset frequency.
//
// ForecastFrequency is a required field
ForecastFrequency *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s FeaturizationConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s FeaturizationConfig) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *FeaturizationConfig) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "FeaturizationConfig"}
if s.Featurizations != nil && len(s.Featurizations) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Featurizations", 1))
}
if s.ForecastDimensions != nil && len(s.ForecastDimensions) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ForecastDimensions", 1))
}
if s.ForecastFrequency == nil {
invalidParams.Add(request.NewErrParamRequired("ForecastFrequency"))
}
if s.ForecastFrequency != nil && len(*s.ForecastFrequency) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ForecastFrequency", 1))
}
if s.Featurizations != nil {
for i, v := range s.Featurizations {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Featurizations", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFeaturizations sets the Featurizations field's value.
func (s *FeaturizationConfig) SetFeaturizations(v []*Featurization) *FeaturizationConfig {
s.Featurizations = v
return s
}
// SetForecastDimensions sets the ForecastDimensions field's value.
func (s *FeaturizationConfig) SetForecastDimensions(v []*string) *FeaturizationConfig {
s.ForecastDimensions = v
return s
}
// SetForecastFrequency sets the ForecastFrequency field's value.
func (s *FeaturizationConfig) SetForecastFrequency(v string) *FeaturizationConfig {
s.ForecastFrequency = &v
return s
}
// Provides information about the method that featurizes (transforms) a dataset
// field. The method is part of the FeaturizationPipeline of the Featurization
// object.
//
// The following is an example of how you specify a FeaturizationMethod object.
//
// {
//
// "FeaturizationMethodName": "filling",
//
// "FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero",
// "backfill": "zero"}
//
// }
type FeaturizationMethod struct {
_ struct{} `type:"structure"`
// The name of the method. The "filling" method is the only supported method.
//
// FeaturizationMethodName is a required field
FeaturizationMethodName *string `type:"string" required:"true" enum:"FeaturizationMethodName"`
// The method parameters (key-value pairs), which are a map of override parameters.
// Specify these parameters to override the default values. Related Time Series
// attributes do not accept aggregation parameters.
//
// The following list shows the parameters and their valid values for the "filling"
// featurization method for a Target Time Series dataset. Bold signifies the
// default value.
//
// * aggregation: sum, avg, first, min, max
//
// * frontfill: none
//
// * middlefill: zero, nan (not a number), value, median, mean, min, max
//
// * backfill: zero, nan, value, median, mean, min, max
//
// The following list shows the parameters and their valid values for a Related
// Time Series featurization method (there are no defaults):
//
// * middlefill: zero, value, median, mean, min, max
//
// * backfill: zero, value, median, mean, min, max
//
// * futurefill: zero, value, median, mean, min, max
//
// To set a filling method to a specific value, set the fill parameter to value
// and define the value in a corresponding _value parameter. For example, to
// set backfilling to a value of 2, include the following: "backfill": "value"
// and "backfill_value":"2".
FeaturizationMethodParameters map[string]*string `min:"1" type:"map"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s FeaturizationMethod) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s FeaturizationMethod) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *FeaturizationMethod) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "FeaturizationMethod"}
if s.FeaturizationMethodName == nil {
invalidParams.Add(request.NewErrParamRequired("FeaturizationMethodName"))
}
if s.FeaturizationMethodParameters != nil && len(s.FeaturizationMethodParameters) < 1 {
invalidParams.Add(request.NewErrParamMinLen("FeaturizationMethodParameters", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFeaturizationMethodName sets the FeaturizationMethodName field's value.
func (s *FeaturizationMethod) SetFeaturizationMethodName(v string) *FeaturizationMethod {
s.FeaturizationMethodName = &v
return s
}
// SetFeaturizationMethodParameters sets the FeaturizationMethodParameters field's value.
func (s *FeaturizationMethod) SetFeaturizationMethodParameters(v map[string]*string) *FeaturizationMethod {
s.FeaturizationMethodParameters = v
return s
}
// Describes a filter for choosing a subset of objects. Each filter consists
// of a condition and a match statement. The condition is either IS or IS_NOT,
// which specifies whether to include or exclude the objects that match the
// statement, respectively. The match statement consists of a key and a value.
type Filter struct {
_ struct{} `type:"structure"`
// The condition to apply. To include the objects that match the statement,
// specify IS. To exclude matching objects, specify IS_NOT.
//
// Condition is a required field
Condition *string `type:"string" required:"true" enum:"FilterConditionString"`
// The name of the parameter to filter on.
//
// Key is a required field
Key *string `type:"string" required:"true"`
// The value to match.
//
// Value is a required field
Value *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Filter) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Filter) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Filter) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "Filter"}
if s.Condition == nil {
invalidParams.Add(request.NewErrParamRequired("Condition"))
}
if s.Key == nil {
invalidParams.Add(request.NewErrParamRequired("Key"))
}
if s.Value == nil {
invalidParams.Add(request.NewErrParamRequired("Value"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetCondition sets the Condition field's value.
func (s *Filter) SetCondition(v string) *Filter {
s.Condition = &v
return s
}
// SetKey sets the Key field's value.
func (s *Filter) SetKey(v string) *Filter {
s.Key = &v
return s
}
// SetValue sets the Value field's value.
func (s *Filter) SetValue(v string) *Filter {
s.Value = &v
return s
}
// Provides a summary of the forecast export job properties used in the ListForecastExportJobs
// operation. To get the complete set of properties, call the DescribeForecastExportJob
// operation, and provide the listed ForecastExportJobArn.
type ForecastExportJobSummary struct {
_ struct{} `type:"structure"`
// When the forecast export job was created.
CreationTime *time.Time `type:"timestamp"`
// The path to the Amazon Simple Storage Service (Amazon S3) bucket where the
// forecast is exported.
Destination *DataDestination `type:"structure"`
// The Amazon Resource Name (ARN) of the forecast export job.
ForecastExportJobArn *string `type:"string"`
// The name of the forecast export job.
ForecastExportJobName *string `min:"1" type:"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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ForecastExportJobSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ForecastExportJobSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *ForecastExportJobSummary) SetCreationTime(v time.Time) *ForecastExportJobSummary {
s.CreationTime = &v
return s
}
// SetDestination sets the Destination field's value.
func (s *ForecastExportJobSummary) SetDestination(v *DataDestination) *ForecastExportJobSummary {
s.Destination = v
return s
}
// SetForecastExportJobArn sets the ForecastExportJobArn field's value.
func (s *ForecastExportJobSummary) SetForecastExportJobArn(v string) *ForecastExportJobSummary {
s.ForecastExportJobArn = &v
return s
}
// SetForecastExportJobName sets the ForecastExportJobName field's value.
func (s *ForecastExportJobSummary) SetForecastExportJobName(v string) *ForecastExportJobSummary {
s.ForecastExportJobName = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *ForecastExportJobSummary) SetLastModificationTime(v time.Time) *ForecastExportJobSummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *ForecastExportJobSummary) SetMessage(v string) *ForecastExportJobSummary {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *ForecastExportJobSummary) SetStatus(v string) *ForecastExportJobSummary {
s.Status = &v
return s
}
// Provides a summary of the forecast properties used in the ListForecasts operation.
// To get the complete set of properties, call the DescribeForecast operation,
// and provide the ForecastArn that is listed in the summary.
type ForecastSummary struct {
_ struct{} `type:"structure"`
// Whether the Forecast was created from an AutoPredictor.
CreatedUsingAutoPredictor *bool `type:"boolean"`
// When the forecast creation task was created.
CreationTime *time.Time `type:"timestamp"`
// The Amazon Resource Name (ARN) of the dataset group that provided the data
// used to train the predictor.
DatasetGroupArn *string `type:"string"`
// The ARN of the forecast.
ForecastArn *string `type:"string"`
// The name of the forecast.
ForecastName *string `min:"1" type:"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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"string"`
// The ARN of the predictor used to generate the forecast.
PredictorArn *string `type:"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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ForecastSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ForecastSummary) GoString() string {
return s.String()
}
// SetCreatedUsingAutoPredictor sets the CreatedUsingAutoPredictor field's value.
func (s *ForecastSummary) SetCreatedUsingAutoPredictor(v bool) *ForecastSummary {
s.CreatedUsingAutoPredictor = &v
return s
}
// SetCreationTime sets the CreationTime field's value.
func (s *ForecastSummary) SetCreationTime(v time.Time) *ForecastSummary {
s.CreationTime = &v
return s
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *ForecastSummary) SetDatasetGroupArn(v string) *ForecastSummary {
s.DatasetGroupArn = &v
return s
}
// SetForecastArn sets the ForecastArn field's value.
func (s *ForecastSummary) SetForecastArn(v string) *ForecastSummary {
s.ForecastArn = &v
return s
}
// SetForecastName sets the ForecastName field's value.
func (s *ForecastSummary) SetForecastName(v string) *ForecastSummary {
s.ForecastName = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *ForecastSummary) SetLastModificationTime(v time.Time) *ForecastSummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *ForecastSummary) SetMessage(v string) *ForecastSummary {
s.Message = &v
return s
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *ForecastSummary) SetPredictorArn(v string) *ForecastSummary {
s.PredictorArn = &v
return s
}
// SetStatus sets the Status field's value.
func (s *ForecastSummary) SetStatus(v string) *ForecastSummary {
s.Status = &v
return s
}
type GetAccuracyMetricsInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the predictor to get metrics for.
//
// PredictorArn is a required field
PredictorArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetAccuracyMetricsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetAccuracyMetricsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetAccuracyMetricsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "GetAccuracyMetricsInput"}
if s.PredictorArn == nil {
invalidParams.Add(request.NewErrParamRequired("PredictorArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *GetAccuracyMetricsInput) SetPredictorArn(v string) *GetAccuracyMetricsInput {
s.PredictorArn = &v
return s
}
type GetAccuracyMetricsOutput struct {
_ struct{} `type:"structure"`
//
// 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 *string `type:"string" enum:"AutoMLOverrideStrategy"`
// Whether the predictor was created with CreateAutoPredictor.
IsAutoPredictor *bool `type:"boolean"`
// The accuracy metric used to optimize the predictor.
OptimizationMetric *string `type:"string" enum:"OptimizationMetric"`
// An array of results from evaluating the predictor.
PredictorEvaluationResults []*EvaluationResult `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetAccuracyMetricsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s GetAccuracyMetricsOutput) GoString() string {
return s.String()
}
// SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value.
func (s *GetAccuracyMetricsOutput) SetAutoMLOverrideStrategy(v string) *GetAccuracyMetricsOutput {
s.AutoMLOverrideStrategy = &v
return s
}
// SetIsAutoPredictor sets the IsAutoPredictor field's value.
func (s *GetAccuracyMetricsOutput) SetIsAutoPredictor(v bool) *GetAccuracyMetricsOutput {
s.IsAutoPredictor = &v
return s
}
// SetOptimizationMetric sets the OptimizationMetric field's value.
func (s *GetAccuracyMetricsOutput) SetOptimizationMetric(v string) *GetAccuracyMetricsOutput {
s.OptimizationMetric = &v
return s
}
// SetPredictorEvaluationResults sets the PredictorEvaluationResults field's value.
func (s *GetAccuracyMetricsOutput) SetPredictorEvaluationResults(v []*EvaluationResult) *GetAccuracyMetricsOutput {
s.PredictorEvaluationResults = v
return s
}
// Configuration information for a hyperparameter tuning job. You specify this
// object in the CreatePredictor request.
//
// A hyperparameter is a parameter that governs the model training process.
// You set hyperparameters before training starts, unlike model parameters,
// which are determined during training. The values of the hyperparameters effect
// which values are chosen for the model parameters.
//
// In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter
// values that optimize a specified metric. Forecast accomplishes this by running
// many training jobs over a range of hyperparameter values. The optimum set
// of values depends on the algorithm, the training data, and the specified
// metric objective.
type HyperParameterTuningJobConfig struct {
_ struct{} `type:"structure"`
// Specifies the ranges of valid values for the hyperparameters.
ParameterRanges *ParameterRanges `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s HyperParameterTuningJobConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s HyperParameterTuningJobConfig) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *HyperParameterTuningJobConfig) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "HyperParameterTuningJobConfig"}
if s.ParameterRanges != nil {
if err := s.ParameterRanges.Validate(); err != nil {
invalidParams.AddNested("ParameterRanges", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetParameterRanges sets the ParameterRanges field's value.
func (s *HyperParameterTuningJobConfig) SetParameterRanges(v *ParameterRanges) *HyperParameterTuningJobConfig {
s.ParameterRanges = v
return s
}
// This object belongs to the CreatePredictor operation. If you created your
// predictor with CreateAutoPredictor, see DataConfig.
//
// The data used to train a predictor. The data includes a dataset group and
// any supplementary features. You specify this object in the CreatePredictor
// request.
type InputDataConfig struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset group.
//
// DatasetGroupArn is a required field
DatasetGroupArn *string `type:"string" required:"true"`
// An array of supplementary features. The only supported feature is a holiday
// calendar.
SupplementaryFeatures []*SupplementaryFeature `min:"1" type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InputDataConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InputDataConfig) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *InputDataConfig) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "InputDataConfig"}
if s.DatasetGroupArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn"))
}
if s.SupplementaryFeatures != nil && len(s.SupplementaryFeatures) < 1 {
invalidParams.Add(request.NewErrParamMinLen("SupplementaryFeatures", 1))
}
if s.SupplementaryFeatures != nil {
for i, v := range s.SupplementaryFeatures {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SupplementaryFeatures", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *InputDataConfig) SetDatasetGroupArn(v string) *InputDataConfig {
s.DatasetGroupArn = &v
return s
}
// SetSupplementaryFeatures sets the SupplementaryFeatures field's value.
func (s *InputDataConfig) SetSupplementaryFeatures(v []*SupplementaryFeature) *InputDataConfig {
s.SupplementaryFeatures = v
return s
}
// Specifies an integer hyperparameter and it's range of tunable values. This
// object is part of the ParameterRanges object.
type IntegerParameterRange struct {
_ struct{} `type:"structure"`
// The maximum tunable value of the hyperparameter.
//
// MaxValue is a required field
MaxValue *int64 `type:"integer" required:"true"`
// The minimum tunable value of the hyperparameter.
//
// MinValue is a required field
MinValue *int64 `type:"integer" required:"true"`
// The name of the hyperparameter to tune.
//
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
// The scale that hyperparameter tuning uses to search the hyperparameter range.
// Valid values:
//
// Auto
//
// Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
//
// Linear
//
// Hyperparameter tuning searches the values in the hyperparameter range by
// using a linear scale.
//
// Logarithmic
//
// Hyperparameter tuning searches the values in the hyperparameter range by
// using a logarithmic scale.
//
// Logarithmic scaling works only for ranges that have values greater than 0.
//
// ReverseLogarithmic
//
// Not supported for IntegerParameterRange.
//
// Reverse logarithmic scaling works only for ranges that are entirely within
// the range 0 <= x < 1.0.
//
// For information about choosing a hyperparameter scale, see Hyperparameter
// Scaling (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type).
// One of the following values:
ScalingType *string `type:"string" enum:"ScalingType"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s IntegerParameterRange) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s IntegerParameterRange) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *IntegerParameterRange) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "IntegerParameterRange"}
if s.MaxValue == nil {
invalidParams.Add(request.NewErrParamRequired("MaxValue"))
}
if s.MinValue == nil {
invalidParams.Add(request.NewErrParamRequired("MinValue"))
}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Name", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMaxValue sets the MaxValue field's value.
func (s *IntegerParameterRange) SetMaxValue(v int64) *IntegerParameterRange {
s.MaxValue = &v
return s
}
// SetMinValue sets the MinValue field's value.
func (s *IntegerParameterRange) SetMinValue(v int64) *IntegerParameterRange {
s.MinValue = &v
return s
}
// SetName sets the Name field's value.
func (s *IntegerParameterRange) SetName(v string) *IntegerParameterRange {
s.Name = &v
return s
}
// SetScalingType sets the ScalingType field's value.
func (s *IntegerParameterRange) SetScalingType(v string) *IntegerParameterRange {
s.ScalingType = &v
return s
}
// We can't process the request because it includes an invalid value or a value
// that exceeds the valid range.
type InvalidInputException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidInputException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidInputException) GoString() string {
return s.String()
}
func newErrorInvalidInputException(v protocol.ResponseMetadata) error {
return &InvalidInputException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *InvalidInputException) Code() string {
return "InvalidInputException"
}
// Message returns the exception's message.
func (s *InvalidInputException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidInputException) OrigErr() error {
return nil
}
func (s *InvalidInputException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *InvalidInputException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *InvalidInputException) RequestID() string {
return s.RespMetadata.RequestID
}
// The token is not valid. Tokens expire after 24 hours.
type InvalidNextTokenException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidNextTokenException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s InvalidNextTokenException) GoString() string {
return s.String()
}
func newErrorInvalidNextTokenException(v protocol.ResponseMetadata) error {
return &InvalidNextTokenException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *InvalidNextTokenException) Code() string {
return "InvalidNextTokenException"
}
// Message returns the exception's message.
func (s *InvalidNextTokenException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidNextTokenException) OrigErr() error {
return nil
}
func (s *InvalidNextTokenException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *InvalidNextTokenException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *InvalidNextTokenException) RequestID() string {
return s.RespMetadata.RequestID
}
// The limit on the number of resources per account has been exceeded.
type LimitExceededException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s LimitExceededException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s LimitExceededException) GoString() string {
return s.String()
}
func newErrorLimitExceededException(v protocol.ResponseMetadata) error {
return &LimitExceededException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *LimitExceededException) Code() string {
return "LimitExceededException"
}
// Message returns the exception's message.
func (s *LimitExceededException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) OrigErr() error {
return nil
}
func (s *LimitExceededException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *LimitExceededException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) RequestID() string {
return s.RespMetadata.RequestID
}
type ListDatasetGroupsInput struct {
_ struct{} `type:"structure"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetGroupsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetGroupsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListDatasetGroupsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListDatasetGroupsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListDatasetGroupsInput) SetMaxResults(v int64) *ListDatasetGroupsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListDatasetGroupsInput) SetNextToken(v string) *ListDatasetGroupsInput {
s.NextToken = &v
return s
}
type ListDatasetGroupsOutput struct {
_ struct{} `type:"structure"`
// An array of objects that summarize each dataset group's properties.
DatasetGroups []*DatasetGroupSummary `type:"list"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetGroupsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetGroupsOutput) GoString() string {
return s.String()
}
// SetDatasetGroups sets the DatasetGroups field's value.
func (s *ListDatasetGroupsOutput) SetDatasetGroups(v []*DatasetGroupSummary) *ListDatasetGroupsOutput {
s.DatasetGroups = v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListDatasetGroupsOutput) SetNextToken(v string) *ListDatasetGroupsOutput {
s.NextToken = &v
return s
}
type ListDatasetImportJobsInput struct {
_ struct{} `type:"structure"`
// 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 []*Filter `type:"list"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetImportJobsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetImportJobsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListDatasetImportJobsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListDatasetImportJobsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListDatasetImportJobsInput) SetFilters(v []*Filter) *ListDatasetImportJobsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListDatasetImportJobsInput) SetMaxResults(v int64) *ListDatasetImportJobsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListDatasetImportJobsInput) SetNextToken(v string) *ListDatasetImportJobsInput {
s.NextToken = &v
return s
}
type ListDatasetImportJobsOutput struct {
_ struct{} `type:"structure"`
// An array of objects that summarize each dataset import job's properties.
DatasetImportJobs []*DatasetImportJobSummary `type:"list"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetImportJobsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetImportJobsOutput) GoString() string {
return s.String()
}
// SetDatasetImportJobs sets the DatasetImportJobs field's value.
func (s *ListDatasetImportJobsOutput) SetDatasetImportJobs(v []*DatasetImportJobSummary) *ListDatasetImportJobsOutput {
s.DatasetImportJobs = v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListDatasetImportJobsOutput) SetNextToken(v string) *ListDatasetImportJobsOutput {
s.NextToken = &v
return s
}
type ListDatasetsInput struct {
_ struct{} `type:"structure"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListDatasetsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListDatasetsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput {
s.NextToken = &v
return s
}
type ListDatasetsOutput struct {
_ struct{} `type:"structure"`
// An array of objects that summarize each dataset's properties.
Datasets []*DatasetSummary `type:"list"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListDatasetsOutput) GoString() string {
return s.String()
}
// SetDatasets sets the Datasets field's value.
func (s *ListDatasetsOutput) SetDatasets(v []*DatasetSummary) *ListDatasetsOutput {
s.Datasets = v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput {
s.NextToken = &v
return s
}
type ListExplainabilitiesInput struct {
_ struct{} `type:"structure"`
// 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 []*Filter `type:"list"`
// The number of items returned in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListExplainabilitiesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListExplainabilitiesInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListExplainabilitiesInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListExplainabilitiesInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListExplainabilitiesInput) SetFilters(v []*Filter) *ListExplainabilitiesInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListExplainabilitiesInput) SetMaxResults(v int64) *ListExplainabilitiesInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListExplainabilitiesInput) SetNextToken(v string) *ListExplainabilitiesInput {
s.NextToken = &v
return s
}
type ListExplainabilitiesOutput struct {
_ struct{} `type:"structure"`
// An array of objects that summarize the properties of each Explainability
// resource.
Explainabilities []*ExplainabilitySummary `type:"list"`
// Returns this token if the response is truncated. To retrieve the next set
// of results, use the token in the next request.
NextToken *string `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListExplainabilitiesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListExplainabilitiesOutput) GoString() string {
return s.String()
}
// SetExplainabilities sets the Explainabilities field's value.
func (s *ListExplainabilitiesOutput) SetExplainabilities(v []*ExplainabilitySummary) *ListExplainabilitiesOutput {
s.Explainabilities = v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListExplainabilitiesOutput) SetNextToken(v string) *ListExplainabilitiesOutput {
s.NextToken = &v
return s
}
type ListExplainabilityExportsInput struct {
_ struct{} `type:"structure"`
// 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 []*Filter `type:"list"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListExplainabilityExportsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListExplainabilityExportsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListExplainabilityExportsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListExplainabilityExportsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListExplainabilityExportsInput) SetFilters(v []*Filter) *ListExplainabilityExportsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListExplainabilityExportsInput) SetMaxResults(v int64) *ListExplainabilityExportsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListExplainabilityExportsInput) SetNextToken(v string) *ListExplainabilityExportsInput {
s.NextToken = &v
return s
}
type ListExplainabilityExportsOutput struct {
_ struct{} `type:"structure"`
// An array of objects that summarize the properties of each Explainability
// export.
ExplainabilityExports []*ExplainabilityExportSummary `type:"list"`
// Returns this token if the response is truncated. To retrieve the next set
// of results, use the token in the next request.
NextToken *string `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListExplainabilityExportsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListExplainabilityExportsOutput) GoString() string {
return s.String()
}
// SetExplainabilityExports sets the ExplainabilityExports field's value.
func (s *ListExplainabilityExportsOutput) SetExplainabilityExports(v []*ExplainabilityExportSummary) *ListExplainabilityExportsOutput {
s.ExplainabilityExports = v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListExplainabilityExportsOutput) SetNextToken(v string) *ListExplainabilityExportsOutput {
s.NextToken = &v
return s
}
type ListForecastExportJobsInput struct {
_ struct{} `type:"structure"`
// 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:<acct-id>:forecast/electricityforecast"
// } ]
Filters []*Filter `type:"list"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListForecastExportJobsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListForecastExportJobsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListForecastExportJobsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListForecastExportJobsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListForecastExportJobsInput) SetFilters(v []*Filter) *ListForecastExportJobsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListForecastExportJobsInput) SetMaxResults(v int64) *ListForecastExportJobsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListForecastExportJobsInput) SetNextToken(v string) *ListForecastExportJobsInput {
s.NextToken = &v
return s
}
type ListForecastExportJobsOutput struct {
_ struct{} `type:"structure"`
// An array of objects that summarize each export job's properties.
ForecastExportJobs []*ForecastExportJobSummary `type:"list"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListForecastExportJobsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListForecastExportJobsOutput) GoString() string {
return s.String()
}
// SetForecastExportJobs sets the ForecastExportJobs field's value.
func (s *ListForecastExportJobsOutput) SetForecastExportJobs(v []*ForecastExportJobSummary) *ListForecastExportJobsOutput {
s.ForecastExportJobs = v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListForecastExportJobsOutput) SetNextToken(v string) *ListForecastExportJobsOutput {
s.NextToken = &v
return s
}
type ListForecastsInput struct {
_ struct{} `type:"structure"`
// 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 []*Filter `type:"list"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListForecastsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListForecastsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListForecastsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListForecastsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListForecastsInput) SetFilters(v []*Filter) *ListForecastsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListForecastsInput) SetMaxResults(v int64) *ListForecastsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListForecastsInput) SetNextToken(v string) *ListForecastsInput {
s.NextToken = &v
return s
}
type ListForecastsOutput struct {
_ struct{} `type:"structure"`
// An array of objects that summarize each forecast's properties.
Forecasts []*ForecastSummary `type:"list"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListForecastsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListForecastsOutput) GoString() string {
return s.String()
}
// SetForecasts sets the Forecasts field's value.
func (s *ListForecastsOutput) SetForecasts(v []*ForecastSummary) *ListForecastsOutput {
s.Forecasts = v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListForecastsOutput) SetNextToken(v string) *ListForecastsOutput {
s.NextToken = &v
return s
}
type ListMonitorEvaluationsInput struct {
_ struct{} `type:"structure"`
// 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 []*Filter `type:"list"`
// The maximum number of monitoring results to return.
MaxResults *int64 `min:"1" type:"integer"`
// The Amazon Resource Name (ARN) of the monitor resource to get results from.
//
// MonitorArn is a required field
MonitorArn *string `type:"string" required:"true"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListMonitorEvaluationsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListMonitorEvaluationsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListMonitorEvaluationsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListMonitorEvaluationsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.MonitorArn == nil {
invalidParams.Add(request.NewErrParamRequired("MonitorArn"))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListMonitorEvaluationsInput) SetFilters(v []*Filter) *ListMonitorEvaluationsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListMonitorEvaluationsInput) SetMaxResults(v int64) *ListMonitorEvaluationsInput {
s.MaxResults = &v
return s
}
// SetMonitorArn sets the MonitorArn field's value.
func (s *ListMonitorEvaluationsInput) SetMonitorArn(v string) *ListMonitorEvaluationsInput {
s.MonitorArn = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListMonitorEvaluationsInput) SetNextToken(v string) *ListMonitorEvaluationsInput {
s.NextToken = &v
return s
}
type ListMonitorEvaluationsOutput struct {
_ struct{} `type:"structure"`
// 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 `min:"1" type:"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 (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).
// For more information about retrieving monitoring results see Viewing Monitoring
// Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).
PredictorMonitorEvaluations []*PredictorMonitorEvaluation `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListMonitorEvaluationsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListMonitorEvaluationsOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *ListMonitorEvaluationsOutput) SetNextToken(v string) *ListMonitorEvaluationsOutput {
s.NextToken = &v
return s
}
// SetPredictorMonitorEvaluations sets the PredictorMonitorEvaluations field's value.
func (s *ListMonitorEvaluationsOutput) SetPredictorMonitorEvaluations(v []*PredictorMonitorEvaluation) *ListMonitorEvaluationsOutput {
s.PredictorMonitorEvaluations = v
return s
}
type ListMonitorsInput struct {
_ struct{} `type:"structure"`
// 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 []*Filter `type:"list"`
// The maximum number of monitors to include in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListMonitorsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListMonitorsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListMonitorsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListMonitorsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListMonitorsInput) SetFilters(v []*Filter) *ListMonitorsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListMonitorsInput) SetMaxResults(v int64) *ListMonitorsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListMonitorsInput) SetNextToken(v string) *ListMonitorsInput {
s.NextToken = &v
return s
}
type ListMonitorsOutput struct {
_ struct{} `type:"structure"`
// An array of objects that summarize each monitor's properties.
Monitors []*MonitorSummary `type:"list"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListMonitorsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListMonitorsOutput) GoString() string {
return s.String()
}
// SetMonitors sets the Monitors field's value.
func (s *ListMonitorsOutput) SetMonitors(v []*MonitorSummary) *ListMonitorsOutput {
s.Monitors = v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListMonitorsOutput) SetNextToken(v string) *ListMonitorsOutput {
s.NextToken = &v
return s
}
type ListPredictorBacktestExportJobsInput struct {
_ struct{} `type:"structure"`
// 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 []*Filter `type:"list"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListPredictorBacktestExportJobsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListPredictorBacktestExportJobsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListPredictorBacktestExportJobsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListPredictorBacktestExportJobsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListPredictorBacktestExportJobsInput) SetFilters(v []*Filter) *ListPredictorBacktestExportJobsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListPredictorBacktestExportJobsInput) SetMaxResults(v int64) *ListPredictorBacktestExportJobsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListPredictorBacktestExportJobsInput) SetNextToken(v string) *ListPredictorBacktestExportJobsInput {
s.NextToken = &v
return s
}
type ListPredictorBacktestExportJobsOutput struct {
_ struct{} `type:"structure"`
// Returns this token if the response is truncated. To retrieve the next set
// of results, use the token in the next request.
NextToken *string `min:"1" type:"string"`
// An array of objects that summarize the properties of each predictor backtest
// export job.
PredictorBacktestExportJobs []*PredictorBacktestExportJobSummary `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListPredictorBacktestExportJobsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListPredictorBacktestExportJobsOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *ListPredictorBacktestExportJobsOutput) SetNextToken(v string) *ListPredictorBacktestExportJobsOutput {
s.NextToken = &v
return s
}
// SetPredictorBacktestExportJobs sets the PredictorBacktestExportJobs field's value.
func (s *ListPredictorBacktestExportJobsOutput) SetPredictorBacktestExportJobs(v []*PredictorBacktestExportJobSummary) *ListPredictorBacktestExportJobsOutput {
s.PredictorBacktestExportJobs = v
return s
}
type ListPredictorsInput struct {
_ struct{} `type:"structure"`
// 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 []*Filter `type:"list"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListPredictorsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListPredictorsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListPredictorsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListPredictorsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListPredictorsInput) SetFilters(v []*Filter) *ListPredictorsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListPredictorsInput) SetMaxResults(v int64) *ListPredictorsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListPredictorsInput) SetNextToken(v string) *ListPredictorsInput {
s.NextToken = &v
return s
}
type ListPredictorsOutput struct {
_ struct{} `type:"structure"`
// 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 `min:"1" type:"string"`
// An array of objects that summarize each predictor's properties.
Predictors []*PredictorSummary `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListPredictorsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListPredictorsOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *ListPredictorsOutput) SetNextToken(v string) *ListPredictorsOutput {
s.NextToken = &v
return s
}
// SetPredictors sets the Predictors field's value.
func (s *ListPredictorsOutput) SetPredictors(v []*PredictorSummary) *ListPredictorsOutput {
s.Predictors = v
return s
}
type ListTagsForResourceInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) that identifies the resource for which to
// list the tags.
//
// ResourceArn is a required field
ResourceArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListTagsForResourceInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListTagsForResourceInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListTagsForResourceInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"}
if s.ResourceArn == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetResourceArn sets the ResourceArn field's value.
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput {
s.ResourceArn = &v
return s
}
type ListTagsForResourceOutput struct {
_ struct{} `type:"structure"`
// The tags for the resource.
Tags []*Tag `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListTagsForResourceOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListTagsForResourceOutput) GoString() string {
return s.String()
}
// SetTags sets the Tags field's value.
func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput {
s.Tags = v
return s
}
type ListWhatIfAnalysesInput struct {
_ struct{} `type:"structure"`
// 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:<acct-id>:forecast/electricityWhatIf"
// } ]
Filters []*Filter `type:"list"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfAnalysesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfAnalysesInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListWhatIfAnalysesInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListWhatIfAnalysesInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListWhatIfAnalysesInput) SetFilters(v []*Filter) *ListWhatIfAnalysesInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListWhatIfAnalysesInput) SetMaxResults(v int64) *ListWhatIfAnalysesInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListWhatIfAnalysesInput) SetNextToken(v string) *ListWhatIfAnalysesInput {
s.NextToken = &v
return s
}
type ListWhatIfAnalysesOutput struct {
_ struct{} `type:"structure"`
// 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 `min:"1" type:"string"`
// An array of WhatIfAnalysisSummary objects that describe the matched analyses.
WhatIfAnalyses []*WhatIfAnalysisSummary `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfAnalysesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfAnalysesOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *ListWhatIfAnalysesOutput) SetNextToken(v string) *ListWhatIfAnalysesOutput {
s.NextToken = &v
return s
}
// SetWhatIfAnalyses sets the WhatIfAnalyses field's value.
func (s *ListWhatIfAnalysesOutput) SetWhatIfAnalyses(v []*WhatIfAnalysisSummary) *ListWhatIfAnalysesOutput {
s.WhatIfAnalyses = v
return s
}
type ListWhatIfForecastExportsInput struct {
_ struct{} `type:"structure"`
// 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:<acct-id>:forecast/electricityWIFExport" } ]
Filters []*Filter `type:"list"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfForecastExportsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfForecastExportsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListWhatIfForecastExportsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListWhatIfForecastExportsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListWhatIfForecastExportsInput) SetFilters(v []*Filter) *ListWhatIfForecastExportsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListWhatIfForecastExportsInput) SetMaxResults(v int64) *ListWhatIfForecastExportsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListWhatIfForecastExportsInput) SetNextToken(v string) *ListWhatIfForecastExportsInput {
s.NextToken = &v
return s
}
type ListWhatIfForecastExportsOutput struct {
_ struct{} `type:"structure"`
// 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 `min:"1" type:"string"`
// An array of WhatIfForecastExports objects that describe the matched forecast
// exports.
WhatIfForecastExports []*WhatIfForecastExportSummary `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfForecastExportsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfForecastExportsOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *ListWhatIfForecastExportsOutput) SetNextToken(v string) *ListWhatIfForecastExportsOutput {
s.NextToken = &v
return s
}
// SetWhatIfForecastExports sets the WhatIfForecastExports field's value.
func (s *ListWhatIfForecastExportsOutput) SetWhatIfForecastExports(v []*WhatIfForecastExportSummary) *ListWhatIfForecastExportsOutput {
s.WhatIfForecastExports = v
return s
}
type ListWhatIfForecastsInput struct {
_ struct{} `type:"structure"`
// 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:<acct-id>:forecast/electricityWhatIfForecast"
// } ]
Filters []*Filter `type:"list"`
// The number of items to return in the response.
MaxResults *int64 `min:"1" type:"integer"`
// 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 `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfForecastsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfForecastsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListWhatIfForecastsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ListWhatIfForecastsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
}
if s.Filters != nil {
for i, v := range s.Filters {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFilters sets the Filters field's value.
func (s *ListWhatIfForecastsInput) SetFilters(v []*Filter) *ListWhatIfForecastsInput {
s.Filters = v
return s
}
// SetMaxResults sets the MaxResults field's value.
func (s *ListWhatIfForecastsInput) SetMaxResults(v int64) *ListWhatIfForecastsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *ListWhatIfForecastsInput) SetNextToken(v string) *ListWhatIfForecastsInput {
s.NextToken = &v
return s
}
type ListWhatIfForecastsOutput struct {
_ struct{} `type:"structure"`
// 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 `min:"1" type:"string"`
// An array of WhatIfForecasts objects that describe the matched forecasts.
WhatIfForecasts []*WhatIfForecastSummary `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfForecastsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ListWhatIfForecastsOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *ListWhatIfForecastsOutput) SetNextToken(v string) *ListWhatIfForecastsOutput {
s.NextToken = &v
return s
}
// SetWhatIfForecasts sets the WhatIfForecasts field's value.
func (s *ListWhatIfForecastsOutput) SetWhatIfForecasts(v []*WhatIfForecastSummary) *ListWhatIfForecastsOutput {
s.WhatIfForecasts = v
return s
}
// An individual metric Forecast calculated when monitoring predictor usage.
// You can compare the value for this metric to the metric's value in the Baseline
// to see how your predictor's performance is changing.
//
// For more information about metrics generated by Forecast see Evaluating Predictor
// Accuracy (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)
type MetricResult struct {
_ struct{} `type:"structure"`
// The name of the metric.
MetricName *string `type:"string"`
// The value for the metric.
MetricValue *float64 `type:"double"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MetricResult) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MetricResult) GoString() string {
return s.String()
}
// SetMetricName sets the MetricName field's value.
func (s *MetricResult) SetMetricName(v string) *MetricResult {
s.MetricName = &v
return s
}
// SetMetricValue sets the MetricValue field's value.
func (s *MetricResult) SetMetricValue(v float64) *MetricResult {
s.MetricValue = &v
return s
}
// Provides metrics that are used to evaluate the performance of a predictor.
// This object is part of the WindowSummary object.
type Metrics struct {
_ struct{} `type:"structure"`
// The average value of all weighted quantile losses.
AverageWeightedQuantileLoss *float64 `type:"double"`
// Provides detailed error metrics for each forecast type. Metrics include root-mean
// square-error (RMSE), mean absolute percentage error (MAPE), mean absolute
// scaled error (MASE), and weighted average percentage error (WAPE).
ErrorMetrics []*ErrorMetric `type:"list"`
// The root-mean-square error (RMSE).
//
// Deprecated: This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE
RMSE *float64 `deprecated:"true" type:"double"`
// An array of weighted quantile losses. Quantiles divide a probability distribution
// into regions of equal probability. The distribution in this case is the loss
// function.
WeightedQuantileLosses []*WeightedQuantileLoss `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Metrics) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Metrics) GoString() string {
return s.String()
}
// SetAverageWeightedQuantileLoss sets the AverageWeightedQuantileLoss field's value.
func (s *Metrics) SetAverageWeightedQuantileLoss(v float64) *Metrics {
s.AverageWeightedQuantileLoss = &v
return s
}
// SetErrorMetrics sets the ErrorMetrics field's value.
func (s *Metrics) SetErrorMetrics(v []*ErrorMetric) *Metrics {
s.ErrorMetrics = v
return s
}
// SetRMSE sets the RMSE field's value.
func (s *Metrics) SetRMSE(v float64) *Metrics {
s.RMSE = &v
return s
}
// SetWeightedQuantileLosses sets the WeightedQuantileLosses field's value.
func (s *Metrics) SetWeightedQuantileLosses(v []*WeightedQuantileLoss) *Metrics {
s.WeightedQuantileLosses = v
return s
}
// The configuration details for the predictor monitor.
type MonitorConfig struct {
_ struct{} `type:"structure"`
// The name of the monitor resource.
//
// MonitorName is a required field
MonitorName *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MonitorConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MonitorConfig) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *MonitorConfig) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "MonitorConfig"}
if s.MonitorName == nil {
invalidParams.Add(request.NewErrParamRequired("MonitorName"))
}
if s.MonitorName != nil && len(*s.MonitorName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("MonitorName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMonitorName sets the MonitorName field's value.
func (s *MonitorConfig) SetMonitorName(v string) *MonitorConfig {
s.MonitorName = &v
return s
}
// The source of the data the monitor used during the evaluation.
type MonitorDataSource struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset import job used to import the
// data that initiated the monitor evaluation.
DatasetImportJobArn *string `type:"string"`
// The Amazon Resource Name (ARN) of the forecast the monitor used during the
// evaluation.
ForecastArn *string `type:"string"`
// The Amazon Resource Name (ARN) of the predictor resource you are monitoring.
PredictorArn *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MonitorDataSource) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MonitorDataSource) GoString() string {
return s.String()
}
// SetDatasetImportJobArn sets the DatasetImportJobArn field's value.
func (s *MonitorDataSource) SetDatasetImportJobArn(v string) *MonitorDataSource {
s.DatasetImportJobArn = &v
return s
}
// SetForecastArn sets the ForecastArn field's value.
func (s *MonitorDataSource) SetForecastArn(v string) *MonitorDataSource {
s.ForecastArn = &v
return s
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *MonitorDataSource) SetPredictorArn(v string) *MonitorDataSource {
s.PredictorArn = &v
return s
}
// Provides information about the monitor resource.
type MonitorInfo struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the monitor resource.
MonitorArn *string `type:"string"`
// The status of the monitor. States include:
//
// * ACTIVE
//
// * ACTIVE_STOPPING, ACTIVE_STOPPED
//
// * UPDATE_IN_PROGRESS
//
// * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
//
// * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
Status *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MonitorInfo) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MonitorInfo) GoString() string {
return s.String()
}
// SetMonitorArn sets the MonitorArn field's value.
func (s *MonitorInfo) SetMonitorArn(v string) *MonitorInfo {
s.MonitorArn = &v
return s
}
// SetStatus sets the Status field's value.
func (s *MonitorInfo) SetStatus(v string) *MonitorInfo {
s.Status = &v
return s
}
// Provides a summary of the monitor properties used in the ListMonitors operation.
// To get a complete set of properties, call the DescribeMonitor operation,
// and provide the listed MonitorArn.
type MonitorSummary struct {
_ struct{} `type:"structure"`
// When the monitor resource was created.
CreationTime *time.Time `type:"timestamp"`
// The last time the monitor resource was modified. The timestamp depends on
// the status of the job:
//
// * CREATE_PENDING - The CreationTime.
//
// * CREATE_IN_PROGRESS - The current timestamp.
//
// * STOPPED - When the resource stopped.
//
// * ACTIVE or CREATE_FAILED - When the monitor creation finished or failed.
LastModificationTime *time.Time `type:"timestamp"`
// The Amazon Resource Name (ARN) of the monitor resource.
MonitorArn *string `type:"string"`
// The name of the monitor resource.
MonitorName *string `min:"1" type:"string"`
// The Amazon Resource Name (ARN) of the predictor being monitored.
ResourceArn *string `type:"string"`
// The status of the monitor. States include:
//
// * ACTIVE
//
// * ACTIVE_STOPPING, ACTIVE_STOPPED
//
// * UPDATE_IN_PROGRESS
//
// * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
//
// * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
Status *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MonitorSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s MonitorSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *MonitorSummary) SetCreationTime(v time.Time) *MonitorSummary {
s.CreationTime = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *MonitorSummary) SetLastModificationTime(v time.Time) *MonitorSummary {
s.LastModificationTime = &v
return s
}
// SetMonitorArn sets the MonitorArn field's value.
func (s *MonitorSummary) SetMonitorArn(v string) *MonitorSummary {
s.MonitorArn = &v
return s
}
// SetMonitorName sets the MonitorName field's value.
func (s *MonitorSummary) SetMonitorName(v string) *MonitorSummary {
s.MonitorName = &v
return s
}
// SetResourceArn sets the ResourceArn field's value.
func (s *MonitorSummary) SetResourceArn(v string) *MonitorSummary {
s.ResourceArn = &v
return s
}
// SetStatus sets the Status field's value.
func (s *MonitorSummary) SetStatus(v string) *MonitorSummary {
s.Status = &v
return s
}
// Specifies the categorical, continuous, and integer hyperparameters, and their
// ranges of tunable values. The range of tunable values determines which values
// that a hyperparameter tuning job can choose for the specified hyperparameter.
// This object is part of the HyperParameterTuningJobConfig object.
type ParameterRanges struct {
_ struct{} `type:"structure"`
// Specifies the tunable range for each categorical hyperparameter.
CategoricalParameterRanges []*CategoricalParameterRange `min:"1" type:"list"`
// Specifies the tunable range for each continuous hyperparameter.
ContinuousParameterRanges []*ContinuousParameterRange `min:"1" type:"list"`
// Specifies the tunable range for each integer hyperparameter.
IntegerParameterRanges []*IntegerParameterRange `min:"1" type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ParameterRanges) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ParameterRanges) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ParameterRanges) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ParameterRanges"}
if s.CategoricalParameterRanges != nil && len(s.CategoricalParameterRanges) < 1 {
invalidParams.Add(request.NewErrParamMinLen("CategoricalParameterRanges", 1))
}
if s.ContinuousParameterRanges != nil && len(s.ContinuousParameterRanges) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ContinuousParameterRanges", 1))
}
if s.IntegerParameterRanges != nil && len(s.IntegerParameterRanges) < 1 {
invalidParams.Add(request.NewErrParamMinLen("IntegerParameterRanges", 1))
}
if s.CategoricalParameterRanges != nil {
for i, v := range s.CategoricalParameterRanges {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CategoricalParameterRanges", i), err.(request.ErrInvalidParams))
}
}
}
if s.ContinuousParameterRanges != nil {
for i, v := range s.ContinuousParameterRanges {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ContinuousParameterRanges", i), err.(request.ErrInvalidParams))
}
}
}
if s.IntegerParameterRanges != nil {
for i, v := range s.IntegerParameterRanges {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "IntegerParameterRanges", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetCategoricalParameterRanges sets the CategoricalParameterRanges field's value.
func (s *ParameterRanges) SetCategoricalParameterRanges(v []*CategoricalParameterRange) *ParameterRanges {
s.CategoricalParameterRanges = v
return s
}
// SetContinuousParameterRanges sets the ContinuousParameterRanges field's value.
func (s *ParameterRanges) SetContinuousParameterRanges(v []*ContinuousParameterRange) *ParameterRanges {
s.ContinuousParameterRanges = v
return s
}
// SetIntegerParameterRanges sets the IntegerParameterRanges field's value.
func (s *ParameterRanges) SetIntegerParameterRanges(v []*IntegerParameterRange) *ParameterRanges {
s.IntegerParameterRanges = v
return s
}
// Provides a summary of the predictor backtest export job properties used in
// the ListPredictorBacktestExportJobs operation. To get a complete set of properties,
// call the DescribePredictorBacktestExportJob operation, and provide the listed
// PredictorBacktestExportJobArn.
type PredictorBacktestExportJobSummary struct {
_ struct{} `type:"structure"`
// When the predictor backtest export job was created.
CreationTime *time.Time `type:"timestamp"`
// 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 *DataDestination `type:"structure"`
// 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 `type:"timestamp"`
// Information about any errors that may have occurred during the backtest export.
Message *string `type:"string"`
// The Amazon Resource Name (ARN) of the predictor backtest export job.
PredictorBacktestExportJobArn *string `type:"string"`
// The name of the predictor backtest export job.
PredictorBacktestExportJobName *string `min:"1" type:"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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorBacktestExportJobSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorBacktestExportJobSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *PredictorBacktestExportJobSummary) SetCreationTime(v time.Time) *PredictorBacktestExportJobSummary {
s.CreationTime = &v
return s
}
// SetDestination sets the Destination field's value.
func (s *PredictorBacktestExportJobSummary) SetDestination(v *DataDestination) *PredictorBacktestExportJobSummary {
s.Destination = v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *PredictorBacktestExportJobSummary) SetLastModificationTime(v time.Time) *PredictorBacktestExportJobSummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *PredictorBacktestExportJobSummary) SetMessage(v string) *PredictorBacktestExportJobSummary {
s.Message = &v
return s
}
// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.
func (s *PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobArn(v string) *PredictorBacktestExportJobSummary {
s.PredictorBacktestExportJobArn = &v
return s
}
// SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value.
func (s *PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobName(v string) *PredictorBacktestExportJobSummary {
s.PredictorBacktestExportJobName = &v
return s
}
// SetStatus sets the Status field's value.
func (s *PredictorBacktestExportJobSummary) SetStatus(v string) *PredictorBacktestExportJobSummary {
s.Status = &v
return s
}
// Metrics you can use as a baseline for comparison purposes. Use these metrics
// when you interpret monitoring results for an auto predictor.
type PredictorBaseline struct {
_ struct{} `type:"structure"`
// The initial accuracy metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)
// for the predictor. Use these metrics as a baseline for comparison purposes
// as you use your predictor and the metrics change.
BaselineMetrics []*BaselineMetric `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorBaseline) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorBaseline) GoString() string {
return s.String()
}
// SetBaselineMetrics sets the BaselineMetrics field's value.
func (s *PredictorBaseline) SetBaselineMetrics(v []*BaselineMetric) *PredictorBaseline {
s.BaselineMetrics = v
return s
}
// Provides details about a predictor event, such as a retraining.
type PredictorEvent struct {
_ struct{} `type:"structure"`
// The timestamp for when the event occurred.
Datetime *time.Time `type:"timestamp"`
// The type of event. For example, Retrain. A retraining event denotes the timepoint
// when a predictor was retrained. Any monitor results from before the Datetime
// are from the previous predictor. Any new metrics are for the newly retrained
// predictor.
Detail *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorEvent) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorEvent) GoString() string {
return s.String()
}
// SetDatetime sets the Datetime field's value.
func (s *PredictorEvent) SetDatetime(v time.Time) *PredictorEvent {
s.Datetime = &v
return s
}
// SetDetail sets the Detail field's value.
func (s *PredictorEvent) SetDetail(v string) *PredictorEvent {
s.Detail = &v
return s
}
// The algorithm used to perform a backtest and the status of those tests.
type PredictorExecution struct {
_ struct{} `type:"structure"`
// The ARN of the algorithm used to test the predictor.
AlgorithmArn *string `type:"string"`
// An array of test windows used to evaluate the algorithm. The NumberOfBacktestWindows
// from the object determines the number of windows in the array.
TestWindows []*TestWindowSummary `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorExecution) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorExecution) GoString() string {
return s.String()
}
// SetAlgorithmArn sets the AlgorithmArn field's value.
func (s *PredictorExecution) SetAlgorithmArn(v string) *PredictorExecution {
s.AlgorithmArn = &v
return s
}
// SetTestWindows sets the TestWindows field's value.
func (s *PredictorExecution) SetTestWindows(v []*TestWindowSummary) *PredictorExecution {
s.TestWindows = v
return s
}
// Contains details on the backtests performed to evaluate the accuracy of the
// predictor. The tests are returned in descending order of accuracy, with the
// most accurate backtest appearing first. You specify the number of backtests
// to perform when you call the operation.
type PredictorExecutionDetails struct {
_ struct{} `type:"structure"`
// An array of the backtests performed to evaluate the accuracy of the predictor
// against a particular algorithm. The NumberOfBacktestWindows from the object
// determines the number of windows in the array.
PredictorExecutions []*PredictorExecution `min:"1" type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorExecutionDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorExecutionDetails) GoString() string {
return s.String()
}
// SetPredictorExecutions sets the PredictorExecutions field's value.
func (s *PredictorExecutionDetails) SetPredictorExecutions(v []*PredictorExecution) *PredictorExecutionDetails {
s.PredictorExecutions = v
return s
}
// Describes the results of a monitor evaluation.
type PredictorMonitorEvaluation struct {
_ struct{} `type:"structure"`
// The status of the monitor evaluation. The state can be SUCCESS or FAILURE.
EvaluationState *string `type:"string"`
// The timestamp that indicates when the monitor evaluation was started.
EvaluationTime *time.Time `type:"timestamp"`
// Information about any errors that may have occurred during the monitor evaluation.
Message *string `type:"string"`
// A list of metrics Forecast calculated when monitoring a predictor. You can
// compare the value for each metric in the list to the metric's value in the
// Baseline to see how your predictor's performance is changing.
MetricResults []*MetricResult `type:"list"`
// The Amazon Resource Name (ARN) of the monitor resource.
MonitorArn *string `type:"string"`
// The source of the data the monitor resource used during the evaluation.
MonitorDataSource *MonitorDataSource `type:"structure"`
// The number of items considered during the evaluation.
NumItemsEvaluated *int64 `type:"long"`
// Provides details about a predictor event, such as a retraining.
PredictorEvent *PredictorEvent `type:"structure"`
// The Amazon Resource Name (ARN) of the resource to monitor.
ResourceArn *string `type:"string"`
// The timestamp that indicates the end of the window that is used for monitor
// evaluation.
WindowEndDatetime *time.Time `type:"timestamp"`
// The timestamp that indicates the start of the window that is used for monitor
// evaluation.
WindowStartDatetime *time.Time `type:"timestamp"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorMonitorEvaluation) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorMonitorEvaluation) GoString() string {
return s.String()
}
// SetEvaluationState sets the EvaluationState field's value.
func (s *PredictorMonitorEvaluation) SetEvaluationState(v string) *PredictorMonitorEvaluation {
s.EvaluationState = &v
return s
}
// SetEvaluationTime sets the EvaluationTime field's value.
func (s *PredictorMonitorEvaluation) SetEvaluationTime(v time.Time) *PredictorMonitorEvaluation {
s.EvaluationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *PredictorMonitorEvaluation) SetMessage(v string) *PredictorMonitorEvaluation {
s.Message = &v
return s
}
// SetMetricResults sets the MetricResults field's value.
func (s *PredictorMonitorEvaluation) SetMetricResults(v []*MetricResult) *PredictorMonitorEvaluation {
s.MetricResults = v
return s
}
// SetMonitorArn sets the MonitorArn field's value.
func (s *PredictorMonitorEvaluation) SetMonitorArn(v string) *PredictorMonitorEvaluation {
s.MonitorArn = &v
return s
}
// SetMonitorDataSource sets the MonitorDataSource field's value.
func (s *PredictorMonitorEvaluation) SetMonitorDataSource(v *MonitorDataSource) *PredictorMonitorEvaluation {
s.MonitorDataSource = v
return s
}
// SetNumItemsEvaluated sets the NumItemsEvaluated field's value.
func (s *PredictorMonitorEvaluation) SetNumItemsEvaluated(v int64) *PredictorMonitorEvaluation {
s.NumItemsEvaluated = &v
return s
}
// SetPredictorEvent sets the PredictorEvent field's value.
func (s *PredictorMonitorEvaluation) SetPredictorEvent(v *PredictorEvent) *PredictorMonitorEvaluation {
s.PredictorEvent = v
return s
}
// SetResourceArn sets the ResourceArn field's value.
func (s *PredictorMonitorEvaluation) SetResourceArn(v string) *PredictorMonitorEvaluation {
s.ResourceArn = &v
return s
}
// SetWindowEndDatetime sets the WindowEndDatetime field's value.
func (s *PredictorMonitorEvaluation) SetWindowEndDatetime(v time.Time) *PredictorMonitorEvaluation {
s.WindowEndDatetime = &v
return s
}
// SetWindowStartDatetime sets the WindowStartDatetime field's value.
func (s *PredictorMonitorEvaluation) SetWindowStartDatetime(v time.Time) *PredictorMonitorEvaluation {
s.WindowStartDatetime = &v
return s
}
// Provides a summary of the predictor properties that are used in the ListPredictors
// operation. To get the complete set of properties, call the DescribePredictor
// operation, and provide the listed PredictorArn.
type PredictorSummary struct {
_ struct{} `type:"structure"`
// When the model training task was created.
CreationTime *time.Time `type:"timestamp"`
// The Amazon Resource Name (ARN) of the dataset group that contains the data
// used to train the predictor.
DatasetGroupArn *string `type:"string"`
// Whether AutoPredictor was used to create the predictor.
IsAutoPredictor *bool `type:"boolean"`
// 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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"string"`
// The ARN of the predictor.
PredictorArn *string `type:"string"`
// The name of the predictor.
PredictorName *string `min:"1" type:"string"`
// A summary of the reference predictor used if the predictor was retrained
// or upgraded.
ReferencePredictorSummary *ReferencePredictorSummary `type:"structure"`
// 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 `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s PredictorSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *PredictorSummary) SetCreationTime(v time.Time) *PredictorSummary {
s.CreationTime = &v
return s
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *PredictorSummary) SetDatasetGroupArn(v string) *PredictorSummary {
s.DatasetGroupArn = &v
return s
}
// SetIsAutoPredictor sets the IsAutoPredictor field's value.
func (s *PredictorSummary) SetIsAutoPredictor(v bool) *PredictorSummary {
s.IsAutoPredictor = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *PredictorSummary) SetLastModificationTime(v time.Time) *PredictorSummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *PredictorSummary) SetMessage(v string) *PredictorSummary {
s.Message = &v
return s
}
// SetPredictorArn sets the PredictorArn field's value.
func (s *PredictorSummary) SetPredictorArn(v string) *PredictorSummary {
s.PredictorArn = &v
return s
}
// SetPredictorName sets the PredictorName field's value.
func (s *PredictorSummary) SetPredictorName(v string) *PredictorSummary {
s.PredictorName = &v
return s
}
// SetReferencePredictorSummary sets the ReferencePredictorSummary field's value.
func (s *PredictorSummary) SetReferencePredictorSummary(v *ReferencePredictorSummary) *PredictorSummary {
s.ReferencePredictorSummary = v
return s
}
// SetStatus sets the Status field's value.
func (s *PredictorSummary) SetStatus(v string) *PredictorSummary {
s.Status = &v
return s
}
// Provides a summary of the reference predictor used when retraining or upgrading
// a predictor.
type ReferencePredictorSummary struct {
_ struct{} `type:"structure"`
// The ARN of the reference predictor.
Arn *string `type:"string"`
// Whether the reference predictor is Active or Deleted.
State *string `type:"string" enum:"State"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ReferencePredictorSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ReferencePredictorSummary) GoString() string {
return s.String()
}
// SetArn sets the Arn field's value.
func (s *ReferencePredictorSummary) SetArn(v string) *ReferencePredictorSummary {
s.Arn = &v
return s
}
// SetState sets the State field's value.
func (s *ReferencePredictorSummary) SetState(v string) *ReferencePredictorSummary {
s.State = &v
return s
}
// There is already a resource with this name. Try again with a different name.
type ResourceAlreadyExistsException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceAlreadyExistsException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceAlreadyExistsException) GoString() string {
return s.String()
}
func newErrorResourceAlreadyExistsException(v protocol.ResponseMetadata) error {
return &ResourceAlreadyExistsException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ResourceAlreadyExistsException) Code() string {
return "ResourceAlreadyExistsException"
}
// Message returns the exception's message.
func (s *ResourceAlreadyExistsException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceAlreadyExistsException) OrigErr() error {
return nil
}
func (s *ResourceAlreadyExistsException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ResourceAlreadyExistsException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ResourceAlreadyExistsException) RequestID() string {
return s.RespMetadata.RequestID
}
// The specified resource is in use.
type ResourceInUseException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceInUseException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceInUseException) GoString() string {
return s.String()
}
func newErrorResourceInUseException(v protocol.ResponseMetadata) error {
return &ResourceInUseException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ResourceInUseException) Code() string {
return "ResourceInUseException"
}
// Message returns the exception's message.
func (s *ResourceInUseException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceInUseException) OrigErr() error {
return nil
}
func (s *ResourceInUseException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ResourceInUseException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ResourceInUseException) RequestID() string {
return s.RespMetadata.RequestID
}
// We can't find a resource with that Amazon Resource Name (ARN). Check the
// ARN and try again.
type ResourceNotFoundException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceNotFoundException) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResourceNotFoundException) GoString() string {
return s.String()
}
func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error {
return &ResourceNotFoundException{
RespMetadata: v,
}
}
// Code returns the exception type name.
func (s *ResourceNotFoundException) Code() string {
return "ResourceNotFoundException"
}
// Message returns the exception's message.
func (s *ResourceNotFoundException) Message() string {
if s.Message_ != nil {
return *s.Message_
}
return ""
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) OrigErr() error {
return nil
}
func (s *ResourceNotFoundException) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
// Status code returns the HTTP status code for the request's response error.
func (s *ResourceNotFoundException) StatusCode() int {
return s.RespMetadata.StatusCode
}
// RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) RequestID() string {
return s.RespMetadata.RequestID
}
type ResumeResourceInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the monitor resource to resume.
//
// ResourceArn is a required field
ResourceArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResumeResourceInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResumeResourceInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ResumeResourceInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "ResumeResourceInput"}
if s.ResourceArn == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetResourceArn sets the ResourceArn field's value.
func (s *ResumeResourceInput) SetResourceArn(v string) *ResumeResourceInput {
s.ResourceArn = &v
return s
}
type ResumeResourceOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResumeResourceOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s ResumeResourceOutput) GoString() string {
return s.String()
}
// The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket,
// and an Identity and Access Management (IAM) role that Amazon Forecast can
// assume to access the file(s). Optionally, includes an Key Management Service
// (KMS) key. This object is part of the DataSource object that is submitted
// in the CreateDatasetImportJob request, and part of the DataDestination object.
type S3Config struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
KMSKeyArn *string `type:"string"`
// The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s)
// in an Amazon S3 bucket.
//
// Path is a required field
Path *string `min:"7" type:"string" required:"true"`
// The ARN of the Identity and Access Management (IAM) role that Amazon Forecast
// can assume to access the Amazon S3 bucket or files. If you provide a value
// for the KMSKeyArn key, the role must allow access to the key.
//
// Passing a role across Amazon Web Services accounts is not allowed. If you
// pass a role that isn't in your account, you get an InvalidInputException
// error.
//
// RoleArn is a required field
RoleArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s S3Config) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s S3Config) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *S3Config) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "S3Config"}
if s.Path == nil {
invalidParams.Add(request.NewErrParamRequired("Path"))
}
if s.Path != nil && len(*s.Path) < 7 {
invalidParams.Add(request.NewErrParamMinLen("Path", 7))
}
if s.RoleArn == nil {
invalidParams.Add(request.NewErrParamRequired("RoleArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetKMSKeyArn sets the KMSKeyArn field's value.
func (s *S3Config) SetKMSKeyArn(v string) *S3Config {
s.KMSKeyArn = &v
return s
}
// SetPath sets the Path field's value.
func (s *S3Config) SetPath(v string) *S3Config {
s.Path = &v
return s
}
// SetRoleArn sets the RoleArn field's value.
func (s *S3Config) SetRoleArn(v string) *S3Config {
s.RoleArn = &v
return s
}
// Defines the fields of a dataset.
type Schema struct {
_ struct{} `type:"structure"`
// An array of attributes specifying the name and type of each field in a dataset.
Attributes []*SchemaAttribute `min:"1" type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Schema) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Schema) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Schema) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "Schema"}
if s.Attributes != nil && len(s.Attributes) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Attributes", 1))
}
if s.Attributes != nil {
for i, v := range s.Attributes {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Attributes", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAttributes sets the Attributes field's value.
func (s *Schema) SetAttributes(v []*SchemaAttribute) *Schema {
s.Attributes = v
return s
}
// An attribute of a schema, which defines a dataset field. A schema attribute
// is required for every field in a dataset. The Schema (https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html)
// object contains an array of SchemaAttribute objects.
type SchemaAttribute struct {
_ struct{} `type:"structure"`
// The name of the dataset field.
AttributeName *string `min:"1" type:"string"`
// The data type of the field.
//
// For a related time series dataset, other than date, item_id, and forecast
// dimensions attributes, all attributes should be of numerical type (integer/float).
AttributeType *string `type:"string" enum:"AttributeType"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s SchemaAttribute) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s SchemaAttribute) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *SchemaAttribute) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "SchemaAttribute"}
if s.AttributeName != nil && len(*s.AttributeName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAttributeName sets the AttributeName field's value.
func (s *SchemaAttribute) SetAttributeName(v string) *SchemaAttribute {
s.AttributeName = &v
return s
}
// SetAttributeType sets the AttributeType field's value.
func (s *SchemaAttribute) SetAttributeType(v string) *SchemaAttribute {
s.AttributeType = &v
return s
}
// Provides statistics for each data field imported into to an Amazon Forecast
// dataset with the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)
// operation.
type Statistics struct {
_ struct{} `type:"structure"`
// For a numeric field, the average value in the field.
Avg *float64 `type:"double"`
// The number of values in the field. If the response value is -1, refer to
// CountLong.
Count *int64 `type:"integer"`
// The number of distinct values in the field. If the response value is -1,
// refer to CountDistinctLong.
CountDistinct *int64 `type:"integer"`
// The number of distinct values in the field. CountDistinctLong is used instead
// of CountDistinct if the value is greater than 2,147,483,647.
CountDistinctLong *int64 `type:"long"`
// The number of values in the field. CountLong is used instead of Count if
// the value is greater than 2,147,483,647.
CountLong *int64 `type:"long"`
// The number of NAN (not a number) values in the field. If the response value
// is -1, refer to CountNanLong.
CountNan *int64 `type:"integer"`
// The number of NAN (not a number) values in the field. CountNanLong is used
// instead of CountNan if the value is greater than 2,147,483,647.
CountNanLong *int64 `type:"long"`
// The number of null values in the field. If the response value is -1, refer
// to CountNullLong.
CountNull *int64 `type:"integer"`
// The number of null values in the field. CountNullLong is used instead of
// CountNull if the value is greater than 2,147,483,647.
CountNullLong *int64 `type:"long"`
// For a numeric field, the maximum value in the field.
Max *string `type:"string"`
// For a numeric field, the minimum value in the field.
Min *string `type:"string"`
// For a numeric field, the standard deviation.
Stddev *float64 `type:"double"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Statistics) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Statistics) GoString() string {
return s.String()
}
// SetAvg sets the Avg field's value.
func (s *Statistics) SetAvg(v float64) *Statistics {
s.Avg = &v
return s
}
// SetCount sets the Count field's value.
func (s *Statistics) SetCount(v int64) *Statistics {
s.Count = &v
return s
}
// SetCountDistinct sets the CountDistinct field's value.
func (s *Statistics) SetCountDistinct(v int64) *Statistics {
s.CountDistinct = &v
return s
}
// SetCountDistinctLong sets the CountDistinctLong field's value.
func (s *Statistics) SetCountDistinctLong(v int64) *Statistics {
s.CountDistinctLong = &v
return s
}
// SetCountLong sets the CountLong field's value.
func (s *Statistics) SetCountLong(v int64) *Statistics {
s.CountLong = &v
return s
}
// SetCountNan sets the CountNan field's value.
func (s *Statistics) SetCountNan(v int64) *Statistics {
s.CountNan = &v
return s
}
// SetCountNanLong sets the CountNanLong field's value.
func (s *Statistics) SetCountNanLong(v int64) *Statistics {
s.CountNanLong = &v
return s
}
// SetCountNull sets the CountNull field's value.
func (s *Statistics) SetCountNull(v int64) *Statistics {
s.CountNull = &v
return s
}
// SetCountNullLong sets the CountNullLong field's value.
func (s *Statistics) SetCountNullLong(v int64) *Statistics {
s.CountNullLong = &v
return s
}
// SetMax sets the Max field's value.
func (s *Statistics) SetMax(v string) *Statistics {
s.Max = &v
return s
}
// SetMin sets the Min field's value.
func (s *Statistics) SetMin(v string) *Statistics {
s.Min = &v
return s
}
// SetStddev sets the Stddev field's value.
func (s *Statistics) SetStddev(v float64) *Statistics {
s.Stddev = &v
return s
}
type StopResourceInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) that identifies the resource to stop. The
// supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn,
// ForecastArn, ForecastExportJobArn, ExplainabilityArn, and ExplainabilityExportArn.
//
// ResourceArn is a required field
ResourceArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s StopResourceInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s StopResourceInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *StopResourceInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "StopResourceInput"}
if s.ResourceArn == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetResourceArn sets the ResourceArn field's value.
func (s *StopResourceInput) SetResourceArn(v string) *StopResourceInput {
s.ResourceArn = &v
return s
}
type StopResourceOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s StopResourceOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s StopResourceOutput) GoString() string {
return s.String()
}
// This object belongs to the CreatePredictor operation. If you created your
// predictor with CreateAutoPredictor, see AdditionalDataset.
//
// Describes a supplementary feature of a dataset group. This object is part
// of the InputDataConfig object. Forecast supports the Weather Index and Holidays
// built-in featurizations.
//
// # Weather Index
//
// The Amazon Forecast Weather Index is a built-in featurization that incorporates
// historical and projected weather information into your model. The Weather
// Index supplements your datasets with over two years of historical weather
// data and up to 14 days of projected weather data. For more information, see
// Amazon Forecast Weather Index (https://docs.aws.amazon.com/forecast/latest/dg/weather.html).
//
// # Holidays
//
// Holidays is a built-in featurization that incorporates a feature-engineered
// dataset of national holiday information into your model. It provides native
// support for the holiday calendars of 66 countries. To view the holiday calendars,
// refer to the Jollyday (http://jollyday.sourceforge.net/data.html) library.
// For more information, see Holidays Featurization (https://docs.aws.amazon.com/forecast/latest/dg/holidays.html).
type SupplementaryFeature struct {
_ struct{} `type:"structure"`
// The name of the feature. Valid values: "holiday" and "weather".
//
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
// Weather Index
//
// To enable the Weather Index, set the value to "true"
//
// Holidays
//
// To enable Holidays, specify a country with one of the following two-letter
// country codes:
//
// * "AL" - ALBANIA
//
// * "AR" - ARGENTINA
//
// * "AT" - AUSTRIA
//
// * "AU" - AUSTRALIA
//
// * "BA" - BOSNIA HERZEGOVINA
//
// * "BE" - BELGIUM
//
// * "BG" - BULGARIA
//
// * "BO" - BOLIVIA
//
// * "BR" - BRAZIL
//
// * "BY" - BELARUS
//
// * "CA" - CANADA
//
// * "CL" - CHILE
//
// * "CO" - COLOMBIA
//
// * "CR" - COSTA RICA
//
// * "HR" - CROATIA
//
// * "CZ" - CZECH REPUBLIC
//
// * "DK" - DENMARK
//
// * "EC" - ECUADOR
//
// * "EE" - ESTONIA
//
// * "ET" - ETHIOPIA
//
// * "FI" - FINLAND
//
// * "FR" - FRANCE
//
// * "DE" - GERMANY
//
// * "GR" - GREECE
//
// * "HU" - HUNGARY
//
// * "IS" - ICELAND
//
// * "IN" - INDIA
//
// * "IE" - IRELAND
//
// * "IT" - ITALY
//
// * "JP" - JAPAN
//
// * "KZ" - KAZAKHSTAN
//
// * "KR" - KOREA
//
// * "LV" - LATVIA
//
// * "LI" - LIECHTENSTEIN
//
// * "LT" - LITHUANIA
//
// * "LU" - LUXEMBOURG
//
// * "MK" - MACEDONIA
//
// * "MT" - MALTA
//
// * "MX" - MEXICO
//
// * "MD" - MOLDOVA
//
// * "ME" - MONTENEGRO
//
// * "NL" - NETHERLANDS
//
// * "NZ" - NEW ZEALAND
//
// * "NI" - NICARAGUA
//
// * "NG" - NIGERIA
//
// * "NO" - NORWAY
//
// * "PA" - PANAMA
//
// * "PY" - PARAGUAY
//
// * "PE" - PERU
//
// * "PL" - POLAND
//
// * "PT" - PORTUGAL
//
// * "RO" - ROMANIA
//
// * "RU" - RUSSIA
//
// * "RS" - SERBIA
//
// * "SK" - SLOVAKIA
//
// * "SI" - SLOVENIA
//
// * "ZA" - SOUTH AFRICA
//
// * "ES" - SPAIN
//
// * "SE" - SWEDEN
//
// * "CH" - SWITZERLAND
//
// * "UA" - UKRAINE
//
// * "AE" - UNITED ARAB EMIRATES
//
// * "US" - UNITED STATES
//
// * "UK" - UNITED KINGDOM
//
// * "UY" - URUGUAY
//
// * "VE" - VENEZUELA
//
// Value is a required field
Value *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s SupplementaryFeature) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s SupplementaryFeature) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *SupplementaryFeature) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "SupplementaryFeature"}
if s.Name == nil {
invalidParams.Add(request.NewErrParamRequired("Name"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Name", 1))
}
if s.Value == nil {
invalidParams.Add(request.NewErrParamRequired("Value"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetName sets the Name field's value.
func (s *SupplementaryFeature) SetName(v string) *SupplementaryFeature {
s.Name = &v
return s
}
// SetValue sets the Value field's value.
func (s *SupplementaryFeature) SetValue(v string) *SupplementaryFeature {
s.Value = &v
return s
}
// The optional metadata that you apply to a resource 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.
type Tag struct {
_ struct{} `type:"structure"`
// One part of a key-value pair that makes up a tag. A key is a general label
// that acts like a category for more specific tag values.
//
// Key is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Tag's
// String and GoString methods.
//
// Key is a required field
Key *string `min:"1" type:"string" required:"true" sensitive:"true"`
// The optional part of a key-value pair that makes up a tag. A value acts as
// a descriptor within a tag category (key).
//
// Value is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Tag's
// String and GoString methods.
//
// Value is a required field
Value *string `type:"string" required:"true" sensitive:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Tag) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s Tag) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Tag) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "Tag"}
if s.Key == nil {
invalidParams.Add(request.NewErrParamRequired("Key"))
}
if s.Key != nil && len(*s.Key) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Key", 1))
}
if s.Value == nil {
invalidParams.Add(request.NewErrParamRequired("Value"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetKey sets the Key field's value.
func (s *Tag) SetKey(v string) *Tag {
s.Key = &v
return s
}
// SetValue sets the Value field's value.
func (s *Tag) SetValue(v string) *Tag {
s.Value = &v
return s
}
type TagResourceInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) that identifies the resource for which to
// list the tags.
//
// ResourceArn is a required field
ResourceArn *string `type:"string" required:"true"`
// 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.
//
// Tags is a required field
Tags []*Tag `type:"list" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TagResourceInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TagResourceInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *TagResourceInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"}
if s.ResourceArn == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
}
if s.Tags == nil {
invalidParams.Add(request.NewErrParamRequired("Tags"))
}
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetResourceArn sets the ResourceArn field's value.
func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput {
s.ResourceArn = &v
return s
}
// SetTags sets the Tags field's value.
func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput {
s.Tags = v
return s
}
type TagResourceOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TagResourceOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TagResourceOutput) GoString() string {
return s.String()
}
// The status, start time, and end time of a backtest, as well as a failure
// reason if applicable.
type TestWindowSummary struct {
_ struct{} `type:"structure"`
// If the test failed, the reason why it failed.
Message *string `type:"string"`
// The status of the test. Possible status values are:
//
// * ACTIVE
//
// * CREATE_IN_PROGRESS
//
// * CREATE_FAILED
Status *string `type:"string"`
// The time at which the test ended.
TestWindowEnd *time.Time `type:"timestamp"`
// The time at which the test began.
TestWindowStart *time.Time `type:"timestamp"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TestWindowSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TestWindowSummary) GoString() string {
return s.String()
}
// SetMessage sets the Message field's value.
func (s *TestWindowSummary) SetMessage(v string) *TestWindowSummary {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *TestWindowSummary) SetStatus(v string) *TestWindowSummary {
s.Status = &v
return s
}
// SetTestWindowEnd sets the TestWindowEnd field's value.
func (s *TestWindowSummary) SetTestWindowEnd(v time.Time) *TestWindowSummary {
s.TestWindowEnd = &v
return s
}
// SetTestWindowStart sets the TestWindowStart field's value.
func (s *TestWindowSummary) SetTestWindowStart(v time.Time) *TestWindowSummary {
s.TestWindowStart = &v
return s
}
// The time boundary Forecast uses to align and aggregate your data to match
// your forecast frequency. Provide the unit of time and the time boundary as
// a key value pair. If you don't provide a time boundary, Forecast uses a set
// of Default Time Boundaries (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries).
//
// For more information about aggregation, see Data Aggregation for Different
// Forecast Frequencies (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html).
// For more information setting a custom time boundary, see Specifying a Time
// Boundary (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary).
type TimeAlignmentBoundary struct {
_ struct{} `type:"structure"`
// The day of the month to use for time alignment during aggregation.
DayOfMonth *int64 `min:"1" type:"integer"`
// The day of week to use for time alignment during aggregation. The day must
// be in uppercase.
DayOfWeek *string `type:"string" enum:"DayOfWeek"`
// The hour of day to use for time alignment during aggregation.
Hour *int64 `type:"integer"`
// The month to use for time alignment during aggregation. The month must be
// in uppercase.
Month *string `type:"string" enum:"Month"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeAlignmentBoundary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeAlignmentBoundary) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *TimeAlignmentBoundary) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "TimeAlignmentBoundary"}
if s.DayOfMonth != nil && *s.DayOfMonth < 1 {
invalidParams.Add(request.NewErrParamMinValue("DayOfMonth", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDayOfMonth sets the DayOfMonth field's value.
func (s *TimeAlignmentBoundary) SetDayOfMonth(v int64) *TimeAlignmentBoundary {
s.DayOfMonth = &v
return s
}
// SetDayOfWeek sets the DayOfWeek field's value.
func (s *TimeAlignmentBoundary) SetDayOfWeek(v string) *TimeAlignmentBoundary {
s.DayOfWeek = &v
return s
}
// SetHour sets the Hour field's value.
func (s *TimeAlignmentBoundary) SetHour(v int64) *TimeAlignmentBoundary {
s.Hour = &v
return s
}
// SetMonth sets the Month field's value.
func (s *TimeAlignmentBoundary) SetMonth(v string) *TimeAlignmentBoundary {
s.Month = &v
return s
}
// Creates a subset of items within an attribute that are modified. For example,
// you can use this operation to create a subset of items that cost $5 or less.
// To do this, you specify "AttributeName": "price", "AttributeValue": "5",
// and "Condition": "LESS_THAN". Pair this operation with the Action operation
// within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation
// to define how the attribute is modified.
type TimeSeriesCondition struct {
_ struct{} `type:"structure"`
// The item_id, dimension name, IM name, or timestamp that you are modifying.
//
// AttributeName is a required field
AttributeName *string `min:"1" type:"string" required:"true"`
// The value that is applied for the chosen Condition.
//
// AttributeValue is a required field
AttributeValue *string `type:"string" required:"true"`
// The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and
// GREATER_THAN.
//
// Condition is a required field
Condition *string `type:"string" required:"true" enum:"Condition"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesCondition) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesCondition) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *TimeSeriesCondition) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "TimeSeriesCondition"}
if s.AttributeName == nil {
invalidParams.Add(request.NewErrParamRequired("AttributeName"))
}
if s.AttributeName != nil && len(*s.AttributeName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1))
}
if s.AttributeValue == nil {
invalidParams.Add(request.NewErrParamRequired("AttributeValue"))
}
if s.Condition == nil {
invalidParams.Add(request.NewErrParamRequired("Condition"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAttributeName sets the AttributeName field's value.
func (s *TimeSeriesCondition) SetAttributeName(v string) *TimeSeriesCondition {
s.AttributeName = &v
return s
}
// SetAttributeValue sets the AttributeValue field's value.
func (s *TimeSeriesCondition) SetAttributeValue(v string) *TimeSeriesCondition {
s.AttributeValue = &v
return s
}
// SetCondition sets the Condition field's value.
func (s *TimeSeriesCondition) SetCondition(v string) *TimeSeriesCondition {
s.Condition = &v
return s
}
// Details about the import file that contains the time series for which you
// want to create forecasts.
type TimeSeriesIdentifiers struct {
_ struct{} `type:"structure"`
// 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 *DataSource `type:"structure"`
// The format of the data, either CSV or PARQUET.
Format *string `type:"string"`
// Defines the fields of a dataset.
Schema *Schema `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesIdentifiers) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesIdentifiers) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *TimeSeriesIdentifiers) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "TimeSeriesIdentifiers"}
if s.DataSource != nil {
if err := s.DataSource.Validate(); err != nil {
invalidParams.AddNested("DataSource", err.(request.ErrInvalidParams))
}
}
if s.Schema != nil {
if err := s.Schema.Validate(); err != nil {
invalidParams.AddNested("Schema", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDataSource sets the DataSource field's value.
func (s *TimeSeriesIdentifiers) SetDataSource(v *DataSource) *TimeSeriesIdentifiers {
s.DataSource = v
return s
}
// SetFormat sets the Format field's value.
func (s *TimeSeriesIdentifiers) SetFormat(v string) *TimeSeriesIdentifiers {
s.Format = &v
return s
}
// SetSchema sets the Schema field's value.
func (s *TimeSeriesIdentifiers) SetSchema(v *Schema) *TimeSeriesIdentifiers {
s.Schema = v
return s
}
// A replacement dataset is a modified version of the baseline related time
// series that contains only the values that you want to include in a what-if
// forecast. The replacement dataset must contain the forecast dimensions and
// item identifiers in the baseline related time series as well as at least
// 1 changed time series. This dataset is merged with the baseline related time
// series to create a transformed dataset that is used for the what-if forecast.
type TimeSeriesReplacementsDataSource struct {
_ struct{} `type:"structure"`
// The format of the replacement data, CSV or PARQUET.
Format *string `type:"string"`
// The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket,
// and an Identity and Access Management (IAM) role that Amazon Forecast can
// assume to access the file(s). Optionally, includes an Key Management Service
// (KMS) key. This object is part of the DataSource object that is submitted
// in the CreateDatasetImportJob request, and part of the DataDestination object.
//
// S3Config is a required field
S3Config *S3Config `type:"structure" required:"true"`
// Defines the fields of a dataset.
//
// Schema is a required field
Schema *Schema `type:"structure" required:"true"`
// The timestamp format of the replacement data.
TimestampFormat *string `type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesReplacementsDataSource) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesReplacementsDataSource) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *TimeSeriesReplacementsDataSource) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "TimeSeriesReplacementsDataSource"}
if s.S3Config == nil {
invalidParams.Add(request.NewErrParamRequired("S3Config"))
}
if s.Schema == nil {
invalidParams.Add(request.NewErrParamRequired("Schema"))
}
if s.S3Config != nil {
if err := s.S3Config.Validate(); err != nil {
invalidParams.AddNested("S3Config", err.(request.ErrInvalidParams))
}
}
if s.Schema != nil {
if err := s.Schema.Validate(); err != nil {
invalidParams.AddNested("Schema", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetFormat sets the Format field's value.
func (s *TimeSeriesReplacementsDataSource) SetFormat(v string) *TimeSeriesReplacementsDataSource {
s.Format = &v
return s
}
// SetS3Config sets the S3Config field's value.
func (s *TimeSeriesReplacementsDataSource) SetS3Config(v *S3Config) *TimeSeriesReplacementsDataSource {
s.S3Config = v
return s
}
// SetSchema sets the Schema field's value.
func (s *TimeSeriesReplacementsDataSource) SetSchema(v *Schema) *TimeSeriesReplacementsDataSource {
s.Schema = v
return s
}
// SetTimestampFormat sets the TimestampFormat field's value.
func (s *TimeSeriesReplacementsDataSource) SetTimestampFormat(v string) *TimeSeriesReplacementsDataSource {
s.TimestampFormat = &v
return s
}
// 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
type TimeSeriesSelector struct {
_ struct{} `type:"structure"`
// Details about the import file that contains the time series for which you
// want to create forecasts.
TimeSeriesIdentifiers *TimeSeriesIdentifiers `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesSelector) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesSelector) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *TimeSeriesSelector) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "TimeSeriesSelector"}
if s.TimeSeriesIdentifiers != nil {
if err := s.TimeSeriesIdentifiers.Validate(); err != nil {
invalidParams.AddNested("TimeSeriesIdentifiers", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetTimeSeriesIdentifiers sets the TimeSeriesIdentifiers field's value.
func (s *TimeSeriesSelector) SetTimeSeriesIdentifiers(v *TimeSeriesIdentifiers) *TimeSeriesSelector {
s.TimeSeriesIdentifiers = v
return s
}
// A transformation function is a pair of operations that select and modify
// the rows in a related time series. You select the rows that you want with
// a condition operation and you modify the rows with a transformation operation.
// All conditions are joined with an AND operation, meaning that all conditions
// must be true for the transformation to be applied. Transformations are applied
// in the order that they are listed.
type TimeSeriesTransformation struct {
_ struct{} `type:"structure"`
// An array of actions that define a time series and how it is transformed.
// These transformations create a new time series that is used for the what-if
// analysis.
Action *Action `type:"structure"`
// An array of conditions that define which members of the related time series
// are transformed.
TimeSeriesConditions []*TimeSeriesCondition `type:"list"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesTransformation) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s TimeSeriesTransformation) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *TimeSeriesTransformation) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "TimeSeriesTransformation"}
if s.Action != nil {
if err := s.Action.Validate(); err != nil {
invalidParams.AddNested("Action", err.(request.ErrInvalidParams))
}
}
if s.TimeSeriesConditions != nil {
for i, v := range s.TimeSeriesConditions {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "TimeSeriesConditions", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAction sets the Action field's value.
func (s *TimeSeriesTransformation) SetAction(v *Action) *TimeSeriesTransformation {
s.Action = v
return s
}
// SetTimeSeriesConditions sets the TimeSeriesConditions field's value.
func (s *TimeSeriesTransformation) SetTimeSeriesConditions(v []*TimeSeriesCondition) *TimeSeriesTransformation {
s.TimeSeriesConditions = v
return s
}
type UntagResourceInput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) that identifies the resource for which to
// list the tags.
//
// ResourceArn is a required field
ResourceArn *string `type:"string" required:"true"`
// The keys of the tags to be removed.
//
// TagKeys is a required field
TagKeys []*string `type:"list" required:"true" sensitive:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UntagResourceInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UntagResourceInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *UntagResourceInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"}
if s.ResourceArn == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
}
if s.TagKeys == nil {
invalidParams.Add(request.NewErrParamRequired("TagKeys"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetResourceArn sets the ResourceArn field's value.
func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput {
s.ResourceArn = &v
return s
}
// SetTagKeys sets the TagKeys field's value.
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput {
s.TagKeys = v
return s
}
type UntagResourceOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UntagResourceOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UntagResourceOutput) GoString() string {
return s.String()
}
type UpdateDatasetGroupInput struct {
_ struct{} `type:"structure"`
// An array of the Amazon Resource Names (ARNs) of the datasets to add to the
// dataset group.
//
// DatasetArns is a required field
DatasetArns []*string `type:"list" required:"true"`
// The ARN of the dataset group.
//
// DatasetGroupArn is a required field
DatasetGroupArn *string `type:"string" required:"true"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UpdateDatasetGroupInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UpdateDatasetGroupInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *UpdateDatasetGroupInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "UpdateDatasetGroupInput"}
if s.DatasetArns == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetArns"))
}
if s.DatasetGroupArn == nil {
invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetDatasetArns sets the DatasetArns field's value.
func (s *UpdateDatasetGroupInput) SetDatasetArns(v []*string) *UpdateDatasetGroupInput {
s.DatasetArns = v
return s
}
// SetDatasetGroupArn sets the DatasetGroupArn field's value.
func (s *UpdateDatasetGroupInput) SetDatasetGroupArn(v string) *UpdateDatasetGroupInput {
s.DatasetGroupArn = &v
return s
}
type UpdateDatasetGroupOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UpdateDatasetGroupOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s UpdateDatasetGroupOutput) GoString() string {
return s.String()
}
// The weighted loss value for a quantile. This object is part of the Metrics
// object.
type WeightedQuantileLoss struct {
_ struct{} `type:"structure"`
// The difference between the predicted value and the actual value over the
// quantile, weighted (normalized) by dividing by the sum over all quantiles.
LossValue *float64 `type:"double"`
// The quantile. Quantiles divide a probability distribution into regions of
// equal probability. For example, if the distribution was divided into 5 regions
// of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.
Quantile *float64 `type:"double"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WeightedQuantileLoss) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WeightedQuantileLoss) GoString() string {
return s.String()
}
// SetLossValue sets the LossValue field's value.
func (s *WeightedQuantileLoss) SetLossValue(v float64) *WeightedQuantileLoss {
s.LossValue = &v
return s
}
// SetQuantile sets the Quantile field's value.
func (s *WeightedQuantileLoss) SetQuantile(v float64) *WeightedQuantileLoss {
s.Quantile = &v
return s
}
// Provides a summary of the what-if analysis properties used in the ListWhatIfAnalyses
// operation. To get the complete set of properties, call the DescribeWhatIfAnalysis
// operation, and provide the WhatIfAnalysisArn that is listed in the summary.
type WhatIfAnalysisSummary struct {
_ struct{} `type:"structure"`
// When the what-if analysis was created.
CreationTime *time.Time `type:"timestamp"`
// The Amazon Resource Name (ARN) of the baseline forecast that is being used
// in this what-if analysis.
ForecastArn *string `type:"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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"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 `type:"string"`
// The Amazon Resource Name (ARN) of the what-if analysis.
WhatIfAnalysisArn *string `type:"string"`
// The name of the what-if analysis.
WhatIfAnalysisName *string `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WhatIfAnalysisSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WhatIfAnalysisSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *WhatIfAnalysisSummary) SetCreationTime(v time.Time) *WhatIfAnalysisSummary {
s.CreationTime = &v
return s
}
// SetForecastArn sets the ForecastArn field's value.
func (s *WhatIfAnalysisSummary) SetForecastArn(v string) *WhatIfAnalysisSummary {
s.ForecastArn = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *WhatIfAnalysisSummary) SetLastModificationTime(v time.Time) *WhatIfAnalysisSummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *WhatIfAnalysisSummary) SetMessage(v string) *WhatIfAnalysisSummary {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *WhatIfAnalysisSummary) SetStatus(v string) *WhatIfAnalysisSummary {
s.Status = &v
return s
}
// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.
func (s *WhatIfAnalysisSummary) SetWhatIfAnalysisArn(v string) *WhatIfAnalysisSummary {
s.WhatIfAnalysisArn = &v
return s
}
// SetWhatIfAnalysisName sets the WhatIfAnalysisName field's value.
func (s *WhatIfAnalysisSummary) SetWhatIfAnalysisName(v string) *WhatIfAnalysisSummary {
s.WhatIfAnalysisName = &v
return s
}
// Provides a summary of the what-if forecast export properties used in the
// ListWhatIfForecastExports operation. To get the complete set of properties,
// call the DescribeWhatIfForecastExport operation, and provide the WhatIfForecastExportArn
// that is listed in the summary.
type WhatIfForecastExportSummary struct {
_ struct{} `type:"structure"`
// When the what-if forecast export was created.
CreationTime *time.Time `type:"timestamp"`
// The path to the Amazon Simple Storage Service (Amazon S3) bucket where the
// forecast is exported.
Destination *DataDestination `type:"structure"`
// 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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"string"`
// The status of the what-if forecast export. 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 `type:"string"`
// An array of Amazon Resource Names (ARNs) that define the what-if forecasts
// included in the export.
WhatIfForecastArns []*string `min:"1" type:"list"`
// The Amazon Resource Name (ARN) of the what-if forecast export.
WhatIfForecastExportArn *string `type:"string"`
// The what-if forecast export name.
WhatIfForecastExportName *string `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WhatIfForecastExportSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WhatIfForecastExportSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *WhatIfForecastExportSummary) SetCreationTime(v time.Time) *WhatIfForecastExportSummary {
s.CreationTime = &v
return s
}
// SetDestination sets the Destination field's value.
func (s *WhatIfForecastExportSummary) SetDestination(v *DataDestination) *WhatIfForecastExportSummary {
s.Destination = v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *WhatIfForecastExportSummary) SetLastModificationTime(v time.Time) *WhatIfForecastExportSummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *WhatIfForecastExportSummary) SetMessage(v string) *WhatIfForecastExportSummary {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *WhatIfForecastExportSummary) SetStatus(v string) *WhatIfForecastExportSummary {
s.Status = &v
return s
}
// SetWhatIfForecastArns sets the WhatIfForecastArns field's value.
func (s *WhatIfForecastExportSummary) SetWhatIfForecastArns(v []*string) *WhatIfForecastExportSummary {
s.WhatIfForecastArns = v
return s
}
// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.
func (s *WhatIfForecastExportSummary) SetWhatIfForecastExportArn(v string) *WhatIfForecastExportSummary {
s.WhatIfForecastExportArn = &v
return s
}
// SetWhatIfForecastExportName sets the WhatIfForecastExportName field's value.
func (s *WhatIfForecastExportSummary) SetWhatIfForecastExportName(v string) *WhatIfForecastExportSummary {
s.WhatIfForecastExportName = &v
return s
}
// Provides a summary of the what-if forecast properties used in the ListWhatIfForecasts
// operation. To get the complete set of properties, call the DescribeWhatIfForecast
// operation, and provide the WhatIfForecastArn that is listed in the summary.
type WhatIfForecastSummary struct {
_ struct{} `type:"structure"`
// When the what-if forecast was created.
CreationTime *time.Time `type:"timestamp"`
// 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 `type:"timestamp"`
// If an error occurred, an informational message about the error.
Message *string `type:"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 analysis must be ACTIVE before you can access the
// analysis.
Status *string `type:"string"`
// The Amazon Resource Name (ARN) of the what-if analysis that contains this
// what-if forecast.
WhatIfAnalysisArn *string `type:"string"`
// The Amazon Resource Name (ARN) of the what-if forecast.
WhatIfForecastArn *string `type:"string"`
// The name of the what-if forecast.
WhatIfForecastName *string `min:"1" type:"string"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WhatIfForecastSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WhatIfForecastSummary) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *WhatIfForecastSummary) SetCreationTime(v time.Time) *WhatIfForecastSummary {
s.CreationTime = &v
return s
}
// SetLastModificationTime sets the LastModificationTime field's value.
func (s *WhatIfForecastSummary) SetLastModificationTime(v time.Time) *WhatIfForecastSummary {
s.LastModificationTime = &v
return s
}
// SetMessage sets the Message field's value.
func (s *WhatIfForecastSummary) SetMessage(v string) *WhatIfForecastSummary {
s.Message = &v
return s
}
// SetStatus sets the Status field's value.
func (s *WhatIfForecastSummary) SetStatus(v string) *WhatIfForecastSummary {
s.Status = &v
return s
}
// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.
func (s *WhatIfForecastSummary) SetWhatIfAnalysisArn(v string) *WhatIfForecastSummary {
s.WhatIfAnalysisArn = &v
return s
}
// SetWhatIfForecastArn sets the WhatIfForecastArn field's value.
func (s *WhatIfForecastSummary) SetWhatIfForecastArn(v string) *WhatIfForecastSummary {
s.WhatIfForecastArn = &v
return s
}
// SetWhatIfForecastName sets the WhatIfForecastName field's value.
func (s *WhatIfForecastSummary) SetWhatIfForecastName(v string) *WhatIfForecastSummary {
s.WhatIfForecastName = &v
return s
}
// The metrics for a time range within the evaluation portion of a dataset.
// This object is part of the EvaluationResult object.
//
// The TestWindowStart and TestWindowEnd parameters are determined by the BackTestWindowOffset
// parameter of the EvaluationParameters object.
type WindowSummary struct {
_ struct{} `type:"structure"`
// The type of evaluation.
//
// * SUMMARY - The average metrics across all windows.
//
// * COMPUTED - The metrics for the specified window.
EvaluationType *string `type:"string" enum:"EvaluationType"`
// The number of data points within the window.
ItemCount *int64 `type:"integer"`
// Provides metrics used to evaluate the performance of a predictor.
Metrics *Metrics `type:"structure"`
// The timestamp that defines the end of the window.
TestWindowEnd *time.Time `type:"timestamp"`
// The timestamp that defines the start of the window.
TestWindowStart *time.Time `type:"timestamp"`
}
// String returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WindowSummary) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation.
//
// API parameter values that are decorated as "sensitive" in the API will not
// be included in the string output. The member name will be present, but the
// value will be replaced with "sensitive".
func (s WindowSummary) GoString() string {
return s.String()
}
// SetEvaluationType sets the EvaluationType field's value.
func (s *WindowSummary) SetEvaluationType(v string) *WindowSummary {
s.EvaluationType = &v
return s
}
// SetItemCount sets the ItemCount field's value.
func (s *WindowSummary) SetItemCount(v int64) *WindowSummary {
s.ItemCount = &v
return s
}
// SetMetrics sets the Metrics field's value.
func (s *WindowSummary) SetMetrics(v *Metrics) *WindowSummary {
s.Metrics = v
return s
}
// SetTestWindowEnd sets the TestWindowEnd field's value.
func (s *WindowSummary) SetTestWindowEnd(v time.Time) *WindowSummary {
s.TestWindowEnd = &v
return s
}
// SetTestWindowStart sets the TestWindowStart field's value.
func (s *WindowSummary) SetTestWindowStart(v time.Time) *WindowSummary {
s.TestWindowStart = &v
return s
}
const (
// AttributeTypeString is a AttributeType enum value
AttributeTypeString = "string"
// AttributeTypeInteger is a AttributeType enum value
AttributeTypeInteger = "integer"
// AttributeTypeFloat is a AttributeType enum value
AttributeTypeFloat = "float"
// AttributeTypeTimestamp is a AttributeType enum value
AttributeTypeTimestamp = "timestamp"
// AttributeTypeGeolocation is a AttributeType enum value
AttributeTypeGeolocation = "geolocation"
)
// AttributeType_Values returns all elements of the AttributeType enum
func AttributeType_Values() []string {
return []string{
AttributeTypeString,
AttributeTypeInteger,
AttributeTypeFloat,
AttributeTypeTimestamp,
AttributeTypeGeolocation,
}
}
const (
// AutoMLOverrideStrategyLatencyOptimized is a AutoMLOverrideStrategy enum value
AutoMLOverrideStrategyLatencyOptimized = "LatencyOptimized"
// AutoMLOverrideStrategyAccuracyOptimized is a AutoMLOverrideStrategy enum value
AutoMLOverrideStrategyAccuracyOptimized = "AccuracyOptimized"
)
// AutoMLOverrideStrategy_Values returns all elements of the AutoMLOverrideStrategy enum
func AutoMLOverrideStrategy_Values() []string {
return []string{
AutoMLOverrideStrategyLatencyOptimized,
AutoMLOverrideStrategyAccuracyOptimized,
}
}
const (
// ConditionEquals is a Condition enum value
ConditionEquals = "EQUALS"
// ConditionNotEquals is a Condition enum value
ConditionNotEquals = "NOT_EQUALS"
// ConditionLessThan is a Condition enum value
ConditionLessThan = "LESS_THAN"
// ConditionGreaterThan is a Condition enum value
ConditionGreaterThan = "GREATER_THAN"
)
// Condition_Values returns all elements of the Condition enum
func Condition_Values() []string {
return []string{
ConditionEquals,
ConditionNotEquals,
ConditionLessThan,
ConditionGreaterThan,
}
}
const (
// DatasetTypeTargetTimeSeries is a DatasetType enum value
DatasetTypeTargetTimeSeries = "TARGET_TIME_SERIES"
// DatasetTypeRelatedTimeSeries is a DatasetType enum value
DatasetTypeRelatedTimeSeries = "RELATED_TIME_SERIES"
// DatasetTypeItemMetadata is a DatasetType enum value
DatasetTypeItemMetadata = "ITEM_METADATA"
)
// DatasetType_Values returns all elements of the DatasetType enum
func DatasetType_Values() []string {
return []string{
DatasetTypeTargetTimeSeries,
DatasetTypeRelatedTimeSeries,
DatasetTypeItemMetadata,
}
}
const (
// DayOfWeekMonday is a DayOfWeek enum value
DayOfWeekMonday = "MONDAY"
// DayOfWeekTuesday is a DayOfWeek enum value
DayOfWeekTuesday = "TUESDAY"
// DayOfWeekWednesday is a DayOfWeek enum value
DayOfWeekWednesday = "WEDNESDAY"
// DayOfWeekThursday is a DayOfWeek enum value
DayOfWeekThursday = "THURSDAY"
// DayOfWeekFriday is a DayOfWeek enum value
DayOfWeekFriday = "FRIDAY"
// DayOfWeekSaturday is a DayOfWeek enum value
DayOfWeekSaturday = "SATURDAY"
// DayOfWeekSunday is a DayOfWeek enum value
DayOfWeekSunday = "SUNDAY"
)
// DayOfWeek_Values returns all elements of the DayOfWeek enum
func DayOfWeek_Values() []string {
return []string{
DayOfWeekMonday,
DayOfWeekTuesday,
DayOfWeekWednesday,
DayOfWeekThursday,
DayOfWeekFriday,
DayOfWeekSaturday,
DayOfWeekSunday,
}
}
const (
// DomainRetail is a Domain enum value
DomainRetail = "RETAIL"
// DomainCustom is a Domain enum value
DomainCustom = "CUSTOM"
// DomainInventoryPlanning is a Domain enum value
DomainInventoryPlanning = "INVENTORY_PLANNING"
// DomainEc2Capacity is a Domain enum value
DomainEc2Capacity = "EC2_CAPACITY"
// DomainWorkForce is a Domain enum value
DomainWorkForce = "WORK_FORCE"
// DomainWebTraffic is a Domain enum value
DomainWebTraffic = "WEB_TRAFFIC"
// DomainMetrics is a Domain enum value
DomainMetrics = "METRICS"
)
// Domain_Values returns all elements of the Domain enum
func Domain_Values() []string {
return []string{
DomainRetail,
DomainCustom,
DomainInventoryPlanning,
DomainEc2Capacity,
DomainWorkForce,
DomainWebTraffic,
DomainMetrics,
}
}
const (
// EvaluationTypeSummary is a EvaluationType enum value
EvaluationTypeSummary = "SUMMARY"
// EvaluationTypeComputed is a EvaluationType enum value
EvaluationTypeComputed = "COMPUTED"
)
// EvaluationType_Values returns all elements of the EvaluationType enum
func EvaluationType_Values() []string {
return []string{
EvaluationTypeSummary,
EvaluationTypeComputed,
}
}
const (
// FeaturizationMethodNameFilling is a FeaturizationMethodName enum value
FeaturizationMethodNameFilling = "filling"
)
// FeaturizationMethodName_Values returns all elements of the FeaturizationMethodName enum
func FeaturizationMethodName_Values() []string {
return []string{
FeaturizationMethodNameFilling,
}
}
const (
// FilterConditionStringIs is a FilterConditionString enum value
FilterConditionStringIs = "IS"
// FilterConditionStringIsNot is a FilterConditionString enum value
FilterConditionStringIsNot = "IS_NOT"
)
// FilterConditionString_Values returns all elements of the FilterConditionString enum
func FilterConditionString_Values() []string {
return []string{
FilterConditionStringIs,
FilterConditionStringIsNot,
}
}
const (
// ImportModeFull is a ImportMode enum value
ImportModeFull = "FULL"
// ImportModeIncremental is a ImportMode enum value
ImportModeIncremental = "INCREMENTAL"
)
// ImportMode_Values returns all elements of the ImportMode enum
func ImportMode_Values() []string {
return []string{
ImportModeFull,
ImportModeIncremental,
}
}
const (
// MonthJanuary is a Month enum value
MonthJanuary = "JANUARY"
// MonthFebruary is a Month enum value
MonthFebruary = "FEBRUARY"
// MonthMarch is a Month enum value
MonthMarch = "MARCH"
// MonthApril is a Month enum value
MonthApril = "APRIL"
// MonthMay is a Month enum value
MonthMay = "MAY"
// MonthJune is a Month enum value
MonthJune = "JUNE"
// MonthJuly is a Month enum value
MonthJuly = "JULY"
// MonthAugust is a Month enum value
MonthAugust = "AUGUST"
// MonthSeptember is a Month enum value
MonthSeptember = "SEPTEMBER"
// MonthOctober is a Month enum value
MonthOctober = "OCTOBER"
// MonthNovember is a Month enum value
MonthNovember = "NOVEMBER"
// MonthDecember is a Month enum value
MonthDecember = "DECEMBER"
)
// Month_Values returns all elements of the Month enum
func Month_Values() []string {
return []string{
MonthJanuary,
MonthFebruary,
MonthMarch,
MonthApril,
MonthMay,
MonthJune,
MonthJuly,
MonthAugust,
MonthSeptember,
MonthOctober,
MonthNovember,
MonthDecember,
}
}
const (
// OperationAdd is a Operation enum value
OperationAdd = "ADD"
// OperationSubtract is a Operation enum value
OperationSubtract = "SUBTRACT"
// OperationMultiply is a Operation enum value
OperationMultiply = "MULTIPLY"
// OperationDivide is a Operation enum value
OperationDivide = "DIVIDE"
)
// Operation_Values returns all elements of the Operation enum
func Operation_Values() []string {
return []string{
OperationAdd,
OperationSubtract,
OperationMultiply,
OperationDivide,
}
}
const (
// OptimizationMetricWape is a OptimizationMetric enum value
OptimizationMetricWape = "WAPE"
// OptimizationMetricRmse is a OptimizationMetric enum value
OptimizationMetricRmse = "RMSE"
// OptimizationMetricAverageWeightedQuantileLoss is a OptimizationMetric enum value
OptimizationMetricAverageWeightedQuantileLoss = "AverageWeightedQuantileLoss"
// OptimizationMetricMase is a OptimizationMetric enum value
OptimizationMetricMase = "MASE"
// OptimizationMetricMape is a OptimizationMetric enum value
OptimizationMetricMape = "MAPE"
)
// OptimizationMetric_Values returns all elements of the OptimizationMetric enum
func OptimizationMetric_Values() []string {
return []string{
OptimizationMetricWape,
OptimizationMetricRmse,
OptimizationMetricAverageWeightedQuantileLoss,
OptimizationMetricMase,
OptimizationMetricMape,
}
}
const (
// ScalingTypeAuto is a ScalingType enum value
ScalingTypeAuto = "Auto"
// ScalingTypeLinear is a ScalingType enum value
ScalingTypeLinear = "Linear"
// ScalingTypeLogarithmic is a ScalingType enum value
ScalingTypeLogarithmic = "Logarithmic"
// ScalingTypeReverseLogarithmic is a ScalingType enum value
ScalingTypeReverseLogarithmic = "ReverseLogarithmic"
)
// ScalingType_Values returns all elements of the ScalingType enum
func ScalingType_Values() []string {
return []string{
ScalingTypeAuto,
ScalingTypeLinear,
ScalingTypeLogarithmic,
ScalingTypeReverseLogarithmic,
}
}
const (
// StateActive is a State enum value
StateActive = "Active"
// StateDeleted is a State enum value
StateDeleted = "Deleted"
)
// State_Values returns all elements of the State enum
func State_Values() []string {
return []string{
StateActive,
StateDeleted,
}
}
const (
// TimePointGranularityAll is a TimePointGranularity enum value
TimePointGranularityAll = "ALL"
// TimePointGranularitySpecific is a TimePointGranularity enum value
TimePointGranularitySpecific = "SPECIFIC"
)
// TimePointGranularity_Values returns all elements of the TimePointGranularity enum
func TimePointGranularity_Values() []string {
return []string{
TimePointGranularityAll,
TimePointGranularitySpecific,
}
}
const (
// TimeSeriesGranularityAll is a TimeSeriesGranularity enum value
TimeSeriesGranularityAll = "ALL"
// TimeSeriesGranularitySpecific is a TimeSeriesGranularity enum value
TimeSeriesGranularitySpecific = "SPECIFIC"
)
// TimeSeriesGranularity_Values returns all elements of the TimeSeriesGranularity enum
func TimeSeriesGranularity_Values() []string {
return []string{
TimeSeriesGranularityAll,
TimeSeriesGranularitySpecific,
}
}