forecastservice

package
v1.25.3 Latest Latest
Warning

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

Go to latest
Published: Oct 1, 2019 License: Apache-2.0 Imports: 10 Imported by: 30

Documentation

Overview

Package forecastservice provides the client and types for making API requests to Amazon Forecast Service.

Provides APIs for creating and managing Amazon Forecast resources.

See https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26 for more information on this service.

See forecastservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/forecastservice/

Using the Client

To contact Amazon Forecast Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Forecast Service client ForecastService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/forecastservice/#New

Index

Constants

View Source
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"
)
View Source
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"
)
View Source
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"
)
View Source
const (
	// EvaluationTypeSummary is a EvaluationType enum value
	EvaluationTypeSummary = "SUMMARY"

	// EvaluationTypeComputed is a EvaluationType enum value
	EvaluationTypeComputed = "COMPUTED"
)
View Source
const (
	// FilterConditionStringIs is a FilterConditionString enum value
	FilterConditionStringIs = "IS"

	// FilterConditionStringIsNot is a FilterConditionString enum value
	FilterConditionStringIsNot = "IS_NOT"
)
View Source
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"
)
View Source
const (

	// ErrCodeInvalidInputException for service response error code
	// "InvalidInputException".
	//
	// We can't process the request because it includes an invalid value or a value
	// that exceeds the valid range.
	ErrCodeInvalidInputException = "InvalidInputException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The token is not valid. Tokens expire after 24 hours.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The limit on the number of requests per second has been exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// There is already a resource with that Amazon Resource Name (ARN). Try again
	// with a different ARN.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The specified resource is in use.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// We can't find a resource with that Amazon Resource Name (ARN). Check the
	// ARN and try again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source
const (
	ServiceName = "forecast"  // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "forecast"  // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source
const (
	// FeaturizationMethodNameFilling is a FeaturizationMethodName enum value
	FeaturizationMethodNameFilling = "filling"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CategoricalParameterRange

type CategoricalParameterRange struct {

	// 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"`
	// contains filtered or unexported fields
}

Specifies a categorical hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

func (CategoricalParameterRange) GoString

func (s CategoricalParameterRange) GoString() string

GoString returns the string representation

func (*CategoricalParameterRange) SetName

SetName sets the Name field's value.

func (*CategoricalParameterRange) SetValues

SetValues sets the Values field's value.

func (CategoricalParameterRange) String

func (s CategoricalParameterRange) String() string

String returns the string representation

func (*CategoricalParameterRange) Validate

func (s *CategoricalParameterRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContinuousParameterRange

type ContinuousParameterRange struct {

	// 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.
	// 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:
	//
	// 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 only values greater than
	// 0.
	//
	// ReverseLogarithmic
	//
	// Hyperparemeter 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.
	ScalingType *string `type:"string" enum:"ScalingType"`
	// contains filtered or unexported fields
}

Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

func (ContinuousParameterRange) GoString

func (s ContinuousParameterRange) GoString() string

GoString returns the string representation

func (*ContinuousParameterRange) SetMaxValue

SetMaxValue sets the MaxValue field's value.

func (*ContinuousParameterRange) SetMinValue

SetMinValue sets the MinValue field's value.

func (*ContinuousParameterRange) SetName

SetName sets the Name field's value.

func (*ContinuousParameterRange) SetScalingType

SetScalingType sets the ScalingType field's value.

func (ContinuousParameterRange) String

func (s ContinuousParameterRange) String() string

String returns the string representation

func (*ContinuousParameterRange) Validate

func (s *ContinuousParameterRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetGroupInput

type CreateDatasetGroupInput struct {

	// 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. 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 howitworks-datasets-groups.
	//
	// Domain is a required field
	Domain *string `type:"string" required:"true" enum:"Domain"`
	// contains filtered or unexported fields
}

func (CreateDatasetGroupInput) GoString

func (s CreateDatasetGroupInput) GoString() string

GoString returns the string representation

func (*CreateDatasetGroupInput) SetDatasetArns

func (s *CreateDatasetGroupInput) SetDatasetArns(v []*string) *CreateDatasetGroupInput

SetDatasetArns sets the DatasetArns field's value.

func (*CreateDatasetGroupInput) SetDatasetGroupName

func (s *CreateDatasetGroupInput) SetDatasetGroupName(v string) *CreateDatasetGroupInput

SetDatasetGroupName sets the DatasetGroupName field's value.

func (*CreateDatasetGroupInput) SetDomain

SetDomain sets the Domain field's value.

func (CreateDatasetGroupInput) String

func (s CreateDatasetGroupInput) String() string

String returns the string representation

func (*CreateDatasetGroupInput) Validate

func (s *CreateDatasetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetGroupOutput

type CreateDatasetGroupOutput struct {

	// The Amazon Resource Name (ARN) of the dataset group.
	DatasetGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetGroupOutput) GoString

func (s CreateDatasetGroupOutput) GoString() string

GoString returns the string representation

func (*CreateDatasetGroupOutput) SetDatasetGroupArn

func (s *CreateDatasetGroupOutput) SetDatasetGroupArn(v string) *CreateDatasetGroupOutput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (CreateDatasetGroupOutput) String

func (s CreateDatasetGroupOutput) String() string

String returns the string representation

type CreateDatasetImportJobInput

type CreateDatasetImportJobInput struct {

	// The location of the training data to import and an AWS Identity and Access
	// Management (IAM) role that Amazon Forecast can assume to access the data.
	//
	// 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. It is recommended to include the current
	// timestamp in the name to guard against getting a ResourceAlreadyExistsException
	// exception, for example, 20190721DatasetImport.
	//
	// DatasetImportJobName is a required field
	DatasetImportJobName *string `min:"1" type:"string" required:"true"`

	// The format of timestamps in the dataset. Two formats are supported, dependent
	// on the DataFrequency specified when the dataset was created.
	//
	//    * "yyyy-MM-dd" For data frequencies: Y, M, W, and D
	//
	//    * "yyyy-MM-dd HH:mm:ss" For data frequencies: H, 30min, 15min, and 1min;
	//    and optionally, for: Y, M, W, and D
	TimestampFormat *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetImportJobInput) GoString

func (s CreateDatasetImportJobInput) GoString() string

GoString returns the string representation

func (*CreateDatasetImportJobInput) SetDataSource

SetDataSource sets the DataSource field's value.

func (*CreateDatasetImportJobInput) SetDatasetArn

SetDatasetArn sets the DatasetArn field's value.

func (*CreateDatasetImportJobInput) SetDatasetImportJobName

func (s *CreateDatasetImportJobInput) SetDatasetImportJobName(v string) *CreateDatasetImportJobInput

SetDatasetImportJobName sets the DatasetImportJobName field's value.

func (*CreateDatasetImportJobInput) SetTimestampFormat

SetTimestampFormat sets the TimestampFormat field's value.

func (CreateDatasetImportJobInput) String

String returns the string representation

func (*CreateDatasetImportJobInput) Validate

func (s *CreateDatasetImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetImportJobOutput

type CreateDatasetImportJobOutput struct {

	// The Amazon Resource Name (ARN) of the dataset import job.
	DatasetImportJobArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetImportJobOutput) GoString

func (s CreateDatasetImportJobOutput) GoString() string

GoString returns the string representation

func (*CreateDatasetImportJobOutput) SetDatasetImportJobArn

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (CreateDatasetImportJobOutput) String

String returns the string representation

type CreateDatasetInput

type CreateDatasetInput struct {

	// 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, "D" indicates every day and "15min" indicates
	// every 15 minutes.
	DataFrequency *string `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. 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 howitworks-datasets-groups.
	//
	// Domain is a required field
	Domain *string `type:"string" required:"true" enum:"Domain"`

	// An AWS Key Management Service (KMS) key and the AWS 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 howitworks-domains-ds-types.
	//
	// Schema is a required field
	Schema *Schema `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDatasetInput) GoString

func (s CreateDatasetInput) GoString() string

GoString returns the string representation

func (*CreateDatasetInput) SetDataFrequency

func (s *CreateDatasetInput) SetDataFrequency(v string) *CreateDatasetInput

SetDataFrequency sets the DataFrequency field's value.

func (*CreateDatasetInput) SetDatasetName

func (s *CreateDatasetInput) SetDatasetName(v string) *CreateDatasetInput

SetDatasetName sets the DatasetName field's value.

func (*CreateDatasetInput) SetDatasetType

func (s *CreateDatasetInput) SetDatasetType(v string) *CreateDatasetInput

SetDatasetType sets the DatasetType field's value.

func (*CreateDatasetInput) SetDomain

func (s *CreateDatasetInput) SetDomain(v string) *CreateDatasetInput

SetDomain sets the Domain field's value.

func (*CreateDatasetInput) SetEncryptionConfig

func (s *CreateDatasetInput) SetEncryptionConfig(v *EncryptionConfig) *CreateDatasetInput

SetEncryptionConfig sets the EncryptionConfig field's value.

func (*CreateDatasetInput) SetSchema

func (s *CreateDatasetInput) SetSchema(v *Schema) *CreateDatasetInput

SetSchema sets the Schema field's value.

func (CreateDatasetInput) String

func (s CreateDatasetInput) String() string

String returns the string representation

func (*CreateDatasetInput) Validate

func (s *CreateDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetOutput

type CreateDatasetOutput struct {

	// The Amazon Resource Name (ARN) of the dataset.
	DatasetArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetOutput) GoString

func (s CreateDatasetOutput) GoString() string

GoString returns the string representation

func (*CreateDatasetOutput) SetDatasetArn

func (s *CreateDatasetOutput) SetDatasetArn(v string) *CreateDatasetOutput

SetDatasetArn sets the DatasetArn field's value.

func (CreateDatasetOutput) String

func (s CreateDatasetOutput) String() string

String returns the string representation

type CreateForecastExportJobInput

type CreateForecastExportJobInput struct {

	// The path to the Amazon S3 bucket where you want to save the forecast and
	// an AWS Identity and Access Management (IAM) role that Amazon Forecast can
	// assume to access the bucket.
	//
	// 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"`
	// contains filtered or unexported fields
}

func (CreateForecastExportJobInput) GoString

func (s CreateForecastExportJobInput) GoString() string

GoString returns the string representation

func (*CreateForecastExportJobInput) SetDestination

SetDestination sets the Destination field's value.

func (*CreateForecastExportJobInput) SetForecastArn

SetForecastArn sets the ForecastArn field's value.

func (*CreateForecastExportJobInput) SetForecastExportJobName

func (s *CreateForecastExportJobInput) SetForecastExportJobName(v string) *CreateForecastExportJobInput

SetForecastExportJobName sets the ForecastExportJobName field's value.

func (CreateForecastExportJobInput) String

String returns the string representation

func (*CreateForecastExportJobInput) Validate

func (s *CreateForecastExportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateForecastExportJobOutput

type CreateForecastExportJobOutput struct {

	// The Amazon Resource Name (ARN) of the export job.
	ForecastExportJobArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateForecastExportJobOutput) GoString

GoString returns the string representation

func (*CreateForecastExportJobOutput) SetForecastExportJobArn

SetForecastExportJobArn sets the ForecastExportJobArn field's value.

func (CreateForecastExportJobOutput) String

String returns the string representation

type CreateForecastInput

type CreateForecastInput struct {

	// The name for the forecast.
	//
	// ForecastName is a required field
	ForecastName *string `min:"1" type:"string" required:"true"`

	// 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"`
	// contains filtered or unexported fields
}

func (CreateForecastInput) GoString

func (s CreateForecastInput) GoString() string

GoString returns the string representation

func (*CreateForecastInput) SetForecastName

func (s *CreateForecastInput) SetForecastName(v string) *CreateForecastInput

SetForecastName sets the ForecastName field's value.

func (*CreateForecastInput) SetPredictorArn

func (s *CreateForecastInput) SetPredictorArn(v string) *CreateForecastInput

SetPredictorArn sets the PredictorArn field's value.

func (CreateForecastInput) String

func (s CreateForecastInput) String() string

String returns the string representation

func (*CreateForecastInput) Validate

func (s *CreateForecastInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateForecastOutput

type CreateForecastOutput struct {

	// The Amazon Resource Name (ARN) of the forecast.
	ForecastArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateForecastOutput) GoString

func (s CreateForecastOutput) GoString() string

GoString returns the string representation

func (*CreateForecastOutput) SetForecastArn

func (s *CreateForecastOutput) SetForecastArn(v string) *CreateForecastOutput

SetForecastArn sets the ForecastArn field's value.

func (CreateForecastOutput) String

func (s CreateForecastOutput) String() string

String returns the string representation

type CreatePredictorInput

type CreatePredictorInput struct {

	// 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/Deep_AR_Plus - supports hyperparameter
	//    optimization (HPO)
	//
	//    * arn:aws:forecast:::algorithm/ETS
	//
	//    * arn:aws:forecast:::algorithm/NPTS
	//
	//    * arn:aws:forecast:::algorithm/Prophet
	AlgorithmArn *string `type:"string"`

	// An AWS Key Management Service (KMS) key and the AWS 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.
	//
	// ForecastHorizon is a required field
	ForecastHorizon *int64 `type:"integer" required:"true"`

	// 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.
	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"`

	// Whether to perform AutoML. The default value is false. In this case, you
	// are required to specify an algorithm.
	//
	// If you want Amazon Forecast to evaluate the algorithms it provides and choose
	// the best algorithm and configuration for your training dataset, set PerformAutoML
	// to true. This is a good option if you aren't sure which algorithm is suitable
	// for your application.
	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
	// 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 supply the HyperParameterTuningJobConfig
	// object. The tuning job specifies an objective metric, the hyperparameters
	// to optimize, and the valid range for each hyperparameter.
	//
	// The following algorithms support HPO:
	//
	//    * DeepAR+
	PerformHPO *bool `type:"boolean"`

	// A name for the predictor.
	//
	// PredictorName is a required field
	PredictorName *string `min:"1" type:"string" required:"true"`

	// The training parameters to override for model training. The parameters that
	// you can override are listed in the individual algorithms in aws-forecast-choosing-recipes.
	TrainingParameters map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreatePredictorInput) GoString

func (s CreatePredictorInput) GoString() string

GoString returns the string representation

func (*CreatePredictorInput) SetAlgorithmArn

func (s *CreatePredictorInput) SetAlgorithmArn(v string) *CreatePredictorInput

SetAlgorithmArn sets the AlgorithmArn field's value.

func (*CreatePredictorInput) SetEncryptionConfig

func (s *CreatePredictorInput) SetEncryptionConfig(v *EncryptionConfig) *CreatePredictorInput

SetEncryptionConfig sets the EncryptionConfig field's value.

func (*CreatePredictorInput) SetEvaluationParameters

func (s *CreatePredictorInput) SetEvaluationParameters(v *EvaluationParameters) *CreatePredictorInput

SetEvaluationParameters sets the EvaluationParameters field's value.

func (*CreatePredictorInput) SetFeaturizationConfig

func (s *CreatePredictorInput) SetFeaturizationConfig(v *FeaturizationConfig) *CreatePredictorInput

SetFeaturizationConfig sets the FeaturizationConfig field's value.

func (*CreatePredictorInput) SetForecastHorizon

func (s *CreatePredictorInput) SetForecastHorizon(v int64) *CreatePredictorInput

SetForecastHorizon sets the ForecastHorizon field's value.

func (*CreatePredictorInput) SetHPOConfig

SetHPOConfig sets the HPOConfig field's value.

func (*CreatePredictorInput) SetInputDataConfig

func (s *CreatePredictorInput) SetInputDataConfig(v *InputDataConfig) *CreatePredictorInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreatePredictorInput) SetPerformAutoML

func (s *CreatePredictorInput) SetPerformAutoML(v bool) *CreatePredictorInput

SetPerformAutoML sets the PerformAutoML field's value.

func (*CreatePredictorInput) SetPerformHPO

func (s *CreatePredictorInput) SetPerformHPO(v bool) *CreatePredictorInput

SetPerformHPO sets the PerformHPO field's value.

func (*CreatePredictorInput) SetPredictorName

func (s *CreatePredictorInput) SetPredictorName(v string) *CreatePredictorInput

SetPredictorName sets the PredictorName field's value.

func (*CreatePredictorInput) SetTrainingParameters

func (s *CreatePredictorInput) SetTrainingParameters(v map[string]*string) *CreatePredictorInput

SetTrainingParameters sets the TrainingParameters field's value.

func (CreatePredictorInput) String

func (s CreatePredictorInput) String() string

String returns the string representation

func (*CreatePredictorInput) Validate

func (s *CreatePredictorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePredictorOutput

type CreatePredictorOutput struct {

	// The Amazon Resource Name (ARN) of the predictor.
	PredictorArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreatePredictorOutput) GoString

func (s CreatePredictorOutput) GoString() string

GoString returns the string representation

func (*CreatePredictorOutput) SetPredictorArn

func (s *CreatePredictorOutput) SetPredictorArn(v string) *CreatePredictorOutput

SetPredictorArn sets the PredictorArn field's value.

func (CreatePredictorOutput) String

func (s CreatePredictorOutput) String() string

String returns the string representation

type DataDestination

type DataDestination struct {

	// 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"`
	// contains filtered or unexported fields
}

The destination of an exported forecast and credentials to access the location. This object is submitted in the CreateForecastExportJob request.

func (DataDestination) GoString

func (s DataDestination) GoString() string

GoString returns the string representation

func (*DataDestination) SetS3Config

func (s *DataDestination) SetS3Config(v *S3Config) *DataDestination

SetS3Config sets the S3Config field's value.

func (DataDestination) String

func (s DataDestination) String() string

String returns the string representation

func (*DataDestination) Validate

func (s *DataDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataSource

type DataSource struct {

	// The path to the training 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"`
	// contains filtered or unexported fields
}

The source of your training data and credentials to access the data. This object is submitted in the CreateDatasetImportJob request.

func (DataSource) GoString

func (s DataSource) GoString() string

GoString returns the string representation

func (*DataSource) SetS3Config

func (s *DataSource) SetS3Config(v *S3Config) *DataSource

SetS3Config sets the S3Config field's value.

func (DataSource) String

func (s DataSource) String() string

String returns the string representation

func (*DataSource) Validate

func (s *DataSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetGroupSummary

type DatasetGroupSummary struct {

	// When the datase 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
	// operation. While the dataset group is being updated, LastModificationTime
	// is the current query time.
	LastModificationTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To get the complete set of properties, call the DescribeDatasetGroup operation, and provide the listed DatasetGroupArn.

func (DatasetGroupSummary) GoString

func (s DatasetGroupSummary) GoString() string

GoString returns the string representation

func (*DatasetGroupSummary) SetCreationTime

func (s *DatasetGroupSummary) SetCreationTime(v time.Time) *DatasetGroupSummary

SetCreationTime sets the CreationTime field's value.

func (*DatasetGroupSummary) SetDatasetGroupArn

func (s *DatasetGroupSummary) SetDatasetGroupArn(v string) *DatasetGroupSummary

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*DatasetGroupSummary) SetDatasetGroupName

func (s *DatasetGroupSummary) SetDatasetGroupName(v string) *DatasetGroupSummary

SetDatasetGroupName sets the DatasetGroupName field's value.

func (*DatasetGroupSummary) SetLastModificationTime

func (s *DatasetGroupSummary) SetLastModificationTime(v time.Time) *DatasetGroupSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (DatasetGroupSummary) String

func (s DatasetGroupSummary) String() string

String returns the string representation

type DatasetImportJobSummary

type DatasetImportJobSummary struct {

	// When the dataset import job was created.
	CreationTime *time.Time `type:"timestamp"`

	// The location of the Amazon S3 bucket that contains the training data.
	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"`

	// Dependent on the status as follows:
	//
	//    * CREATE_PENDING - same as CreationTime
	//
	//    * CREATE_IN_PROGRESS - the current timestamp
	//
	//    * 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. The status is reflected in the status
	// of the dataset. For example, when the import job status is CREATE_IN_PROGRESS,
	// the status of the dataset is UPDATE_IN_PROGRESS. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the DescribeDatasetImportJob operation, and provide the listed DatasetImportJobArn.

func (DatasetImportJobSummary) GoString

func (s DatasetImportJobSummary) GoString() string

GoString returns the string representation

func (*DatasetImportJobSummary) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*DatasetImportJobSummary) SetDataSource

SetDataSource sets the DataSource field's value.

func (*DatasetImportJobSummary) SetDatasetImportJobArn

func (s *DatasetImportJobSummary) SetDatasetImportJobArn(v string) *DatasetImportJobSummary

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (*DatasetImportJobSummary) SetDatasetImportJobName

func (s *DatasetImportJobSummary) SetDatasetImportJobName(v string) *DatasetImportJobSummary

SetDatasetImportJobName sets the DatasetImportJobName field's value.

func (*DatasetImportJobSummary) SetLastModificationTime

func (s *DatasetImportJobSummary) SetLastModificationTime(v time.Time) *DatasetImportJobSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (*DatasetImportJobSummary) SetMessage

SetMessage sets the Message field's value.

func (*DatasetImportJobSummary) SetStatus

SetStatus sets the Status field's value.

func (DatasetImportJobSummary) String

func (s DatasetImportJobSummary) String() string

String returns the string representation

type DatasetSummary

type DatasetSummary struct {

	// 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 the dataset is created, LastModificationTime is the same as CreationTime.
	// After a CreateDatasetImportJob operation is called, LastModificationTime
	// is when the import job finished or failed. While data is being imported to
	// the dataset, LastModificationTime is the current query time.
	LastModificationTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides a summary of the dataset properties used in the ListDatasets operation. To get the complete set of properties, call the DescribeDataset operation, and provide the listed DatasetArn.

func (DatasetSummary) GoString

func (s DatasetSummary) GoString() string

GoString returns the string representation

func (*DatasetSummary) SetCreationTime

func (s *DatasetSummary) SetCreationTime(v time.Time) *DatasetSummary

SetCreationTime sets the CreationTime field's value.

func (*DatasetSummary) SetDatasetArn

func (s *DatasetSummary) SetDatasetArn(v string) *DatasetSummary

SetDatasetArn sets the DatasetArn field's value.

func (*DatasetSummary) SetDatasetName

func (s *DatasetSummary) SetDatasetName(v string) *DatasetSummary

SetDatasetName sets the DatasetName field's value.

func (*DatasetSummary) SetDatasetType

func (s *DatasetSummary) SetDatasetType(v string) *DatasetSummary

SetDatasetType sets the DatasetType field's value.

func (*DatasetSummary) SetDomain

func (s *DatasetSummary) SetDomain(v string) *DatasetSummary

SetDomain sets the Domain field's value.

func (*DatasetSummary) SetLastModificationTime

func (s *DatasetSummary) SetLastModificationTime(v time.Time) *DatasetSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (DatasetSummary) String

func (s DatasetSummary) String() string

String returns the string representation

type DeleteDatasetGroupInput

type DeleteDatasetGroupInput struct {

	// The Amazon Resource Name (ARN) of the dataset group to delete.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDatasetGroupInput) GoString

func (s DeleteDatasetGroupInput) GoString() string

GoString returns the string representation

func (*DeleteDatasetGroupInput) SetDatasetGroupArn

func (s *DeleteDatasetGroupInput) SetDatasetGroupArn(v string) *DeleteDatasetGroupInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (DeleteDatasetGroupInput) String

func (s DeleteDatasetGroupInput) String() string

String returns the string representation

func (*DeleteDatasetGroupInput) Validate

func (s *DeleteDatasetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDatasetGroupOutput

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

func (DeleteDatasetGroupOutput) GoString

func (s DeleteDatasetGroupOutput) GoString() string

GoString returns the string representation

func (DeleteDatasetGroupOutput) String

func (s DeleteDatasetGroupOutput) String() string

String returns the string representation

type DeleteDatasetImportJobInput

type DeleteDatasetImportJobInput struct {

	// The Amazon Resource Name (ARN) of the dataset import job to delete.
	//
	// DatasetImportJobArn is a required field
	DatasetImportJobArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDatasetImportJobInput) GoString

func (s DeleteDatasetImportJobInput) GoString() string

GoString returns the string representation

func (*DeleteDatasetImportJobInput) SetDatasetImportJobArn

func (s *DeleteDatasetImportJobInput) SetDatasetImportJobArn(v string) *DeleteDatasetImportJobInput

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (DeleteDatasetImportJobInput) String

String returns the string representation

func (*DeleteDatasetImportJobInput) Validate

func (s *DeleteDatasetImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDatasetImportJobOutput

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

func (DeleteDatasetImportJobOutput) GoString

func (s DeleteDatasetImportJobOutput) GoString() string

GoString returns the string representation

func (DeleteDatasetImportJobOutput) String

String returns the string representation

type DeleteDatasetInput

type DeleteDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset to delete.
	//
	// DatasetArn is a required field
	DatasetArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDatasetInput) GoString

func (s DeleteDatasetInput) GoString() string

GoString returns the string representation

func (*DeleteDatasetInput) SetDatasetArn

func (s *DeleteDatasetInput) SetDatasetArn(v string) *DeleteDatasetInput

SetDatasetArn sets the DatasetArn field's value.

func (DeleteDatasetInput) String

func (s DeleteDatasetInput) String() string

String returns the string representation

func (*DeleteDatasetInput) Validate

func (s *DeleteDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDatasetOutput

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

func (DeleteDatasetOutput) GoString

func (s DeleteDatasetOutput) GoString() string

GoString returns the string representation

func (DeleteDatasetOutput) String

func (s DeleteDatasetOutput) String() string

String returns the string representation

type DeleteForecastExportJobInput

type DeleteForecastExportJobInput struct {

	// The Amazon Resource Name (ARN) of the forecast export job to delete.
	//
	// ForecastExportJobArn is a required field
	ForecastExportJobArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteForecastExportJobInput) GoString

func (s DeleteForecastExportJobInput) GoString() string

GoString returns the string representation

func (*DeleteForecastExportJobInput) SetForecastExportJobArn

func (s *DeleteForecastExportJobInput) SetForecastExportJobArn(v string) *DeleteForecastExportJobInput

SetForecastExportJobArn sets the ForecastExportJobArn field's value.

func (DeleteForecastExportJobInput) String

String returns the string representation

func (*DeleteForecastExportJobInput) Validate

func (s *DeleteForecastExportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteForecastExportJobOutput

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

func (DeleteForecastExportJobOutput) GoString

GoString returns the string representation

func (DeleteForecastExportJobOutput) String

String returns the string representation

type DeleteForecastInput

type DeleteForecastInput struct {

	// The Amazon Resource Name (ARN) of the forecast to delete.
	//
	// ForecastArn is a required field
	ForecastArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteForecastInput) GoString

func (s DeleteForecastInput) GoString() string

GoString returns the string representation

func (*DeleteForecastInput) SetForecastArn

func (s *DeleteForecastInput) SetForecastArn(v string) *DeleteForecastInput

SetForecastArn sets the ForecastArn field's value.

func (DeleteForecastInput) String

func (s DeleteForecastInput) String() string

String returns the string representation

func (*DeleteForecastInput) Validate

func (s *DeleteForecastInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteForecastOutput

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

func (DeleteForecastOutput) GoString

func (s DeleteForecastOutput) GoString() string

GoString returns the string representation

func (DeleteForecastOutput) String

func (s DeleteForecastOutput) String() string

String returns the string representation

type DeletePredictorInput

type DeletePredictorInput struct {

	// The Amazon Resource Name (ARN) of the predictor to delete.
	//
	// PredictorArn is a required field
	PredictorArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePredictorInput) GoString

func (s DeletePredictorInput) GoString() string

GoString returns the string representation

func (*DeletePredictorInput) SetPredictorArn

func (s *DeletePredictorInput) SetPredictorArn(v string) *DeletePredictorInput

SetPredictorArn sets the PredictorArn field's value.

func (DeletePredictorInput) String

func (s DeletePredictorInput) String() string

String returns the string representation

func (*DeletePredictorInput) Validate

func (s *DeletePredictorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePredictorOutput

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

func (DeletePredictorOutput) GoString

func (s DeletePredictorOutput) GoString() string

GoString returns the string representation

func (DeletePredictorOutput) String

func (s DeletePredictorOutput) String() string

String returns the string representation

type DescribeDatasetGroupInput

type DescribeDatasetGroupInput struct {

	// The Amazon Resource Name (ARN) of the dataset group.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatasetGroupInput) GoString

func (s DescribeDatasetGroupInput) GoString() string

GoString returns the string representation

func (*DescribeDatasetGroupInput) SetDatasetGroupArn

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (DescribeDatasetGroupInput) String

func (s DescribeDatasetGroupInput) String() string

String returns the string representation

func (*DescribeDatasetGroupInput) Validate

func (s *DescribeDatasetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatasetGroupOutput

type DescribeDatasetGroupOutput struct {

	// 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. 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 howitworks-datasets-groups.
	Domain *string `type:"string" enum:"Domain"`

	// When the dataset group was created or last updated from a call to the UpdateDatasetGroup
	// operation. While the dataset group is being updated, LastModificationTime
	// is the current query time.
	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 the UpdateDatasetGroup operation is called.
	//
	// The Status of the dataset group must be ACTIVE before creating a predictor
	// using the dataset group.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDatasetGroupOutput) GoString

func (s DescribeDatasetGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeDatasetGroupOutput) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*DescribeDatasetGroupOutput) SetDatasetArns

SetDatasetArns sets the DatasetArns field's value.

func (*DescribeDatasetGroupOutput) SetDatasetGroupArn

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*DescribeDatasetGroupOutput) SetDatasetGroupName

SetDatasetGroupName sets the DatasetGroupName field's value.

func (*DescribeDatasetGroupOutput) SetDomain

SetDomain sets the Domain field's value.

func (*DescribeDatasetGroupOutput) SetLastModificationTime

func (s *DescribeDatasetGroupOutput) SetLastModificationTime(v time.Time) *DescribeDatasetGroupOutput

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeDatasetGroupOutput) SetStatus

SetStatus sets the Status field's value.

func (DescribeDatasetGroupOutput) String

String returns the string representation

type DescribeDatasetImportJobInput

type DescribeDatasetImportJobInput struct {

	// The Amazon Resource Name (ARN) of the dataset import job.
	//
	// DatasetImportJobArn is a required field
	DatasetImportJobArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatasetImportJobInput) GoString

GoString returns the string representation

func (*DescribeDatasetImportJobInput) SetDatasetImportJobArn

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (DescribeDatasetImportJobInput) String

String returns the string representation

func (*DescribeDatasetImportJobInput) Validate

func (s *DescribeDatasetImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatasetImportJobOutput

type DescribeDatasetImportJobOutput struct {

	// When the dataset import job was created.
	CreationTime *time.Time `type:"timestamp"`

	// The size of the dataset in gigabytes (GB) after completion of the import
	// job.
	DataSize *float64 `type:"double"`

	// The location of the training data to import. The training data must be stored
	// in an Amazon S3 bucket.
	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"`

	// Statistical information about each field in the input data.
	FieldStatistics map[string]*Statistics `type:"map"`

	// Dependent on the status as follows:
	//
	//    * CREATE_PENDING - same as CreationTime
	//
	//    * CREATE_IN_PROGRESS - the current timestamp
	//
	//    * 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. The status is reflected in the status
	// of the dataset. For example, when the import job status is CREATE_IN_PROGRESS,
	// the status of the dataset is UPDATE_IN_PROGRESS. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`

	// The format of timestamps in the dataset. Two formats are supported dependent
	// on the DataFrequency specified when the dataset was created.
	//
	//    * "yyyy-MM-dd" For data frequencies: Y, M, W, and D
	//
	//    * "yyyy-MM-dd HH:mm:ss" For data frequencies: H, 30min, 15min, and 1min;
	//    and optionally, for: Y, M, W, and D
	TimestampFormat *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDatasetImportJobOutput) GoString

GoString returns the string representation

func (*DescribeDatasetImportJobOutput) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*DescribeDatasetImportJobOutput) SetDataSize

SetDataSize sets the DataSize field's value.

func (*DescribeDatasetImportJobOutput) SetDataSource

SetDataSource sets the DataSource field's value.

func (*DescribeDatasetImportJobOutput) SetDatasetArn

SetDatasetArn sets the DatasetArn field's value.

func (*DescribeDatasetImportJobOutput) SetDatasetImportJobArn

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (*DescribeDatasetImportJobOutput) SetDatasetImportJobName

SetDatasetImportJobName sets the DatasetImportJobName field's value.

func (*DescribeDatasetImportJobOutput) SetFieldStatistics

SetFieldStatistics sets the FieldStatistics field's value.

func (*DescribeDatasetImportJobOutput) SetLastModificationTime

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeDatasetImportJobOutput) SetMessage

SetMessage sets the Message field's value.

func (*DescribeDatasetImportJobOutput) SetStatus

SetStatus sets the Status field's value.

func (*DescribeDatasetImportJobOutput) SetTimestampFormat

SetTimestampFormat sets the TimestampFormat field's value.

func (DescribeDatasetImportJobOutput) String

String returns the string representation

type DescribeDatasetInput

type DescribeDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset.
	//
	// DatasetArn is a required field
	DatasetArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatasetInput) GoString

func (s DescribeDatasetInput) GoString() string

GoString returns the string representation

func (*DescribeDatasetInput) SetDatasetArn

func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput

SetDatasetArn sets the DatasetArn field's value.

func (DescribeDatasetInput) String

func (s DescribeDatasetInput) String() string

String returns the string representation

func (*DescribeDatasetInput) Validate

func (s *DescribeDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatasetOutput

type DescribeDatasetOutput struct {

	// 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 `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 dataset domain.
	Domain *string `type:"string" enum:"Domain"`

	// An AWS Key Management Service (KMS) key and the AWS Identity and Access Management
	// (IAM) role that Amazon Forecast can assume to access the key.
	EncryptionConfig *EncryptionConfig `type:"structure"`

	// When the dataset is created, LastModificationTime is the same as CreationTime.
	// After a CreateDatasetImportJob operation is called, LastModificationTime
	// is when the import job finished or failed. While data is being imported to
	// the dataset, LastModificationTime is the current query time.
	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 operation. During this time, the status reflects
	// 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"`
	// contains filtered or unexported fields
}

func (DescribeDatasetOutput) GoString

func (s DescribeDatasetOutput) GoString() string

GoString returns the string representation

func (*DescribeDatasetOutput) SetCreationTime

func (s *DescribeDatasetOutput) SetCreationTime(v time.Time) *DescribeDatasetOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeDatasetOutput) SetDataFrequency

func (s *DescribeDatasetOutput) SetDataFrequency(v string) *DescribeDatasetOutput

SetDataFrequency sets the DataFrequency field's value.

func (*DescribeDatasetOutput) SetDatasetArn

func (s *DescribeDatasetOutput) SetDatasetArn(v string) *DescribeDatasetOutput

SetDatasetArn sets the DatasetArn field's value.

func (*DescribeDatasetOutput) SetDatasetName

func (s *DescribeDatasetOutput) SetDatasetName(v string) *DescribeDatasetOutput

SetDatasetName sets the DatasetName field's value.

func (*DescribeDatasetOutput) SetDatasetType

func (s *DescribeDatasetOutput) SetDatasetType(v string) *DescribeDatasetOutput

SetDatasetType sets the DatasetType field's value.

func (*DescribeDatasetOutput) SetDomain

SetDomain sets the Domain field's value.

func (*DescribeDatasetOutput) SetEncryptionConfig

func (s *DescribeDatasetOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribeDatasetOutput

SetEncryptionConfig sets the EncryptionConfig field's value.

func (*DescribeDatasetOutput) SetLastModificationTime

func (s *DescribeDatasetOutput) SetLastModificationTime(v time.Time) *DescribeDatasetOutput

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeDatasetOutput) SetSchema

SetSchema sets the Schema field's value.

func (*DescribeDatasetOutput) SetStatus

SetStatus sets the Status field's value.

func (DescribeDatasetOutput) String

func (s DescribeDatasetOutput) String() string

String returns the string representation

type DescribeForecastExportJobInput

type DescribeForecastExportJobInput struct {

	// The Amazon Resource Name (ARN) of the forecast export job.
	//
	// ForecastExportJobArn is a required field
	ForecastExportJobArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeForecastExportJobInput) GoString

GoString returns the string representation

func (*DescribeForecastExportJobInput) SetForecastExportJobArn

SetForecastExportJobArn sets the ForecastExportJobArn field's value.

func (DescribeForecastExportJobInput) String

String returns the string representation

func (*DescribeForecastExportJobInput) Validate

func (s *DescribeForecastExportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeForecastExportJobOutput

type DescribeForecastExportJobOutput struct {

	// When the forecast export job was created.
	CreationTime *time.Time `type:"timestamp"`

	// The path to the AWS 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"`

	// When the last successful export job finished.
	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. One of the following states:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * 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 Amazon S3 bucket.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeForecastExportJobOutput) GoString

GoString returns the string representation

func (*DescribeForecastExportJobOutput) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*DescribeForecastExportJobOutput) SetDestination

SetDestination sets the Destination field's value.

func (*DescribeForecastExportJobOutput) SetForecastArn

SetForecastArn sets the ForecastArn field's value.

func (*DescribeForecastExportJobOutput) SetForecastExportJobArn

SetForecastExportJobArn sets the ForecastExportJobArn field's value.

func (*DescribeForecastExportJobOutput) SetForecastExportJobName

SetForecastExportJobName sets the ForecastExportJobName field's value.

func (*DescribeForecastExportJobOutput) SetLastModificationTime

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeForecastExportJobOutput) SetMessage

SetMessage sets the Message field's value.

func (*DescribeForecastExportJobOutput) SetStatus

SetStatus sets the Status field's value.

func (DescribeForecastExportJobOutput) String

String returns the string representation

type DescribeForecastInput

type DescribeForecastInput struct {

	// The Amazon Resource Name (ARN) of the forecast.
	//
	// ForecastArn is a required field
	ForecastArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeForecastInput) GoString

func (s DescribeForecastInput) GoString() string

GoString returns the string representation

func (*DescribeForecastInput) SetForecastArn

func (s *DescribeForecastInput) SetForecastArn(v string) *DescribeForecastInput

SetForecastArn sets the ForecastArn field's value.

func (DescribeForecastInput) String

func (s DescribeForecastInput) String() string

String returns the string representation

func (*DescribeForecastInput) Validate

func (s *DescribeForecastInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeForecastOutput

type DescribeForecastOutput struct {

	// 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 same forecast ARN as given in the request.
	ForecastArn *string `type:"string"`

	// The name of the forecast.
	ForecastName *string `min:"1" type:"string"`

	// Initially, the same as CreationTime (status is CREATE_PENDING). Updated when
	// inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS),
	// and when inference is complete (status changed to ACTIVE) or fails (status
	// changed to CREATE_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
	//
	//    * 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"`
	// contains filtered or unexported fields
}

func (DescribeForecastOutput) GoString

func (s DescribeForecastOutput) GoString() string

GoString returns the string representation

func (*DescribeForecastOutput) SetCreationTime

func (s *DescribeForecastOutput) SetCreationTime(v time.Time) *DescribeForecastOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeForecastOutput) SetDatasetGroupArn

func (s *DescribeForecastOutput) SetDatasetGroupArn(v string) *DescribeForecastOutput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*DescribeForecastOutput) SetForecastArn

SetForecastArn sets the ForecastArn field's value.

func (*DescribeForecastOutput) SetForecastName

func (s *DescribeForecastOutput) SetForecastName(v string) *DescribeForecastOutput

SetForecastName sets the ForecastName field's value.

func (*DescribeForecastOutput) SetLastModificationTime

func (s *DescribeForecastOutput) SetLastModificationTime(v time.Time) *DescribeForecastOutput

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeForecastOutput) SetMessage

SetMessage sets the Message field's value.

func (*DescribeForecastOutput) SetPredictorArn

func (s *DescribeForecastOutput) SetPredictorArn(v string) *DescribeForecastOutput

SetPredictorArn sets the PredictorArn field's value.

func (*DescribeForecastOutput) SetStatus

SetStatus sets the Status field's value.

func (DescribeForecastOutput) String

func (s DescribeForecastOutput) String() string

String returns the string representation

type DescribePredictorInput

type DescribePredictorInput struct {

	// The Amazon Resource Name (ARN) of the predictor that you want information
	// about.
	//
	// PredictorArn is a required field
	PredictorArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePredictorInput) GoString

func (s DescribePredictorInput) GoString() string

GoString returns the string representation

func (*DescribePredictorInput) SetPredictorArn

func (s *DescribePredictorInput) SetPredictorArn(v string) *DescribePredictorInput

SetPredictorArn sets the PredictorArn field's value.

func (DescribePredictorInput) String

func (s DescribePredictorInput) String() string

String returns the string representation

func (*DescribePredictorInput) Validate

func (s *DescribePredictorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePredictorOutput

type DescribePredictorOutput struct {

	// 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"`

	// When the model training task was created.
	CreationTime *time.Time `type:"timestamp"`

	// An array of ARNs of the dataset import jobs used to import training data
	// for the predictor.
	DatasetImportJobArns []*string `type:"list"`

	// An AWS Key Management Service (KMS) key and the AWS 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 *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 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"`

	// Initially, the same as CreationTime (status is CREATE_PENDING). Updated when
	// training starts (status changed to CREATE_IN_PROGRESS), and when training
	// is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
	LastModificationTime *time.Time `type:"timestamp"`

	// If an error occurred, an informational message about the error.
	Message *string `type:"string"`

	// Whether the predictor is set to perform AutoML.
	PerformAutoML *bool `type:"boolean"`

	// Whether the predictor is set to perform HPO.
	PerformHPO *bool `type:"boolean"`

	// The ARN of the predictor.
	PredictorArn *string `min:"1" type:"string"`

	// 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
	//
	//    * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
	//
	// The Status of the predictor must be ACTIVE before using the predictor to
	// create a forecast.
	Status *string `type:"string"`

	// The training parameters to override for model training. The parameters that
	// you can override are listed in the individual algorithms in aws-forecast-choosing-recipes.
	TrainingParameters map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (DescribePredictorOutput) GoString

func (s DescribePredictorOutput) GoString() string

GoString returns the string representation

func (*DescribePredictorOutput) SetAlgorithmArn

SetAlgorithmArn sets the AlgorithmArn field's value.

func (*DescribePredictorOutput) SetAutoMLAlgorithmArns

func (s *DescribePredictorOutput) SetAutoMLAlgorithmArns(v []*string) *DescribePredictorOutput

SetAutoMLAlgorithmArns sets the AutoMLAlgorithmArns field's value.

func (*DescribePredictorOutput) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*DescribePredictorOutput) SetDatasetImportJobArns

func (s *DescribePredictorOutput) SetDatasetImportJobArns(v []*string) *DescribePredictorOutput

SetDatasetImportJobArns sets the DatasetImportJobArns field's value.

func (*DescribePredictorOutput) SetEncryptionConfig

SetEncryptionConfig sets the EncryptionConfig field's value.

func (*DescribePredictorOutput) SetEvaluationParameters

SetEvaluationParameters sets the EvaluationParameters field's value.

func (*DescribePredictorOutput) SetFeaturizationConfig

SetFeaturizationConfig sets the FeaturizationConfig field's value.

func (*DescribePredictorOutput) SetForecastHorizon

func (s *DescribePredictorOutput) SetForecastHorizon(v int64) *DescribePredictorOutput

SetForecastHorizon sets the ForecastHorizon field's value.

func (*DescribePredictorOutput) SetHPOConfig

SetHPOConfig sets the HPOConfig field's value.

func (*DescribePredictorOutput) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*DescribePredictorOutput) SetLastModificationTime

func (s *DescribePredictorOutput) SetLastModificationTime(v time.Time) *DescribePredictorOutput

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribePredictorOutput) SetMessage

SetMessage sets the Message field's value.

func (*DescribePredictorOutput) SetPerformAutoML

func (s *DescribePredictorOutput) SetPerformAutoML(v bool) *DescribePredictorOutput

SetPerformAutoML sets the PerformAutoML field's value.

func (*DescribePredictorOutput) SetPerformHPO

SetPerformHPO sets the PerformHPO field's value.

func (*DescribePredictorOutput) SetPredictorArn

SetPredictorArn sets the PredictorArn field's value.

func (*DescribePredictorOutput) SetPredictorName

func (s *DescribePredictorOutput) SetPredictorName(v string) *DescribePredictorOutput

SetPredictorName sets the PredictorName field's value.

func (*DescribePredictorOutput) SetStatus

SetStatus sets the Status field's value.

func (*DescribePredictorOutput) SetTrainingParameters

func (s *DescribePredictorOutput) SetTrainingParameters(v map[string]*string) *DescribePredictorOutput

SetTrainingParameters sets the TrainingParameters field's value.

func (DescribePredictorOutput) String

func (s DescribePredictorOutput) String() string

String returns the string representation

type EncryptionConfig

type EncryptionConfig struct {

	// The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
	//
	// KMSKeyArn is a required field
	KMSKeyArn *string `type:"string" required:"true"`

	// The ARN of the AWS Identity and Access Management (IAM) role that Amazon
	// Forecast can assume to access the AWS KMS key.
	//
	// Cross-account pass role is not allowed. If you pass a role that doesn't belong
	// to your account, an InvalidInputException is thrown.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. This object is optionally submitted in the CreateDataset and CreatePredictor requests.

func (EncryptionConfig) GoString

func (s EncryptionConfig) GoString() string

GoString returns the string representation

func (*EncryptionConfig) SetKMSKeyArn

func (s *EncryptionConfig) SetKMSKeyArn(v string) *EncryptionConfig

SetKMSKeyArn sets the KMSKeyArn field's value.

func (*EncryptionConfig) SetRoleArn

func (s *EncryptionConfig) SetRoleArn(v string) *EncryptionConfig

SetRoleArn sets the RoleArn field's value.

func (EncryptionConfig) String

func (s EncryptionConfig) String() string

String returns the string representation

func (*EncryptionConfig) Validate

func (s *EncryptionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EvaluationParameters

type EvaluationParameters struct {

	// The point from the end of the dataset where you want to split the data for
	// model training and evaluation. The value is specified as the number of data
	// points.
	BackTestWindowOffset *int64 `type:"integer"`

	// The number of times to split the input data. The default is 1. The range
	// is 1 through 5.
	NumberOfBacktestWindows *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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 and can be overridden in the CreatePredictor request.

For example, suppose that you have a dataset with data collection frequency set to every day and you have 200 days worth of data (that is, 200 data points). Now suppose that you set the NumberOfBacktestWindows to 2 and the BackTestWindowOffset parameter to 20. The algorithm splits the data twice. The first time, the algorithm trains the model using the first 180 data points and uses the last 20 data points for evaluation. The second time, the algorithm trains the model using the first 160 data points and uses the last 40 data points for evaluation.

func (EvaluationParameters) GoString

func (s EvaluationParameters) GoString() string

GoString returns the string representation

func (*EvaluationParameters) SetBackTestWindowOffset

func (s *EvaluationParameters) SetBackTestWindowOffset(v int64) *EvaluationParameters

SetBackTestWindowOffset sets the BackTestWindowOffset field's value.

func (*EvaluationParameters) SetNumberOfBacktestWindows

func (s *EvaluationParameters) SetNumberOfBacktestWindows(v int64) *EvaluationParameters

SetNumberOfBacktestWindows sets the NumberOfBacktestWindows field's value.

func (EvaluationParameters) String

func (s EvaluationParameters) String() string

String returns the string representation

type EvaluationResult

type EvaluationResult struct {

	// 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"`
	// contains filtered or unexported fields
}

The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.

func (EvaluationResult) GoString

func (s EvaluationResult) GoString() string

GoString returns the string representation

func (*EvaluationResult) SetAlgorithmArn

func (s *EvaluationResult) SetAlgorithmArn(v string) *EvaluationResult

SetAlgorithmArn sets the AlgorithmArn field's value.

func (*EvaluationResult) SetTestWindows

func (s *EvaluationResult) SetTestWindows(v []*WindowSummary) *EvaluationResult

SetTestWindows sets the TestWindows field's value.

func (EvaluationResult) String

func (s EvaluationResult) String() string

String returns the string representation

type Featurization

type Featurization struct {

	// The name of the schema attribute specifying the data field to be featurized.
	// In this release, only the target field of the TARGET_TIME_SERIES dataset
	// type is supported. For example, for the RETAIL domain, the target is demand,
	// and for the CUSTOM domain, the target is target_value.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// An array FeaturizationMethod objects that specifies the feature transformation
	// methods. For this release, the number of methods is limited to one.
	FeaturizationPipeline []*FeaturizationMethod `min:"1" type:"list"`
	// contains filtered or unexported fields
}

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"}

} ]

}

func (Featurization) GoString

func (s Featurization) GoString() string

GoString returns the string representation

func (*Featurization) SetAttributeName

func (s *Featurization) SetAttributeName(v string) *Featurization

SetAttributeName sets the AttributeName field's value.

func (*Featurization) SetFeaturizationPipeline

func (s *Featurization) SetFeaturizationPipeline(v []*FeaturizationMethod) *Featurization

SetFeaturizationPipeline sets the FeaturizationPipeline field's value.

func (Featurization) String

func (s Featurization) String() string

String returns the string representation

func (*Featurization) Validate

func (s *Featurization) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FeaturizationConfig

type FeaturizationConfig struct {

	// An array of featurization (transformation) information for the fields of
	// a dataset. In this release, only a single featurization is supported.
	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.
	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 is a required field
	ForecastFrequency *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 in your CreatePredictor request. Amazon Forecast applies the featurization to the TARGET_TIME_SERIES dataset before model training.

You can create multiple featurization configurations. For example, you might call the CreatePredictor operation twice by specifying different featurization configurations.

func (FeaturizationConfig) GoString

func (s FeaturizationConfig) GoString() string

GoString returns the string representation

func (*FeaturizationConfig) SetFeaturizations

func (s *FeaturizationConfig) SetFeaturizations(v []*Featurization) *FeaturizationConfig

SetFeaturizations sets the Featurizations field's value.

func (*FeaturizationConfig) SetForecastDimensions

func (s *FeaturizationConfig) SetForecastDimensions(v []*string) *FeaturizationConfig

SetForecastDimensions sets the ForecastDimensions field's value.

func (*FeaturizationConfig) SetForecastFrequency

func (s *FeaturizationConfig) SetForecastFrequency(v string) *FeaturizationConfig

SetForecastFrequency sets the ForecastFrequency field's value.

func (FeaturizationConfig) String

func (s FeaturizationConfig) String() string

String returns the string representation

func (*FeaturizationConfig) Validate

func (s *FeaturizationConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FeaturizationMethod

type FeaturizationMethod struct {

	// The name of the method. In this release, "filling" is the only supported
	// method.
	//
	// FeaturizationMethodName is a required field
	FeaturizationMethodName *string `type:"string" required:"true" enum:"FeaturizationMethodName"`

	// The method parameters (key-value pairs). Specify these to override the default
	// values. The following list shows the parameters and their valid values. Bold
	// signifies the default value.
	//
	//    * aggregation: sum, avg, first, min, max
	//
	//    * frontfill: none
	//
	//    * middlefill: zero, nan (not a number)
	//
	//    * backfill: zero, nan
	FeaturizationMethodParameters map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

Provides information about a method that featurizes (transforms) a dataset field. The method is part of the FeaturizationPipeline of the Featurization object. If FeaturizationMethodParameters isn't specified, Amazon Forecast uses default parameters.

For example:

{

"FeaturizationMethodName": "filling",

"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}

}

func (FeaturizationMethod) GoString

func (s FeaturizationMethod) GoString() string

GoString returns the string representation

func (*FeaturizationMethod) SetFeaturizationMethodName

func (s *FeaturizationMethod) SetFeaturizationMethodName(v string) *FeaturizationMethod

SetFeaturizationMethodName sets the FeaturizationMethodName field's value.

func (*FeaturizationMethod) SetFeaturizationMethodParameters

func (s *FeaturizationMethod) SetFeaturizationMethodParameters(v map[string]*string) *FeaturizationMethod

SetFeaturizationMethodParameters sets the FeaturizationMethodParameters field's value.

func (FeaturizationMethod) String

func (s FeaturizationMethod) String() string

String returns the string representation

func (*FeaturizationMethod) Validate

func (s *FeaturizationMethod) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Filter

type Filter struct {

	// The condition to apply.
	//
	// 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"`

	// A valid value for Key.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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, respectively, the objects that match the statement. The match statement consists of a key and a value.

func (Filter) GoString

func (s Filter) GoString() string

GoString returns the string representation

func (*Filter) SetCondition

func (s *Filter) SetCondition(v string) *Filter

SetCondition sets the Condition field's value.

func (*Filter) SetKey

func (s *Filter) SetKey(v string) *Filter

SetKey sets the Key field's value.

func (*Filter) SetValue

func (s *Filter) SetValue(v string) *Filter

SetValue sets the Value field's value.

func (Filter) String

func (s Filter) String() string

String returns the string representation

func (*Filter) Validate

func (s *Filter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ForecastExportJobSummary

type ForecastExportJobSummary struct {

	// When the forecast export job was created.
	CreationTime *time.Time `type:"timestamp"`

	// The path to the S3 bucket where the forecast is stored.
	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"`

	// When the last successful export job finished.
	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. One of the following states:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * 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 Amazon S3 bucket.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

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.

func (ForecastExportJobSummary) GoString

func (s ForecastExportJobSummary) GoString() string

GoString returns the string representation

func (*ForecastExportJobSummary) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*ForecastExportJobSummary) SetDestination

SetDestination sets the Destination field's value.

func (*ForecastExportJobSummary) SetForecastExportJobArn

func (s *ForecastExportJobSummary) SetForecastExportJobArn(v string) *ForecastExportJobSummary

SetForecastExportJobArn sets the ForecastExportJobArn field's value.

func (*ForecastExportJobSummary) SetForecastExportJobName

func (s *ForecastExportJobSummary) SetForecastExportJobName(v string) *ForecastExportJobSummary

SetForecastExportJobName sets the ForecastExportJobName field's value.

func (*ForecastExportJobSummary) SetLastModificationTime

func (s *ForecastExportJobSummary) SetLastModificationTime(v time.Time) *ForecastExportJobSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (*ForecastExportJobSummary) SetMessage

SetMessage sets the Message field's value.

func (*ForecastExportJobSummary) SetStatus

SetStatus sets the Status field's value.

func (ForecastExportJobSummary) String

func (s ForecastExportJobSummary) String() string

String returns the string representation

type ForecastService

type ForecastService struct {
	*client.Client
}

ForecastService provides the API operation methods for making requests to Amazon Forecast Service. See this package's package overview docs for details on the service.

ForecastService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the ForecastService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a ForecastService client from just a session.
svc := forecastservice.New(mySession)

// Create a ForecastService client with additional configuration
svc := forecastservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ForecastService) CreateDataset

func (c *ForecastService) CreateDataset(input *CreateDatasetInput) (*CreateDatasetOutput, error)

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. Amazon Forecast uses this information when training the model and generating a forecast.

  • 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 of the dataset, including the field name and data type.

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

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

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" There is already a resource with that Amazon Resource Name (ARN). Try again with a different ARN.

  • ErrCodeLimitExceededException "LimitExceededException" The limit on the number of requests per second has been exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDataset

func (*ForecastService) CreateDatasetGroup

func (c *ForecastService) CreateDatasetGroup(input *CreateDatasetGroupInput) (*CreateDatasetGroupOutput, error)

CreateDatasetGroup API operation for Amazon Forecast Service.

Creates an Amazon Forecast dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or you can add datasets later with the UpdateDatasetGroup operation.

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

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

The Status of a dataset group must be ACTIVE before you can create a predictor using the dataset group. Use the DescribeDatasetGroup 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 CreateDatasetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" There is already a resource with that Amazon Resource Name (ARN). Try again with a different ARN.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeLimitExceededException "LimitExceededException" The limit on the number of requests per second has been exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetGroup

func (*ForecastService) CreateDatasetGroupRequest

func (c *ForecastService) CreateDatasetGroupRequest(input *CreateDatasetGroupInput) (req *request.Request, output *CreateDatasetGroupOutput)

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 (*ForecastService) CreateDatasetGroupWithContext

func (c *ForecastService) CreateDatasetGroupWithContext(ctx aws.Context, input *CreateDatasetGroupInput, opts ...request.Option) (*CreateDatasetGroupOutput, error)

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 (*ForecastService) CreateDatasetImportJob

func (c *ForecastService) CreateDatasetImportJob(input *CreateDatasetImportJobInput) (*CreateDatasetImportJobOutput, error)

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 object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. For more information, see aws-forecast-iam-roles.

Two properties of the training data are optionally specified:

  • The delimiter that separates the data fields. The default delimiter is a comma (,), which is the only supported delimiter in this release.

  • The format of timestamps. If the format is not specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

When Amazon Forecast uploads your training data, it verifies that the data was collected at the DataFrequency specified when the target dataset was created. For more information, see CreateDataset and howitworks-datasets-groups. Amazon Forecast also verifies the delimiter and timestamp format.

You can use the ListDatasetImportJobs operation to get a list of all your dataset import jobs, filtered by specified criteria.

To get a list of all your dataset import jobs, filtered by the specified criteria, use the ListDatasetGroups 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" There is already a resource with that Amazon Resource Name (ARN). Try again with a different ARN.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeLimitExceededException "LimitExceededException" The limit on the number of requests per second has been exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJob

func (*ForecastService) CreateDatasetImportJobRequest

func (c *ForecastService) CreateDatasetImportJobRequest(input *CreateDatasetImportJobInput) (req *request.Request, output *CreateDatasetImportJobOutput)

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 (*ForecastService) CreateDatasetImportJobWithContext

func (c *ForecastService) CreateDatasetImportJobWithContext(ctx aws.Context, input *CreateDatasetImportJobInput, opts ...request.Option) (*CreateDatasetImportJobOutput, error)

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 (*ForecastService) CreateDatasetRequest

func (c *ForecastService) CreateDatasetRequest(input *CreateDatasetInput) (req *request.Request, output *CreateDatasetOutput)

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 (*ForecastService) CreateDatasetWithContext

func (c *ForecastService) CreateDatasetWithContext(ctx aws.Context, input *CreateDatasetInput, opts ...request.Option) (*CreateDatasetOutput, error)

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 (*ForecastService) CreateForecast

func (c *ForecastService) CreateForecast(input *CreateForecastInput) (*CreateForecastOutput, error)

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), use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon, specified in the CreatePredictor request, multiplied by the DataFrequency, specified in the CreateDataset request. When you query a forecast, you can request a specific date range within the complete forecast.

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

The forecasts generated by Amazon Forecast are in the same timezone 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.

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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" There is already a resource with that Amazon Resource Name (ARN). Try again with a different ARN.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeLimitExceededException "LimitExceededException" The limit on the number of requests per second has been exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecast

func (*ForecastService) CreateForecastExportJob

CreateForecastExportJob API operation for Amazon Forecast Service.

Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket.

You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see 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. Use the DescribeForecastExportJob 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 CreateForecastExportJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" There is already a resource with that Amazon Resource Name (ARN). Try again with a different ARN.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeLimitExceededException "LimitExceededException" The limit on the number of requests per second has been exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJob

func (*ForecastService) CreateForecastExportJobRequest

func (c *ForecastService) CreateForecastExportJobRequest(input *CreateForecastExportJobInput) (req *request.Request, output *CreateForecastExportJobOutput)

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 (*ForecastService) CreateForecastExportJobWithContext

func (c *ForecastService) CreateForecastExportJobWithContext(ctx aws.Context, input *CreateForecastExportJobInput, opts ...request.Option) (*CreateForecastExportJobOutput, error)

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 (*ForecastService) CreateForecastRequest

func (c *ForecastService) CreateForecastRequest(input *CreateForecastInput) (req *request.Request, output *CreateForecastOutput)

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 (*ForecastService) CreateForecastWithContext

func (c *ForecastService) CreateForecastWithContext(ctx aws.Context, input *CreateForecastInput, opts ...request.Option) (*CreateForecastOutput, error)

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 (*ForecastService) CreatePredictor

func (c *ForecastService) CreatePredictor(input *CreatePredictorInput) (*CreatePredictorOutput, error)

CreatePredictor API operation for Amazon Forecast Service.

Creates an Amazon Forecast predictor.

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

Amazon Forecast uses the chosen algorithm to train a model using the latest version of the datasets in the specified dataset group. The result is called a predictor. You then generate a forecast using the CreateForecast operation.

After training a model, the CreatePredictor operation also evaluates it. To see the evaluation metrics, use the GetAccuracyMetrics operation. Always review the evaluation metrics before deciding to use the predictor to generate a forecast.

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

AutoML

If you set PerformAutoML to true, Amazon Forecast evaluates each algorithm and chooses the one that minimizes the objective function. The objective function is defined as the mean of the weighted 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 your predictors, use the ListPredictors operation.

The Status of the predictor must be ACTIVE, signifying that training has completed, before you can use the predictor to create a forecast. Use the DescribePredictor 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 CreatePredictor for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" There is already a resource with that Amazon Resource Name (ARN). Try again with a different ARN.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

  • ErrCodeLimitExceededException "LimitExceededException" The limit on the number of requests per second has been exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictor

func (*ForecastService) CreatePredictorRequest

func (c *ForecastService) CreatePredictorRequest(input *CreatePredictorInput) (req *request.Request, output *CreatePredictorOutput)

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 (*ForecastService) CreatePredictorWithContext

func (c *ForecastService) CreatePredictorWithContext(ctx aws.Context, input *CreatePredictorInput, opts ...request.Option) (*CreatePredictorOutput, error)

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 (*ForecastService) DeleteDataset

func (c *ForecastService) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error)

DeleteDataset API operation for Amazon Forecast Service.

Deletes an Amazon Forecast dataset created using the CreateDataset operation. To be deleted, the dataset must have a status of ACTIVE or CREATE_FAILED. Use the DescribeDataset 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 DeleteDataset for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDataset

func (*ForecastService) DeleteDatasetGroup

func (c *ForecastService) DeleteDatasetGroup(input *DeleteDatasetGroupInput) (*DeleteDatasetGroupOutput, error)

DeleteDatasetGroup API operation for Amazon Forecast Service.

Deletes a dataset group created using the CreateDatasetGroup operation. To be deleted, the dataset group must have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. Use the DescribeDatasetGroup operation to get the status.

The 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetGroup

func (*ForecastService) DeleteDatasetGroupRequest

func (c *ForecastService) DeleteDatasetGroupRequest(input *DeleteDatasetGroupInput) (req *request.Request, output *DeleteDatasetGroupOutput)

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 (*ForecastService) DeleteDatasetGroupWithContext

func (c *ForecastService) DeleteDatasetGroupWithContext(ctx aws.Context, input *DeleteDatasetGroupInput, opts ...request.Option) (*DeleteDatasetGroupOutput, error)

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 (*ForecastService) DeleteDatasetImportJob

func (c *ForecastService) DeleteDatasetImportJob(input *DeleteDatasetImportJobInput) (*DeleteDatasetImportJobOutput, error)

DeleteDatasetImportJob API operation for Amazon Forecast Service.

Deletes a dataset import job created using the CreateDatasetImportJob operation. To be deleted, the import job must have a status of ACTIVE or CREATE_FAILED. Use the DescribeDatasetImportJob 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 DeleteDatasetImportJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetImportJob

func (*ForecastService) DeleteDatasetImportJobRequest

func (c *ForecastService) DeleteDatasetImportJobRequest(input *DeleteDatasetImportJobInput) (req *request.Request, output *DeleteDatasetImportJobOutput)

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 (*ForecastService) DeleteDatasetImportJobWithContext

func (c *ForecastService) DeleteDatasetImportJobWithContext(ctx aws.Context, input *DeleteDatasetImportJobInput, opts ...request.Option) (*DeleteDatasetImportJobOutput, error)

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 (*ForecastService) DeleteDatasetRequest

func (c *ForecastService) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput)

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 (*ForecastService) DeleteDatasetWithContext

func (c *ForecastService) DeleteDatasetWithContext(ctx aws.Context, input *DeleteDatasetInput, opts ...request.Option) (*DeleteDatasetOutput, error)

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 (*ForecastService) DeleteForecast

func (c *ForecastService) DeleteForecast(input *DeleteForecastInput) (*DeleteForecastOutput, error)

DeleteForecast API operation for Amazon Forecast Service.

Deletes a forecast created using the CreateForecast operation. To be deleted, the forecast must have a status of ACTIVE or CREATE_FAILED. Use the DescribeForecast operation to get the status.

You can't delete a forecast while it is 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 DeleteForecast for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecast

func (*ForecastService) DeleteForecastExportJob

DeleteForecastExportJob API operation for Amazon Forecast Service.

Deletes a forecast export job created using the CreateForecastExportJob operation. To be deleted, the export job must have a status of ACTIVE or CREATE_FAILED. Use the DescribeForecastExportJob 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 DeleteForecastExportJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastExportJob

func (*ForecastService) DeleteForecastExportJobRequest

func (c *ForecastService) DeleteForecastExportJobRequest(input *DeleteForecastExportJobInput) (req *request.Request, output *DeleteForecastExportJobOutput)

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 (*ForecastService) DeleteForecastExportJobWithContext

func (c *ForecastService) DeleteForecastExportJobWithContext(ctx aws.Context, input *DeleteForecastExportJobInput, opts ...request.Option) (*DeleteForecastExportJobOutput, error)

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 (*ForecastService) DeleteForecastRequest

func (c *ForecastService) DeleteForecastRequest(input *DeleteForecastInput) (req *request.Request, output *DeleteForecastOutput)

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 (*ForecastService) DeleteForecastWithContext

func (c *ForecastService) DeleteForecastWithContext(ctx aws.Context, input *DeleteForecastInput, opts ...request.Option) (*DeleteForecastOutput, error)

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 (*ForecastService) DeletePredictor

func (c *ForecastService) DeletePredictor(input *DeletePredictorInput) (*DeletePredictorOutput, error)

DeletePredictor API operation for Amazon Forecast Service.

Deletes a predictor created using the CreatePredictor operation. To be deleted, the predictor must have a status of ACTIVE or CREATE_FAILED. Use the DescribePredictor operation to get the status.

Any forecasts generated by the predictor will no longer be available.

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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictor

func (*ForecastService) DeletePredictorRequest

func (c *ForecastService) DeletePredictorRequest(input *DeletePredictorInput) (req *request.Request, output *DeletePredictorOutput)

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 (*ForecastService) DeletePredictorWithContext

func (c *ForecastService) DeletePredictorWithContext(ctx aws.Context, input *DeletePredictorInput, opts ...request.Option) (*DeletePredictorOutput, error)

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 (*ForecastService) DescribeDataset

func (c *ForecastService) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error)

DescribeDataset API operation for Amazon Forecast Service.

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the properties provided by the user in the CreateDataset request, this operation includes the following 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "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 (*ForecastService) DescribeDatasetGroup

func (c *ForecastService) DescribeDatasetGroup(input *DescribeDatasetGroupInput) (*DescribeDatasetGroupOutput, error)

DescribeDatasetGroup API operation for Amazon Forecast Service.

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the properties provided by the user 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "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 (*ForecastService) DescribeDatasetGroupRequest

func (c *ForecastService) DescribeDatasetGroupRequest(input *DescribeDatasetGroupInput) (req *request.Request, output *DescribeDatasetGroupOutput)

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 (*ForecastService) DescribeDatasetGroupWithContext

func (c *ForecastService) DescribeDatasetGroupWithContext(ctx aws.Context, input *DescribeDatasetGroupInput, opts ...request.Option) (*DescribeDatasetGroupOutput, error)

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 (*ForecastService) DescribeDatasetImportJob

DescribeDatasetImportJob API operation for Amazon Forecast Service.

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the properties provided by the user 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "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 (*ForecastService) DescribeDatasetImportJobRequest

func (c *ForecastService) DescribeDatasetImportJobRequest(input *DescribeDatasetImportJobInput) (req *request.Request, output *DescribeDatasetImportJobOutput)

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 (*ForecastService) DescribeDatasetImportJobWithContext

func (c *ForecastService) DescribeDatasetImportJobWithContext(ctx aws.Context, input *DescribeDatasetImportJobInput, opts ...request.Option) (*DescribeDatasetImportJobOutput, error)

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 (*ForecastService) DescribeDatasetRequest

func (c *ForecastService) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput)

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 (*ForecastService) DescribeDatasetWithContext

func (c *ForecastService) DescribeDatasetWithContext(ctx aws.Context, input *DescribeDatasetInput, opts ...request.Option) (*DescribeDatasetOutput, error)

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 (*ForecastService) DescribeForecast

func (c *ForecastService) DescribeForecast(input *DescribeForecastInput) (*DescribeForecastOutput, error)

DescribeForecast API operation for Amazon Forecast Service.

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided by the user in the CreateForecast request, this operation includes 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "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 (*ForecastService) DescribeForecastExportJob

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 includes 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "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 (*ForecastService) DescribeForecastExportJobRequest

func (c *ForecastService) DescribeForecastExportJobRequest(input *DescribeForecastExportJobInput) (req *request.Request, output *DescribeForecastExportJobOutput)

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 (*ForecastService) DescribeForecastExportJobWithContext

func (c *ForecastService) DescribeForecastExportJobWithContext(ctx aws.Context, input *DescribeForecastExportJobInput, opts ...request.Option) (*DescribeForecastExportJobOutput, error)

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 (*ForecastService) DescribeForecastRequest

func (c *ForecastService) DescribeForecastRequest(input *DescribeForecastInput) (req *request.Request, output *DescribeForecastOutput)

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 (*ForecastService) DescribeForecastWithContext

func (c *ForecastService) DescribeForecastWithContext(ctx aws.Context, input *DescribeForecastInput, opts ...request.Option) (*DescribeForecastOutput, error)

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 (*ForecastService) DescribePredictor

func (c *ForecastService) DescribePredictor(input *DescribePredictorInput) (*DescribePredictorOutput, error)

DescribePredictor API operation for Amazon Forecast Service.

Describes a predictor created using the CreatePredictor operation.

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

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

  • AutoMLAlgorithmArns - If AutoML is performed, the algorithms 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "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 (*ForecastService) DescribePredictorRequest

func (c *ForecastService) DescribePredictorRequest(input *DescribePredictorInput) (req *request.Request, output *DescribePredictorOutput)

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 (*ForecastService) DescribePredictorWithContext

func (c *ForecastService) DescribePredictorWithContext(ctx aws.Context, input *DescribePredictorInput, opts ...request.Option) (*DescribePredictorOutput, error)

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 (*ForecastService) GetAccuracyMetrics

func (c *ForecastService) GetAccuracyMetrics(input *GetAccuracyMetricsInput) (*GetAccuracyMetricsOutput, error)

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.

Metrics are generated for each backtest window evaluated. For more information, see EvaluationParameters.

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

For an example of how to train a model and review metrics, see getting-started.

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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics

func (*ForecastService) GetAccuracyMetricsRequest

func (c *ForecastService) GetAccuracyMetricsRequest(input *GetAccuracyMetricsInput) (req *request.Request, output *GetAccuracyMetricsOutput)

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 (*ForecastService) GetAccuracyMetricsWithContext

func (c *ForecastService) GetAccuracyMetricsWithContext(ctx aws.Context, input *GetAccuracyMetricsInput, opts ...request.Option) (*GetAccuracyMetricsOutput, error)

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 (*ForecastService) ListDatasetGroups

func (c *ForecastService) ListDatasetGroups(input *ListDatasetGroupsInput) (*ListDatasetGroupsOutput, error)

ListDatasetGroups API operation for Amazon Forecast Service.

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeDatasetGroup 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 Codes:

  • ErrCodeInvalidNextTokenException "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 (*ForecastService) ListDatasetGroupsPages

func (c *ForecastService) ListDatasetGroupsPages(input *ListDatasetGroupsInput, fn func(*ListDatasetGroupsOutput, bool) bool) error

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 (*ForecastService) ListDatasetGroupsPagesWithContext

func (c *ForecastService) ListDatasetGroupsPagesWithContext(ctx aws.Context, input *ListDatasetGroupsInput, fn func(*ListDatasetGroupsOutput, bool) bool, opts ...request.Option) error

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 (*ForecastService) ListDatasetGroupsRequest

func (c *ForecastService) ListDatasetGroupsRequest(input *ListDatasetGroupsInput) (req *request.Request, output *ListDatasetGroupsOutput)

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 (*ForecastService) ListDatasetGroupsWithContext

func (c *ForecastService) ListDatasetGroupsWithContext(ctx aws.Context, input *ListDatasetGroupsInput, opts ...request.Option) (*ListDatasetGroupsOutput, error)

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 (*ForecastService) ListDatasetImportJobs

func (c *ForecastService) ListDatasetImportJobs(input *ListDatasetImportJobsInput) (*ListDatasetImportJobsOutput, error)

ListDatasetImportJobs API operation for Amazon Forecast Service.

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing 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 ListDatasetImportJobs for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The token is not valid. Tokens expire after 24 hours.

  • ErrCodeInvalidInputException "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 (*ForecastService) ListDatasetImportJobsPages

func (c *ForecastService) ListDatasetImportJobsPages(input *ListDatasetImportJobsInput, fn func(*ListDatasetImportJobsOutput, bool) bool) error

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 (*ForecastService) ListDatasetImportJobsPagesWithContext

func (c *ForecastService) ListDatasetImportJobsPagesWithContext(ctx aws.Context, input *ListDatasetImportJobsInput, fn func(*ListDatasetImportJobsOutput, bool) bool, opts ...request.Option) error

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 (*ForecastService) ListDatasetImportJobsRequest

func (c *ForecastService) ListDatasetImportJobsRequest(input *ListDatasetImportJobsInput) (req *request.Request, output *ListDatasetImportJobsOutput)

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 (*ForecastService) ListDatasetImportJobsWithContext

func (c *ForecastService) ListDatasetImportJobsWithContext(ctx aws.Context, input *ListDatasetImportJobsInput, opts ...request.Option) (*ListDatasetImportJobsOutput, error)

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 (*ForecastService) ListDatasets

func (c *ForecastService) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error)

ListDatasets API operation for Amazon Forecast Service.

Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeDataset 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 Codes:

  • ErrCodeInvalidNextTokenException "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 (*ForecastService) ListDatasetsPages

func (c *ForecastService) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error

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 (*ForecastService) ListDatasetsPagesWithContext

func (c *ForecastService) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error

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 (*ForecastService) ListDatasetsRequest

func (c *ForecastService) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput)

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 (*ForecastService) ListDatasetsWithContext

func (c *ForecastService) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error)

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 (*ForecastService) ListForecastExportJobs

func (c *ForecastService) ListForecastExportJobs(input *ListForecastExportJobsInput) (*ListForecastExportJobsOutput, error)

ListForecastExportJobs API operation for Amazon Forecast Service.

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeForecastExportJob operation. The list can be filtered 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 Codes:

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The token is not valid. Tokens expire after 24 hours.

  • ErrCodeInvalidInputException "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 (*ForecastService) ListForecastExportJobsPages

func (c *ForecastService) ListForecastExportJobsPages(input *ListForecastExportJobsInput, fn func(*ListForecastExportJobsOutput, bool) bool) error

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 (*ForecastService) ListForecastExportJobsPagesWithContext

func (c *ForecastService) ListForecastExportJobsPagesWithContext(ctx aws.Context, input *ListForecastExportJobsInput, fn func(*ListForecastExportJobsOutput, bool) bool, opts ...request.Option) error

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 (*ForecastService) ListForecastExportJobsRequest

func (c *ForecastService) ListForecastExportJobsRequest(input *ListForecastExportJobsInput) (req *request.Request, output *ListForecastExportJobsOutput)

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 (*ForecastService) ListForecastExportJobsWithContext

func (c *ForecastService) ListForecastExportJobsWithContext(ctx aws.Context, input *ListForecastExportJobsInput, opts ...request.Option) (*ListForecastExportJobsOutput, error)

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 (*ForecastService) ListForecasts

func (c *ForecastService) ListForecasts(input *ListForecastsInput) (*ListForecastsOutput, error)

ListForecasts API operation for Amazon Forecast Service.

Returns a list of forecasts created using the CreateForecast operation. For each forecast, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeForecast operation. The list can be filtered 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 Codes:

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The token is not valid. Tokens expire after 24 hours.

  • ErrCodeInvalidInputException "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 (*ForecastService) ListForecastsPages

func (c *ForecastService) ListForecastsPages(input *ListForecastsInput, fn func(*ListForecastsOutput, bool) bool) error

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 (*ForecastService) ListForecastsPagesWithContext

func (c *ForecastService) ListForecastsPagesWithContext(ctx aws.Context, input *ListForecastsInput, fn func(*ListForecastsOutput, bool) bool, opts ...request.Option) error

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 (*ForecastService) ListForecastsRequest

func (c *ForecastService) ListForecastsRequest(input *ListForecastsInput) (req *request.Request, output *ListForecastsOutput)

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 (*ForecastService) ListForecastsWithContext

func (c *ForecastService) ListForecastsWithContext(ctx aws.Context, input *ListForecastsInput, opts ...request.Option) (*ListForecastsOutput, error)

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 (*ForecastService) ListPredictors

func (c *ForecastService) ListPredictors(input *ListPredictorsInput) (*ListPredictorsOutput, error)

ListPredictors API operation for Amazon Forecast Service.

Returns a list of predictors created using the CreatePredictor operation. For each predictor, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. The list can be filtered 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 Codes:

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The token is not valid. Tokens expire after 24 hours.

  • ErrCodeInvalidInputException "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 (*ForecastService) ListPredictorsPages

func (c *ForecastService) ListPredictorsPages(input *ListPredictorsInput, fn func(*ListPredictorsOutput, bool) bool) error

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 (*ForecastService) ListPredictorsPagesWithContext

func (c *ForecastService) ListPredictorsPagesWithContext(ctx aws.Context, input *ListPredictorsInput, fn func(*ListPredictorsOutput, bool) bool, opts ...request.Option) error

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 (*ForecastService) ListPredictorsRequest

func (c *ForecastService) ListPredictorsRequest(input *ListPredictorsInput) (req *request.Request, output *ListPredictorsOutput)

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 (*ForecastService) ListPredictorsWithContext

func (c *ForecastService) ListPredictorsWithContext(ctx aws.Context, input *ListPredictorsInput, opts ...request.Option) (*ListPredictorsOutput, error)

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 (*ForecastService) UpdateDatasetGroup

func (c *ForecastService) UpdateDatasetGroup(input *UpdateDatasetGroupInput) (*UpdateDatasetGroupOutput, error)

UpdateDatasetGroup API operation for Amazon Forecast Service.

Replaces any existing datasets in the dataset group with the specified datasets.

The Status of the dataset group must be ACTIVE before creating a predictor using the dataset group. Use the DescribeDatasetGroup 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 Codes:

  • ErrCodeInvalidInputException "InvalidInputException" We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UpdateDatasetGroup

func (*ForecastService) UpdateDatasetGroupRequest

func (c *ForecastService) UpdateDatasetGroupRequest(input *UpdateDatasetGroupInput) (req *request.Request, output *UpdateDatasetGroupOutput)

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 (*ForecastService) UpdateDatasetGroupWithContext

func (c *ForecastService) UpdateDatasetGroupWithContext(ctx aws.Context, input *UpdateDatasetGroupInput, opts ...request.Option) (*UpdateDatasetGroupOutput, error)

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.

type ForecastSummary

type ForecastSummary struct {

	// 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"`

	// Initially, the same as CreationTime (status is CREATE_PENDING). Updated when
	// inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS),
	// and when inference is complete (status changed to ACTIVE) or fails (status
	// changed to CREATE_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
	//
	//    * 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"`
	// contains filtered or unexported fields
}

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 listed ForecastArn.

func (ForecastSummary) GoString

func (s ForecastSummary) GoString() string

GoString returns the string representation

func (*ForecastSummary) SetCreationTime

func (s *ForecastSummary) SetCreationTime(v time.Time) *ForecastSummary

SetCreationTime sets the CreationTime field's value.

func (*ForecastSummary) SetDatasetGroupArn

func (s *ForecastSummary) SetDatasetGroupArn(v string) *ForecastSummary

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*ForecastSummary) SetForecastArn

func (s *ForecastSummary) SetForecastArn(v string) *ForecastSummary

SetForecastArn sets the ForecastArn field's value.

func (*ForecastSummary) SetForecastName

func (s *ForecastSummary) SetForecastName(v string) *ForecastSummary

SetForecastName sets the ForecastName field's value.

func (*ForecastSummary) SetLastModificationTime

func (s *ForecastSummary) SetLastModificationTime(v time.Time) *ForecastSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (*ForecastSummary) SetMessage

func (s *ForecastSummary) SetMessage(v string) *ForecastSummary

SetMessage sets the Message field's value.

func (*ForecastSummary) SetPredictorArn

func (s *ForecastSummary) SetPredictorArn(v string) *ForecastSummary

SetPredictorArn sets the PredictorArn field's value.

func (*ForecastSummary) SetStatus

func (s *ForecastSummary) SetStatus(v string) *ForecastSummary

SetStatus sets the Status field's value.

func (ForecastSummary) String

func (s ForecastSummary) String() string

String returns the string representation

type GetAccuracyMetricsInput

type GetAccuracyMetricsInput struct {

	// The Amazon Resource Name (ARN) of the predictor to get metrics for.
	//
	// PredictorArn is a required field
	PredictorArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAccuracyMetricsInput) GoString

func (s GetAccuracyMetricsInput) GoString() string

GoString returns the string representation

func (*GetAccuracyMetricsInput) SetPredictorArn

SetPredictorArn sets the PredictorArn field's value.

func (GetAccuracyMetricsInput) String

func (s GetAccuracyMetricsInput) String() string

String returns the string representation

func (*GetAccuracyMetricsInput) Validate

func (s *GetAccuracyMetricsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAccuracyMetricsOutput

type GetAccuracyMetricsOutput struct {

	// An array of results from evaluating the predictor.
	PredictorEvaluationResults []*EvaluationResult `type:"list"`
	// contains filtered or unexported fields
}

func (GetAccuracyMetricsOutput) GoString

func (s GetAccuracyMetricsOutput) GoString() string

GoString returns the string representation

func (*GetAccuracyMetricsOutput) SetPredictorEvaluationResults

func (s *GetAccuracyMetricsOutput) SetPredictorEvaluationResults(v []*EvaluationResult) *GetAccuracyMetricsOutput

SetPredictorEvaluationResults sets the PredictorEvaluationResults field's value.

func (GetAccuracyMetricsOutput) String

func (s GetAccuracyMetricsOutput) String() string

String returns the string representation

type HyperParameterTuningJobConfig

type HyperParameterTuningJobConfig struct {

	// Specifies the ranges of valid values for the hyperparameters.
	ParameterRanges *ParameterRanges `type:"structure"`
	// contains filtered or unexported fields
}

Configuration information for a hyperparameter tuning job. This object is specified in the CreatePredictor request.

A hyperparameter is a parameter that governs the model training process and is set before training starts. This is as opposed to a model parameter that is determined during training. The values of the hyperparameters have an effect on the chosen model parameters.

A hyperparameter tuning job is the process of choosing the optimum set of hyperparameter values that optimize a specified metric. This is accomplished by running many training jobs over a range of hyperparameter values. The optimum set of values is dependent on the algorithm, the training data, and the given metric objective.

func (HyperParameterTuningJobConfig) GoString

GoString returns the string representation

func (*HyperParameterTuningJobConfig) SetParameterRanges

SetParameterRanges sets the ParameterRanges field's value.

func (HyperParameterTuningJobConfig) String

String returns the string representation

func (*HyperParameterTuningJobConfig) Validate

func (s *HyperParameterTuningJobConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InputDataConfig

type InputDataConfig struct {

	// 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. For this release, the only supported
	// feature is a holiday calendar.
	SupplementaryFeatures []*SupplementaryFeature `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The data used to train a predictor. The data includes a dataset group and any supplementary features. This object is specified in the CreatePredictor request.

func (InputDataConfig) GoString

func (s InputDataConfig) GoString() string

GoString returns the string representation

func (*InputDataConfig) SetDatasetGroupArn

func (s *InputDataConfig) SetDatasetGroupArn(v string) *InputDataConfig

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*InputDataConfig) SetSupplementaryFeatures

func (s *InputDataConfig) SetSupplementaryFeatures(v []*SupplementaryFeature) *InputDataConfig

SetSupplementaryFeatures sets the SupplementaryFeatures field's value.

func (InputDataConfig) String

func (s InputDataConfig) String() string

String returns the string representation

func (*InputDataConfig) Validate

func (s *InputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IntegerParameterRange

type IntegerParameterRange struct {

	// 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.
	// 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:
	//
	// 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 only 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.
	ScalingType *string `type:"string" enum:"ScalingType"`
	// contains filtered or unexported fields
}

Specifies an integer hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

func (IntegerParameterRange) GoString

func (s IntegerParameterRange) GoString() string

GoString returns the string representation

func (*IntegerParameterRange) SetMaxValue

SetMaxValue sets the MaxValue field's value.

func (*IntegerParameterRange) SetMinValue

SetMinValue sets the MinValue field's value.

func (*IntegerParameterRange) SetName

SetName sets the Name field's value.

func (*IntegerParameterRange) SetScalingType

func (s *IntegerParameterRange) SetScalingType(v string) *IntegerParameterRange

SetScalingType sets the ScalingType field's value.

func (IntegerParameterRange) String

func (s IntegerParameterRange) String() string

String returns the string representation

func (*IntegerParameterRange) Validate

func (s *IntegerParameterRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetGroupsInput

type ListDatasetGroupsInput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (ListDatasetGroupsInput) GoString

func (s ListDatasetGroupsInput) GoString() string

GoString returns the string representation

func (*ListDatasetGroupsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetGroupsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDatasetGroupsInput) String

func (s ListDatasetGroupsInput) String() string

String returns the string representation

func (*ListDatasetGroupsInput) Validate

func (s *ListDatasetGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetGroupsOutput

type ListDatasetGroupsOutput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (ListDatasetGroupsOutput) GoString

func (s ListDatasetGroupsOutput) GoString() string

GoString returns the string representation

func (*ListDatasetGroupsOutput) SetDatasetGroups

SetDatasetGroups sets the DatasetGroups field's value.

func (*ListDatasetGroupsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDatasetGroupsOutput) String

func (s ListDatasetGroupsOutput) String() string

String returns the string representation

type ListDatasetImportJobsInput

type ListDatasetImportJobsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT, which specifies whether
	// to include or exclude, respectively, from the list, the predictors that match
	// the statement. The match statement consists of a key and a value. In this
	// release, Name is the only valid key, which filters on the DatasetImportJobName
	// property.
	//
	//    * Condition - IS or IS_NOT
	//
	//    * Key - Name
	//
	//    * Value - the value to match
	//
	// For example, to list all dataset import jobs named my_dataset_import_job,
	// you would specify:
	//
	// "Filters": [ { "Condition": "IS", "Key": "Name", "Value": "my_dataset_import_job"
	// } ]
	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"`
	// contains filtered or unexported fields
}

func (ListDatasetImportJobsInput) GoString

func (s ListDatasetImportJobsInput) GoString() string

GoString returns the string representation

func (*ListDatasetImportJobsInput) SetFilters

SetFilters sets the Filters field's value.

func (*ListDatasetImportJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetImportJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDatasetImportJobsInput) String

String returns the string representation

func (*ListDatasetImportJobsInput) Validate

func (s *ListDatasetImportJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetImportJobsOutput

type ListDatasetImportJobsOutput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (ListDatasetImportJobsOutput) GoString

func (s ListDatasetImportJobsOutput) GoString() string

GoString returns the string representation

func (*ListDatasetImportJobsOutput) SetDatasetImportJobs

SetDatasetImportJobs sets the DatasetImportJobs field's value.

func (*ListDatasetImportJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDatasetImportJobsOutput) String

String returns the string representation

type ListDatasetsInput

type ListDatasetsInput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (ListDatasetsInput) GoString

func (s ListDatasetsInput) GoString() string

GoString returns the string representation

func (*ListDatasetsInput) SetMaxResults

func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetsInput) SetNextToken

func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput

SetNextToken sets the NextToken field's value.

func (ListDatasetsInput) String

func (s ListDatasetsInput) String() string

String returns the string representation

func (*ListDatasetsInput) Validate

func (s *ListDatasetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetsOutput

type ListDatasetsOutput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (ListDatasetsOutput) GoString

func (s ListDatasetsOutput) GoString() string

GoString returns the string representation

func (*ListDatasetsOutput) SetDatasets

SetDatasets sets the Datasets field's value.

func (*ListDatasetsOutput) SetNextToken

func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput

SetNextToken sets the NextToken field's value.

func (ListDatasetsOutput) String

func (s ListDatasetsOutput) String() string

String returns the string representation

type ListForecastExportJobsInput

type ListForecastExportJobsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT, which specifies whether
	// to include or exclude, respectively, from the list, the predictors that match
	// the statement. The match statement consists of a key and a value. In this
	// release, Name is the only valid key, which filters on the ForecastExportJobName
	// property.
	//
	//    * Condition - IS or IS_NOT
	//
	//    * Key - Name
	//
	//    * Value - the value to match
	//
	// For example, to list all forecast export jobs named my_forecast_export_job,
	// you would specify:
	//
	// "Filters": [ { "Condition": "IS", "Key": "Name", "Value": "my_forecast_export_job"
	// } ]
	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"`
	// contains filtered or unexported fields
}

func (ListForecastExportJobsInput) GoString

func (s ListForecastExportJobsInput) GoString() string

GoString returns the string representation

func (*ListForecastExportJobsInput) SetFilters

SetFilters sets the Filters field's value.

func (*ListForecastExportJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListForecastExportJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListForecastExportJobsInput) String

String returns the string representation

func (*ListForecastExportJobsInput) Validate

func (s *ListForecastExportJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListForecastExportJobsOutput

type ListForecastExportJobsOutput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (ListForecastExportJobsOutput) GoString

func (s ListForecastExportJobsOutput) GoString() string

GoString returns the string representation

func (*ListForecastExportJobsOutput) SetForecastExportJobs

SetForecastExportJobs sets the ForecastExportJobs field's value.

func (*ListForecastExportJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListForecastExportJobsOutput) String

String returns the string representation

type ListForecastsInput

type ListForecastsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT, which specifies whether
	// to include or exclude, respectively, from the list, the predictors that match
	// the statement. The match statement consists of a key and a value. In this
	// release, Name is the only valid key, which filters on the ForecastName property.
	//
	//    * Condition - IS or IS_NOT
	//
	//    * Key - Name
	//
	//    * Value - the value to match
	//
	// For example, to list all forecasts named my_forecast, you would specify:
	//
	// "Filters": [ { "Condition": "IS", "Key": "Name", "Value": "my_forecast" }
	// ]
	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"`
	// contains filtered or unexported fields
}

func (ListForecastsInput) GoString

func (s ListForecastsInput) GoString() string

GoString returns the string representation

func (*ListForecastsInput) SetFilters

func (s *ListForecastsInput) SetFilters(v []*Filter) *ListForecastsInput

SetFilters sets the Filters field's value.

func (*ListForecastsInput) SetMaxResults

func (s *ListForecastsInput) SetMaxResults(v int64) *ListForecastsInput

SetMaxResults sets the MaxResults field's value.

func (*ListForecastsInput) SetNextToken

func (s *ListForecastsInput) SetNextToken(v string) *ListForecastsInput

SetNextToken sets the NextToken field's value.

func (ListForecastsInput) String

func (s ListForecastsInput) String() string

String returns the string representation

func (*ListForecastsInput) Validate

func (s *ListForecastsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListForecastsOutput

type ListForecastsOutput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (ListForecastsOutput) GoString

func (s ListForecastsOutput) GoString() string

GoString returns the string representation

func (*ListForecastsOutput) SetForecasts

SetForecasts sets the Forecasts field's value.

func (*ListForecastsOutput) SetNextToken

func (s *ListForecastsOutput) SetNextToken(v string) *ListForecastsOutput

SetNextToken sets the NextToken field's value.

func (ListForecastsOutput) String

func (s ListForecastsOutput) String() string

String returns the string representation

type ListPredictorsInput

type ListPredictorsInput struct {

	// An array of filters. For each filter, you provide a condition and a match
	// statement. The condition is either IS or IS_NOT, which specifies whether
	// to include or exclude, respectively, from the list, the predictors that match
	// the statement. The match statement consists of a key and a value. In this
	// release, Name is the only valid key, which filters on the PredictorName property.
	//
	//    * Condition - IS or IS_NOT
	//
	//    * Key - Name
	//
	//    * Value - the value to match
	//
	// For example, to list all predictors named my_predictor, you would specify:
	//
	// "Filters": [ { "Condition": "IS", "Key": "Name", "Value": "my_predictor"
	// } ]
	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"`
	// contains filtered or unexported fields
}

func (ListPredictorsInput) GoString

func (s ListPredictorsInput) GoString() string

GoString returns the string representation

func (*ListPredictorsInput) SetFilters

func (s *ListPredictorsInput) SetFilters(v []*Filter) *ListPredictorsInput

SetFilters sets the Filters field's value.

func (*ListPredictorsInput) SetMaxResults

func (s *ListPredictorsInput) SetMaxResults(v int64) *ListPredictorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPredictorsInput) SetNextToken

func (s *ListPredictorsInput) SetNextToken(v string) *ListPredictorsInput

SetNextToken sets the NextToken field's value.

func (ListPredictorsInput) String

func (s ListPredictorsInput) String() string

String returns the string representation

func (*ListPredictorsInput) Validate

func (s *ListPredictorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPredictorsOutput

type ListPredictorsOutput struct {

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

	// An array of objects that summarize each predictor's properties.
	Predictors []*PredictorSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListPredictorsOutput) GoString

func (s ListPredictorsOutput) GoString() string

GoString returns the string representation

func (*ListPredictorsOutput) SetNextToken

func (s *ListPredictorsOutput) SetNextToken(v string) *ListPredictorsOutput

SetNextToken sets the NextToken field's value.

func (*ListPredictorsOutput) SetPredictors

SetPredictors sets the Predictors field's value.

func (ListPredictorsOutput) String

func (s ListPredictorsOutput) String() string

String returns the string representation

type Metrics

type Metrics struct {

	// The root mean square error (RMSE).
	RMSE *float64 `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"`
	// contains filtered or unexported fields
}

Provides metrics used to evaluate the performance of a predictor. This object is part of the WindowSummary object.

func (Metrics) GoString

func (s Metrics) GoString() string

GoString returns the string representation

func (*Metrics) SetRMSE

func (s *Metrics) SetRMSE(v float64) *Metrics

SetRMSE sets the RMSE field's value.

func (*Metrics) SetWeightedQuantileLosses

func (s *Metrics) SetWeightedQuantileLosses(v []*WeightedQuantileLoss) *Metrics

SetWeightedQuantileLosses sets the WeightedQuantileLosses field's value.

func (Metrics) String

func (s Metrics) String() string

String returns the string representation

type ParameterRanges

type ParameterRanges struct {

	// 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"`
	// contains filtered or unexported fields
}

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.

func (ParameterRanges) GoString

func (s ParameterRanges) GoString() string

GoString returns the string representation

func (*ParameterRanges) SetCategoricalParameterRanges

func (s *ParameterRanges) SetCategoricalParameterRanges(v []*CategoricalParameterRange) *ParameterRanges

SetCategoricalParameterRanges sets the CategoricalParameterRanges field's value.

func (*ParameterRanges) SetContinuousParameterRanges

func (s *ParameterRanges) SetContinuousParameterRanges(v []*ContinuousParameterRange) *ParameterRanges

SetContinuousParameterRanges sets the ContinuousParameterRanges field's value.

func (*ParameterRanges) SetIntegerParameterRanges

func (s *ParameterRanges) SetIntegerParameterRanges(v []*IntegerParameterRange) *ParameterRanges

SetIntegerParameterRanges sets the IntegerParameterRanges field's value.

func (ParameterRanges) String

func (s ParameterRanges) String() string

String returns the string representation

func (*ParameterRanges) Validate

func (s *ParameterRanges) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PredictorSummary

type PredictorSummary struct {

	// 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"`

	// Initially, the same as CreationTime (status is CREATE_PENDING). Updated when
	// training starts (status changed to CREATE_IN_PROGRESS), and when training
	// is complete (status changed to ACTIVE) or fails (status changed to CREATE_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"`

	// The status of the predictor. 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 Status of the predictor must be ACTIVE before using the predictor to
	// create a forecast.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the predictor properties used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

func (PredictorSummary) GoString

func (s PredictorSummary) GoString() string

GoString returns the string representation

func (*PredictorSummary) SetCreationTime

func (s *PredictorSummary) SetCreationTime(v time.Time) *PredictorSummary

SetCreationTime sets the CreationTime field's value.

func (*PredictorSummary) SetDatasetGroupArn

func (s *PredictorSummary) SetDatasetGroupArn(v string) *PredictorSummary

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*PredictorSummary) SetLastModificationTime

func (s *PredictorSummary) SetLastModificationTime(v time.Time) *PredictorSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (*PredictorSummary) SetMessage

func (s *PredictorSummary) SetMessage(v string) *PredictorSummary

SetMessage sets the Message field's value.

func (*PredictorSummary) SetPredictorArn

func (s *PredictorSummary) SetPredictorArn(v string) *PredictorSummary

SetPredictorArn sets the PredictorArn field's value.

func (*PredictorSummary) SetPredictorName

func (s *PredictorSummary) SetPredictorName(v string) *PredictorSummary

SetPredictorName sets the PredictorName field's value.

func (*PredictorSummary) SetStatus

func (s *PredictorSummary) SetStatus(v string) *PredictorSummary

SetStatus sets the Status field's value.

func (PredictorSummary) String

func (s PredictorSummary) String() string

String returns the string representation

type S3Config

type S3Config struct {

	// The Amazon Resource Name (ARN) of an AWS 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 `type:"string" required:"true"`

	// The ARN of the AWS Identity and Access Management (IAM) role that Amazon
	// Forecast can assume to access the Amazon S3 bucket or file(s).
	//
	// Cross-account pass role is not allowed. If you pass a role that doesn't belong
	// to your account, an InvalidInputException is thrown.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is submitted in the CreateDatasetImportJob and CreateForecastExportJob requests.

func (S3Config) GoString

func (s S3Config) GoString() string

GoString returns the string representation

func (*S3Config) SetKMSKeyArn

func (s *S3Config) SetKMSKeyArn(v string) *S3Config

SetKMSKeyArn sets the KMSKeyArn field's value.

func (*S3Config) SetPath

func (s *S3Config) SetPath(v string) *S3Config

SetPath sets the Path field's value.

func (*S3Config) SetRoleArn

func (s *S3Config) SetRoleArn(v string) *S3Config

SetRoleArn sets the RoleArn field's value.

func (S3Config) String

func (s S3Config) String() string

String returns the string representation

func (*S3Config) Validate

func (s *S3Config) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Schema

type Schema struct {

	// An array of attributes specifying the name and type of each field in a dataset.
	Attributes []*SchemaAttribute `type:"list"`
	// contains filtered or unexported fields
}

Defines the fields of a dataset. This object is specified in the CreateDataset request.

func (Schema) GoString

func (s Schema) GoString() string

GoString returns the string representation

func (*Schema) SetAttributes

func (s *Schema) SetAttributes(v []*SchemaAttribute) *Schema

SetAttributes sets the Attributes field's value.

func (Schema) String

func (s Schema) String() string

String returns the string representation

func (*Schema) Validate

func (s *Schema) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SchemaAttribute

type SchemaAttribute struct {

	// The name of the dataset field.
	AttributeName *string `min:"1" type:"string"`

	// The data type of the field.
	AttributeType *string `type:"string" enum:"AttributeType"`
	// contains filtered or unexported fields
}

An attribute of a schema, which defines a field of a dataset. A schema attribute is required for every field in a dataset. The Schema object contains an array of SchemaAttribute objects.

func (SchemaAttribute) GoString

func (s SchemaAttribute) GoString() string

GoString returns the string representation

func (*SchemaAttribute) SetAttributeName

func (s *SchemaAttribute) SetAttributeName(v string) *SchemaAttribute

SetAttributeName sets the AttributeName field's value.

func (*SchemaAttribute) SetAttributeType

func (s *SchemaAttribute) SetAttributeType(v string) *SchemaAttribute

SetAttributeType sets the AttributeType field's value.

func (SchemaAttribute) String

func (s SchemaAttribute) String() string

String returns the string representation

func (*SchemaAttribute) Validate

func (s *SchemaAttribute) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Statistics

type Statistics struct {

	// For a numeric field, the average value in the field.
	Avg *float64 `type:"double"`

	// The number of values in the field.
	Count *int64 `type:"integer"`

	// The number of distinct values in the field.
	CountDistinct *int64 `type:"integer"`

	// The number of NAN (not a number) values in the field.
	CountNan *int64 `type:"integer"`

	// The number of null values in the field.
	CountNull *int64 `type:"integer"`

	// 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"`
	// contains filtered or unexported fields
}

Provides statistics for each data field imported to an Amazon Forecast dataset with the CreateDatasetImportJob operation.

func (Statistics) GoString

func (s Statistics) GoString() string

GoString returns the string representation

func (*Statistics) SetAvg

func (s *Statistics) SetAvg(v float64) *Statistics

SetAvg sets the Avg field's value.

func (*Statistics) SetCount

func (s *Statistics) SetCount(v int64) *Statistics

SetCount sets the Count field's value.

func (*Statistics) SetCountDistinct

func (s *Statistics) SetCountDistinct(v int64) *Statistics

SetCountDistinct sets the CountDistinct field's value.

func (*Statistics) SetCountNan

func (s *Statistics) SetCountNan(v int64) *Statistics

SetCountNan sets the CountNan field's value.

func (*Statistics) SetCountNull

func (s *Statistics) SetCountNull(v int64) *Statistics

SetCountNull sets the CountNull field's value.

func (*Statistics) SetMax

func (s *Statistics) SetMax(v string) *Statistics

SetMax sets the Max field's value.

func (*Statistics) SetMin

func (s *Statistics) SetMin(v string) *Statistics

SetMin sets the Min field's value.

func (*Statistics) SetStddev

func (s *Statistics) SetStddev(v float64) *Statistics

SetStddev sets the Stddev field's value.

func (Statistics) String

func (s Statistics) String() string

String returns the string representation

type SupplementaryFeature

type SupplementaryFeature struct {

	// The name of the feature. This must be "holiday".
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// One of the following 2 letter country codes:
	//
	//    * "AU" - AUSTRALIA
	//
	//    * "DE" - GERMANY
	//
	//    * "JP" - JAPAN
	//
	//    * "US" - UNITED_STATES
	//
	//    * "UK" - UNITED_KINGDOM
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object.

For this release, the only supported feature is a holiday calendar. If the calendar is used, all data should belong to the same country as the calendar. For the calendar data, see http://jollyday.sourceforge.net/data.html (http://jollyday.sourceforge.net/data.html).

func (SupplementaryFeature) GoString

func (s SupplementaryFeature) GoString() string

GoString returns the string representation

func (*SupplementaryFeature) SetName

SetName sets the Name field's value.

func (*SupplementaryFeature) SetValue

SetValue sets the Value field's value.

func (SupplementaryFeature) String

func (s SupplementaryFeature) String() string

String returns the string representation

func (*SupplementaryFeature) Validate

func (s *SupplementaryFeature) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDatasetGroupInput

type UpdateDatasetGroupInput struct {

	// An array of 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"`
	// contains filtered or unexported fields
}

func (UpdateDatasetGroupInput) GoString

func (s UpdateDatasetGroupInput) GoString() string

GoString returns the string representation

func (*UpdateDatasetGroupInput) SetDatasetArns

func (s *UpdateDatasetGroupInput) SetDatasetArns(v []*string) *UpdateDatasetGroupInput

SetDatasetArns sets the DatasetArns field's value.

func (*UpdateDatasetGroupInput) SetDatasetGroupArn

func (s *UpdateDatasetGroupInput) SetDatasetGroupArn(v string) *UpdateDatasetGroupInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (UpdateDatasetGroupInput) String

func (s UpdateDatasetGroupInput) String() string

String returns the string representation

func (*UpdateDatasetGroupInput) Validate

func (s *UpdateDatasetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDatasetGroupOutput

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

func (UpdateDatasetGroupOutput) GoString

func (s UpdateDatasetGroupOutput) GoString() string

GoString returns the string representation

func (UpdateDatasetGroupOutput) String

func (s UpdateDatasetGroupOutput) String() string

String returns the string representation

type WeightedQuantileLoss

type WeightedQuantileLoss struct {

	// The difference between the predicted value and 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"`
	// contains filtered or unexported fields
}

The weighted loss value for a quantile. This object is part of the Metrics object.

func (WeightedQuantileLoss) GoString

func (s WeightedQuantileLoss) GoString() string

GoString returns the string representation

func (*WeightedQuantileLoss) SetLossValue

SetLossValue sets the LossValue field's value.

func (*WeightedQuantileLoss) SetQuantile

SetQuantile sets the Quantile field's value.

func (WeightedQuantileLoss) String

func (s WeightedQuantileLoss) String() string

String returns the string representation

type WindowSummary

type WindowSummary struct {

	// 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. This object
	// is part of the WindowSummary object.
	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"`
	// contains filtered or unexported fields
}

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.

func (WindowSummary) GoString

func (s WindowSummary) GoString() string

GoString returns the string representation

func (*WindowSummary) SetEvaluationType

func (s *WindowSummary) SetEvaluationType(v string) *WindowSummary

SetEvaluationType sets the EvaluationType field's value.

func (*WindowSummary) SetItemCount

func (s *WindowSummary) SetItemCount(v int64) *WindowSummary

SetItemCount sets the ItemCount field's value.

func (*WindowSummary) SetMetrics

func (s *WindowSummary) SetMetrics(v *Metrics) *WindowSummary

SetMetrics sets the Metrics field's value.

func (*WindowSummary) SetTestWindowEnd

func (s *WindowSummary) SetTestWindowEnd(v time.Time) *WindowSummary

SetTestWindowEnd sets the TestWindowEnd field's value.

func (*WindowSummary) SetTestWindowStart

func (s *WindowSummary) SetTestWindowStart(v time.Time) *WindowSummary

SetTestWindowStart sets the TestWindowStart field's value.

func (WindowSummary) String

func (s WindowSummary) String() string

String returns the string representation

Directories

Path Synopsis
Package forecastserviceiface provides an interface to enable mocking the Amazon Forecast Service service client for testing your code.
Package forecastserviceiface provides an interface to enable mocking the Amazon Forecast Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL