forecastservice

package
v1.42.9 Latest Latest
Warning

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

 Go to latest Published: Aug 3, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

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"

	// AttributeTypeGeolocation is a AttributeType enum value
	AttributeTypeGeolocation = "geolocation"
)
View Source 
const (
	// AutoMLOverrideStrategyLatencyOptimized is a AutoMLOverrideStrategy enum value
	AutoMLOverrideStrategyLatencyOptimized = "LatencyOptimized"

	// AutoMLOverrideStrategyAccuracyOptimized is a AutoMLOverrideStrategy enum value
	AutoMLOverrideStrategyAccuracyOptimized = "AccuracyOptimized"
)
View Source 
const (
	// ConditionEquals is a Condition enum value
	ConditionEquals = "EQUALS"

	// ConditionNotEquals is a Condition enum value
	ConditionNotEquals = "NOT_EQUALS"

	// ConditionLessThan is a Condition enum value
	ConditionLessThan = "LESS_THAN"

	// ConditionGreaterThan is a Condition enum value
	ConditionGreaterThan = "GREATER_THAN"
)
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 (
	// DayOfWeekMonday is a DayOfWeek enum value
	DayOfWeekMonday = "MONDAY"

	// DayOfWeekTuesday is a DayOfWeek enum value
	DayOfWeekTuesday = "TUESDAY"

	// DayOfWeekWednesday is a DayOfWeek enum value
	DayOfWeekWednesday = "WEDNESDAY"

	// DayOfWeekThursday is a DayOfWeek enum value
	DayOfWeekThursday = "THURSDAY"

	// DayOfWeekFriday is a DayOfWeek enum value
	DayOfWeekFriday = "FRIDAY"

	// DayOfWeekSaturday is a DayOfWeek enum value
	DayOfWeekSaturday = "SATURDAY"

	// DayOfWeekSunday is a DayOfWeek enum value
	DayOfWeekSunday = "SUNDAY"
)
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 (
	// ImportModeFull is a ImportMode enum value
	ImportModeFull = "FULL"

	// ImportModeIncremental is a ImportMode enum value
	ImportModeIncremental = "INCREMENTAL"
)
View Source 
const (
	// MonthJanuary is a Month enum value
	MonthJanuary = "JANUARY"

	// MonthFebruary is a Month enum value
	MonthFebruary = "FEBRUARY"

	// MonthMarch is a Month enum value
	MonthMarch = "MARCH"

	// MonthApril is a Month enum value
	MonthApril = "APRIL"

	// MonthMay is a Month enum value
	MonthMay = "MAY"

	// MonthJune is a Month enum value
	MonthJune = "JUNE"

	// MonthJuly is a Month enum value
	MonthJuly = "JULY"

	// MonthAugust is a Month enum value
	MonthAugust = "AUGUST"

	// MonthSeptember is a Month enum value
	MonthSeptember = "SEPTEMBER"

	// MonthOctober is a Month enum value
	MonthOctober = "OCTOBER"

	// MonthNovember is a Month enum value
	MonthNovember = "NOVEMBER"

	// MonthDecember is a Month enum value
	MonthDecember = "DECEMBER"
)
View Source 
const (
	// OperationAdd is a Operation enum value
	OperationAdd = "ADD"

	// OperationSubtract is a Operation enum value
	OperationSubtract = "SUBTRACT"

	// OperationMultiply is a Operation enum value
	OperationMultiply = "MULTIPLY"

	// OperationDivide is a Operation enum value
	OperationDivide = "DIVIDE"
)
View Source 
const (
	// OptimizationMetricWape is a OptimizationMetric enum value
	OptimizationMetricWape = "WAPE"

	// OptimizationMetricRmse is a OptimizationMetric enum value
	OptimizationMetricRmse = "RMSE"

	// OptimizationMetricAverageWeightedQuantileLoss is a OptimizationMetric enum value
	OptimizationMetricAverageWeightedQuantileLoss = "AverageWeightedQuantileLoss"

	// OptimizationMetricMase is a OptimizationMetric enum value
	OptimizationMetricMase = "MASE"

	// OptimizationMetricMape is a OptimizationMetric enum value
	OptimizationMetricMape = "MAPE"
)
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 (
	// StateActive is a State enum value
	StateActive = "Active"

	// StateDeleted is a State enum value
	StateDeleted = "Deleted"
)
View Source 
const (
	// TimePointGranularityAll is a TimePointGranularity enum value
	TimePointGranularityAll = "ALL"

	// TimePointGranularitySpecific is a TimePointGranularity enum value
	TimePointGranularitySpecific = "SPECIFIC"
)
View Source 
const (
	// TimeSeriesGranularityAll is a TimeSeriesGranularity enum value
	TimeSeriesGranularityAll = "ALL"

	// TimeSeriesGranularitySpecific is a TimeSeriesGranularity enum value
	TimeSeriesGranularitySpecific = "SPECIFIC"
)
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 resources per account has been exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// There is already a resource with this name. Try again with a different name.
	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 identifier of a specific service.
)

Service information constants

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

Variables

This section is empty.

Functions

func AttributeType_Values 

func AttributeType_Values() []string

AttributeType_Values returns all elements of the AttributeType enum

func AutoMLOverrideStrategy_Values 

func AutoMLOverrideStrategy_Values() []string

AutoMLOverrideStrategy_Values returns all elements of the AutoMLOverrideStrategy enum

func Condition_Values added in v1.42.9 

func Condition_Values() []string

Condition_Values returns all elements of the Condition enum

func DatasetType_Values 

func DatasetType_Values() []string

DatasetType_Values returns all elements of the DatasetType enum

func DayOfWeek_Values added in v1.42.9 

func DayOfWeek_Values() []string

DayOfWeek_Values returns all elements of the DayOfWeek enum

func Domain_Values 

func Domain_Values() []string

Domain_Values returns all elements of the Domain enum

func EvaluationType_Values 

func EvaluationType_Values() []string

EvaluationType_Values returns all elements of the EvaluationType enum

func FeaturizationMethodName_Values 

func FeaturizationMethodName_Values() []string

FeaturizationMethodName_Values returns all elements of the FeaturizationMethodName enum

func FilterConditionString_Values 

func FilterConditionString_Values() []string

FilterConditionString_Values returns all elements of the FilterConditionString enum

func ImportMode_Values added in v1.42.9 

func ImportMode_Values() []string

ImportMode_Values returns all elements of the ImportMode enum

func Month_Values added in v1.42.9 

func Month_Values() []string

Month_Values returns all elements of the Month enum

func Operation_Values added in v1.42.9 

func Operation_Values() []string

Operation_Values returns all elements of the Operation enum

func OptimizationMetric_Values 

func OptimizationMetric_Values() []string

OptimizationMetric_Values returns all elements of the OptimizationMetric enum

func ScalingType_Values 

func ScalingType_Values() []string

ScalingType_Values returns all elements of the ScalingType enum

func State_Values added in v1.42.9 

func State_Values() []string

State_Values returns all elements of the State enum

func TimePointGranularity_Values added in v1.42.9 

func TimePointGranularity_Values() []string

TimePointGranularity_Values returns all elements of the TimePointGranularity enum

func TimeSeriesGranularity_Values added in v1.42.9 

func TimeSeriesGranularity_Values() []string

TimeSeriesGranularity_Values returns all elements of the TimeSeriesGranularity enum

Types

type Action added in v1.42.9 

type Action struct {

	// The related time series that you are modifying. This value is case insensitive.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// The operation that is applied to the provided attribute. Operations include:
	//
	//    * ADD - adds Value to all rows of AttributeName.
	//
	//    * SUBTRACT - subtracts Value from all rows of AttributeName.
	//
	//    * MULTIPLY - multiplies all rows of AttributeName by Value.
	//
	//    * DIVIDE - divides all rows of AttributeName by Value.
	//
	// Operation is a required field
	Operation *string `type:"string" required:"true" enum:"Operation"`

	// The value that is applied for the chosen Operation.
	//
	// Value is a required field
	Value *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Defines the modifications that you are making to an attribute for a what-if forecast. For example, you can use this operation to create a what-if forecast that investigates a 10% off sale on all shoes. To do this, you specify "AttributeName": "shoes", "Operation": "MULTIPLY", and "Value": "0.90". Pair this operation with the TimeSeriesCondition operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define a subset of attribute items that are modified.

func (Action) GoString added in v1.42.9 

func (s Action) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Action) SetAttributeName added in v1.42.9 

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

SetAttributeName sets the AttributeName field's value.

func (*Action) SetOperation added in v1.42.9 

func (s *Action) SetOperation(v string) *Action

SetOperation sets the Operation field's value.

func (*Action) SetValue added in v1.42.9 

func (s *Action) SetValue(v float64) *Action

SetValue sets the Value field's value.

func (Action) String added in v1.42.9 

func (s Action) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Action) Validate added in v1.42.9 

func (s *Action) Validate() error

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

type AdditionalDataset added in v1.42.9 

type AdditionalDataset struct {

	// Weather Index
	//
	// To enable the Weather Index, do not specify a value for Configuration.
	//
	// Holidays
	//
	// Holidays
	//
	// To enable Holidays, set CountryCode to one of the following two-letter country
	// codes:
	//
	//    * "AL" - ALBANIA
	//
	//    * "AR" - ARGENTINA
	//
	//    * "AT" - AUSTRIA
	//
	//    * "AU" - AUSTRALIA
	//
	//    * "BA" - BOSNIA HERZEGOVINA
	//
	//    * "BE" - BELGIUM
	//
	//    * "BG" - BULGARIA
	//
	//    * "BO" - BOLIVIA
	//
	//    * "BR" - BRAZIL
	//
	//    * "BY" - BELARUS
	//
	//    * "CA" - CANADA
	//
	//    * "CL" - CHILE
	//
	//    * "CO" - COLOMBIA
	//
	//    * "CR" - COSTA RICA
	//
	//    * "HR" - CROATIA
	//
	//    * "CZ" - CZECH REPUBLIC
	//
	//    * "DK" - DENMARK
	//
	//    * "EC" - ECUADOR
	//
	//    * "EE" - ESTONIA
	//
	//    * "ET" - ETHIOPIA
	//
	//    * "FI" - FINLAND
	//
	//    * "FR" - FRANCE
	//
	//    * "DE" - GERMANY
	//
	//    * "GR" - GREECE
	//
	//    * "HU" - HUNGARY
	//
	//    * "IS" - ICELAND
	//
	//    * "IN" - INDIA
	//
	//    * "IE" - IRELAND
	//
	//    * "IT" - ITALY
	//
	//    * "JP" - JAPAN
	//
	//    * "KZ" - KAZAKHSTAN
	//
	//    * "KR" - KOREA
	//
	//    * "LV" - LATVIA
	//
	//    * "LI" - LIECHTENSTEIN
	//
	//    * "LT" - LITHUANIA
	//
	//    * "LU" - LUXEMBOURG
	//
	//    * "MK" - MACEDONIA
	//
	//    * "MT" - MALTA
	//
	//    * "MX" - MEXICO
	//
	//    * "MD" - MOLDOVA
	//
	//    * "ME" - MONTENEGRO
	//
	//    * "NL" - NETHERLANDS
	//
	//    * "NZ" - NEW ZEALAND
	//
	//    * "NI" - NICARAGUA
	//
	//    * "NG" - NIGERIA
	//
	//    * "NO" - NORWAY
	//
	//    * "PA" - PANAMA
	//
	//    * "PY" - PARAGUAY
	//
	//    * "PE" - PERU
	//
	//    * "PL" - POLAND
	//
	//    * "PT" - PORTUGAL
	//
	//    * "RO" - ROMANIA
	//
	//    * "RU" - RUSSIA
	//
	//    * "RS" - SERBIA
	//
	//    * "SK" - SLOVAKIA
	//
	//    * "SI" - SLOVENIA
	//
	//    * "ZA" - SOUTH AFRICA
	//
	//    * "ES" - SPAIN
	//
	//    * "SE" - SWEDEN
	//
	//    * "CH" - SWITZERLAND
	//
	//    * "UA" - UKRAINE
	//
	//    * "AE" - UNITED ARAB EMIRATES
	//
	//    * "US" - UNITED STATES
	//
	//    * "UK" - UNITED KINGDOM
	//
	//    * "UY" - URUGUAY
	//
	//    * "VE" - VENEZUELA
	Configuration map[string][]*string `type:"map"`

	// The name of the additional dataset. Valid names: "holiday" and "weather".
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.

Weather Index

The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index (https://docs.aws.amazon.com/forecast/latest/dg/weather.html).

Holidays

Holidays is a built-in dataset that incorporates national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday (http://jollyday.sourceforge.net/data.html) library. For more information, see Holidays Featurization (https://docs.aws.amazon.com/forecast/latest/dg/holidays.html).

func (AdditionalDataset) GoString added in v1.42.9 

func (s AdditionalDataset) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdditionalDataset) SetConfiguration added in v1.42.9 

func (s *AdditionalDataset) SetConfiguration(v map[string][]*string) *AdditionalDataset

SetConfiguration sets the Configuration field's value.

func (*AdditionalDataset) SetName added in v1.42.9 

func (s *AdditionalDataset) SetName(v string) *AdditionalDataset

SetName sets the Name field's value.

func (AdditionalDataset) String added in v1.42.9 

func (s AdditionalDataset) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdditionalDataset) Validate added in v1.42.9 

func (s *AdditionalDataset) Validate() error

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

type AttributeConfig added in v1.42.9 

type AttributeConfig struct {

	// The name of the attribute as specified in the schema. Amazon Forecast supports
	// the target field of the target time series and the related time series datasets.
	// For example, for the RETAIL domain, the target is demand.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// The method parameters (key-value pairs), which are a map of override parameters.
	// Specify these parameters to override the default values. Related Time Series
	// attributes do not accept aggregation parameters.
	//
	// The following list shows the parameters and their valid values for the "filling"
	// featurization method for a Target Time Series dataset. Default values are
	// bolded.
	//
	//    * aggregation: sum, avg, first, min, max
	//
	//    * frontfill: none
	//
	//    * middlefill: zero, nan (not a number), value, median, mean, min, max
	//
	//    * backfill: zero, nan, value, median, mean, min, max
	//
	// The following list shows the parameters and their valid values for a Related
	// Time Series featurization method (there are no defaults):
	//
	//    * middlefill: zero, value, median, mean, min, max
	//
	//    * backfill: zero, value, median, mean, min, max
	//
	//    * futurefill: zero, value, median, mean, min, max
	//
	// To set a filling method to a specific value, set the fill parameter to value
	// and define the value in a corresponding _value parameter. For example, to
	// set backfilling to a value of 2, include the following: "backfill": "value"
	// and "backfill_value":"2".
	//
	// Transformations is a required field
	Transformations map[string]*string `min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the method used to transform attributes.

The following is an example using the RETAIL domain:

{

"AttributeName": "demand",

"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}

}

func (AttributeConfig) GoString added in v1.42.9 

func (s AttributeConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeConfig) SetAttributeName added in v1.42.9 

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

SetAttributeName sets the AttributeName field's value.

func (*AttributeConfig) SetTransformations added in v1.42.9 

func (s *AttributeConfig) SetTransformations(v map[string]*string) *AttributeConfig

SetTransformations sets the Transformations field's value.

func (AttributeConfig) String added in v1.42.9 

func (s AttributeConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeConfig) Validate added in v1.42.9 

func (s *AttributeConfig) Validate() error

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

type Baseline added in v1.42.9 

type Baseline struct {

	// The initial accuracy metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)
	// for the predictor you are monitoring. Use these metrics as a baseline for
	// comparison purposes as you use your predictor and the metrics change.
	PredictorBaseline *PredictorBaseline `type:"structure"`
	// contains filtered or unexported fields
}

Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.

func (Baseline) GoString added in v1.42.9 

func (s Baseline) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Baseline) SetPredictorBaseline added in v1.42.9 

func (s *Baseline) SetPredictorBaseline(v *PredictorBaseline) *Baseline

SetPredictorBaseline sets the PredictorBaseline field's value.

func (Baseline) String added in v1.42.9 

func (s Baseline) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BaselineMetric added in v1.42.9 

type BaselineMetric struct {

	// The name of the metric.
	Name *string `min:"1" type:"string"`

	// The value for the metric.
	Value *float64 `type:"double"`
	// contains filtered or unexported fields
}

An individual metric that you can use for comparison as you evaluate your monitoring results.

func (BaselineMetric) GoString added in v1.42.9 

func (s BaselineMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BaselineMetric) SetName added in v1.42.9 

func (s *BaselineMetric) SetName(v string) *BaselineMetric

SetName sets the Name field's value.

func (*BaselineMetric) SetValue added in v1.42.9 

func (s *BaselineMetric) SetValue(v float64) *BaselineMetric

SetValue sets the Value field's value.

func (BaselineMetric) String added in v1.42.9 

func (s BaselineMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CategoricalParameterRange) SetName 

func (s *CategoricalParameterRange) SetName(v string) *CategoricalParameterRange

SetName sets the Name field's value.

func (*CategoricalParameterRange) SetValues 

func (s *CategoricalParameterRange) SetValues(v []*string) *CategoricalParameterRange

SetValues sets the Values field's value.

func (CategoricalParameterRange) String 

func (s CategoricalParameterRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.
	// Valid values:
	//
	// Auto
	//
	// Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
	//
	// Linear
	//
	// Hyperparameter tuning searches the values in the hyperparameter range by
	// using a linear scale.
	//
	// Logarithmic
	//
	// Hyperparameter tuning searches the values in the hyperparameter range by
	// using a logarithmic scale.
	//
	// Logarithmic scaling works only for ranges that have values greater than 0.
	//
	// ReverseLogarithmic
	//
	// hyperparameter tuning searches the values in the hyperparameter range by
	// using a reverse logarithmic scale.
	//
	// Reverse logarithmic scaling works only for ranges that are entirely within
	// the range 0 <= x < 1.0.
	//
	// For information about choosing a hyperparameter scale, see Hyperparameter
	// Scaling (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type).
	// One of the following values:
	ScalingType *string `type:"string" enum:"ScalingType"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContinuousParameterRange) SetMaxValue 

func (s *ContinuousParameterRange) SetMaxValue(v float64) *ContinuousParameterRange

SetMaxValue sets the MaxValue field's value.

func (*ContinuousParameterRange) SetMinValue 

func (s *ContinuousParameterRange) SetMinValue(v float64) *ContinuousParameterRange

SetMinValue sets the MinValue field's value.

func (*ContinuousParameterRange) SetName 

func (s *ContinuousParameterRange) SetName(v string) *ContinuousParameterRange

SetName sets the Name field's value.

func (*ContinuousParameterRange) SetScalingType 

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

SetScalingType sets the ScalingType field's value.

func (ContinuousParameterRange) String 

func (s ContinuousParameterRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContinuousParameterRange) Validate 

func (s *ContinuousParameterRange) Validate() error

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

type CreateAutoPredictorInput added in v1.42.9 

type CreateAutoPredictorInput struct {

	// The data configuration for your dataset group and any additional datasets.
	DataConfig *DataConfig `type:"structure"`

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

	// Create an Explainability resource for the predictor.
	ExplainPredictor *bool `type:"boolean"`

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

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

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

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

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

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric *string `type:"string" enum:"OptimizationMetric"`

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

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

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

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

func (CreateAutoPredictorInput) GoString added in v1.42.9 

func (s CreateAutoPredictorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAutoPredictorInput) SetDataConfig added in v1.42.9 

func (s *CreateAutoPredictorInput) SetDataConfig(v *DataConfig) *CreateAutoPredictorInput

SetDataConfig sets the DataConfig field's value.

func (*CreateAutoPredictorInput) SetEncryptionConfig added in v1.42.9 

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

SetEncryptionConfig sets the EncryptionConfig field's value.

func (*CreateAutoPredictorInput) SetExplainPredictor added in v1.42.9 

func (s *CreateAutoPredictorInput) SetExplainPredictor(v bool) *CreateAutoPredictorInput

SetExplainPredictor sets the ExplainPredictor field's value.

func (*CreateAutoPredictorInput) SetForecastDimensions added in v1.42.9 

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

SetForecastDimensions sets the ForecastDimensions field's value.

func (*CreateAutoPredictorInput) SetForecastFrequency added in v1.42.9 

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

SetForecastFrequency sets the ForecastFrequency field's value.

func (*CreateAutoPredictorInput) SetForecastHorizon added in v1.42.9 

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

SetForecastHorizon sets the ForecastHorizon field's value.

func (*CreateAutoPredictorInput) SetForecastTypes added in v1.42.9 

func (s *CreateAutoPredictorInput) SetForecastTypes(v []*string) *CreateAutoPredictorInput

SetForecastTypes sets the ForecastTypes field's value.

func (*CreateAutoPredictorInput) SetMonitorConfig added in v1.42.9 

func (s *CreateAutoPredictorInput) SetMonitorConfig(v *MonitorConfig) *CreateAutoPredictorInput

SetMonitorConfig sets the MonitorConfig field's value.

func (*CreateAutoPredictorInput) SetOptimizationMetric added in v1.42.9 

func (s *CreateAutoPredictorInput) SetOptimizationMetric(v string) *CreateAutoPredictorInput

SetOptimizationMetric sets the OptimizationMetric field's value.

func (*CreateAutoPredictorInput) SetPredictorName added in v1.42.9 

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

SetPredictorName sets the PredictorName field's value.

func (*CreateAutoPredictorInput) SetReferencePredictorArn added in v1.42.9 

func (s *CreateAutoPredictorInput) SetReferencePredictorArn(v string) *CreateAutoPredictorInput

SetReferencePredictorArn sets the ReferencePredictorArn field's value.

func (*CreateAutoPredictorInput) SetTags added in v1.42.9 

func (s *CreateAutoPredictorInput) SetTags(v []*Tag) *CreateAutoPredictorInput

SetTags sets the Tags field's value.

func (*CreateAutoPredictorInput) SetTimeAlignmentBoundary added in v1.42.9 

func (s *CreateAutoPredictorInput) SetTimeAlignmentBoundary(v *TimeAlignmentBoundary) *CreateAutoPredictorInput

SetTimeAlignmentBoundary sets the TimeAlignmentBoundary field's value.

func (CreateAutoPredictorInput) String added in v1.42.9 

func (s CreateAutoPredictorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAutoPredictorInput) Validate added in v1.42.9 

func (s *CreateAutoPredictorInput) Validate() error

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

type CreateAutoPredictorOutput added in v1.42.9 

type CreateAutoPredictorOutput struct {

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

func (CreateAutoPredictorOutput) GoString added in v1.42.9 

func (s CreateAutoPredictorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAutoPredictorOutput) SetPredictorArn added in v1.42.9 

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

SetPredictorArn sets the PredictorArn field's value.

func (CreateAutoPredictorOutput) String added in v1.42.9 

func (s CreateAutoPredictorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. When you add a dataset to a
	// dataset group, this value and the value specified for the Domain parameter
	// of the CreateDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html)
	// operation must match.
	//
	// The Domain and DatasetType that you choose determine the fields that must
	// be present in training data that you import to a dataset. For example, if
	// you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon
	// Forecast requires that item_id, timestamp, and demand fields are present
	// in your data. For more information, see Dataset groups (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).
	//
	// Domain is a required field
	Domain *string `type:"string" required:"true" enum:"Domain"`

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

func (CreateDatasetGroupInput) GoString 

func (s CreateDatasetGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

SetDomain sets the Domain field's value.

func (*CreateDatasetGroupInput) SetTags 

func (s *CreateDatasetGroupInput) SetTags(v []*Tag) *CreateDatasetGroupInput

SetTags sets the Tags field's value.

func (CreateDatasetGroupInput) String 

func (s CreateDatasetGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDatasetImportJobInput 

type CreateDatasetImportJobInput struct {

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

	// The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want
	// to import data to.
	//
	// DatasetArn is a required field
	DatasetArn *string `type:"string" required:"true"`

	// The name for the dataset import job. We recommend including the current timestamp
	// in the name, for example, 20190721DatasetImport. This can help you avoid
	// getting a ResourceAlreadyExistsException exception.
	//
	// DatasetImportJobName is a required field
	DatasetImportJobName *string `min:"1" type:"string" required:"true"`

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

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

	// Specifies whether the dataset import job is a FULL or INCREMENTAL import.
	// A FULL dataset import replaces all of the existing data with the newly imported
	// data. An INCREMENTAL import appends the imported data to the existing data.
	ImportMode *string `type:"string" enum:"ImportMode"`

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

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

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

	// Automatically derive time zone information from the geolocation attribute.
	// This option is ideal for datasets that contain timestamps in multiple time
	// zones and those timestamps are expressed in local time.
	UseGeolocationForTimeZone *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (CreateDatasetImportJobInput) GoString 

func (s CreateDatasetImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetImportJobInput) SetDataSource 

func (s *CreateDatasetImportJobInput) SetDataSource(v *DataSource) *CreateDatasetImportJobInput

SetDataSource sets the DataSource field's value.

func (*CreateDatasetImportJobInput) SetDatasetArn 

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

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) SetFormat added in v1.42.9 

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

SetFormat sets the Format field's value.

func (*CreateDatasetImportJobInput) SetGeolocationFormat 

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

SetGeolocationFormat sets the GeolocationFormat field's value.

func (*CreateDatasetImportJobInput) SetImportMode added in v1.42.9 

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

SetImportMode sets the ImportMode field's value.

func (*CreateDatasetImportJobInput) SetTags 

func (s *CreateDatasetImportJobInput) SetTags(v []*Tag) *CreateDatasetImportJobInput

SetTags sets the Tags field's value.

func (*CreateDatasetImportJobInput) SetTimeZone 

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

SetTimeZone sets the TimeZone field's value.

func (*CreateDatasetImportJobInput) SetTimestampFormat 

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

SetTimestampFormat sets the TimestampFormat field's value.

func (*CreateDatasetImportJobInput) SetUseGeolocationForTimeZone 

func (s *CreateDatasetImportJobInput) SetUseGeolocationForTimeZone(v bool) *CreateDatasetImportJobInput

SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value.

func (CreateDatasetImportJobInput) String 

func (s CreateDatasetImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetImportJobOutput) SetDatasetImportJobArn 

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

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (CreateDatasetImportJobOutput) String 

func (s CreateDatasetImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDatasetInput 

type CreateDatasetInput struct {

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

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

	// The dataset type. Valid values depend on the chosen Domain.
	//
	// DatasetType is a required field
	DatasetType *string `type:"string" required:"true" enum:"DatasetType"`

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

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

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

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

func (CreateDatasetInput) GoString 

func (s CreateDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetTags 

func (s *CreateDatasetInput) SetTags(v []*Tag) *CreateDatasetInput

SetTags sets the Tags field's value.

func (CreateDatasetInput) String 

func (s CreateDatasetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateExplainabilityExportInput added in v1.42.9 

type CreateExplainabilityExportInput struct {

	// The destination for an export job. Provide an S3 path, an Identity and Access
	// Management (IAM) role that allows Amazon Forecast to access the location,
	// and an Key Management Service (KMS) key (optional).
	//
	// Destination is a required field
	Destination *DataDestination `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of the Explainability to export.
	//
	// ExplainabilityArn is a required field
	ExplainabilityArn *string `type:"string" required:"true"`

	// A unique name for the Explainability export.
	//
	// ExplainabilityExportName is a required field
	ExplainabilityExportName *string `min:"1" type:"string" required:"true"`

	// The format of the exported data, CSV or PARQUET.
	Format *string `type:"string"`

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

func (CreateExplainabilityExportInput) GoString added in v1.42.9 

func (s CreateExplainabilityExportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExplainabilityExportInput) SetDestination added in v1.42.9 

func (s *CreateExplainabilityExportInput) SetDestination(v *DataDestination) *CreateExplainabilityExportInput

SetDestination sets the Destination field's value.

func (*CreateExplainabilityExportInput) SetExplainabilityArn added in v1.42.9 

func (s *CreateExplainabilityExportInput) SetExplainabilityArn(v string) *CreateExplainabilityExportInput

SetExplainabilityArn sets the ExplainabilityArn field's value.

func (*CreateExplainabilityExportInput) SetExplainabilityExportName added in v1.42.9 

func (s *CreateExplainabilityExportInput) SetExplainabilityExportName(v string) *CreateExplainabilityExportInput

SetExplainabilityExportName sets the ExplainabilityExportName field's value.

func (*CreateExplainabilityExportInput) SetFormat added in v1.42.9 

func (s *CreateExplainabilityExportInput) SetFormat(v string) *CreateExplainabilityExportInput

SetFormat sets the Format field's value.

func (*CreateExplainabilityExportInput) SetTags added in v1.42.9 

func (s *CreateExplainabilityExportInput) SetTags(v []*Tag) *CreateExplainabilityExportInput

SetTags sets the Tags field's value.

func (CreateExplainabilityExportInput) String added in v1.42.9 

func (s CreateExplainabilityExportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExplainabilityExportInput) Validate added in v1.42.9 

func (s *CreateExplainabilityExportInput) Validate() error

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

type CreateExplainabilityExportOutput added in v1.42.9 

type CreateExplainabilityExportOutput struct {

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

func (CreateExplainabilityExportOutput) GoString added in v1.42.9 

func (s CreateExplainabilityExportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExplainabilityExportOutput) SetExplainabilityExportArn added in v1.42.9 

func (s *CreateExplainabilityExportOutput) SetExplainabilityExportArn(v string) *CreateExplainabilityExportOutput

SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.

func (CreateExplainabilityExportOutput) String added in v1.42.9 

func (s CreateExplainabilityExportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateExplainabilityInput added in v1.42.9 

type CreateExplainabilityInput struct {

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

	// Create an Explainability visualization that is viewable within the Amazon
	// Web Services console.
	EnableVisualization *bool `type:"boolean"`

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

	// The configuration settings that define the granularity of time series and
	// time points for the Explainability.
	//
	// ExplainabilityConfig is a required field
	ExplainabilityConfig *ExplainabilityConfig `type:"structure" required:"true"`

	// A unique name for the Explainability.
	//
	// ExplainabilityName is a required field
	ExplainabilityName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Predictor or Forecast used to create
	// the Explainability.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// Defines the fields of a dataset.
	Schema *Schema `type:"structure"`

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

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

func (CreateExplainabilityInput) GoString added in v1.42.9 

func (s CreateExplainabilityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExplainabilityInput) SetDataSource added in v1.42.9 

func (s *CreateExplainabilityInput) SetDataSource(v *DataSource) *CreateExplainabilityInput

SetDataSource sets the DataSource field's value.

func (*CreateExplainabilityInput) SetEnableVisualization added in v1.42.9 

func (s *CreateExplainabilityInput) SetEnableVisualization(v bool) *CreateExplainabilityInput

SetEnableVisualization sets the EnableVisualization field's value.

func (*CreateExplainabilityInput) SetEndDateTime added in v1.42.9 

func (s *CreateExplainabilityInput) SetEndDateTime(v string) *CreateExplainabilityInput

SetEndDateTime sets the EndDateTime field's value.

func (*CreateExplainabilityInput) SetExplainabilityConfig added in v1.42.9 

func (s *CreateExplainabilityInput) SetExplainabilityConfig(v *ExplainabilityConfig) *CreateExplainabilityInput

SetExplainabilityConfig sets the ExplainabilityConfig field's value.

func (*CreateExplainabilityInput) SetExplainabilityName added in v1.42.9 

func (s *CreateExplainabilityInput) SetExplainabilityName(v string) *CreateExplainabilityInput

SetExplainabilityName sets the ExplainabilityName field's value.

func (*CreateExplainabilityInput) SetResourceArn added in v1.42.9 

func (s *CreateExplainabilityInput) SetResourceArn(v string) *CreateExplainabilityInput

SetResourceArn sets the ResourceArn field's value.

func (*CreateExplainabilityInput) SetSchema added in v1.42.9 

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

SetSchema sets the Schema field's value.

func (*CreateExplainabilityInput) SetStartDateTime added in v1.42.9 

func (s *CreateExplainabilityInput) SetStartDateTime(v string) *CreateExplainabilityInput

SetStartDateTime sets the StartDateTime field's value.

func (*CreateExplainabilityInput) SetTags added in v1.42.9 

func (s *CreateExplainabilityInput) SetTags(v []*Tag) *CreateExplainabilityInput

SetTags sets the Tags field's value.

func (CreateExplainabilityInput) String added in v1.42.9 

func (s CreateExplainabilityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExplainabilityInput) Validate added in v1.42.9 

func (s *CreateExplainabilityInput) Validate() error

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

type CreateExplainabilityOutput added in v1.42.9 

type CreateExplainabilityOutput struct {

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

func (CreateExplainabilityOutput) GoString added in v1.42.9 

func (s CreateExplainabilityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExplainabilityOutput) SetExplainabilityArn added in v1.42.9 

func (s *CreateExplainabilityOutput) SetExplainabilityArn(v string) *CreateExplainabilityOutput

SetExplainabilityArn sets the ExplainabilityArn field's value.

func (CreateExplainabilityOutput) String added in v1.42.9 

func (s CreateExplainabilityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateForecastExportJobInput 

type CreateForecastExportJobInput struct {

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

	// The Amazon Resource Name (ARN) of the forecast that you want to export.
	//
	// ForecastArn is a required field
	ForecastArn *string `type:"string" required:"true"`

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

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

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

func (CreateForecastExportJobInput) GoString 

func (s CreateForecastExportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateForecastExportJobInput) SetDestination 

func (s *CreateForecastExportJobInput) SetDestination(v *DataDestination) *CreateForecastExportJobInput

SetDestination sets the Destination field's value.

func (*CreateForecastExportJobInput) SetForecastArn 

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

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) SetFormat added in v1.42.9 

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

SetFormat sets the Format field's value.

func (*CreateForecastExportJobInput) SetTags 

func (s *CreateForecastExportJobInput) SetTags(v []*Tag) *CreateForecastExportJobInput

SetTags sets the Tags field's value.

func (CreateForecastExportJobInput) String 

func (s CreateForecastExportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s CreateForecastExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateForecastExportJobOutput) SetForecastExportJobArn 

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

SetForecastExportJobArn sets the ForecastExportJobArn field's value.

func (CreateForecastExportJobOutput) String 

func (s CreateForecastExportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateForecastInput 

type CreateForecastInput struct {

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

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

	// The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
	//
	// PredictorArn is a required field
	PredictorArn *string `type:"string" required:"true"`

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

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

func (CreateForecastInput) GoString 

func (s CreateForecastInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateForecastInput) SetForecastName 

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

SetForecastName sets the ForecastName field's value.

func (*CreateForecastInput) SetForecastTypes 

func (s *CreateForecastInput) SetForecastTypes(v []*string) *CreateForecastInput

SetForecastTypes sets the ForecastTypes field's value.

func (*CreateForecastInput) SetPredictorArn 

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

SetPredictorArn sets the PredictorArn field's value.

func (*CreateForecastInput) SetTags 

func (s *CreateForecastInput) SetTags(v []*Tag) *CreateForecastInput

SetTags sets the Tags field's value.

func (*CreateForecastInput) SetTimeSeriesSelector added in v1.42.9 

func (s *CreateForecastInput) SetTimeSeriesSelector(v *TimeSeriesSelector) *CreateForecastInput

SetTimeSeriesSelector sets the TimeSeriesSelector field's value.

func (CreateForecastInput) String 

func (s CreateForecastInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateMonitorInput added in v1.42.9 

type CreateMonitorInput struct {

	// The name of the monitor resource.
	//
	// MonitorName is a required field
	MonitorName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the predictor to monitor.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

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

func (CreateMonitorInput) GoString added in v1.42.9 

func (s CreateMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMonitorInput) SetMonitorName added in v1.42.9 

func (s *CreateMonitorInput) SetMonitorName(v string) *CreateMonitorInput

SetMonitorName sets the MonitorName field's value.

func (*CreateMonitorInput) SetResourceArn added in v1.42.9 

func (s *CreateMonitorInput) SetResourceArn(v string) *CreateMonitorInput

SetResourceArn sets the ResourceArn field's value.

func (*CreateMonitorInput) SetTags added in v1.42.9 

func (s *CreateMonitorInput) SetTags(v []*Tag) *CreateMonitorInput

SetTags sets the Tags field's value.

func (CreateMonitorInput) String added in v1.42.9 

func (s CreateMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMonitorInput) Validate added in v1.42.9 

func (s *CreateMonitorInput) Validate() error

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

type CreateMonitorOutput added in v1.42.9 

type CreateMonitorOutput struct {

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

func (CreateMonitorOutput) GoString added in v1.42.9 

func (s CreateMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMonitorOutput) SetMonitorArn added in v1.42.9 

func (s *CreateMonitorOutput) SetMonitorArn(v string) *CreateMonitorOutput

SetMonitorArn sets the MonitorArn field's value.

func (CreateMonitorOutput) String added in v1.42.9 

func (s CreateMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePredictorBacktestExportJobInput 

type CreatePredictorBacktestExportJobInput struct {

	// The destination for an export job. Provide an S3 path, an Identity and Access
	// Management (IAM) role that allows Amazon Forecast to access the location,
	// and an Key Management Service (KMS) key (optional).
	//
	// Destination is a required field
	Destination *DataDestination `type:"structure" required:"true"`

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

	// The Amazon Resource Name (ARN) of the predictor that you want to export.
	//
	// PredictorArn is a required field
	PredictorArn *string `type:"string" required:"true"`

	// The name for the backtest export job.
	//
	// PredictorBacktestExportJobName is a required field
	PredictorBacktestExportJobName *string `min:"1" type:"string" required:"true"`

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

func (CreatePredictorBacktestExportJobInput) GoString 

func (s CreatePredictorBacktestExportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePredictorBacktestExportJobInput) SetDestination 

func (s *CreatePredictorBacktestExportJobInput) SetDestination(v *DataDestination) *CreatePredictorBacktestExportJobInput

SetDestination sets the Destination field's value.

func (*CreatePredictorBacktestExportJobInput) SetFormat added in v1.42.9 

func (s *CreatePredictorBacktestExportJobInput) SetFormat(v string) *CreatePredictorBacktestExportJobInput

SetFormat sets the Format field's value.

func (*CreatePredictorBacktestExportJobInput) SetPredictorArn 

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

SetPredictorArn sets the PredictorArn field's value.

func (*CreatePredictorBacktestExportJobInput) SetPredictorBacktestExportJobName 

func (s *CreatePredictorBacktestExportJobInput) SetPredictorBacktestExportJobName(v string) *CreatePredictorBacktestExportJobInput

SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value.

func (*CreatePredictorBacktestExportJobInput) SetTags 

func (s *CreatePredictorBacktestExportJobInput) SetTags(v []*Tag) *CreatePredictorBacktestExportJobInput

SetTags sets the Tags field's value.

func (CreatePredictorBacktestExportJobInput) String 

func (s CreatePredictorBacktestExportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePredictorBacktestExportJobInput) Validate 

func (s *CreatePredictorBacktestExportJobInput) Validate() error

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

type CreatePredictorBacktestExportJobOutput 

type CreatePredictorBacktestExportJobOutput struct {

	// The Amazon Resource Name (ARN) of the predictor backtest export job that
	// you want to export.
	PredictorBacktestExportJobArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreatePredictorBacktestExportJobOutput) GoString 

func (s CreatePredictorBacktestExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn 

func (s *CreatePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn(v string) *CreatePredictorBacktestExportJobOutput

SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.

func (CreatePredictorBacktestExportJobOutput) String 

func (s CreatePredictorBacktestExportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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/CNN-QR
	//
	//    * arn:aws:forecast:::algorithm/Deep_AR_Plus
	//
	//    * arn:aws:forecast:::algorithm/ETS
	//
	//    * arn:aws:forecast:::algorithm/NPTS
	//
	//    * arn:aws:forecast:::algorithm/Prophet
	AlgorithmArn *string `type:"string"`

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

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

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

	// The featurization configuration.
	//
	// FeaturizationConfig is a required field
	FeaturizationConfig *FeaturizationConfig `type:"structure" required:"true"`

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

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

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

	// Describes the dataset group that contains the data to use to train the predictor.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric *string `type:"string" enum:"OptimizationMetric"`

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

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

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

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

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

func (CreatePredictorInput) GoString 

func (s CreatePredictorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePredictorInput) SetAlgorithmArn 

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

SetAlgorithmArn sets the AlgorithmArn field's value.

func (*CreatePredictorInput) SetAutoMLOverrideStrategy 

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

SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy 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) SetForecastTypes 

func (s *CreatePredictorInput) SetForecastTypes(v []*string) *CreatePredictorInput

SetForecastTypes sets the ForecastTypes field's value.

func (*CreatePredictorInput) SetHPOConfig 

func (s *CreatePredictorInput) SetHPOConfig(v *HyperParameterTuningJobConfig) *CreatePredictorInput

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) SetOptimizationMetric 

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

SetOptimizationMetric sets the OptimizationMetric 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) SetTags 

func (s *CreatePredictorInput) SetTags(v []*Tag) *CreatePredictorInput

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWhatIfAnalysisInput added in v1.42.9 

type CreateWhatIfAnalysisInput struct {

	// The Amazon Resource Name (ARN) of the baseline forecast.
	//
	// ForecastArn is a required field
	ForecastArn *string `type:"string" required:"true"`

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

	// Defines the set of time series that are used in the what-if analysis with
	// a TimeSeriesIdentifiers object. What-if analyses are performed only for the
	// time series in this object.
	//
	// The TimeSeriesIdentifiers object needs the following information:
	//
	//    * DataSource
	//
	//    * Format
	//
	//    * Schema
	TimeSeriesSelector *TimeSeriesSelector `type:"structure"`

	// The name of the what-if analysis. Each name must be unique.
	//
	// WhatIfAnalysisName is a required field
	WhatIfAnalysisName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWhatIfAnalysisInput) GoString added in v1.42.9 

func (s CreateWhatIfAnalysisInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWhatIfAnalysisInput) SetForecastArn added in v1.42.9 

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

SetForecastArn sets the ForecastArn field's value.

func (*CreateWhatIfAnalysisInput) SetTags added in v1.42.9 

func (s *CreateWhatIfAnalysisInput) SetTags(v []*Tag) *CreateWhatIfAnalysisInput

SetTags sets the Tags field's value.

func (*CreateWhatIfAnalysisInput) SetTimeSeriesSelector added in v1.42.9 

func (s *CreateWhatIfAnalysisInput) SetTimeSeriesSelector(v *TimeSeriesSelector) *CreateWhatIfAnalysisInput

SetTimeSeriesSelector sets the TimeSeriesSelector field's value.

func (*CreateWhatIfAnalysisInput) SetWhatIfAnalysisName added in v1.42.9 

func (s *CreateWhatIfAnalysisInput) SetWhatIfAnalysisName(v string) *CreateWhatIfAnalysisInput

SetWhatIfAnalysisName sets the WhatIfAnalysisName field's value.

func (CreateWhatIfAnalysisInput) String added in v1.42.9 

func (s CreateWhatIfAnalysisInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWhatIfAnalysisInput) Validate added in v1.42.9 

func (s *CreateWhatIfAnalysisInput) Validate() error

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

type CreateWhatIfAnalysisOutput added in v1.42.9 

type CreateWhatIfAnalysisOutput struct {

	// The Amazon Resource Name (ARN) of the what-if analysis.
	WhatIfAnalysisArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateWhatIfAnalysisOutput) GoString added in v1.42.9 

func (s CreateWhatIfAnalysisOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWhatIfAnalysisOutput) SetWhatIfAnalysisArn added in v1.42.9 

func (s *CreateWhatIfAnalysisOutput) SetWhatIfAnalysisArn(v string) *CreateWhatIfAnalysisOutput

SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.

func (CreateWhatIfAnalysisOutput) String added in v1.42.9 

func (s CreateWhatIfAnalysisOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWhatIfForecastExportInput added in v1.42.9 

type CreateWhatIfForecastExportInput struct {

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

	// The format of the exported data, CSV or PARQUET.
	Format *string `type:"string"`

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

	// The list of what-if forecast Amazon Resource Names (ARNs) to export.
	//
	// WhatIfForecastArns is a required field
	WhatIfForecastArns []*string `min:"1" type:"list" required:"true"`

	// The name of the what-if forecast to export.
	//
	// WhatIfForecastExportName is a required field
	WhatIfForecastExportName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWhatIfForecastExportInput) GoString added in v1.42.9 

func (s CreateWhatIfForecastExportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWhatIfForecastExportInput) SetDestination added in v1.42.9 

func (s *CreateWhatIfForecastExportInput) SetDestination(v *DataDestination) *CreateWhatIfForecastExportInput

SetDestination sets the Destination field's value.

func (*CreateWhatIfForecastExportInput) SetFormat added in v1.42.9 

func (s *CreateWhatIfForecastExportInput) SetFormat(v string) *CreateWhatIfForecastExportInput

SetFormat sets the Format field's value.

func (*CreateWhatIfForecastExportInput) SetTags added in v1.42.9 

func (s *CreateWhatIfForecastExportInput) SetTags(v []*Tag) *CreateWhatIfForecastExportInput

SetTags sets the Tags field's value.

func (*CreateWhatIfForecastExportInput) SetWhatIfForecastArns added in v1.42.9 

func (s *CreateWhatIfForecastExportInput) SetWhatIfForecastArns(v []*string) *CreateWhatIfForecastExportInput

SetWhatIfForecastArns sets the WhatIfForecastArns field's value.

func (*CreateWhatIfForecastExportInput) SetWhatIfForecastExportName added in v1.42.9 

func (s *CreateWhatIfForecastExportInput) SetWhatIfForecastExportName(v string) *CreateWhatIfForecastExportInput

SetWhatIfForecastExportName sets the WhatIfForecastExportName field's value.

func (CreateWhatIfForecastExportInput) String added in v1.42.9 

func (s CreateWhatIfForecastExportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWhatIfForecastExportInput) Validate added in v1.42.9 

func (s *CreateWhatIfForecastExportInput) Validate() error

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

type CreateWhatIfForecastExportOutput added in v1.42.9 

type CreateWhatIfForecastExportOutput struct {

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

func (CreateWhatIfForecastExportOutput) GoString added in v1.42.9 

func (s CreateWhatIfForecastExportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWhatIfForecastExportOutput) SetWhatIfForecastExportArn added in v1.42.9 

func (s *CreateWhatIfForecastExportOutput) SetWhatIfForecastExportArn(v string) *CreateWhatIfForecastExportOutput

SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.

func (CreateWhatIfForecastExportOutput) String added in v1.42.9 

func (s CreateWhatIfForecastExportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWhatIfForecastInput added in v1.42.9 

type CreateWhatIfForecastInput struct {

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

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

	// The transformations that are applied to the baseline time series. Each transformation
	// contains an action and a set of conditions. An action is applied only when
	// all conditions are met. If no conditions are provided, the action is applied
	// to all items.
	TimeSeriesTransformations []*TimeSeriesTransformation `type:"list"`

	// The Amazon Resource Name (ARN) of the what-if analysis.
	//
	// WhatIfAnalysisArn is a required field
	WhatIfAnalysisArn *string `type:"string" required:"true"`

	// The name of the what-if forecast. Names must be unique within each what-if
	// analysis.
	//
	// WhatIfForecastName is a required field
	WhatIfForecastName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWhatIfForecastInput) GoString added in v1.42.9 

func (s CreateWhatIfForecastInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWhatIfForecastInput) SetTags added in v1.42.9 

func (s *CreateWhatIfForecastInput) SetTags(v []*Tag) *CreateWhatIfForecastInput

SetTags sets the Tags field's value.

func (*CreateWhatIfForecastInput) SetTimeSeriesReplacementsDataSource added in v1.42.9 

func (s *CreateWhatIfForecastInput) SetTimeSeriesReplacementsDataSource(v *TimeSeriesReplacementsDataSource) *CreateWhatIfForecastInput

SetTimeSeriesReplacementsDataSource sets the TimeSeriesReplacementsDataSource field's value.

func (*CreateWhatIfForecastInput) SetTimeSeriesTransformations added in v1.42.9 

func (s *CreateWhatIfForecastInput) SetTimeSeriesTransformations(v []*TimeSeriesTransformation) *CreateWhatIfForecastInput

SetTimeSeriesTransformations sets the TimeSeriesTransformations field's value.

func (*CreateWhatIfForecastInput) SetWhatIfAnalysisArn added in v1.42.9 

func (s *CreateWhatIfForecastInput) SetWhatIfAnalysisArn(v string) *CreateWhatIfForecastInput

SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.

func (*CreateWhatIfForecastInput) SetWhatIfForecastName added in v1.42.9 

func (s *CreateWhatIfForecastInput) SetWhatIfForecastName(v string) *CreateWhatIfForecastInput

SetWhatIfForecastName sets the WhatIfForecastName field's value.

func (CreateWhatIfForecastInput) String added in v1.42.9 

func (s CreateWhatIfForecastInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWhatIfForecastInput) Validate added in v1.42.9 

func (s *CreateWhatIfForecastInput) Validate() error

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

type CreateWhatIfForecastOutput added in v1.42.9 

type CreateWhatIfForecastOutput struct {

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

func (CreateWhatIfForecastOutput) GoString added in v1.42.9 

func (s CreateWhatIfForecastOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWhatIfForecastOutput) SetWhatIfForecastArn added in v1.42.9 

func (s *CreateWhatIfForecastOutput) SetWhatIfForecastArn(v string) *CreateWhatIfForecastOutput

SetWhatIfForecastArn sets the WhatIfForecastArn field's value.

func (CreateWhatIfForecastOutput) String added in v1.42.9 

func (s CreateWhatIfForecastOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataConfig added in v1.42.9 

type DataConfig struct {

	// Additional built-in datasets like Holidays and the Weather Index.
	AdditionalDatasets []*AdditionalDataset `min:"1" type:"list"`

	// Aggregation and filling options for attributes in your dataset group.
	AttributeConfigs []*AttributeConfig `min:"1" type:"list"`

	// The ARN of the dataset group used to train the predictor.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The data configuration for your dataset group and any additional datasets.

func (DataConfig) GoString added in v1.42.9 

func (s DataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataConfig) SetAdditionalDatasets added in v1.42.9 

func (s *DataConfig) SetAdditionalDatasets(v []*AdditionalDataset) *DataConfig

SetAdditionalDatasets sets the AdditionalDatasets field's value.

func (*DataConfig) SetAttributeConfigs added in v1.42.9 

func (s *DataConfig) SetAttributeConfigs(v []*AttributeConfig) *DataConfig

SetAttributeConfigs sets the AttributeConfigs field's value.

func (*DataConfig) SetDatasetGroupArn added in v1.42.9 

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

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (DataConfig) String added in v1.42.9 

func (s DataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataConfig) Validate added in v1.42.9 

func (s *DataConfig) Validate() error

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

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 for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).

func (DataDestination) GoString 

func (s DataDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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 data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.

func (DataSource) GoString 

func (s DataSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 dataset group was created.
	CreationTime *time.Time `type:"timestamp"`

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

	// The name of the dataset group.
	DatasetGroupName *string `min:"1" type:"string"`

	// When the dataset group was created or last updated from a call to the UpdateDatasetGroup
	// (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)
	// operation. While the dataset group is being updated, LastModificationTime
	// is the current time of the ListDatasetGroups call.
	LastModificationTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides a summary of the dataset group properties used in the ListDatasetGroups (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) operation. To get the complete set of properties, call the DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation, and provide the DatasetGroupArn.

func (DatasetGroupSummary) GoString 

func (s DatasetGroupSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DatasetImportJobSummary 

type DatasetImportJobSummary struct {

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

	// The location of the training data to import and an Identity and Access Management
	// (IAM) role that Amazon Forecast can assume to access the data. The training
	// data must be stored in an Amazon S3 bucket.
	//
	// If encryption is used, DataSource includes an Key Management Service (KMS)
	// key.
	DataSource *DataSource `type:"structure"`

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

	// The name of the dataset import job.
	DatasetImportJobName *string `min:"1" type:"string"`

	// The import mode of the dataset import job, FULL or INCREMENTAL.
	ImportMode *string `type:"string" enum:"ImportMode"`

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

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

	// The status of the dataset import job. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the dataset import job properties used in the ListDatasetImportJobs (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) operation. To get the complete set of properties, call the DescribeDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) operation, and provide the DatasetImportJobArn.

func (DatasetImportJobSummary) GoString 

func (s DatasetImportJobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetImportJobSummary) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*DatasetImportJobSummary) SetDataSource 

func (s *DatasetImportJobSummary) SetDataSource(v *DataSource) *DatasetImportJobSummary

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) SetImportMode added in v1.42.9 

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

SetImportMode sets the ImportMode field's value.

func (*DatasetImportJobSummary) SetLastModificationTime 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DatasetImportJobSummary) SetMessage 

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

SetMessage sets the Message field's value.

func (*DatasetImportJobSummary) SetStatus 

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

SetStatus sets the Status field's value.

func (DatasetImportJobSummary) String 

func (s DatasetImportJobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 you create a dataset, LastModificationTime is the same as CreationTime.
	// While data is being imported to the dataset, LastModificationTime is the
	// current time of the ListDatasets call. After a CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html)
	// operation has finished, LastModificationTime is when the import job completed
	// or failed.
	LastModificationTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides a summary of the dataset properties used in the ListDatasets (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) operation. To get the complete set of properties, call the DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation, and provide the DatasetArn.

func (DatasetSummary) GoString 

func (s DatasetSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDatasetGroupOutput) String 

func (s DeleteDatasetGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDatasetImportJobInput) SetDatasetImportJobArn 

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

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (DeleteDatasetImportJobInput) String 

func (s DeleteDatasetImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDatasetImportJobOutput) String 

func (s DeleteDatasetImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDatasetOutput) String 

func (s DeleteDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteExplainabilityExportInput added in v1.42.9 

type DeleteExplainabilityExportInput struct {

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

func (DeleteExplainabilityExportInput) GoString added in v1.42.9 

func (s DeleteExplainabilityExportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteExplainabilityExportInput) SetExplainabilityExportArn added in v1.42.9 

func (s *DeleteExplainabilityExportInput) SetExplainabilityExportArn(v string) *DeleteExplainabilityExportInput

SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.

func (DeleteExplainabilityExportInput) String added in v1.42.9 

func (s DeleteExplainabilityExportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteExplainabilityExportInput) Validate added in v1.42.9 

func (s *DeleteExplainabilityExportInput) Validate() error

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

type DeleteExplainabilityExportOutput added in v1.42.9 

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

func (DeleteExplainabilityExportOutput) GoString added in v1.42.9 

func (s DeleteExplainabilityExportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteExplainabilityExportOutput) String added in v1.42.9 

func (s DeleteExplainabilityExportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteExplainabilityInput added in v1.42.9 

type DeleteExplainabilityInput struct {

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

func (DeleteExplainabilityInput) GoString added in v1.42.9 

func (s DeleteExplainabilityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteExplainabilityInput) SetExplainabilityArn added in v1.42.9 

func (s *DeleteExplainabilityInput) SetExplainabilityArn(v string) *DeleteExplainabilityInput

SetExplainabilityArn sets the ExplainabilityArn field's value.

func (DeleteExplainabilityInput) String added in v1.42.9 

func (s DeleteExplainabilityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteExplainabilityInput) Validate added in v1.42.9 

func (s *DeleteExplainabilityInput) Validate() error

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

type DeleteExplainabilityOutput added in v1.42.9 

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

func (DeleteExplainabilityOutput) GoString added in v1.42.9 

func (s DeleteExplainabilityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteExplainabilityOutput) String added in v1.42.9 

func (s DeleteExplainabilityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteForecastExportJobInput) SetForecastExportJobArn 

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

SetForecastExportJobArn sets the ForecastExportJobArn field's value.

func (DeleteForecastExportJobInput) String 

func (s DeleteForecastExportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

func (s DeleteForecastExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteForecastExportJobOutput) String 

func (s DeleteForecastExportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteForecastOutput) String 

func (s DeleteForecastOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMonitorInput added in v1.42.9 

type DeleteMonitorInput struct {

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

func (DeleteMonitorInput) GoString added in v1.42.9 

func (s DeleteMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMonitorInput) SetMonitorArn added in v1.42.9 

func (s *DeleteMonitorInput) SetMonitorArn(v string) *DeleteMonitorInput

SetMonitorArn sets the MonitorArn field's value.

func (DeleteMonitorInput) String added in v1.42.9 

func (s DeleteMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMonitorInput) Validate added in v1.42.9 

func (s *DeleteMonitorInput) Validate() error

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

type DeleteMonitorOutput added in v1.42.9 

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

func (DeleteMonitorOutput) GoString added in v1.42.9 

func (s DeleteMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteMonitorOutput) String added in v1.42.9 

func (s DeleteMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePredictorBacktestExportJobInput 

type DeletePredictorBacktestExportJobInput struct {

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

func (DeletePredictorBacktestExportJobInput) GoString 

func (s DeletePredictorBacktestExportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn 

func (s *DeletePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn(v string) *DeletePredictorBacktestExportJobInput

SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.

func (DeletePredictorBacktestExportJobInput) String 

func (s DeletePredictorBacktestExportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePredictorBacktestExportJobInput) Validate 

func (s *DeletePredictorBacktestExportJobInput) Validate() error

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

type DeletePredictorBacktestExportJobOutput 

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

func (DeletePredictorBacktestExportJobOutput) GoString 

func (s DeletePredictorBacktestExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeletePredictorBacktestExportJobOutput) String 

func (s DeletePredictorBacktestExportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeletePredictorOutput) String 

func (s DeletePredictorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteResourceTreeInput 

type DeleteResourceTreeInput struct {

	// The Amazon Resource Name (ARN) of the parent resource to delete. All child
	// resources of the parent resource will also be deleted.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteResourceTreeInput) GoString 

func (s DeleteResourceTreeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteResourceTreeInput) SetResourceArn 

func (s *DeleteResourceTreeInput) SetResourceArn(v string) *DeleteResourceTreeInput

SetResourceArn sets the ResourceArn field's value.

func (DeleteResourceTreeInput) String 

func (s DeleteResourceTreeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteResourceTreeInput) Validate 

func (s *DeleteResourceTreeInput) Validate() error

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

type DeleteResourceTreeOutput 

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

func (DeleteResourceTreeOutput) GoString 

func (s DeleteResourceTreeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteResourceTreeOutput) String 

func (s DeleteResourceTreeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWhatIfAnalysisInput added in v1.42.9 

type DeleteWhatIfAnalysisInput struct {

	// The Amazon Resource Name (ARN) of the what-if analysis that you want to delete.
	//
	// WhatIfAnalysisArn is a required field
	WhatIfAnalysisArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWhatIfAnalysisInput) GoString added in v1.42.9 

func (s DeleteWhatIfAnalysisInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWhatIfAnalysisInput) SetWhatIfAnalysisArn added in v1.42.9 

func (s *DeleteWhatIfAnalysisInput) SetWhatIfAnalysisArn(v string) *DeleteWhatIfAnalysisInput

SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.

func (DeleteWhatIfAnalysisInput) String added in v1.42.9 

func (s DeleteWhatIfAnalysisInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWhatIfAnalysisInput) Validate added in v1.42.9 

func (s *DeleteWhatIfAnalysisInput) Validate() error

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

type DeleteWhatIfAnalysisOutput added in v1.42.9 

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

func (DeleteWhatIfAnalysisOutput) GoString added in v1.42.9 

func (s DeleteWhatIfAnalysisOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWhatIfAnalysisOutput) String added in v1.42.9 

func (s DeleteWhatIfAnalysisOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWhatIfForecastExportInput added in v1.42.9 

type DeleteWhatIfForecastExportInput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast export that you want
	// to delete.
	//
	// WhatIfForecastExportArn is a required field
	WhatIfForecastExportArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWhatIfForecastExportInput) GoString added in v1.42.9 

func (s DeleteWhatIfForecastExportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWhatIfForecastExportInput) SetWhatIfForecastExportArn added in v1.42.9 

func (s *DeleteWhatIfForecastExportInput) SetWhatIfForecastExportArn(v string) *DeleteWhatIfForecastExportInput

SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.

func (DeleteWhatIfForecastExportInput) String added in v1.42.9 

func (s DeleteWhatIfForecastExportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWhatIfForecastExportInput) Validate added in v1.42.9 

func (s *DeleteWhatIfForecastExportInput) Validate() error

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

type DeleteWhatIfForecastExportOutput added in v1.42.9 

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

func (DeleteWhatIfForecastExportOutput) GoString added in v1.42.9 

func (s DeleteWhatIfForecastExportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWhatIfForecastExportOutput) String added in v1.42.9 

func (s DeleteWhatIfForecastExportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWhatIfForecastInput added in v1.42.9 

type DeleteWhatIfForecastInput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.
	//
	// WhatIfForecastArn is a required field
	WhatIfForecastArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWhatIfForecastInput) GoString added in v1.42.9 

func (s DeleteWhatIfForecastInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWhatIfForecastInput) SetWhatIfForecastArn added in v1.42.9 

func (s *DeleteWhatIfForecastInput) SetWhatIfForecastArn(v string) *DeleteWhatIfForecastInput

SetWhatIfForecastArn sets the WhatIfForecastArn field's value.

func (DeleteWhatIfForecastInput) String added in v1.42.9 

func (s DeleteWhatIfForecastInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWhatIfForecastInput) Validate added in v1.42.9 

func (s *DeleteWhatIfForecastInput) Validate() error

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

type DeleteWhatIfForecastOutput added in v1.42.9 

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

func (DeleteWhatIfForecastOutput) GoString added in v1.42.9 

func (s DeleteWhatIfForecastOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWhatIfForecastOutput) String added in v1.42.9 

func (s DeleteWhatIfForecastOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAutoPredictorInput added in v1.42.9 

type DescribeAutoPredictorInput struct {

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

func (DescribeAutoPredictorInput) GoString added in v1.42.9 

func (s DescribeAutoPredictorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAutoPredictorInput) SetPredictorArn added in v1.42.9 

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

SetPredictorArn sets the PredictorArn field's value.

func (DescribeAutoPredictorInput) String added in v1.42.9 

func (s DescribeAutoPredictorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAutoPredictorInput) Validate added in v1.42.9 

func (s *DescribeAutoPredictorInput) Validate() error

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

type DescribeAutoPredictorOutput added in v1.42.9 

type DescribeAutoPredictorOutput struct {

	// The timestamp of the CreateAutoPredictor request.
	CreationTime *time.Time `type:"timestamp"`

	// The data configuration for your dataset group and any additional datasets.
	DataConfig *DataConfig `type:"structure"`

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

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

	// The estimated time remaining in minutes for the predictor training job to
	// complete.
	EstimatedTimeRemainingInMinutes *int64 `type:"long"`

	// Provides the status and ARN of the Predictor Explainability.
	ExplainabilityInfo *ExplainabilityInfo `type:"structure"`

	// An array of dimension (field) names that specify the attributes used to group
	// your time series.
	ForecastDimensions []*string `min:"1" type:"list"`

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

	// The number of time-steps that the model predicts. The forecast horizon is
	// also called the prediction length.
	ForecastHorizon *int64 `type:"integer"`

	// The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
	ForecastTypes []*string `min:"1" type:"list"`

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

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

	// A object with the Amazon Resource Name (ARN) and status of the monitor resource.
	MonitorInfo *MonitorInfo `type:"structure"`

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric *string `type:"string" enum:"OptimizationMetric"`

	// The Amazon Resource Name (ARN) of the predictor
	PredictorArn *string `type:"string"`

	// The name of the predictor.
	PredictorName *string `min:"1" type:"string"`

	// The ARN and state of the reference predictor. This parameter is only valid
	// for retrained or upgraded predictors.
	ReferencePredictorSummary *ReferencePredictorSummary `type:"structure"`

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

	// The time boundary Forecast uses when aggregating data.
	TimeAlignmentBoundary *TimeAlignmentBoundary `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAutoPredictorOutput) GoString added in v1.42.9 

func (s DescribeAutoPredictorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAutoPredictorOutput) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeAutoPredictorOutput) SetDataConfig added in v1.42.9 

func (s *DescribeAutoPredictorOutput) SetDataConfig(v *DataConfig) *DescribeAutoPredictorOutput

SetDataConfig sets the DataConfig field's value.

func (*DescribeAutoPredictorOutput) SetDatasetImportJobArns added in v1.42.9 

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

SetDatasetImportJobArns sets the DatasetImportJobArns field's value.

func (*DescribeAutoPredictorOutput) SetEncryptionConfig added in v1.42.9 

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

SetEncryptionConfig sets the EncryptionConfig field's value.

func (*DescribeAutoPredictorOutput) SetEstimatedTimeRemainingInMinutes added in v1.42.9 

func (s *DescribeAutoPredictorOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeAutoPredictorOutput

SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.

func (*DescribeAutoPredictorOutput) SetExplainabilityInfo added in v1.42.9 

func (s *DescribeAutoPredictorOutput) SetExplainabilityInfo(v *ExplainabilityInfo) *DescribeAutoPredictorOutput

SetExplainabilityInfo sets the ExplainabilityInfo field's value.

func (*DescribeAutoPredictorOutput) SetForecastDimensions added in v1.42.9 

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

SetForecastDimensions sets the ForecastDimensions field's value.

func (*DescribeAutoPredictorOutput) SetForecastFrequency added in v1.42.9 

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

SetForecastFrequency sets the ForecastFrequency field's value.

func (*DescribeAutoPredictorOutput) SetForecastHorizon added in v1.42.9 

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

SetForecastHorizon sets the ForecastHorizon field's value.

func (*DescribeAutoPredictorOutput) SetForecastTypes added in v1.42.9 

func (s *DescribeAutoPredictorOutput) SetForecastTypes(v []*string) *DescribeAutoPredictorOutput

SetForecastTypes sets the ForecastTypes field's value.

func (*DescribeAutoPredictorOutput) SetLastModificationTime added in v1.42.9 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeAutoPredictorOutput) SetMessage added in v1.42.9 

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

SetMessage sets the Message field's value.

func (*DescribeAutoPredictorOutput) SetMonitorInfo added in v1.42.9 

func (s *DescribeAutoPredictorOutput) SetMonitorInfo(v *MonitorInfo) *DescribeAutoPredictorOutput

SetMonitorInfo sets the MonitorInfo field's value.

func (*DescribeAutoPredictorOutput) SetOptimizationMetric added in v1.42.9 

func (s *DescribeAutoPredictorOutput) SetOptimizationMetric(v string) *DescribeAutoPredictorOutput

SetOptimizationMetric sets the OptimizationMetric field's value.

func (*DescribeAutoPredictorOutput) SetPredictorArn added in v1.42.9 

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

SetPredictorArn sets the PredictorArn field's value.

func (*DescribeAutoPredictorOutput) SetPredictorName added in v1.42.9 

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

SetPredictorName sets the PredictorName field's value.

func (*DescribeAutoPredictorOutput) SetReferencePredictorSummary added in v1.42.9 

func (s *DescribeAutoPredictorOutput) SetReferencePredictorSummary(v *ReferencePredictorSummary) *DescribeAutoPredictorOutput

SetReferencePredictorSummary sets the ReferencePredictorSummary field's value.

func (*DescribeAutoPredictorOutput) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (*DescribeAutoPredictorOutput) SetTimeAlignmentBoundary added in v1.42.9 

func (s *DescribeAutoPredictorOutput) SetTimeAlignmentBoundary(v *TimeAlignmentBoundary) *DescribeAutoPredictorOutput

SetTimeAlignmentBoundary sets the TimeAlignmentBoundary field's value.

func (DescribeAutoPredictorOutput) String added in v1.42.9 

func (s DescribeAutoPredictorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetGroupInput) SetDatasetGroupArn 

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

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (DescribeDatasetGroupInput) String 

func (s DescribeDatasetGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.
	Domain *string `type:"string" enum:"Domain"`

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

	// The status of the dataset group. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	//
	//    * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
	//
	// The UPDATE states apply when you call the UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html)
	// operation.
	//
	// The Status of the dataset group must be ACTIVE before you can use the dataset
	// group to create a predictor.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDatasetGroupOutput) GoString 

func (s DescribeDatasetGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetGroupOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeDatasetGroupOutput) SetDatasetArns 

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

SetDatasetArns sets the DatasetArns field's value.

func (*DescribeDatasetGroupOutput) SetDatasetGroupArn 

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

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*DescribeDatasetGroupOutput) SetDatasetGroupName 

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

SetDatasetGroupName sets the DatasetGroupName field's value.

func (*DescribeDatasetGroupOutput) SetDomain 

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

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 

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

SetStatus sets the Status field's value.

func (DescribeDatasetGroupOutput) String 

func (s DescribeDatasetGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s DescribeDatasetImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetImportJobInput) SetDatasetImportJobArn 

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

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (DescribeDatasetImportJobInput) String 

func (s DescribeDatasetImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 the import job has finished.
	DataSize *float64 `type:"double"`

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

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

	// The ARN of the dataset import job.
	DatasetImportJobArn *string `type:"string"`

	// The name of the dataset import job.
	DatasetImportJobName *string `min:"1" type:"string"`

	// The estimated time remaining in minutes for the dataset import job to complete.
	EstimatedTimeRemainingInMinutes *int64 `type:"long"`

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

	// The format of the imported data, CSV or PARQUET.
	Format *string `type:"string"`

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

	// The import mode of the dataset import job, FULL or INCREMENTAL.
	ImportMode *string `type:"string" enum:"ImportMode"`

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

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

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

	// The single time zone applied to every item in the dataset
	TimeZone *string `type:"string"`

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

	// Whether TimeZone is automatically derived from the geolocation attribute.
	UseGeolocationForTimeZone *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeDatasetImportJobOutput) GoString 

func (s DescribeDatasetImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetImportJobOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeDatasetImportJobOutput) SetDataSize 

func (s *DescribeDatasetImportJobOutput) SetDataSize(v float64) *DescribeDatasetImportJobOutput

SetDataSize sets the DataSize field's value.

func (*DescribeDatasetImportJobOutput) SetDataSource 

func (s *DescribeDatasetImportJobOutput) SetDataSource(v *DataSource) *DescribeDatasetImportJobOutput

SetDataSource sets the DataSource field's value.

func (*DescribeDatasetImportJobOutput) SetDatasetArn 

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

SetDatasetArn sets the DatasetArn field's value.

func (*DescribeDatasetImportJobOutput) SetDatasetImportJobArn 

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

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (*DescribeDatasetImportJobOutput) SetDatasetImportJobName 

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

SetDatasetImportJobName sets the DatasetImportJobName field's value.

func (*DescribeDatasetImportJobOutput) SetEstimatedTimeRemainingInMinutes 

func (s *DescribeDatasetImportJobOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeDatasetImportJobOutput

SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.

func (*DescribeDatasetImportJobOutput) SetFieldStatistics 

func (s *DescribeDatasetImportJobOutput) SetFieldStatistics(v map[string]*Statistics) *DescribeDatasetImportJobOutput

SetFieldStatistics sets the FieldStatistics field's value.

func (*DescribeDatasetImportJobOutput) SetFormat added in v1.42.9 

func (s *DescribeDatasetImportJobOutput) SetFormat(v string) *DescribeDatasetImportJobOutput

SetFormat sets the Format field's value.

func (*DescribeDatasetImportJobOutput) SetGeolocationFormat 

func (s *DescribeDatasetImportJobOutput) SetGeolocationFormat(v string) *DescribeDatasetImportJobOutput

SetGeolocationFormat sets the GeolocationFormat field's value.

func (*DescribeDatasetImportJobOutput) SetImportMode added in v1.42.9 

func (s *DescribeDatasetImportJobOutput) SetImportMode(v string) *DescribeDatasetImportJobOutput

SetImportMode sets the ImportMode field's value.

func (*DescribeDatasetImportJobOutput) SetLastModificationTime 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeDatasetImportJobOutput) SetMessage 

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

SetMessage sets the Message field's value.

func (*DescribeDatasetImportJobOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*DescribeDatasetImportJobOutput) SetTimeZone 

func (s *DescribeDatasetImportJobOutput) SetTimeZone(v string) *DescribeDatasetImportJobOutput

SetTimeZone sets the TimeZone field's value.

func (*DescribeDatasetImportJobOutput) SetTimestampFormat 

func (s *DescribeDatasetImportJobOutput) SetTimestampFormat(v string) *DescribeDatasetImportJobOutput

SetTimestampFormat sets the TimestampFormat field's value.

func (*DescribeDatasetImportJobOutput) SetUseGeolocationForTimeZone 

func (s *DescribeDatasetImportJobOutput) SetUseGeolocationForTimeZone(v bool) *DescribeDatasetImportJobOutput

SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value.

func (DescribeDatasetImportJobOutput) String 

func (s DescribeDatasetImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the dataset.
	DatasetArn *string `type:"string"`

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

	// The dataset type.
	DatasetType *string `type:"string" enum:"DatasetType"`

	// The domain associated with the dataset.
	Domain *string `type:"string" enum:"Domain"`

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

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

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

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

func (DescribeDatasetOutput) GoString 

func (s DescribeDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 

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

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 

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

SetSchema sets the Schema field's value.

func (*DescribeDatasetOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (DescribeDatasetOutput) String 

func (s DescribeDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeExplainabilityExportInput added in v1.42.9 

type DescribeExplainabilityExportInput struct {

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

func (DescribeExplainabilityExportInput) GoString added in v1.42.9 

func (s DescribeExplainabilityExportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExplainabilityExportInput) SetExplainabilityExportArn added in v1.42.9 

func (s *DescribeExplainabilityExportInput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportInput

SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.

func (DescribeExplainabilityExportInput) String added in v1.42.9 

func (s DescribeExplainabilityExportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExplainabilityExportInput) Validate added in v1.42.9 

func (s *DescribeExplainabilityExportInput) Validate() error

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

type DescribeExplainabilityExportOutput added in v1.42.9 

type DescribeExplainabilityExportOutput struct {

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

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

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

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

	// The name of the Explainability export.
	ExplainabilityExportName *string `min:"1" type:"string"`

	// The format of the exported data, CSV or PARQUET.
	Format *string `type:"string"`

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

	// Information about any errors that occurred during the export.
	Message *string `type:"string"`

	// The status of the Explainability export. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExplainabilityExportOutput) GoString added in v1.42.9 

func (s DescribeExplainabilityExportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExplainabilityExportOutput) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeExplainabilityExportOutput) SetDestination added in v1.42.9 

func (s *DescribeExplainabilityExportOutput) SetDestination(v *DataDestination) *DescribeExplainabilityExportOutput

SetDestination sets the Destination field's value.

func (*DescribeExplainabilityExportOutput) SetExplainabilityArn added in v1.42.9 

func (s *DescribeExplainabilityExportOutput) SetExplainabilityArn(v string) *DescribeExplainabilityExportOutput

SetExplainabilityArn sets the ExplainabilityArn field's value.

func (*DescribeExplainabilityExportOutput) SetExplainabilityExportArn added in v1.42.9 

func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportOutput

SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.

func (*DescribeExplainabilityExportOutput) SetExplainabilityExportName added in v1.42.9 

func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportName(v string) *DescribeExplainabilityExportOutput

SetExplainabilityExportName sets the ExplainabilityExportName field's value.

func (*DescribeExplainabilityExportOutput) SetFormat added in v1.42.9 

func (s *DescribeExplainabilityExportOutput) SetFormat(v string) *DescribeExplainabilityExportOutput

SetFormat sets the Format field's value.

func (*DescribeExplainabilityExportOutput) SetLastModificationTime added in v1.42.9 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeExplainabilityExportOutput) SetMessage added in v1.42.9 

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

SetMessage sets the Message field's value.

func (*DescribeExplainabilityExportOutput) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (DescribeExplainabilityExportOutput) String added in v1.42.9 

func (s DescribeExplainabilityExportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeExplainabilityInput added in v1.42.9 

type DescribeExplainabilityInput struct {

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

func (DescribeExplainabilityInput) GoString added in v1.42.9 

func (s DescribeExplainabilityInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExplainabilityInput) SetExplainabilityArn added in v1.42.9 

func (s *DescribeExplainabilityInput) SetExplainabilityArn(v string) *DescribeExplainabilityInput

SetExplainabilityArn sets the ExplainabilityArn field's value.

func (DescribeExplainabilityInput) String added in v1.42.9 

func (s DescribeExplainabilityInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExplainabilityInput) Validate added in v1.42.9 

func (s *DescribeExplainabilityInput) Validate() error

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

type DescribeExplainabilityOutput added in v1.42.9 

type DescribeExplainabilityOutput struct {

	// When the Explainability resource was created.
	CreationTime *time.Time `type:"timestamp"`

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

	// Whether the visualization was enabled for the Explainability resource.
	EnableVisualization *bool `type:"boolean"`

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

	// The estimated time remaining in minutes for the CreateExplainability job
	// to complete.
	EstimatedTimeRemainingInMinutes *int64 `type:"long"`

	// The Amazon Resource Name (ARN) of the Explainability.
	ExplainabilityArn *string `type:"string"`

	// The configuration settings that define the granularity of time series and
	// time points for the Explainability.
	ExplainabilityConfig *ExplainabilityConfig `type:"structure"`

	// The name of the Explainability.
	ExplainabilityName *string `min:"1" type:"string"`

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

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

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

	// Defines the fields of a dataset.
	Schema *Schema `type:"structure"`

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

	// The status of the Explainability resource. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExplainabilityOutput) GoString added in v1.42.9 

func (s DescribeExplainabilityOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExplainabilityOutput) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeExplainabilityOutput) SetDataSource added in v1.42.9 

func (s *DescribeExplainabilityOutput) SetDataSource(v *DataSource) *DescribeExplainabilityOutput

SetDataSource sets the DataSource field's value.

func (*DescribeExplainabilityOutput) SetEnableVisualization added in v1.42.9 

func (s *DescribeExplainabilityOutput) SetEnableVisualization(v bool) *DescribeExplainabilityOutput

SetEnableVisualization sets the EnableVisualization field's value.

func (*DescribeExplainabilityOutput) SetEndDateTime added in v1.42.9 

func (s *DescribeExplainabilityOutput) SetEndDateTime(v string) *DescribeExplainabilityOutput

SetEndDateTime sets the EndDateTime field's value.

func (*DescribeExplainabilityOutput) SetEstimatedTimeRemainingInMinutes added in v1.42.9 

func (s *DescribeExplainabilityOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeExplainabilityOutput

SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.

func (*DescribeExplainabilityOutput) SetExplainabilityArn added in v1.42.9 

func (s *DescribeExplainabilityOutput) SetExplainabilityArn(v string) *DescribeExplainabilityOutput

SetExplainabilityArn sets the ExplainabilityArn field's value.

func (*DescribeExplainabilityOutput) SetExplainabilityConfig added in v1.42.9 

func (s *DescribeExplainabilityOutput) SetExplainabilityConfig(v *ExplainabilityConfig) *DescribeExplainabilityOutput

SetExplainabilityConfig sets the ExplainabilityConfig field's value.

func (*DescribeExplainabilityOutput) SetExplainabilityName added in v1.42.9 

func (s *DescribeExplainabilityOutput) SetExplainabilityName(v string) *DescribeExplainabilityOutput

SetExplainabilityName sets the ExplainabilityName field's value.

func (*DescribeExplainabilityOutput) SetLastModificationTime added in v1.42.9 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeExplainabilityOutput) SetMessage added in v1.42.9 

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

SetMessage sets the Message field's value.

func (*DescribeExplainabilityOutput) SetResourceArn added in v1.42.9 

func (s *DescribeExplainabilityOutput) SetResourceArn(v string) *DescribeExplainabilityOutput

SetResourceArn sets the ResourceArn field's value.

func (*DescribeExplainabilityOutput) SetSchema added in v1.42.9 

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

SetSchema sets the Schema field's value.

func (*DescribeExplainabilityOutput) SetStartDateTime added in v1.42.9 

func (s *DescribeExplainabilityOutput) SetStartDateTime(v string) *DescribeExplainabilityOutput

SetStartDateTime sets the StartDateTime field's value.

func (*DescribeExplainabilityOutput) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (DescribeExplainabilityOutput) String added in v1.42.9 

func (s DescribeExplainabilityOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s DescribeForecastExportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeForecastExportJobInput) SetForecastExportJobArn 

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

SetForecastExportJobArn sets the ForecastExportJobArn field's value.

func (DescribeForecastExportJobInput) String 

func (s DescribeForecastExportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 Amazon Simple Storage Service (Amazon S3) bucket where the
	// forecast is exported.
	Destination *DataDestination `type:"structure"`

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

	// The ARN of the forecast export job.
	ForecastExportJobArn *string `type:"string"`

	// The name of the forecast export job.
	ForecastExportJobName *string `min:"1" type:"string"`

	// The format of the exported data, CSV or PARQUET.
	Format *string `type:"string"`

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

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

	// The status of the forecast export job. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	//
	// The Status of the forecast export job must be ACTIVE before you can access
	// the forecast in your S3 bucket.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeForecastExportJobOutput) GoString 

func (s DescribeForecastExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeForecastExportJobOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeForecastExportJobOutput) SetDestination 

func (s *DescribeForecastExportJobOutput) SetDestination(v *DataDestination) *DescribeForecastExportJobOutput

SetDestination sets the Destination field's value.

func (*DescribeForecastExportJobOutput) SetForecastArn 

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

SetForecastArn sets the ForecastArn field's value.

func (*DescribeForecastExportJobOutput) SetForecastExportJobArn 

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

SetForecastExportJobArn sets the ForecastExportJobArn field's value.

func (*DescribeForecastExportJobOutput) SetForecastExportJobName 

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

SetForecastExportJobName sets the ForecastExportJobName field's value.

func (*DescribeForecastExportJobOutput) SetFormat added in v1.42.9 

func (s *DescribeForecastExportJobOutput) SetFormat(v string) *DescribeForecastExportJobOutput

SetFormat sets the Format field's value.

func (*DescribeForecastExportJobOutput) SetLastModificationTime 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeForecastExportJobOutput) SetMessage 

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

SetMessage sets the Message field's value.

func (*DescribeForecastExportJobOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (DescribeForecastExportJobOutput) String 

func (s DescribeForecastExportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 estimated time remaining in minutes for the forecast job to complete.
	EstimatedTimeRemainingInMinutes *int64 `type:"long"`

	// The forecast ARN as specified in the request.
	ForecastArn *string `type:"string"`

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

	// The quantiles at which probabilistic forecasts were generated.
	ForecastTypes []*string `min:"1" type:"list"`

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

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

	// The ARN of the predictor used to generate the forecast.
	PredictorArn *string `type:"string"`

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

	// The time series to include in the forecast.
	TimeSeriesSelector *TimeSeriesSelector `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeForecastOutput) GoString 

func (s DescribeForecastOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetEstimatedTimeRemainingInMinutes 

func (s *DescribeForecastOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeForecastOutput

SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.

func (*DescribeForecastOutput) SetForecastArn 

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

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) SetForecastTypes 

func (s *DescribeForecastOutput) SetForecastTypes(v []*string) *DescribeForecastOutput

SetForecastTypes sets the ForecastTypes field's value.

func (*DescribeForecastOutput) SetLastModificationTime 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeForecastOutput) SetMessage 

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

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 

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

SetStatus sets the Status field's value.

func (*DescribeForecastOutput) SetTimeSeriesSelector added in v1.42.9 

func (s *DescribeForecastOutput) SetTimeSeriesSelector(v *TimeSeriesSelector) *DescribeForecastOutput

SetTimeSeriesSelector sets the TimeSeriesSelector field's value.

func (DescribeForecastOutput) String 

func (s DescribeForecastOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMonitorInput added in v1.42.9 

type DescribeMonitorInput struct {

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

func (DescribeMonitorInput) GoString added in v1.42.9 

func (s DescribeMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMonitorInput) SetMonitorArn added in v1.42.9 

func (s *DescribeMonitorInput) SetMonitorArn(v string) *DescribeMonitorInput

SetMonitorArn sets the MonitorArn field's value.

func (DescribeMonitorInput) String added in v1.42.9 

func (s DescribeMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMonitorInput) Validate added in v1.42.9 

func (s *DescribeMonitorInput) Validate() error

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

type DescribeMonitorOutput added in v1.42.9 

type DescribeMonitorOutput struct {

	// Metrics you can use as a baseline for comparison purposes. Use these values
	// you interpret monitoring results for an auto predictor.
	Baseline *Baseline `type:"structure"`

	// The timestamp for when the monitor resource was created.
	CreationTime *time.Time `type:"timestamp"`

	// The estimated number of minutes remaining before the monitor resource finishes
	// its current evaluation.
	EstimatedEvaluationTimeRemainingInMinutes *int64 `type:"long"`

	// The state of the monitor's latest evaluation.
	LastEvaluationState *string `type:"string"`

	// The timestamp of the latest evaluation completed by the monitor.
	LastEvaluationTime *time.Time `type:"timestamp"`

	// The timestamp of the latest modification to the monitor.
	LastModificationTime *time.Time `type:"timestamp"`

	// An error message, if any, for the monitor.
	Message *string `type:"string"`

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

	// The name of the monitor.
	MonitorName *string `min:"1" type:"string"`

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

	// The status of the monitor resource.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMonitorOutput) GoString added in v1.42.9 

func (s DescribeMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMonitorOutput) SetBaseline added in v1.42.9 

func (s *DescribeMonitorOutput) SetBaseline(v *Baseline) *DescribeMonitorOutput

SetBaseline sets the Baseline field's value.

func (*DescribeMonitorOutput) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeMonitorOutput) SetEstimatedEvaluationTimeRemainingInMinutes added in v1.42.9 

func (s *DescribeMonitorOutput) SetEstimatedEvaluationTimeRemainingInMinutes(v int64) *DescribeMonitorOutput

SetEstimatedEvaluationTimeRemainingInMinutes sets the EstimatedEvaluationTimeRemainingInMinutes field's value.

func (*DescribeMonitorOutput) SetLastEvaluationState added in v1.42.9 

func (s *DescribeMonitorOutput) SetLastEvaluationState(v string) *DescribeMonitorOutput

SetLastEvaluationState sets the LastEvaluationState field's value.

func (*DescribeMonitorOutput) SetLastEvaluationTime added in v1.42.9 

func (s *DescribeMonitorOutput) SetLastEvaluationTime(v time.Time) *DescribeMonitorOutput

SetLastEvaluationTime sets the LastEvaluationTime field's value.

func (*DescribeMonitorOutput) SetLastModificationTime added in v1.42.9 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeMonitorOutput) SetMessage added in v1.42.9 

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

SetMessage sets the Message field's value.

func (*DescribeMonitorOutput) SetMonitorArn added in v1.42.9 

func (s *DescribeMonitorOutput) SetMonitorArn(v string) *DescribeMonitorOutput

SetMonitorArn sets the MonitorArn field's value.

func (*DescribeMonitorOutput) SetMonitorName added in v1.42.9 

func (s *DescribeMonitorOutput) SetMonitorName(v string) *DescribeMonitorOutput

SetMonitorName sets the MonitorName field's value.

func (*DescribeMonitorOutput) SetResourceArn added in v1.42.9 

func (s *DescribeMonitorOutput) SetResourceArn(v string) *DescribeMonitorOutput

SetResourceArn sets the ResourceArn field's value.

func (*DescribeMonitorOutput) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (DescribeMonitorOutput) String added in v1.42.9 

func (s DescribeMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePredictorBacktestExportJobInput 

type DescribePredictorBacktestExportJobInput struct {

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

func (DescribePredictorBacktestExportJobInput) GoString 

func (s DescribePredictorBacktestExportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn 

func (s *DescribePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn(v string) *DescribePredictorBacktestExportJobInput

SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.

func (DescribePredictorBacktestExportJobInput) String 

func (s DescribePredictorBacktestExportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePredictorBacktestExportJobInput) Validate 

func (s *DescribePredictorBacktestExportJobInput) Validate() error

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

type DescribePredictorBacktestExportJobOutput 

type DescribePredictorBacktestExportJobOutput struct {

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

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

	// The format of the exported data, CSV or PARQUET.
	Format *string `type:"string"`

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

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

	// The Amazon Resource Name (ARN) of the predictor.
	PredictorArn *string `type:"string"`

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

	// The name of the predictor backtest export job.
	PredictorBacktestExportJobName *string `min:"1" type:"string"`

	// The status of the predictor backtest export job. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribePredictorBacktestExportJobOutput) GoString 

func (s DescribePredictorBacktestExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePredictorBacktestExportJobOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribePredictorBacktestExportJobOutput) SetDestination 

func (s *DescribePredictorBacktestExportJobOutput) SetDestination(v *DataDestination) *DescribePredictorBacktestExportJobOutput

SetDestination sets the Destination field's value.

func (*DescribePredictorBacktestExportJobOutput) SetFormat added in v1.42.9 

func (s *DescribePredictorBacktestExportJobOutput) SetFormat(v string) *DescribePredictorBacktestExportJobOutput

SetFormat sets the Format field's value.

func (*DescribePredictorBacktestExportJobOutput) SetLastModificationTime 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribePredictorBacktestExportJobOutput) SetMessage 

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

SetMessage sets the Message field's value.

func (*DescribePredictorBacktestExportJobOutput) SetPredictorArn 

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

SetPredictorArn sets the PredictorArn field's value.

func (*DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn 

func (s *DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn(v string) *DescribePredictorBacktestExportJobOutput

SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.

func (*DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobName 

func (s *DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobName(v string) *DescribePredictorBacktestExportJobOutput

SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value.

func (*DescribePredictorBacktestExportJobOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (DescribePredictorBacktestExportJobOutput) String 

func (s DescribePredictorBacktestExportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

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

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

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

	// The estimated time remaining in minutes for the predictor training job to
	// complete.
	EstimatedTimeRemainingInMinutes *int64 `type:"long"`

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

	// The featurization configuration.
	FeaturizationConfig *FeaturizationConfig `type:"structure"`

	// The number of time-steps of the forecast. The forecast horizon is also called
	// the prediction length.
	ForecastHorizon *int64 `type:"integer"`

	// The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]
	ForecastTypes []*string `min:"1" type:"list"`

	// The hyperparameter override values for the algorithm.
	HPOConfig *HyperParameterTuningJobConfig `type:"structure"`

	// Describes the dataset group that contains the data to use to train the predictor.
	InputDataConfig *InputDataConfig `type:"structure"`

	// Whether the predictor was created with CreateAutoPredictor.
	IsAutoPredictor *bool `type:"boolean"`

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

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

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric *string `type:"string" enum:"OptimizationMetric"`

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

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

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

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

	// The name of the predictor.
	PredictorName *string `min:"1" type:"string"`

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

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

func (DescribePredictorOutput) GoString 

func (s DescribePredictorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePredictorOutput) SetAlgorithmArn 

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

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) SetAutoMLOverrideStrategy 

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

SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value.

func (*DescribePredictorOutput) SetCreationTime 

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

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 

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

SetEncryptionConfig sets the EncryptionConfig field's value.

func (*DescribePredictorOutput) SetEstimatedTimeRemainingInMinutes 

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

SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.

func (*DescribePredictorOutput) SetEvaluationParameters 

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

SetEvaluationParameters sets the EvaluationParameters field's value.

func (*DescribePredictorOutput) SetFeaturizationConfig 

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

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) SetForecastTypes 

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

SetForecastTypes sets the ForecastTypes field's value.

func (*DescribePredictorOutput) SetHPOConfig 

func (s *DescribePredictorOutput) SetHPOConfig(v *HyperParameterTuningJobConfig) *DescribePredictorOutput

SetHPOConfig sets the HPOConfig field's value.

func (*DescribePredictorOutput) SetInputDataConfig 

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

SetInputDataConfig sets the InputDataConfig field's value.

func (*DescribePredictorOutput) SetIsAutoPredictor added in v1.42.9 

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

SetIsAutoPredictor sets the IsAutoPredictor field's value.

func (*DescribePredictorOutput) SetLastModificationTime 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribePredictorOutput) SetMessage 

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

SetMessage sets the Message field's value.

func (*DescribePredictorOutput) SetOptimizationMetric 

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

SetOptimizationMetric sets the OptimizationMetric field's value.

func (*DescribePredictorOutput) SetPerformAutoML 

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

SetPerformAutoML sets the PerformAutoML field's value.

func (*DescribePredictorOutput) SetPerformHPO 

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

SetPerformHPO sets the PerformHPO field's value.

func (*DescribePredictorOutput) SetPredictorArn 

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

SetPredictorArn sets the PredictorArn field's value.

func (*DescribePredictorOutput) SetPredictorExecutionDetails 

func (s *DescribePredictorOutput) SetPredictorExecutionDetails(v *PredictorExecutionDetails) *DescribePredictorOutput

SetPredictorExecutionDetails sets the PredictorExecutionDetails field's value.

func (*DescribePredictorOutput) SetPredictorName 

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

SetPredictorName sets the PredictorName field's value.

func (*DescribePredictorOutput) SetStatus 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWhatIfAnalysisInput added in v1.42.9 

type DescribeWhatIfAnalysisInput struct {

	// The Amazon Resource Name (ARN) of the what-if analysis that you are interested
	// in.
	//
	// WhatIfAnalysisArn is a required field
	WhatIfAnalysisArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWhatIfAnalysisInput) GoString added in v1.42.9 

func (s DescribeWhatIfAnalysisInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWhatIfAnalysisInput) SetWhatIfAnalysisArn added in v1.42.9 

func (s *DescribeWhatIfAnalysisInput) SetWhatIfAnalysisArn(v string) *DescribeWhatIfAnalysisInput

SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.

func (DescribeWhatIfAnalysisInput) String added in v1.42.9 

func (s DescribeWhatIfAnalysisInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWhatIfAnalysisInput) Validate added in v1.42.9 

func (s *DescribeWhatIfAnalysisInput) Validate() error

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

type DescribeWhatIfAnalysisOutput added in v1.42.9 

type DescribeWhatIfAnalysisOutput struct {

	// When the what-if analysis was created.
	CreationTime *time.Time `type:"timestamp"`

	// The approximate time remaining to complete the what-if analysis, in minutes.
	EstimatedTimeRemainingInMinutes *int64 `type:"long"`

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

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

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

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

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

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

	// The name of the what-if analysis.
	WhatIfAnalysisName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWhatIfAnalysisOutput) GoString added in v1.42.9 

func (s DescribeWhatIfAnalysisOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWhatIfAnalysisOutput) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeWhatIfAnalysisOutput) SetEstimatedTimeRemainingInMinutes added in v1.42.9 

func (s *DescribeWhatIfAnalysisOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeWhatIfAnalysisOutput

SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.

func (*DescribeWhatIfAnalysisOutput) SetForecastArn added in v1.42.9 

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

SetForecastArn sets the ForecastArn field's value.

func (*DescribeWhatIfAnalysisOutput) SetLastModificationTime added in v1.42.9 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeWhatIfAnalysisOutput) SetMessage added in v1.42.9 

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

SetMessage sets the Message field's value.

func (*DescribeWhatIfAnalysisOutput) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (*DescribeWhatIfAnalysisOutput) SetTimeSeriesSelector added in v1.42.9 

func (s *DescribeWhatIfAnalysisOutput) SetTimeSeriesSelector(v *TimeSeriesSelector) *DescribeWhatIfAnalysisOutput

SetTimeSeriesSelector sets the TimeSeriesSelector field's value.

func (*DescribeWhatIfAnalysisOutput) SetWhatIfAnalysisArn added in v1.42.9 

func (s *DescribeWhatIfAnalysisOutput) SetWhatIfAnalysisArn(v string) *DescribeWhatIfAnalysisOutput

SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.

func (*DescribeWhatIfAnalysisOutput) SetWhatIfAnalysisName added in v1.42.9 

func (s *DescribeWhatIfAnalysisOutput) SetWhatIfAnalysisName(v string) *DescribeWhatIfAnalysisOutput

SetWhatIfAnalysisName sets the WhatIfAnalysisName field's value.

func (DescribeWhatIfAnalysisOutput) String added in v1.42.9 

func (s DescribeWhatIfAnalysisOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWhatIfForecastExportInput added in v1.42.9 

type DescribeWhatIfForecastExportInput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast export that you are
	// interested in.
	//
	// WhatIfForecastExportArn is a required field
	WhatIfForecastExportArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWhatIfForecastExportInput) GoString added in v1.42.9 

func (s DescribeWhatIfForecastExportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWhatIfForecastExportInput) SetWhatIfForecastExportArn added in v1.42.9 

func (s *DescribeWhatIfForecastExportInput) SetWhatIfForecastExportArn(v string) *DescribeWhatIfForecastExportInput

SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.

func (DescribeWhatIfForecastExportInput) String added in v1.42.9 

func (s DescribeWhatIfForecastExportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWhatIfForecastExportInput) Validate added in v1.42.9 

func (s *DescribeWhatIfForecastExportInput) Validate() error

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

type DescribeWhatIfForecastExportOutput added in v1.42.9 

type DescribeWhatIfForecastExportOutput struct {

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

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

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

	// The format of the exported data, CSV or PARQUET.
	Format *string `type:"string"`

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

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

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

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

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

	// The name of the what-if forecast export.
	WhatIfForecastExportName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWhatIfForecastExportOutput) GoString added in v1.42.9 

func (s DescribeWhatIfForecastExportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWhatIfForecastExportOutput) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeWhatIfForecastExportOutput) SetDestination added in v1.42.9 

func (s *DescribeWhatIfForecastExportOutput) SetDestination(v *DataDestination) *DescribeWhatIfForecastExportOutput

SetDestination sets the Destination field's value.

func (*DescribeWhatIfForecastExportOutput) SetEstimatedTimeRemainingInMinutes added in v1.42.9 

func (s *DescribeWhatIfForecastExportOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeWhatIfForecastExportOutput

SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.

func (*DescribeWhatIfForecastExportOutput) SetFormat added in v1.42.9 

func (s *DescribeWhatIfForecastExportOutput) SetFormat(v string) *DescribeWhatIfForecastExportOutput

SetFormat sets the Format field's value.

func (*DescribeWhatIfForecastExportOutput) SetLastModificationTime added in v1.42.9 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeWhatIfForecastExportOutput) SetMessage added in v1.42.9 

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

SetMessage sets the Message field's value.

func (*DescribeWhatIfForecastExportOutput) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (*DescribeWhatIfForecastExportOutput) SetWhatIfForecastArns added in v1.42.9 

func (s *DescribeWhatIfForecastExportOutput) SetWhatIfForecastArns(v []*string) *DescribeWhatIfForecastExportOutput

SetWhatIfForecastArns sets the WhatIfForecastArns field's value.

func (*DescribeWhatIfForecastExportOutput) SetWhatIfForecastExportArn added in v1.42.9 

func (s *DescribeWhatIfForecastExportOutput) SetWhatIfForecastExportArn(v string) *DescribeWhatIfForecastExportOutput

SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.

func (*DescribeWhatIfForecastExportOutput) SetWhatIfForecastExportName added in v1.42.9 

func (s *DescribeWhatIfForecastExportOutput) SetWhatIfForecastExportName(v string) *DescribeWhatIfForecastExportOutput

SetWhatIfForecastExportName sets the WhatIfForecastExportName field's value.

func (DescribeWhatIfForecastExportOutput) String added in v1.42.9 

func (s DescribeWhatIfForecastExportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWhatIfForecastInput added in v1.42.9 

type DescribeWhatIfForecastInput struct {

	// The Amazon Resource Name (ARN) of the what-if forecast that you are interested
	// in.
	//
	// WhatIfForecastArn is a required field
	WhatIfForecastArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWhatIfForecastInput) GoString added in v1.42.9 

func (s DescribeWhatIfForecastInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWhatIfForecastInput) SetWhatIfForecastArn added in v1.42.9 

func (s *DescribeWhatIfForecastInput) SetWhatIfForecastArn(v string) *DescribeWhatIfForecastInput

SetWhatIfForecastArn sets the WhatIfForecastArn field's value.

func (DescribeWhatIfForecastInput) String added in v1.42.9 

func (s DescribeWhatIfForecastInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWhatIfForecastInput) Validate added in v1.42.9 

func (s *DescribeWhatIfForecastInput) Validate() error

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

type DescribeWhatIfForecastOutput added in v1.42.9 

type DescribeWhatIfForecastOutput struct {

	// When the what-if forecast was created.
	CreationTime *time.Time `type:"timestamp"`

	// The approximate time remaining to complete the what-if forecast, in minutes.
	EstimatedTimeRemainingInMinutes *int64 `type:"long"`

	// The quantiles at which probabilistic forecasts are generated. You can specify
	// up to five quantiles per what-if forecast in the CreateWhatIfForecast operation.
	// If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
	ForecastTypes []*string `min:"1" type:"list"`

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

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

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

	// An array of S3Config, Schema, and Format elements that describe the replacement
	// time series.
	TimeSeriesReplacementsDataSource *TimeSeriesReplacementsDataSource `type:"structure"`

	// An array of Action and TimeSeriesConditions elements that describe what transformations
	// were applied to which time series.
	TimeSeriesTransformations []*TimeSeriesTransformation `type:"list"`

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

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

	// The name of the what-if forecast.
	WhatIfForecastName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWhatIfForecastOutput) GoString added in v1.42.9 

func (s DescribeWhatIfForecastOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWhatIfForecastOutput) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribeWhatIfForecastOutput) SetEstimatedTimeRemainingInMinutes added in v1.42.9 

func (s *DescribeWhatIfForecastOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeWhatIfForecastOutput

SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value.

func (*DescribeWhatIfForecastOutput) SetForecastTypes added in v1.42.9 

func (s *DescribeWhatIfForecastOutput) SetForecastTypes(v []*string) *DescribeWhatIfForecastOutput

SetForecastTypes sets the ForecastTypes field's value.

func (*DescribeWhatIfForecastOutput) SetLastModificationTime added in v1.42.9 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*DescribeWhatIfForecastOutput) SetMessage added in v1.42.9 

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

SetMessage sets the Message field's value.

func (*DescribeWhatIfForecastOutput) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (*DescribeWhatIfForecastOutput) SetTimeSeriesReplacementsDataSource added in v1.42.9 

func (s *DescribeWhatIfForecastOutput) SetTimeSeriesReplacementsDataSource(v *TimeSeriesReplacementsDataSource) *DescribeWhatIfForecastOutput

SetTimeSeriesReplacementsDataSource sets the TimeSeriesReplacementsDataSource field's value.

func (*DescribeWhatIfForecastOutput) SetTimeSeriesTransformations added in v1.42.9 

func (s *DescribeWhatIfForecastOutput) SetTimeSeriesTransformations(v []*TimeSeriesTransformation) *DescribeWhatIfForecastOutput

SetTimeSeriesTransformations sets the TimeSeriesTransformations field's value.

func (*DescribeWhatIfForecastOutput) SetWhatIfAnalysisArn added in v1.42.9 

func (s *DescribeWhatIfForecastOutput) SetWhatIfAnalysisArn(v string) *DescribeWhatIfForecastOutput

SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.

func (*DescribeWhatIfForecastOutput) SetWhatIfForecastArn added in v1.42.9 

func (s *DescribeWhatIfForecastOutput) SetWhatIfForecastArn(v string) *DescribeWhatIfForecastOutput

SetWhatIfForecastArn sets the WhatIfForecastArn field's value.

func (*DescribeWhatIfForecastOutput) SetWhatIfForecastName added in v1.42.9 

func (s *DescribeWhatIfForecastOutput) SetWhatIfForecastName(v string) *DescribeWhatIfForecastOutput

SetWhatIfForecastName sets the WhatIfForecastName field's value.

func (DescribeWhatIfForecastOutput) String added in v1.42.9 

func (s DescribeWhatIfForecastOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EncryptionConfig 

type EncryptionConfig struct {

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

	// The ARN of the IAM role that Amazon Forecast can assume to access the KMS
	// key.
	//
	// Passing a role across Amazon Web Services accounts is not allowed. If you
	// pass a role that isn't in your account, you get an InvalidInputException
	// error.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (EncryptionConfig) GoString 

func (s EncryptionConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionConfig) Validate 

func (s *EncryptionConfig) Validate() error

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

type ErrorMetric 

type ErrorMetric struct {

	// The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
	ForecastType *string `min:"2" type:"string"`

	// The Mean Absolute Percentage Error (MAPE)
	MAPE *float64 `type:"double"`

	// The Mean Absolute Scaled Error (MASE)
	MASE *float64 `type:"double"`

	// The root-mean-square error (RMSE).
	RMSE *float64 `type:"double"`

	// The weighted absolute percentage error (WAPE).
	WAPE *float64 `type:"double"`
	// contains filtered or unexported fields
}

Provides detailed error metrics to evaluate the performance of a predictor. This object is part of the Metrics object.

func (ErrorMetric) GoString 

func (s ErrorMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ErrorMetric) SetForecastType 

func (s *ErrorMetric) SetForecastType(v string) *ErrorMetric

SetForecastType sets the ForecastType field's value.

func (*ErrorMetric) SetMAPE 

func (s *ErrorMetric) SetMAPE(v float64) *ErrorMetric

SetMAPE sets the MAPE field's value.

func (*ErrorMetric) SetMASE 

func (s *ErrorMetric) SetMASE(v float64) *ErrorMetric

SetMASE sets the MASE field's value.

func (*ErrorMetric) SetRMSE 

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

SetRMSE sets the RMSE field's value.

func (*ErrorMetric) SetWAPE 

func (s *ErrorMetric) SetWAPE(v float64) *ErrorMetric

SetWAPE sets the WAPE field's value.

func (ErrorMetric) String 

func (s ErrorMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EvaluationParameters 

type EvaluationParameters struct {

	// The point from the end of the dataset where you want to split the data for
	// model training and testing (evaluation). Specify the value as the number
	// of data points. The default is the value of the forecast horizon. BackTestWindowOffset
	// can be used to mimic a past virtual forecast start date. This value must
	// be greater than or equal to the forecast horizon and less than half of the
	// TARGET_TIME_SERIES dataset length.
	//
	// ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset
	// length
	BackTestWindowOffset *int64 `type:"integer"`

	// The number of times to split the input data. The default is 1. Valid values
	// are 1 through 5.
	NumberOfBacktestWindows *int64 `type:"integer"`
	// 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 but you can override them in the CreatePredictor request.

func (EvaluationParameters) GoString 

func (s EvaluationParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExplainabilityConfig added in v1.42.9 

type ExplainabilityConfig struct {

	// To create an Explainability for all time points in your forecast horizon,
	// use ALL. To create an Explainability for specific time points in your forecast
	// horizon, use SPECIFIC.
	//
	// Specify time points with the StartDateTime and EndDateTime parameters within
	// the CreateExplainability operation.
	//
	// TimePointGranularity is a required field
	TimePointGranularity *string `type:"string" required:"true" enum:"TimePointGranularity"`

	// To create an Explainability for all time series in your datasets, use ALL.
	// To create an Explainability for specific time series in your datasets, use
	// SPECIFIC.
	//
	// Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket
	// and set the location within the DataDestination data type.
	//
	// TimeSeriesGranularity is a required field
	TimeSeriesGranularity *string `type:"string" required:"true" enum:"TimeSeriesGranularity"`
	// contains filtered or unexported fields
}

The ExplainabilityConfig data type defines the number of time series and time points included in CreateExplainability.

If you provide a predictor ARN for ResourceArn, you must set both TimePointGranularity and TimeSeriesGranularity to “ALL”. When creating Predictor Explainability, Amazon Forecast considers all time series and time points.

If you provide a forecast ARN for ResourceArn, you can set TimePointGranularity and TimeSeriesGranularity to either “ALL” or “Specific”.

func (ExplainabilityConfig) GoString added in v1.42.9 

func (s ExplainabilityConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExplainabilityConfig) SetTimePointGranularity added in v1.42.9 

func (s *ExplainabilityConfig) SetTimePointGranularity(v string) *ExplainabilityConfig

SetTimePointGranularity sets the TimePointGranularity field's value.

func (*ExplainabilityConfig) SetTimeSeriesGranularity added in v1.42.9 

func (s *ExplainabilityConfig) SetTimeSeriesGranularity(v string) *ExplainabilityConfig

SetTimeSeriesGranularity sets the TimeSeriesGranularity field's value.

func (ExplainabilityConfig) String added in v1.42.9 

func (s ExplainabilityConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExplainabilityConfig) Validate added in v1.42.9 

func (s *ExplainabilityConfig) Validate() error

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

type ExplainabilityExportSummary added in v1.42.9 

type ExplainabilityExportSummary struct {

	// When the Explainability was created.
	CreationTime *time.Time `type:"timestamp"`

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

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

	// The name of the Explainability export
	ExplainabilityExportName *string `min:"1" type:"string"`

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

	// Information about any errors that may have occurred during the Explainability
	// export.
	Message *string `type:"string"`

	// The status of the Explainability export. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the Explainability export properties used in the ListExplainabilityExports operation. To get a complete set of properties, call the DescribeExplainabilityExport operation, and provide the ExplainabilityExportArn.

func (ExplainabilityExportSummary) GoString added in v1.42.9 

func (s ExplainabilityExportSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExplainabilityExportSummary) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*ExplainabilityExportSummary) SetDestination added in v1.42.9 

func (s *ExplainabilityExportSummary) SetDestination(v *DataDestination) *ExplainabilityExportSummary

SetDestination sets the Destination field's value.

func (*ExplainabilityExportSummary) SetExplainabilityExportArn added in v1.42.9 

func (s *ExplainabilityExportSummary) SetExplainabilityExportArn(v string) *ExplainabilityExportSummary

SetExplainabilityExportArn sets the ExplainabilityExportArn field's value.

func (*ExplainabilityExportSummary) SetExplainabilityExportName added in v1.42.9 

func (s *ExplainabilityExportSummary) SetExplainabilityExportName(v string) *ExplainabilityExportSummary

SetExplainabilityExportName sets the ExplainabilityExportName field's value.

func (*ExplainabilityExportSummary) SetLastModificationTime added in v1.42.9 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*ExplainabilityExportSummary) SetMessage added in v1.42.9 

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

SetMessage sets the Message field's value.

func (*ExplainabilityExportSummary) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (ExplainabilityExportSummary) String added in v1.42.9 

func (s ExplainabilityExportSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExplainabilityInfo added in v1.42.9 

type ExplainabilityInfo struct {

	// The Amazon Resource Name (ARN) of the Explainability.
	ExplainabilityArn *string `type:"string"`

	// The status of the Explainability. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the Explainability resource.

func (ExplainabilityInfo) GoString added in v1.42.9 

func (s ExplainabilityInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExplainabilityInfo) SetExplainabilityArn added in v1.42.9 

func (s *ExplainabilityInfo) SetExplainabilityArn(v string) *ExplainabilityInfo

SetExplainabilityArn sets the ExplainabilityArn field's value.

func (*ExplainabilityInfo) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (ExplainabilityInfo) String added in v1.42.9 

func (s ExplainabilityInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExplainabilitySummary added in v1.42.9 

type ExplainabilitySummary struct {

	// When the Explainability was created.
	CreationTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the Explainability.
	ExplainabilityArn *string `type:"string"`

	// The configuration settings that define the granularity of time series and
	// time points for the Explainability.
	ExplainabilityConfig *ExplainabilityConfig `type:"structure"`

	// The name of the Explainability.
	ExplainabilityName *string `min:"1" type:"string"`

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

	// Information about any errors that may have occurred during the Explainability
	// creation process.
	Message *string `type:"string"`

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

	// The status of the Explainability. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the Explainability properties used in the ListExplainabilities operation. To get a complete set of properties, call the DescribeExplainability operation, and provide the listed ExplainabilityArn.

func (ExplainabilitySummary) GoString added in v1.42.9 

func (s ExplainabilitySummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExplainabilitySummary) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*ExplainabilitySummary) SetExplainabilityArn added in v1.42.9 

func (s *ExplainabilitySummary) SetExplainabilityArn(v string) *ExplainabilitySummary

SetExplainabilityArn sets the ExplainabilityArn field's value.

func (*ExplainabilitySummary) SetExplainabilityConfig added in v1.42.9 

func (s *ExplainabilitySummary) SetExplainabilityConfig(v *ExplainabilityConfig) *ExplainabilitySummary

SetExplainabilityConfig sets the ExplainabilityConfig field's value.

func (*ExplainabilitySummary) SetExplainabilityName added in v1.42.9 

func (s *ExplainabilitySummary) SetExplainabilityName(v string) *ExplainabilitySummary

SetExplainabilityName sets the ExplainabilityName field's value.

func (*ExplainabilitySummary) SetLastModificationTime added in v1.42.9 

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

SetLastModificationTime sets the LastModificationTime field's value.

func (*ExplainabilitySummary) SetMessage added in v1.42.9 

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

SetMessage sets the Message field's value.

func (*ExplainabilitySummary) SetResourceArn added in v1.42.9 

func (s *ExplainabilitySummary) SetResourceArn(v string) *ExplainabilitySummary

SetResourceArn sets the ResourceArn field's value.

func (*ExplainabilitySummary) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (ExplainabilitySummary) String added in v1.42.9 

func (s ExplainabilitySummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Featurization 

type Featurization struct {

	// The name of the schema attribute that specifies the data field to be featurized.
	// Amazon Forecast supports the target field of the TARGET_TIME_SERIES and the
	// RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target
	// is demand, and for the CUSTOM domain, the target is target_value. For more
	// information, see howitworks-missing-values.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// An array of one FeaturizationMethod object that specifies the feature transformation
	// method.
	FeaturizationPipeline []*FeaturizationMethod `min:"1" type:"list"`
	// contains filtered or unexported fields
}

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.

Provides featurization (transformation) information for a dataset field. This object is part of the FeaturizationConfig object.

For example:

{

"AttributeName": "demand",

FeaturizationPipeline [ {

"FeaturizationMethodName": "filling",

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

} ]

}

func (Featurization) GoString 

func (s Featurization) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	Featurizations []*Featurization `min:"1" type:"list"`

	// An array of dimension (field) names that specify how to group the generated
	// forecast.
	//
	// For example, suppose that you are generating a forecast for item sales across
	// all of your stores, and your dataset contains a store_id field. If you want
	// the sales forecast for each item by store, you would specify store_id as
	// the dimension.
	//
	// All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't
	// need to be specified in the CreatePredictor request. All forecast dimensions
	// specified in the RELATED_TIME_SERIES dataset must be specified in the CreatePredictor
	// request.
	ForecastDimensions []*string `min:"1" type:"list"`

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

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.

In a CreatePredictor operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization.

You define featurization using the FeaturizationConfig object. You specify an array of transformations, one for each field that you want to featurize. You then include the FeaturizationConfig object in your CreatePredictor request. Amazon Forecast applies the featurization to the TARGET_TIME_SERIES and RELATED_TIME_SERIES datasets before model training.

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

func (FeaturizationConfig) GoString 

func (s FeaturizationConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. The "filling" method is the only supported method.
	//
	// FeaturizationMethodName is a required field
	FeaturizationMethodName *string `type:"string" required:"true" enum:"FeaturizationMethodName"`

	// The method parameters (key-value pairs), which are a map of override parameters.
	// Specify these parameters to override the default values. Related Time Series
	// attributes do not accept aggregation parameters.
	//
	// The following list shows the parameters and their valid values for the "filling"
	// featurization method for a Target Time Series dataset. Bold signifies the
	// default value.
	//
	//    * aggregation: sum, avg, first, min, max
	//
	//    * frontfill: none
	//
	//    * middlefill: zero, nan (not a number), value, median, mean, min, max
	//
	//    * backfill: zero, nan, value, median, mean, min, max
	//
	// The following list shows the parameters and their valid values for a Related
	// Time Series featurization method (there are no defaults):
	//
	//    * middlefill: zero, value, median, mean, min, max
	//
	//    * backfill: zero, value, median, mean, min, max
	//
	//    * futurefill: zero, value, median, mean, min, max
	//
	// To set a filling method to a specific value, set the fill parameter to value
	// and define the value in a corresponding _value parameter. For example, to
	// set backfilling to a value of 2, include the following: "backfill": "value"
	// and "backfill_value":"2".
	FeaturizationMethodParameters map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

Provides information about the method that featurizes (transforms) a dataset field. The method is part of the FeaturizationPipeline of the Featurization object.

The following is an example of how you specify a FeaturizationMethod object.

{

"FeaturizationMethodName": "filling",

"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}

}

func (FeaturizationMethod) GoString 

func (s FeaturizationMethod) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. To include the objects that match the statement,
	// specify IS. To exclude matching objects, specify IS_NOT.
	//
	// Condition is a required field
	Condition *string `type:"string" required:"true" enum:"FilterConditionString"`

	// The name of the parameter to filter on.
	//
	// Key is a required field
	Key *string `type:"string" required:"true"`

	// The value to match.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// 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 the objects that match the statement, respectively. The match statement consists of a key and a value.

func (Filter) GoString 

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Simple Storage Service (Amazon S3) bucket where the
	// forecast is exported.
	Destination *DataDestination `type:"structure"`

	// The Amazon Resource Name (ARN) of the forecast export job.
	ForecastExportJobArn *string `type:"string"`

	// The name of the forecast export job.
	ForecastExportJobName *string `min:"1" type:"string"`

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

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

	// The status of the forecast export job. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	//
	// The Status of the forecast export job must be ACTIVE before you can access
	// the forecast in your S3 bucket.
	Status *string `type:"string"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForecastExportJobSummary) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*ForecastExportJobSummary) SetDestination 

func (s *ForecastExportJobSummary) SetDestination(v *DataDestination) *ForecastExportJobSummary

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 

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

SetMessage sets the Message field's value.

func (*ForecastExportJobSummary) SetStatus 

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

SetStatus sets the Status field's value.

func (ForecastExportJobSummary) String 

func (s ForecastExportJobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ForecastService

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: 

mySession := session.Must(session.NewSession())

// 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) CreateAutoPredictor added in v1.42.9 

func (c *ForecastService) CreateAutoPredictor(input *CreateAutoPredictorInput) (*CreateAutoPredictorOutput, error)

CreateAutoPredictor API operation for Amazon Forecast Service.

Creates an Amazon Forecast predictor.

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

Creating new predictors

The following parameters are required when creating a new predictor:

  • PredictorName - A unique name for the predictor.

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

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

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

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

Upgrading and retraining predictors

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

  • PredictorName - A unique name for the predictor.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateAutoPredictor for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreateAutoPredictorRequest added in v1.42.9 

func (c *ForecastService) CreateAutoPredictorRequest(input *CreateAutoPredictorInput) (req *request.Request, output *CreateAutoPredictorOutput)

CreateAutoPredictorRequest generates a "aws/request.Request" representing the client's request for the CreateAutoPredictor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAutoPredictor for more information on using the CreateAutoPredictor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAutoPredictorRequest method.
req, resp := client.CreateAutoPredictorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) CreateAutoPredictorWithContext added in v1.42.9 

func (c *ForecastService) CreateAutoPredictorWithContext(ctx aws.Context, input *CreateAutoPredictorInput, opts ...request.Option) (*CreateAutoPredictorOutput, error)

CreateAutoPredictorWithContext is the same as CreateAutoPredictor with the addition of the ability to pass a context and additional request options.

See CreateAutoPredictor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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.

  • Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.

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

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).

To get a list of all your datasets, use the ListDatasets (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository (https://github.com/aws-samples/amazon-forecast-samples).

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation to get the status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateDataset for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreateDatasetGroup 

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

CreateDatasetGroup API operation for Amazon Forecast Service.

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html).

To get a list of all your datasets groups, use the ListDatasetGroups (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) operation.

The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateDatasetGroup for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*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 (https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html) object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal Amazon Web Services system. For more information, see Set up permissions (https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html).

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

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

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

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateDatasetImportJob for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*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) CreateExplainability added in v1.42.9 

func (c *ForecastService) CreateExplainability(input *CreateExplainabilityInput) (*CreateExplainabilityOutput, error)

CreateExplainability API operation for Amazon Forecast Service.

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

Creates an Amazon Forecast Explainability.

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

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

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

CreateExplainability with a Predictor ARN

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

The following parameters are required when providing a Predictor ARN:

  • ExplainabilityName - A unique name for the Explainability.

  • ResourceArn - The Arn of the predictor.

  • TimePointGranularity - Must be set to “ALL”.

  • TimeSeriesGranularity - Must be set to “ALL”.

Do not specify a value for the following parameters:

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

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

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

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

CreateExplainability with a Forecast ARN

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

The following parameters are required when providing a Predictor ARN:

  • ExplainabilityName - A unique name for the Explainability.

  • ResourceArn - The Arn of the forecast.

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

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

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

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

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

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateExplainability for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreateExplainabilityExport added in v1.42.9 

func (c *ForecastService) CreateExplainabilityExport(input *CreateExplainabilityExportInput) (*CreateExplainabilityExportOutput, error)

CreateExplainabilityExport API operation for Amazon Forecast Service.

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateExplainabilityExport for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreateExplainabilityExportRequest added in v1.42.9 

func (c *ForecastService) CreateExplainabilityExportRequest(input *CreateExplainabilityExportInput) (req *request.Request, output *CreateExplainabilityExportOutput)

CreateExplainabilityExportRequest generates a "aws/request.Request" representing the client's request for the CreateExplainabilityExport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateExplainabilityExport for more information on using the CreateExplainabilityExport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateExplainabilityExportRequest method.
req, resp := client.CreateExplainabilityExportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) CreateExplainabilityExportWithContext added in v1.42.9 

func (c *ForecastService) CreateExplainabilityExportWithContext(ctx aws.Context, input *CreateExplainabilityExportInput, opts ...request.Option) (*CreateExplainabilityExportOutput, error)

CreateExplainabilityExportWithContext is the same as CreateExplainabilityExport with the addition of the ability to pass a context and additional request options.

See CreateExplainabilityExport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) CreateExplainabilityRequest added in v1.42.9 

func (c *ForecastService) CreateExplainabilityRequest(input *CreateExplainabilityInput) (req *request.Request, output *CreateExplainabilityOutput)

CreateExplainabilityRequest generates a "aws/request.Request" representing the client's request for the CreateExplainability operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateExplainability for more information on using the CreateExplainability API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateExplainabilityRequest method.
req, resp := client.CreateExplainabilityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) CreateExplainabilityWithContext added in v1.42.9 

func (c *ForecastService) CreateExplainabilityWithContext(ctx aws.Context, input *CreateExplainabilityInput, opts ...request.Option) (*CreateExplainabilityOutput, error)

CreateExplainabilityWithContext is the same as CreateExplainability with the addition of the ability to pass a context and additional request options.

See CreateExplainability for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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) bucket, use the CreateForecastExportJob operation.

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

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

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

For more information, see howitworks-forecast.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateForecast for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreateForecastExportJob 

func (c *ForecastService) CreateForecastExportJob(input *CreateForecastExportJobInput) (*CreateForecastExportJobOutput, error)

CreateForecastExportJob API operation for Amazon Forecast Service.

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

<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

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

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

For more information, see howitworks-forecast.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateForecastExportJob for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*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) CreateMonitor added in v1.42.9 

func (c *ForecastService) CreateMonitor(input *CreateMonitorInput) (*CreateMonitorOutput, error)

CreateMonitor API operation for Amazon Forecast Service.

Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateMonitor for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreateMonitorRequest added in v1.42.9 

func (c *ForecastService) CreateMonitorRequest(input *CreateMonitorInput) (req *request.Request, output *CreateMonitorOutput)

CreateMonitorRequest generates a "aws/request.Request" representing the client's request for the CreateMonitor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMonitor for more information on using the CreateMonitor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateMonitorRequest method.
req, resp := client.CreateMonitorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) CreateMonitorWithContext added in v1.42.9 

func (c *ForecastService) CreateMonitorWithContext(ctx aws.Context, input *CreateMonitorInput, opts ...request.Option) (*CreateMonitorOutput, error)

CreateMonitorWithContext is the same as CreateMonitor with the addition of the ability to pass a context and additional request options.

See CreateMonitor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) CreatePredictor 

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

CreatePredictor API operation for Amazon Forecast Service.

This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use CreateAutoPredictor.

Creates an Amazon Forecast predictor.

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

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

To see the evaluation metrics, use the GetAccuracyMetrics operation.

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

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

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

AutoML

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

When AutoML is enabled, the following properties are disallowed:

  • AlgorithmArn

  • HPOConfig

  • PerformHPO

  • TrainingParameters

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreatePredictor for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreatePredictorBacktestExportJob 

func (c *ForecastService) CreatePredictorBacktestExportJob(input *CreatePredictorBacktestExportJobInput) (*CreatePredictorBacktestExportJobOutput, error)

CreatePredictorBacktestExportJob API operation for Amazon Forecast Service.

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

The export file names will match the following conventions:

<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreatePredictorBacktestExportJob for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreatePredictorBacktestExportJobRequest 

func (c *ForecastService) CreatePredictorBacktestExportJobRequest(input *CreatePredictorBacktestExportJobInput) (req *request.Request, output *CreatePredictorBacktestExportJobOutput)

CreatePredictorBacktestExportJobRequest generates a "aws/request.Request" representing the client's request for the CreatePredictorBacktestExportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePredictorBacktestExportJob for more information on using the CreatePredictorBacktestExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreatePredictorBacktestExportJobRequest method.
req, resp := client.CreatePredictorBacktestExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) CreatePredictorBacktestExportJobWithContext 

func (c *ForecastService) CreatePredictorBacktestExportJobWithContext(ctx aws.Context, input *CreatePredictorBacktestExportJobInput, opts ...request.Option) (*CreatePredictorBacktestExportJobOutput, error)

CreatePredictorBacktestExportJobWithContext is the same as CreatePredictorBacktestExportJob with the addition of the ability to pass a context and additional request options.

See CreatePredictorBacktestExportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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) CreateWhatIfAnalysis added in v1.42.9 

func (c *ForecastService) CreateWhatIfAnalysis(input *CreateWhatIfAnalysisInput) (*CreateWhatIfAnalysisOutput, error)

CreateWhatIfAnalysis API operation for Amazon Forecast Service.

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

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

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateWhatIfAnalysis for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreateWhatIfAnalysisRequest added in v1.42.9 

func (c *ForecastService) CreateWhatIfAnalysisRequest(input *CreateWhatIfAnalysisInput) (req *request.Request, output *CreateWhatIfAnalysisOutput)

CreateWhatIfAnalysisRequest generates a "aws/request.Request" representing the client's request for the CreateWhatIfAnalysis operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWhatIfAnalysis for more information on using the CreateWhatIfAnalysis API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWhatIfAnalysisRequest method.
req, resp := client.CreateWhatIfAnalysisRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) CreateWhatIfAnalysisWithContext added in v1.42.9 

func (c *ForecastService) CreateWhatIfAnalysisWithContext(ctx aws.Context, input *CreateWhatIfAnalysisInput, opts ...request.Option) (*CreateWhatIfAnalysisOutput, error)

CreateWhatIfAnalysisWithContext is the same as CreateWhatIfAnalysis with the addition of the ability to pass a context and additional request options.

See CreateWhatIfAnalysis for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) CreateWhatIfForecast added in v1.42.9 

func (c *ForecastService) CreateWhatIfForecast(input *CreateWhatIfForecastInput) (*CreateWhatIfForecastOutput, error)

CreateWhatIfForecast API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateWhatIfForecast for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreateWhatIfForecastExport added in v1.42.9 

func (c *ForecastService) CreateWhatIfForecastExport(input *CreateWhatIfForecastExportInput) (*CreateWhatIfForecastExportOutput, error)

CreateWhatIfForecastExport API operation for Amazon Forecast Service.

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

≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

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

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

For more information, see howitworks-forecast.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation CreateWhatIfForecastExport for usage and error information.

Returned Error Types:

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

  • ResourceAlreadyExistsException There is already a resource with this name. Try again with a different name.

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

  • ResourceInUseException The specified resource is in use.

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

func (*ForecastService) CreateWhatIfForecastExportRequest added in v1.42.9 

func (c *ForecastService) CreateWhatIfForecastExportRequest(input *CreateWhatIfForecastExportInput) (req *request.Request, output *CreateWhatIfForecastExportOutput)

CreateWhatIfForecastExportRequest generates a "aws/request.Request" representing the client's request for the CreateWhatIfForecastExport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWhatIfForecastExport for more information on using the CreateWhatIfForecastExport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWhatIfForecastExportRequest method.
req, resp := client.CreateWhatIfForecastExportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) CreateWhatIfForecastExportWithContext added in v1.42.9 

func (c *ForecastService) CreateWhatIfForecastExportWithContext(ctx aws.Context, input *CreateWhatIfForecastExportInput, opts ...request.Option) (*CreateWhatIfForecastExportOutput, error)

CreateWhatIfForecastExportWithContext is the same as CreateWhatIfForecastExport with the addition of the ability to pass a context and additional request options.

See CreateWhatIfForecastExport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) CreateWhatIfForecastRequest added in v1.42.9 

func (c *ForecastService) CreateWhatIfForecastRequest(input *CreateWhatIfForecastInput) (req *request.Request, output *CreateWhatIfForecastOutput)

CreateWhatIfForecastRequest generates a "aws/request.Request" representing the client's request for the CreateWhatIfForecast operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWhatIfForecast for more information on using the CreateWhatIfForecast API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWhatIfForecastRequest method.
req, resp := client.CreateWhatIfForecastRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) CreateWhatIfForecastWithContext added in v1.42.9 

func (c *ForecastService) CreateWhatIfForecastWithContext(ctx aws.Context, input *CreateWhatIfForecastInput, opts ...request.Option) (*CreateWhatIfForecastOutput, error)

CreateWhatIfForecastWithContext is the same as CreateWhatIfForecast with the addition of the ability to pass a context and additional request options.

See CreateWhatIfForecast for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DeleteDataset 

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

DeleteDataset API operation for Amazon Forecast Service.

Deletes an Amazon Forecast dataset that was created using the CreateDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation.

Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation, omitting the deleted dataset's ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteDataset for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteDatasetGroup for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteDatasetImportJob for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*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) DeleteExplainability added in v1.42.9 

func (c *ForecastService) DeleteExplainability(input *DeleteExplainabilityInput) (*DeleteExplainabilityOutput, error)

DeleteExplainability API operation for Amazon Forecast Service.

Deletes an Explainability resource.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteExplainability for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeleteExplainabilityExport added in v1.42.9 

func (c *ForecastService) DeleteExplainabilityExport(input *DeleteExplainabilityExportInput) (*DeleteExplainabilityExportOutput, error)

DeleteExplainabilityExport API operation for Amazon Forecast Service.

Deletes an Explainability export.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteExplainabilityExport for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeleteExplainabilityExportRequest added in v1.42.9 

func (c *ForecastService) DeleteExplainabilityExportRequest(input *DeleteExplainabilityExportInput) (req *request.Request, output *DeleteExplainabilityExportOutput)

DeleteExplainabilityExportRequest generates a "aws/request.Request" representing the client's request for the DeleteExplainabilityExport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteExplainabilityExport for more information on using the DeleteExplainabilityExport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteExplainabilityExportRequest method.
req, resp := client.DeleteExplainabilityExportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DeleteExplainabilityExportWithContext added in v1.42.9 

func (c *ForecastService) DeleteExplainabilityExportWithContext(ctx aws.Context, input *DeleteExplainabilityExportInput, opts ...request.Option) (*DeleteExplainabilityExportOutput, error)

DeleteExplainabilityExportWithContext is the same as DeleteExplainabilityExport with the addition of the ability to pass a context and additional request options.

See DeleteExplainabilityExport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DeleteExplainabilityRequest added in v1.42.9 

func (c *ForecastService) DeleteExplainabilityRequest(input *DeleteExplainabilityInput) (req *request.Request, output *DeleteExplainabilityOutput)

DeleteExplainabilityRequest generates a "aws/request.Request" representing the client's request for the DeleteExplainability operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteExplainability for more information on using the DeleteExplainability API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteExplainabilityRequest method.
req, resp := client.DeleteExplainabilityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DeleteExplainabilityWithContext added in v1.42.9 

func (c *ForecastService) DeleteExplainabilityWithContext(ctx aws.Context, input *DeleteExplainabilityInput, opts ...request.Option) (*DeleteExplainabilityOutput, error)

DeleteExplainabilityWithContext is the same as DeleteExplainability with the addition of the ability to pass a context and additional request options.

See DeleteExplainability for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteForecast for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeleteForecastExportJob 

func (c *ForecastService) DeleteForecastExportJob(input *DeleteForecastExportJobInput) (*DeleteForecastExportJobOutput, error)

DeleteForecastExportJob API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteForecastExportJob for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*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) DeleteMonitor added in v1.42.9 

func (c *ForecastService) DeleteMonitor(input *DeleteMonitorInput) (*DeleteMonitorOutput, error)

DeleteMonitor API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteMonitor for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeleteMonitorRequest added in v1.42.9 

func (c *ForecastService) DeleteMonitorRequest(input *DeleteMonitorInput) (req *request.Request, output *DeleteMonitorOutput)

DeleteMonitorRequest generates a "aws/request.Request" representing the client's request for the DeleteMonitor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMonitor for more information on using the DeleteMonitor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteMonitorRequest method.
req, resp := client.DeleteMonitorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DeleteMonitorWithContext added in v1.42.9 

func (c *ForecastService) DeleteMonitorWithContext(ctx aws.Context, input *DeleteMonitorInput, opts ...request.Option) (*DeleteMonitorOutput, error)

DeleteMonitorWithContext is the same as DeleteMonitor with the addition of the ability to pass a context and additional request options.

See DeleteMonitor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DeletePredictor 

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

DeletePredictor API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeletePredictor for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeletePredictorBacktestExportJob 

func (c *ForecastService) DeletePredictorBacktestExportJob(input *DeletePredictorBacktestExportJobInput) (*DeletePredictorBacktestExportJobOutput, error)

DeletePredictorBacktestExportJob API operation for Amazon Forecast Service.

Deletes a predictor backtest export job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeletePredictorBacktestExportJob for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeletePredictorBacktestExportJobRequest 

func (c *ForecastService) DeletePredictorBacktestExportJobRequest(input *DeletePredictorBacktestExportJobInput) (req *request.Request, output *DeletePredictorBacktestExportJobOutput)

DeletePredictorBacktestExportJobRequest generates a "aws/request.Request" representing the client's request for the DeletePredictorBacktestExportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePredictorBacktestExportJob for more information on using the DeletePredictorBacktestExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeletePredictorBacktestExportJobRequest method.
req, resp := client.DeletePredictorBacktestExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DeletePredictorBacktestExportJobWithContext 

func (c *ForecastService) DeletePredictorBacktestExportJobWithContext(ctx aws.Context, input *DeletePredictorBacktestExportJobInput, opts ...request.Option) (*DeletePredictorBacktestExportJobOutput, error)

DeletePredictorBacktestExportJobWithContext is the same as DeletePredictorBacktestExportJob with the addition of the ability to pass a context and additional request options.

See DeletePredictorBacktestExportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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) DeleteResourceTree 

func (c *ForecastService) DeleteResourceTree(input *DeleteResourceTreeInput) (*DeleteResourceTreeOutput, error)

DeleteResourceTree API operation for Amazon Forecast Service.

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

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

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

  • Dataset: dataset import jobs

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

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

  • Forecast: forecast export jobs

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteResourceTree for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeleteResourceTreeRequest 

func (c *ForecastService) DeleteResourceTreeRequest(input *DeleteResourceTreeInput) (req *request.Request, output *DeleteResourceTreeOutput)

DeleteResourceTreeRequest generates a "aws/request.Request" representing the client's request for the DeleteResourceTree operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteResourceTree for more information on using the DeleteResourceTree API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteResourceTreeRequest method.
req, resp := client.DeleteResourceTreeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DeleteResourceTreeWithContext 

func (c *ForecastService) DeleteResourceTreeWithContext(ctx aws.Context, input *DeleteResourceTreeInput, opts ...request.Option) (*DeleteResourceTreeOutput, error)

DeleteResourceTreeWithContext is the same as DeleteResourceTree with the addition of the ability to pass a context and additional request options.

See DeleteResourceTree for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DeleteWhatIfAnalysis added in v1.42.9 

func (c *ForecastService) DeleteWhatIfAnalysis(input *DeleteWhatIfAnalysisInput) (*DeleteWhatIfAnalysisOutput, error)

DeleteWhatIfAnalysis API operation for Amazon Forecast Service.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteWhatIfAnalysis for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeleteWhatIfAnalysisRequest added in v1.42.9 

func (c *ForecastService) DeleteWhatIfAnalysisRequest(input *DeleteWhatIfAnalysisInput) (req *request.Request, output *DeleteWhatIfAnalysisOutput)

DeleteWhatIfAnalysisRequest generates a "aws/request.Request" representing the client's request for the DeleteWhatIfAnalysis operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWhatIfAnalysis for more information on using the DeleteWhatIfAnalysis API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWhatIfAnalysisRequest method.
req, resp := client.DeleteWhatIfAnalysisRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DeleteWhatIfAnalysisWithContext added in v1.42.9 

func (c *ForecastService) DeleteWhatIfAnalysisWithContext(ctx aws.Context, input *DeleteWhatIfAnalysisInput, opts ...request.Option) (*DeleteWhatIfAnalysisOutput, error)

DeleteWhatIfAnalysisWithContext is the same as DeleteWhatIfAnalysis with the addition of the ability to pass a context and additional request options.

See DeleteWhatIfAnalysis for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DeleteWhatIfForecast added in v1.42.9 

func (c *ForecastService) DeleteWhatIfForecast(input *DeleteWhatIfForecastInput) (*DeleteWhatIfForecastOutput, error)

DeleteWhatIfForecast API operation for Amazon Forecast Service.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteWhatIfForecast for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeleteWhatIfForecastExport added in v1.42.9 

func (c *ForecastService) DeleteWhatIfForecastExport(input *DeleteWhatIfForecastExportInput) (*DeleteWhatIfForecastExportOutput, error)

DeleteWhatIfForecastExport API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DeleteWhatIfForecastExport for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) DeleteWhatIfForecastExportRequest added in v1.42.9 

func (c *ForecastService) DeleteWhatIfForecastExportRequest(input *DeleteWhatIfForecastExportInput) (req *request.Request, output *DeleteWhatIfForecastExportOutput)

DeleteWhatIfForecastExportRequest generates a "aws/request.Request" representing the client's request for the DeleteWhatIfForecastExport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWhatIfForecastExport for more information on using the DeleteWhatIfForecastExport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWhatIfForecastExportRequest method.
req, resp := client.DeleteWhatIfForecastExportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DeleteWhatIfForecastExportWithContext added in v1.42.9 

func (c *ForecastService) DeleteWhatIfForecastExportWithContext(ctx aws.Context, input *DeleteWhatIfForecastExportInput, opts ...request.Option) (*DeleteWhatIfForecastExportOutput, error)

DeleteWhatIfForecastExportWithContext is the same as DeleteWhatIfForecastExport with the addition of the ability to pass a context and additional request options.

See DeleteWhatIfForecastExport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DeleteWhatIfForecastRequest added in v1.42.9 

func (c *ForecastService) DeleteWhatIfForecastRequest(input *DeleteWhatIfForecastInput) (req *request.Request, output *DeleteWhatIfForecastOutput)

DeleteWhatIfForecastRequest generates a "aws/request.Request" representing the client's request for the DeleteWhatIfForecast operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWhatIfForecast for more information on using the DeleteWhatIfForecast API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWhatIfForecastRequest method.
req, resp := client.DeleteWhatIfForecastRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DeleteWhatIfForecastWithContext added in v1.42.9 

func (c *ForecastService) DeleteWhatIfForecastWithContext(ctx aws.Context, input *DeleteWhatIfForecastInput, opts ...request.Option) (*DeleteWhatIfForecastOutput, error)

DeleteWhatIfForecastWithContext is the same as DeleteWhatIfForecast with the addition of the ability to pass a context and additional request options.

See DeleteWhatIfForecast for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DescribeAutoPredictor added in v1.42.9 

func (c *ForecastService) DescribeAutoPredictor(input *DescribeAutoPredictorInput) (*DescribeAutoPredictorOutput, error)

DescribeAutoPredictor API operation for Amazon Forecast Service.

Describes a predictor created using the CreateAutoPredictor operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeAutoPredictor for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribeAutoPredictorRequest added in v1.42.9 

func (c *ForecastService) DescribeAutoPredictorRequest(input *DescribeAutoPredictorInput) (req *request.Request, output *DescribeAutoPredictorOutput)

DescribeAutoPredictorRequest generates a "aws/request.Request" representing the client's request for the DescribeAutoPredictor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAutoPredictor for more information on using the DescribeAutoPredictor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAutoPredictorRequest method.
req, resp := client.DescribeAutoPredictorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DescribeAutoPredictorWithContext added in v1.42.9 

func (c *ForecastService) DescribeAutoPredictorWithContext(ctx aws.Context, input *DescribeAutoPredictorInput, opts ...request.Option) (*DescribeAutoPredictorOutput, error)

DescribeAutoPredictorWithContext is the same as DescribeAutoPredictor with the addition of the ability to pass a context and additional request options.

See DescribeAutoPredictor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation.

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

  • CreationTime

  • LastModificationTime

  • Status

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeDataset for usage and error information.

Returned Error Types:

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

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

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

func (*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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) operation.

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

  • DatasetArns - The datasets belonging to the group.

  • CreationTime

  • LastModificationTime

  • Status

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeDatasetGroup for usage and error information.

Returned Error Types:

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

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

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

func (*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 

func (c *ForecastService) DescribeDatasetImportJob(input *DescribeDatasetImportJobInput) (*DescribeDatasetImportJobOutput, error)

DescribeDatasetImportJob API operation for Amazon Forecast Service.

Describes a dataset import job created using the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation.

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

  • CreationTime

  • LastModificationTime

  • DataSize

  • FieldStatistics

  • Status

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeDatasetImportJob for usage and error information.

Returned Error Types:

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

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

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

func (*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) DescribeExplainability added in v1.42.9 

func (c *ForecastService) DescribeExplainability(input *DescribeExplainabilityInput) (*DescribeExplainabilityOutput, error)

DescribeExplainability API operation for Amazon Forecast Service.

Describes an Explainability resource created using the CreateExplainability operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeExplainability for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribeExplainabilityExport added in v1.42.9 

func (c *ForecastService) DescribeExplainabilityExport(input *DescribeExplainabilityExportInput) (*DescribeExplainabilityExportOutput, error)

DescribeExplainabilityExport API operation for Amazon Forecast Service.

Describes an Explainability export created using the CreateExplainabilityExport operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeExplainabilityExport for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribeExplainabilityExportRequest added in v1.42.9 

func (c *ForecastService) DescribeExplainabilityExportRequest(input *DescribeExplainabilityExportInput) (req *request.Request, output *DescribeExplainabilityExportOutput)

DescribeExplainabilityExportRequest generates a "aws/request.Request" representing the client's request for the DescribeExplainabilityExport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeExplainabilityExport for more information on using the DescribeExplainabilityExport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeExplainabilityExportRequest method.
req, resp := client.DescribeExplainabilityExportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DescribeExplainabilityExportWithContext added in v1.42.9 

func (c *ForecastService) DescribeExplainabilityExportWithContext(ctx aws.Context, input *DescribeExplainabilityExportInput, opts ...request.Option) (*DescribeExplainabilityExportOutput, error)

DescribeExplainabilityExportWithContext is the same as DescribeExplainabilityExport with the addition of the ability to pass a context and additional request options.

See DescribeExplainabilityExport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DescribeExplainabilityRequest added in v1.42.9 

func (c *ForecastService) DescribeExplainabilityRequest(input *DescribeExplainabilityInput) (req *request.Request, output *DescribeExplainabilityOutput)

DescribeExplainabilityRequest generates a "aws/request.Request" representing the client's request for the DescribeExplainability operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeExplainability for more information on using the DescribeExplainability API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeExplainabilityRequest method.
req, resp := client.DescribeExplainabilityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DescribeExplainabilityWithContext added in v1.42.9 

func (c *ForecastService) DescribeExplainabilityWithContext(ctx aws.Context, input *DescribeExplainabilityInput, opts ...request.Option) (*DescribeExplainabilityOutput, error)

DescribeExplainabilityWithContext is the same as DescribeExplainability with the addition of the ability to pass a context and additional request options.

See DescribeExplainability for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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 in the CreateForecast request, this operation lists the following properties:

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

  • CreationTime

  • LastModificationTime

  • Status

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeForecast for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribeForecastExportJob 

func (c *ForecastService) DescribeForecastExportJob(input *DescribeForecastExportJobInput) (*DescribeForecastExportJobOutput, error)

DescribeForecastExportJob API operation for Amazon Forecast Service.

Describes a forecast export job created using the CreateForecastExportJob operation.

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

  • CreationTime

  • LastModificationTime

  • Status

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeForecastExportJob for usage and error information.

Returned Error Types:

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

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

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

func (*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) DescribeMonitor added in v1.42.9 

func (c *ForecastService) DescribeMonitor(input *DescribeMonitorInput) (*DescribeMonitorOutput, error)

DescribeMonitor API operation for Amazon Forecast Service.

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

  • Baseline

  • CreationTime

  • LastEvaluationTime

  • LastEvaluationState

  • LastModificationTime

  • Message

  • Status

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeMonitor for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribeMonitorRequest added in v1.42.9 

func (c *ForecastService) DescribeMonitorRequest(input *DescribeMonitorInput) (req *request.Request, output *DescribeMonitorOutput)

DescribeMonitorRequest generates a "aws/request.Request" representing the client's request for the DescribeMonitor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMonitor for more information on using the DescribeMonitor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeMonitorRequest method.
req, resp := client.DescribeMonitorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DescribeMonitorWithContext added in v1.42.9 

func (c *ForecastService) DescribeMonitorWithContext(ctx aws.Context, input *DescribeMonitorInput, opts ...request.Option) (*DescribeMonitorOutput, error)

DescribeMonitorWithContext is the same as DescribeMonitor with the addition of the ability to pass a context and additional request options.

See DescribeMonitor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DescribePredictor 

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

DescribePredictor API operation for Amazon Forecast Service.

This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor.

Describes a predictor created using the CreatePredictor operation.

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

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

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

  • CreationTime

  • LastModificationTime

  • Status

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribePredictor for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribePredictorBacktestExportJob 

func (c *ForecastService) DescribePredictorBacktestExportJob(input *DescribePredictorBacktestExportJobInput) (*DescribePredictorBacktestExportJobOutput, error)

DescribePredictorBacktestExportJob API operation for Amazon Forecast Service.

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

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

  • CreationTime

  • LastModificationTime

  • Status

  • Message (if an error occurred)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribePredictorBacktestExportJob for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribePredictorBacktestExportJobRequest 

func (c *ForecastService) DescribePredictorBacktestExportJobRequest(input *DescribePredictorBacktestExportJobInput) (req *request.Request, output *DescribePredictorBacktestExportJobOutput)

DescribePredictorBacktestExportJobRequest generates a "aws/request.Request" representing the client's request for the DescribePredictorBacktestExportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePredictorBacktestExportJob for more information on using the DescribePredictorBacktestExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribePredictorBacktestExportJobRequest method.
req, resp := client.DescribePredictorBacktestExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DescribePredictorBacktestExportJobWithContext 

func (c *ForecastService) DescribePredictorBacktestExportJobWithContext(ctx aws.Context, input *DescribePredictorBacktestExportJobInput, opts ...request.Option) (*DescribePredictorBacktestExportJobOutput, error)

DescribePredictorBacktestExportJobWithContext is the same as DescribePredictorBacktestExportJob with the addition of the ability to pass a context and additional request options.

See DescribePredictorBacktestExportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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) DescribeWhatIfAnalysis added in v1.42.9 

func (c *ForecastService) DescribeWhatIfAnalysis(input *DescribeWhatIfAnalysisInput) (*DescribeWhatIfAnalysisOutput, error)

DescribeWhatIfAnalysis API operation for Amazon Forecast Service.

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

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

  • CreationTime

  • LastModificationTime

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

  • Status

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeWhatIfAnalysis for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribeWhatIfAnalysisRequest added in v1.42.9 

func (c *ForecastService) DescribeWhatIfAnalysisRequest(input *DescribeWhatIfAnalysisInput) (req *request.Request, output *DescribeWhatIfAnalysisOutput)

DescribeWhatIfAnalysisRequest generates a "aws/request.Request" representing the client's request for the DescribeWhatIfAnalysis operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWhatIfAnalysis for more information on using the DescribeWhatIfAnalysis API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWhatIfAnalysisRequest method.
req, resp := client.DescribeWhatIfAnalysisRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DescribeWhatIfAnalysisWithContext added in v1.42.9 

func (c *ForecastService) DescribeWhatIfAnalysisWithContext(ctx aws.Context, input *DescribeWhatIfAnalysisInput, opts ...request.Option) (*DescribeWhatIfAnalysisOutput, error)

DescribeWhatIfAnalysisWithContext is the same as DescribeWhatIfAnalysis with the addition of the ability to pass a context and additional request options.

See DescribeWhatIfAnalysis for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DescribeWhatIfForecast added in v1.42.9 

func (c *ForecastService) DescribeWhatIfForecast(input *DescribeWhatIfForecastInput) (*DescribeWhatIfForecastOutput, error)

DescribeWhatIfForecast API operation for Amazon Forecast Service.

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

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

  • CreationTime

  • LastModificationTime

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

  • Status

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeWhatIfForecast for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribeWhatIfForecastExport added in v1.42.9 

func (c *ForecastService) DescribeWhatIfForecastExport(input *DescribeWhatIfForecastExportInput) (*DescribeWhatIfForecastExportOutput, error)

DescribeWhatIfForecastExport API operation for Amazon Forecast Service.

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

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

  • CreationTime

  • LastModificationTime

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

  • Status

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation DescribeWhatIfForecastExport for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) DescribeWhatIfForecastExportRequest added in v1.42.9 

func (c *ForecastService) DescribeWhatIfForecastExportRequest(input *DescribeWhatIfForecastExportInput) (req *request.Request, output *DescribeWhatIfForecastExportOutput)

DescribeWhatIfForecastExportRequest generates a "aws/request.Request" representing the client's request for the DescribeWhatIfForecastExport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWhatIfForecastExport for more information on using the DescribeWhatIfForecastExport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWhatIfForecastExportRequest method.
req, resp := client.DescribeWhatIfForecastExportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DescribeWhatIfForecastExportWithContext added in v1.42.9 

func (c *ForecastService) DescribeWhatIfForecastExportWithContext(ctx aws.Context, input *DescribeWhatIfForecastExportInput, opts ...request.Option) (*DescribeWhatIfForecastExportOutput, error)

DescribeWhatIfForecastExportWithContext is the same as DescribeWhatIfForecastExport with the addition of the ability to pass a context and additional request options.

See DescribeWhatIfForecastExport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) DescribeWhatIfForecastRequest added in v1.42.9 

func (c *ForecastService) DescribeWhatIfForecastRequest(input *DescribeWhatIfForecastInput) (req *request.Request, output *DescribeWhatIfForecastOutput)

DescribeWhatIfForecastRequest generates a "aws/request.Request" representing the client's request for the DescribeWhatIfForecast operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWhatIfForecast for more information on using the DescribeWhatIfForecast API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWhatIfForecastRequest method.
req, resp := client.DescribeWhatIfForecastRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) DescribeWhatIfForecastWithContext added in v1.42.9 

func (c *ForecastService) DescribeWhatIfForecastWithContext(ctx aws.Context, input *DescribeWhatIfForecastInput, opts ...request.Option) (*DescribeWhatIfForecastOutput, error)

DescribeWhatIfForecastWithContext is the same as DescribeWhatIfForecast with the addition of the ability to pass a context and additional request options.

See DescribeWhatIfForecast for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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. For more information, see Predictor Metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html).

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation GetAccuracyMetrics for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListDatasetGroups for usage and error information.

Returned Error Types:

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

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

func (*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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) operation. You can filter the list by providing an array of Filter (https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html) objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListDatasetImportJobs for usage and error information.

Returned Error Types:

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

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

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

func (*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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListDatasets for usage and error information.

Returned Error Types:

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

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

func (*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) ListExplainabilities added in v1.42.9 

func (c *ForecastService) ListExplainabilities(input *ListExplainabilitiesInput) (*ListExplainabilitiesOutput, error)

ListExplainabilities API operation for Amazon Forecast Service.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListExplainabilities for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) ListExplainabilitiesPages added in v1.42.9 

func (c *ForecastService) ListExplainabilitiesPages(input *ListExplainabilitiesInput, fn func(*ListExplainabilitiesOutput, bool) bool) error

ListExplainabilitiesPages iterates over the pages of a ListExplainabilities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListExplainabilities method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListExplainabilities operation.
pageNum := 0
err := client.ListExplainabilitiesPages(params,
    func(page *forecastservice.ListExplainabilitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ForecastService) ListExplainabilitiesPagesWithContext added in v1.42.9 

func (c *ForecastService) ListExplainabilitiesPagesWithContext(ctx aws.Context, input *ListExplainabilitiesInput, fn func(*ListExplainabilitiesOutput, bool) bool, opts ...request.Option) error

ListExplainabilitiesPagesWithContext same as ListExplainabilitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListExplainabilitiesRequest added in v1.42.9 

func (c *ForecastService) ListExplainabilitiesRequest(input *ListExplainabilitiesInput) (req *request.Request, output *ListExplainabilitiesOutput)

ListExplainabilitiesRequest generates a "aws/request.Request" representing the client's request for the ListExplainabilities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListExplainabilities for more information on using the ListExplainabilities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListExplainabilitiesRequest method.
req, resp := client.ListExplainabilitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ListExplainabilitiesWithContext added in v1.42.9 

func (c *ForecastService) ListExplainabilitiesWithContext(ctx aws.Context, input *ListExplainabilitiesInput, opts ...request.Option) (*ListExplainabilitiesOutput, error)

ListExplainabilitiesWithContext is the same as ListExplainabilities with the addition of the ability to pass a context and additional request options.

See ListExplainabilities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListExplainabilityExports added in v1.42.9 

func (c *ForecastService) ListExplainabilityExports(input *ListExplainabilityExportsInput) (*ListExplainabilityExportsOutput, error)

ListExplainabilityExports API operation for Amazon Forecast Service.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListExplainabilityExports for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) ListExplainabilityExportsPages added in v1.42.9 

func (c *ForecastService) ListExplainabilityExportsPages(input *ListExplainabilityExportsInput, fn func(*ListExplainabilityExportsOutput, bool) bool) error

ListExplainabilityExportsPages iterates over the pages of a ListExplainabilityExports operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListExplainabilityExports method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListExplainabilityExports operation.
pageNum := 0
err := client.ListExplainabilityExportsPages(params,
    func(page *forecastservice.ListExplainabilityExportsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ForecastService) ListExplainabilityExportsPagesWithContext added in v1.42.9 

func (c *ForecastService) ListExplainabilityExportsPagesWithContext(ctx aws.Context, input *ListExplainabilityExportsInput, fn func(*ListExplainabilityExportsOutput, bool) bool, opts ...request.Option) error

ListExplainabilityExportsPagesWithContext same as ListExplainabilityExportsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListExplainabilityExportsRequest added in v1.42.9 

func (c *ForecastService) ListExplainabilityExportsRequest(input *ListExplainabilityExportsInput) (req *request.Request, output *ListExplainabilityExportsOutput)

ListExplainabilityExportsRequest generates a "aws/request.Request" representing the client's request for the ListExplainabilityExports operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListExplainabilityExports for more information on using the ListExplainabilityExports API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListExplainabilityExportsRequest method.
req, resp := client.ListExplainabilityExportsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ListExplainabilityExportsWithContext added in v1.42.9 

func (c *ForecastService) ListExplainabilityExportsWithContext(ctx aws.Context, input *ListExplainabilityExportsInput, opts ...request.Option) (*ListExplainabilityExportsOutput, error)

ListExplainabilityExportsWithContext is the same as ListExplainabilityExports with the addition of the ability to pass a context and additional request options.

See ListExplainabilityExports for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListForecastExportJobs for usage and error information.

Returned Error Types:

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

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

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

func (*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, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListForecasts for usage and error information.

Returned Error Types:

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

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

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

func (*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) ListMonitorEvaluations added in v1.42.9 

func (c *ForecastService) ListMonitorEvaluations(input *ListMonitorEvaluationsInput) (*ListMonitorEvaluationsOutput, error)

ListMonitorEvaluations API operation for Amazon Forecast Service.

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

For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListMonitorEvaluations for usage and error information.

Returned Error Types:

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

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

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

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

func (*ForecastService) ListMonitorEvaluationsPages added in v1.42.9 

func (c *ForecastService) ListMonitorEvaluationsPages(input *ListMonitorEvaluationsInput, fn func(*ListMonitorEvaluationsOutput, bool) bool) error

ListMonitorEvaluationsPages iterates over the pages of a ListMonitorEvaluations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMonitorEvaluations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListMonitorEvaluations operation.
pageNum := 0
err := client.ListMonitorEvaluationsPages(params,
    func(page *forecastservice.ListMonitorEvaluationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ForecastService) ListMonitorEvaluationsPagesWithContext added in v1.42.9 

func (c *ForecastService) ListMonitorEvaluationsPagesWithContext(ctx aws.Context, input *ListMonitorEvaluationsInput, fn func(*ListMonitorEvaluationsOutput, bool) bool, opts ...request.Option) error

ListMonitorEvaluationsPagesWithContext same as ListMonitorEvaluationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListMonitorEvaluationsRequest added in v1.42.9 

func (c *ForecastService) ListMonitorEvaluationsRequest(input *ListMonitorEvaluationsInput) (req *request.Request, output *ListMonitorEvaluationsOutput)

ListMonitorEvaluationsRequest generates a "aws/request.Request" representing the client's request for the ListMonitorEvaluations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMonitorEvaluations for more information on using the ListMonitorEvaluations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListMonitorEvaluationsRequest method.
req, resp := client.ListMonitorEvaluationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ListMonitorEvaluationsWithContext added in v1.42.9 

func (c *ForecastService) ListMonitorEvaluationsWithContext(ctx aws.Context, input *ListMonitorEvaluationsInput, opts ...request.Option) (*ListMonitorEvaluationsOutput, error)

ListMonitorEvaluationsWithContext is the same as ListMonitorEvaluations with the addition of the ability to pass a context and additional request options.

See ListMonitorEvaluations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListMonitors added in v1.42.9 

func (c *ForecastService) ListMonitors(input *ListMonitorsInput) (*ListMonitorsOutput, error)

ListMonitors API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListMonitors for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) ListMonitorsPages added in v1.42.9 

func (c *ForecastService) ListMonitorsPages(input *ListMonitorsInput, fn func(*ListMonitorsOutput, bool) bool) error

ListMonitorsPages iterates over the pages of a ListMonitors operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMonitors method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListMonitors operation.
pageNum := 0
err := client.ListMonitorsPages(params,
    func(page *forecastservice.ListMonitorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ForecastService) ListMonitorsPagesWithContext added in v1.42.9 

func (c *ForecastService) ListMonitorsPagesWithContext(ctx aws.Context, input *ListMonitorsInput, fn func(*ListMonitorsOutput, bool) bool, opts ...request.Option) error

ListMonitorsPagesWithContext same as ListMonitorsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListMonitorsRequest added in v1.42.9 

func (c *ForecastService) ListMonitorsRequest(input *ListMonitorsInput) (req *request.Request, output *ListMonitorsOutput)

ListMonitorsRequest generates a "aws/request.Request" representing the client's request for the ListMonitors operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMonitors for more information on using the ListMonitors API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListMonitorsRequest method.
req, resp := client.ListMonitorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ListMonitorsWithContext added in v1.42.9 

func (c *ForecastService) ListMonitorsWithContext(ctx aws.Context, input *ListMonitorsInput, opts ...request.Option) (*ListMonitorsOutput, error)

ListMonitorsWithContext is the same as ListMonitors with the addition of the ability to pass a context and additional request options.

See ListMonitors for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListPredictorBacktestExportJobs 

func (c *ForecastService) ListPredictorBacktestExportJobs(input *ListPredictorBacktestExportJobsInput) (*ListPredictorBacktestExportJobsOutput, error)

ListPredictorBacktestExportJobs API operation for Amazon Forecast Service.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListPredictorBacktestExportJobs for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) ListPredictorBacktestExportJobsPages 

func (c *ForecastService) ListPredictorBacktestExportJobsPages(input *ListPredictorBacktestExportJobsInput, fn func(*ListPredictorBacktestExportJobsOutput, bool) bool) error

ListPredictorBacktestExportJobsPages iterates over the pages of a ListPredictorBacktestExportJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPredictorBacktestExportJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPredictorBacktestExportJobs operation.
pageNum := 0
err := client.ListPredictorBacktestExportJobsPages(params,
    func(page *forecastservice.ListPredictorBacktestExportJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ForecastService) ListPredictorBacktestExportJobsPagesWithContext 

func (c *ForecastService) ListPredictorBacktestExportJobsPagesWithContext(ctx aws.Context, input *ListPredictorBacktestExportJobsInput, fn func(*ListPredictorBacktestExportJobsOutput, bool) bool, opts ...request.Option) error

ListPredictorBacktestExportJobsPagesWithContext same as ListPredictorBacktestExportJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListPredictorBacktestExportJobsRequest 

func (c *ForecastService) ListPredictorBacktestExportJobsRequest(input *ListPredictorBacktestExportJobsInput) (req *request.Request, output *ListPredictorBacktestExportJobsOutput)

ListPredictorBacktestExportJobsRequest generates a "aws/request.Request" representing the client's request for the ListPredictorBacktestExportJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPredictorBacktestExportJobs for more information on using the ListPredictorBacktestExportJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPredictorBacktestExportJobsRequest method.
req, resp := client.ListPredictorBacktestExportJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ListPredictorBacktestExportJobsWithContext 

func (c *ForecastService) ListPredictorBacktestExportJobsWithContext(ctx aws.Context, input *ListPredictorBacktestExportJobsInput, opts ...request.Option) (*ListPredictorBacktestExportJobsOutput, error)

ListPredictorBacktestExportJobsWithContext is the same as ListPredictorBacktestExportJobs with the addition of the ability to pass a context and additional request options.

See ListPredictorBacktestExportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*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 CreateAutoPredictor or CreatePredictor operations. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListPredictors for usage and error information.

Returned Error Types:

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

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

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

func (*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) ListTagsForResource 

func (c *ForecastService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Forecast Service.

Lists the tags for an Amazon Forecast resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListTagsForResource for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) ListTagsForResourceRequest 

func (c *ForecastService) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ListTagsForResourceWithContext 

func (c *ForecastService) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListWhatIfAnalyses added in v1.42.9 

func (c *ForecastService) ListWhatIfAnalyses(input *ListWhatIfAnalysesInput) (*ListWhatIfAnalysesOutput, error)

ListWhatIfAnalyses API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListWhatIfAnalyses for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) ListWhatIfAnalysesPages added in v1.42.9 

func (c *ForecastService) ListWhatIfAnalysesPages(input *ListWhatIfAnalysesInput, fn func(*ListWhatIfAnalysesOutput, bool) bool) error

ListWhatIfAnalysesPages iterates over the pages of a ListWhatIfAnalyses operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWhatIfAnalyses method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListWhatIfAnalyses operation.
pageNum := 0
err := client.ListWhatIfAnalysesPages(params,
    func(page *forecastservice.ListWhatIfAnalysesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ForecastService) ListWhatIfAnalysesPagesWithContext added in v1.42.9 

func (c *ForecastService) ListWhatIfAnalysesPagesWithContext(ctx aws.Context, input *ListWhatIfAnalysesInput, fn func(*ListWhatIfAnalysesOutput, bool) bool, opts ...request.Option) error

ListWhatIfAnalysesPagesWithContext same as ListWhatIfAnalysesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListWhatIfAnalysesRequest added in v1.42.9 

func (c *ForecastService) ListWhatIfAnalysesRequest(input *ListWhatIfAnalysesInput) (req *request.Request, output *ListWhatIfAnalysesOutput)

ListWhatIfAnalysesRequest generates a "aws/request.Request" representing the client's request for the ListWhatIfAnalyses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWhatIfAnalyses for more information on using the ListWhatIfAnalyses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListWhatIfAnalysesRequest method.
req, resp := client.ListWhatIfAnalysesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ListWhatIfAnalysesWithContext added in v1.42.9 

func (c *ForecastService) ListWhatIfAnalysesWithContext(ctx aws.Context, input *ListWhatIfAnalysesInput, opts ...request.Option) (*ListWhatIfAnalysesOutput, error)

ListWhatIfAnalysesWithContext is the same as ListWhatIfAnalyses with the addition of the ability to pass a context and additional request options.

See ListWhatIfAnalyses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListWhatIfForecastExports added in v1.42.9 

func (c *ForecastService) ListWhatIfForecastExports(input *ListWhatIfForecastExportsInput) (*ListWhatIfForecastExportsOutput, error)

ListWhatIfForecastExports API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListWhatIfForecastExports for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) ListWhatIfForecastExportsPages added in v1.42.9 

func (c *ForecastService) ListWhatIfForecastExportsPages(input *ListWhatIfForecastExportsInput, fn func(*ListWhatIfForecastExportsOutput, bool) bool) error

ListWhatIfForecastExportsPages iterates over the pages of a ListWhatIfForecastExports operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWhatIfForecastExports method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListWhatIfForecastExports operation.
pageNum := 0
err := client.ListWhatIfForecastExportsPages(params,
    func(page *forecastservice.ListWhatIfForecastExportsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ForecastService) ListWhatIfForecastExportsPagesWithContext added in v1.42.9 

func (c *ForecastService) ListWhatIfForecastExportsPagesWithContext(ctx aws.Context, input *ListWhatIfForecastExportsInput, fn func(*ListWhatIfForecastExportsOutput, bool) bool, opts ...request.Option) error

ListWhatIfForecastExportsPagesWithContext same as ListWhatIfForecastExportsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListWhatIfForecastExportsRequest added in v1.42.9 

func (c *ForecastService) ListWhatIfForecastExportsRequest(input *ListWhatIfForecastExportsInput) (req *request.Request, output *ListWhatIfForecastExportsOutput)

ListWhatIfForecastExportsRequest generates a "aws/request.Request" representing the client's request for the ListWhatIfForecastExports operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWhatIfForecastExports for more information on using the ListWhatIfForecastExports API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListWhatIfForecastExportsRequest method.
req, resp := client.ListWhatIfForecastExportsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ListWhatIfForecastExportsWithContext added in v1.42.9 

func (c *ForecastService) ListWhatIfForecastExportsWithContext(ctx aws.Context, input *ListWhatIfForecastExportsInput, opts ...request.Option) (*ListWhatIfForecastExportsOutput, error)

ListWhatIfForecastExportsWithContext is the same as ListWhatIfForecastExports with the addition of the ability to pass a context and additional request options.

See ListWhatIfForecastExports for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListWhatIfForecasts added in v1.42.9 

func (c *ForecastService) ListWhatIfForecasts(input *ListWhatIfForecastsInput) (*ListWhatIfForecastsOutput, error)

ListWhatIfForecasts API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ListWhatIfForecasts for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) ListWhatIfForecastsPages added in v1.42.9 

func (c *ForecastService) ListWhatIfForecastsPages(input *ListWhatIfForecastsInput, fn func(*ListWhatIfForecastsOutput, bool) bool) error

ListWhatIfForecastsPages iterates over the pages of a ListWhatIfForecasts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWhatIfForecasts method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListWhatIfForecasts operation.
pageNum := 0
err := client.ListWhatIfForecastsPages(params,
    func(page *forecastservice.ListWhatIfForecastsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ForecastService) ListWhatIfForecastsPagesWithContext added in v1.42.9 

func (c *ForecastService) ListWhatIfForecastsPagesWithContext(ctx aws.Context, input *ListWhatIfForecastsInput, fn func(*ListWhatIfForecastsOutput, bool) bool, opts ...request.Option) error

ListWhatIfForecastsPagesWithContext same as ListWhatIfForecastsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ListWhatIfForecastsRequest added in v1.42.9 

func (c *ForecastService) ListWhatIfForecastsRequest(input *ListWhatIfForecastsInput) (req *request.Request, output *ListWhatIfForecastsOutput)

ListWhatIfForecastsRequest generates a "aws/request.Request" representing the client's request for the ListWhatIfForecasts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWhatIfForecasts for more information on using the ListWhatIfForecasts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListWhatIfForecastsRequest method.
req, resp := client.ListWhatIfForecastsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ListWhatIfForecastsWithContext added in v1.42.9 

func (c *ForecastService) ListWhatIfForecastsWithContext(ctx aws.Context, input *ListWhatIfForecastsInput, opts ...request.Option) (*ListWhatIfForecastsOutput, error)

ListWhatIfForecastsWithContext is the same as ListWhatIfForecasts with the addition of the ability to pass a context and additional request options.

See ListWhatIfForecasts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) ResumeResource added in v1.42.9 

func (c *ForecastService) ResumeResource(input *ResumeResourceInput) (*ResumeResourceOutput, error)

ResumeResource API operation for Amazon Forecast Service.

Resumes a stopped monitor resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation ResumeResource for usage and error information.

Returned Error Types:

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

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

  • ResourceInUseException The specified resource is in use.

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

func (*ForecastService) ResumeResourceRequest added in v1.42.9 

func (c *ForecastService) ResumeResourceRequest(input *ResumeResourceInput) (req *request.Request, output *ResumeResourceOutput)

ResumeResourceRequest generates a "aws/request.Request" representing the client's request for the ResumeResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResumeResource for more information on using the ResumeResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ResumeResourceRequest method.
req, resp := client.ResumeResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) ResumeResourceWithContext added in v1.42.9 

func (c *ForecastService) ResumeResourceWithContext(ctx aws.Context, input *ResumeResourceInput, opts ...request.Option) (*ResumeResourceOutput, error)

ResumeResourceWithContext is the same as ResumeResource with the addition of the ability to pass a context and additional request options.

See ResumeResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) StopResource 

func (c *ForecastService) StopResource(input *StopResourceInput) (*StopResourceOutput, error)

StopResource API operation for Amazon Forecast Service.

Stops a resource.

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

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

  • Dataset Import Job

  • Predictor Job

  • Forecast Job

  • Forecast Export Job

  • Predictor Backtest Export Job

  • Explainability Job

  • Explainability Export Job

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation StopResource for usage and error information.

Returned Error Types:

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

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

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

func (*ForecastService) StopResourceRequest 

func (c *ForecastService) StopResourceRequest(input *StopResourceInput) (req *request.Request, output *StopResourceOutput)

StopResourceRequest generates a "aws/request.Request" representing the client's request for the StopResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopResource for more information on using the StopResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopResourceRequest method.
req, resp := client.StopResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) StopResourceWithContext 

func (c *ForecastService) StopResourceWithContext(ctx aws.Context, input *StopResourceInput, opts ...request.Option) (*StopResourceOutput, error)

StopResourceWithContext is the same as StopResource with the addition of the ability to pass a context and additional request options.

See StopResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) TagResource 

func (c *ForecastService) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Forecast Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation TagResource for usage and error information.

Returned Error Types:

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

  • LimitExceededException The limit on the number of resources per account has been exceeded.

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

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

func (*ForecastService) TagResourceRequest 

func (c *ForecastService) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) TagResourceWithContext 

func (c *ForecastService) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) UntagResource 

func (c *ForecastService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Forecast Service.

Deletes the specified tags from a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation UntagResource for usage and error information.

Returned Error Types:

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

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

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

func (*ForecastService) UntagResourceRequest 

func (c *ForecastService) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*ForecastService) UntagResourceWithContext 

func (c *ForecastService) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ForecastService) UpdateDatasetGroup 

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

UpdateDatasetGroup API operation for Amazon Forecast Service.

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

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation to get the status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Forecast Service's API operation UpdateDatasetGroup for usage and error information.

Returned Error Types:

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

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

  • ResourceInUseException The specified resource is in use.

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

func (*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 {

	// Whether the Forecast was created from an AutoPredictor.
	CreatedUsingAutoPredictor *bool `type:"boolean"`

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

	// The Amazon Resource Name (ARN) of the dataset group that provided the data
	// used to train the predictor.
	DatasetGroupArn *string `type:"string"`

	// The ARN of the forecast.
	ForecastArn *string `type:"string"`

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

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

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

	// The ARN of the predictor used to generate the forecast.
	PredictorArn *string `type:"string"`

	// The status of the forecast. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	//
	// The Status of the forecast must be ACTIVE before you can query or export
	// the forecast.
	Status *string `type:"string"`
	// 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 ForecastArn that is listed in the summary.

func (ForecastSummary) GoString 

func (s ForecastSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForecastSummary) SetCreatedUsingAutoPredictor added in v1.42.9 

func (s *ForecastSummary) SetCreatedUsingAutoPredictor(v bool) *ForecastSummary

SetCreatedUsingAutoPredictor sets the CreatedUsingAutoPredictor field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAccuracyMetricsInput) SetPredictorArn 

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

SetPredictorArn sets the PredictorArn field's value.

func (GetAccuracyMetricsInput) String 

func (s GetAccuracyMetricsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 {

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

	// Whether the predictor was created with CreateAutoPredictor.
	IsAutoPredictor *bool `type:"boolean"`

	// The accuracy metric used to optimize the predictor.
	OptimizationMetric *string `type:"string" enum:"OptimizationMetric"`

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

func (GetAccuracyMetricsOutput) GoString 

func (s GetAccuracyMetricsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAccuracyMetricsOutput) SetAutoMLOverrideStrategy 

func (s *GetAccuracyMetricsOutput) SetAutoMLOverrideStrategy(v string) *GetAccuracyMetricsOutput

SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value.

func (*GetAccuracyMetricsOutput) SetIsAutoPredictor added in v1.42.9 

func (s *GetAccuracyMetricsOutput) SetIsAutoPredictor(v bool) *GetAccuracyMetricsOutput

SetIsAutoPredictor sets the IsAutoPredictor field's value.

func (*GetAccuracyMetricsOutput) SetOptimizationMetric 

func (s *GetAccuracyMetricsOutput) SetOptimizationMetric(v string) *GetAccuracyMetricsOutput

SetOptimizationMetric sets the OptimizationMetric field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. You specify this object in the CreatePredictor request.

A hyperparameter is a parameter that governs the model training process. You set hyperparameters before training starts, unlike model parameters, which are determined during training. The values of the hyperparameters effect which values are chosen for the model parameters.

In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter values that optimize a specified metric. Forecast accomplishes this by running many training jobs over a range of hyperparameter values. The optimum set of values depends on the algorithm, the training data, and the specified metric objective.

func (HyperParameterTuningJobConfig) GoString 

func (s HyperParameterTuningJobConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HyperParameterTuningJobConfig) SetParameterRanges 

func (s *HyperParameterTuningJobConfig) SetParameterRanges(v *ParameterRanges) *HyperParameterTuningJobConfig

SetParameterRanges sets the ParameterRanges field's value.

func (HyperParameterTuningJobConfig) String 

func (s HyperParameterTuningJobConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see DataConfig.

The data used to train a predictor. The data includes a dataset group and any supplementary features. You specify this object in the CreatePredictor request.

func (InputDataConfig) GoString 

func (s InputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	// Valid values:
	//
	// Auto
	//
	// Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
	//
	// Linear
	//
	// Hyperparameter tuning searches the values in the hyperparameter range by
	// using a linear scale.
	//
	// Logarithmic
	//
	// Hyperparameter tuning searches the values in the hyperparameter range by
	// using a logarithmic scale.
	//
	// Logarithmic scaling works only for ranges that have values greater than 0.
	//
	// ReverseLogarithmic
	//
	// Not supported for IntegerParameterRange.
	//
	// Reverse logarithmic scaling works only for ranges that are entirely within
	// the range 0 <= x < 1.0.
	//
	// For information about choosing a hyperparameter scale, see Hyperparameter
	// Scaling (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type).
	// One of the following values:
	ScalingType *string `type:"string" enum:"ScalingType"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IntegerParameterRange) SetMaxValue 

func (s *IntegerParameterRange) SetMaxValue(v int64) *IntegerParameterRange

SetMaxValue sets the MaxValue field's value.

func (*IntegerParameterRange) SetMinValue 

func (s *IntegerParameterRange) SetMinValue(v int64) *IntegerParameterRange

SetMinValue sets the MinValue field's value.

func (*IntegerParameterRange) SetName 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IntegerParameterRange) Validate 

func (s *IntegerParameterRange) Validate() error

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

type InvalidInputException 

type InvalidInputException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidInputException) Code 

func (s *InvalidInputException) Code() string

Code returns the exception type name.

func (*InvalidInputException) Error 

func (s *InvalidInputException) Error() string

func (InvalidInputException) GoString 

func (s InvalidInputException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidInputException) Message 

func (s *InvalidInputException) Message() string

Message returns the exception's message.

func (*InvalidInputException) OrigErr 

func (s *InvalidInputException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInputException) RequestID 

func (s *InvalidInputException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInputException) StatusCode 

func (s *InvalidInputException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidInputException) String 

func (s InvalidInputException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidNextTokenException 

type InvalidNextTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The token is not valid. Tokens expire after 24 hours.

func (*InvalidNextTokenException) Code 

func (s *InvalidNextTokenException) Code() string

Code returns the exception type name.

func (*InvalidNextTokenException) Error 

func (s *InvalidNextTokenException) Error() string

func (InvalidNextTokenException) GoString 

func (s InvalidNextTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidNextTokenException) Message 

func (s *InvalidNextTokenException) Message() string

Message returns the exception's message.

func (*InvalidNextTokenException) OrigErr 

func (s *InvalidNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNextTokenException) RequestID 

func (s *InvalidNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNextTokenException) StatusCode 

func (s *InvalidNextTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidNextTokenException) String 

func (s InvalidNextTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The limit on the number of resources per account has been exceeded.

func (*LimitExceededException) Code 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetGroupsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetGroupsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDatasetGroupsInput) String 

func (s ListDatasetGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetGroupsOutput) SetDatasetGroups 

func (s *ListDatasetGroupsOutput) SetDatasetGroups(v []*DatasetGroupSummary) *ListDatasetGroupsOutput

SetDatasetGroups sets the DatasetGroups field's value.

func (*ListDatasetGroupsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDatasetGroupsOutput) String 

func (s ListDatasetGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDatasetImportJobsInput 

type ListDatasetImportJobsInput struct {

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetImportJobsInput) SetFilters 

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

SetFilters sets the Filters field's value.

func (*ListDatasetImportJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetImportJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDatasetImportJobsInput) String 

func (s ListDatasetImportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetImportJobsOutput) SetDatasetImportJobs 

func (s *ListDatasetImportJobsOutput) SetDatasetImportJobs(v []*DatasetImportJobSummary) *ListDatasetImportJobsOutput

SetDatasetImportJobs sets the DatasetImportJobs field's value.

func (*ListDatasetImportJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDatasetImportJobsOutput) String 

func (s ListDatasetImportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDatasetsOutput) SetDatasets 

func (s *ListDatasetsOutput) SetDatasets(v []*DatasetSummary) *ListDatasetsOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListExplainabilitiesInput added in v1.42.9 

type ListExplainabilitiesInput struct {

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

	// The number of items returned in the response.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListExplainabilitiesInput) GoString added in v1.42.9 

func (s ListExplainabilitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExplainabilitiesInput) SetFilters added in v1.42.9 

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

SetFilters sets the Filters field's value.

func (*ListExplainabilitiesInput) SetMaxResults added in v1.42.9 

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

SetMaxResults sets the MaxResults field's value.

func (*ListExplainabilitiesInput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListExplainabilitiesInput) String added in v1.42.9 

func (s ListExplainabilitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExplainabilitiesInput) Validate added in v1.42.9 

func (s *ListExplainabilitiesInput) Validate() error

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

type ListExplainabilitiesOutput added in v1.42.9 

type ListExplainabilitiesOutput struct {

	// An array of objects that summarize the properties of each Explainability
	// resource.
	Explainabilities []*ExplainabilitySummary `type:"list"`

	// Returns this token if the response is truncated. To retrieve the next set
	// of results, use the token in the next request.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListExplainabilitiesOutput) GoString added in v1.42.9 

func (s ListExplainabilitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExplainabilitiesOutput) SetExplainabilities added in v1.42.9 

func (s *ListExplainabilitiesOutput) SetExplainabilities(v []*ExplainabilitySummary) *ListExplainabilitiesOutput

SetExplainabilities sets the Explainabilities field's value.

func (*ListExplainabilitiesOutput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListExplainabilitiesOutput) String added in v1.42.9 

func (s ListExplainabilitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListExplainabilityExportsInput added in v1.42.9 

type ListExplainabilityExportsInput struct {

	// An array of filters. For each filter, provide a condition and a match statement.
	// The condition is either IS or IS_NOT, which specifies whether to include
	// or exclude resources that match the statement from the list. The match statement
	// consists of a key and a value.
	//
	// Filter properties
	//
	//    * Condition - The condition to apply. Valid values are IS and IS_NOT.
	//
	//    * Key - The name of the parameter to filter on. Valid values are ResourceArn
	//    and Status.
	//
	//    * Value - The value to match.
	Filters []*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 (ListExplainabilityExportsInput) GoString added in v1.42.9 

func (s ListExplainabilityExportsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExplainabilityExportsInput) SetFilters added in v1.42.9 

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

SetFilters sets the Filters field's value.

func (*ListExplainabilityExportsInput) SetMaxResults added in v1.42.9 

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

SetMaxResults sets the MaxResults field's value.

func (*ListExplainabilityExportsInput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListExplainabilityExportsInput) String added in v1.42.9 

func (s ListExplainabilityExportsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExplainabilityExportsInput) Validate added in v1.42.9 

func (s *ListExplainabilityExportsInput) Validate() error

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

type ListExplainabilityExportsOutput added in v1.42.9 

type ListExplainabilityExportsOutput struct {

	// An array of objects that summarize the properties of each Explainability
	// export.
	ExplainabilityExports []*ExplainabilityExportSummary `type:"list"`

	// Returns this token if the response is truncated. To retrieve the next set
	// of results, use the token in the next request.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListExplainabilityExportsOutput) GoString added in v1.42.9 

func (s ListExplainabilityExportsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExplainabilityExportsOutput) SetExplainabilityExports added in v1.42.9 

func (s *ListExplainabilityExportsOutput) SetExplainabilityExports(v []*ExplainabilityExportSummary) *ListExplainabilityExportsOutput

SetExplainabilityExports sets the ExplainabilityExports field's value.

func (*ListExplainabilityExportsOutput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListExplainabilityExportsOutput) String added in v1.42.9 

func (s ListExplainabilityExportsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListForecastExportJobsInput 

type ListForecastExportJobsInput struct {

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

	// The number of items to return in the response.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListForecastExportJobsInput) GoString 

func (s ListForecastExportJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListForecastExportJobsInput) SetFilters 

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

SetFilters sets the Filters field's value.

func (*ListForecastExportJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListForecastExportJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListForecastExportJobsInput) String 

func (s ListForecastExportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListForecastExportJobsOutput) SetForecastExportJobs 

func (s *ListForecastExportJobsOutput) SetForecastExportJobs(v []*ForecastExportJobSummary) *ListForecastExportJobsOutput

SetForecastExportJobs sets the ForecastExportJobs field's value.

func (*ListForecastExportJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListForecastExportJobsOutput) String 

func (s ListForecastExportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListForecastsInput 

type ListForecastsInput struct {

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListForecastsOutput) SetForecasts 

func (s *ListForecastsOutput) SetForecasts(v []*ForecastSummary) *ListForecastsOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMonitorEvaluationsInput added in v1.42.9 

type ListMonitorEvaluationsInput struct {

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

	// The maximum number of monitoring results to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// The Amazon Resource Name (ARN) of the monitor resource to get results from.
	//
	// MonitorArn is a required field
	MonitorArn *string `type:"string" required:"true"`

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

func (ListMonitorEvaluationsInput) GoString added in v1.42.9 

func (s ListMonitorEvaluationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMonitorEvaluationsInput) SetFilters added in v1.42.9 

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

SetFilters sets the Filters field's value.

func (*ListMonitorEvaluationsInput) SetMaxResults added in v1.42.9 

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

SetMaxResults sets the MaxResults field's value.

func (*ListMonitorEvaluationsInput) SetMonitorArn added in v1.42.9 

func (s *ListMonitorEvaluationsInput) SetMonitorArn(v string) *ListMonitorEvaluationsInput

SetMonitorArn sets the MonitorArn field's value.

func (*ListMonitorEvaluationsInput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListMonitorEvaluationsInput) String added in v1.42.9 

func (s ListMonitorEvaluationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMonitorEvaluationsInput) Validate added in v1.42.9 

func (s *ListMonitorEvaluationsInput) Validate() error

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

type ListMonitorEvaluationsOutput added in v1.42.9 

type ListMonitorEvaluationsOutput struct {

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

	// The monitoring results and predictor events collected by the monitor resource
	// during different windows of time.
	//
	// For information about monitoring see Viewing Monitoring Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).
	// For more information about retrieving monitoring results see Viewing Monitoring
	// Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html).
	PredictorMonitorEvaluations []*PredictorMonitorEvaluation `type:"list"`
	// contains filtered or unexported fields
}

func (ListMonitorEvaluationsOutput) GoString added in v1.42.9 

func (s ListMonitorEvaluationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMonitorEvaluationsOutput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (*ListMonitorEvaluationsOutput) SetPredictorMonitorEvaluations added in v1.42.9 

func (s *ListMonitorEvaluationsOutput) SetPredictorMonitorEvaluations(v []*PredictorMonitorEvaluation) *ListMonitorEvaluationsOutput

SetPredictorMonitorEvaluations sets the PredictorMonitorEvaluations field's value.

func (ListMonitorEvaluationsOutput) String added in v1.42.9 

func (s ListMonitorEvaluationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMonitorsInput added in v1.42.9 

type ListMonitorsInput struct {

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

	// The maximum number of monitors to include in the response.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListMonitorsInput) GoString added in v1.42.9 

func (s ListMonitorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMonitorsInput) SetFilters added in v1.42.9 

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

SetFilters sets the Filters field's value.

func (*ListMonitorsInput) SetMaxResults added in v1.42.9 

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

SetMaxResults sets the MaxResults field's value.

func (*ListMonitorsInput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListMonitorsInput) String added in v1.42.9 

func (s ListMonitorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMonitorsInput) Validate added in v1.42.9 

func (s *ListMonitorsInput) Validate() error

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

type ListMonitorsOutput added in v1.42.9 

type ListMonitorsOutput struct {

	// An array of objects that summarize each monitor's properties.
	Monitors []*MonitorSummary `type:"list"`

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

func (ListMonitorsOutput) GoString added in v1.42.9 

func (s ListMonitorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMonitorsOutput) SetMonitors added in v1.42.9 

func (s *ListMonitorsOutput) SetMonitors(v []*MonitorSummary) *ListMonitorsOutput

SetMonitors sets the Monitors field's value.

func (*ListMonitorsOutput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListMonitorsOutput) String added in v1.42.9 

func (s ListMonitorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPredictorBacktestExportJobsInput 

type ListPredictorBacktestExportJobsInput struct {

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

func (s ListPredictorBacktestExportJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPredictorBacktestExportJobsInput) SetFilters 

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

SetFilters sets the Filters field's value.

func (*ListPredictorBacktestExportJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListPredictorBacktestExportJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListPredictorBacktestExportJobsInput) String 

func (s ListPredictorBacktestExportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPredictorBacktestExportJobsInput) Validate 

func (s *ListPredictorBacktestExportJobsInput) Validate() error

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

type ListPredictorBacktestExportJobsOutput 

type ListPredictorBacktestExportJobsOutput struct {

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

	// An array of objects that summarize the properties of each predictor backtest
	// export job.
	PredictorBacktestExportJobs []*PredictorBacktestExportJobSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListPredictorBacktestExportJobsOutput) GoString 

func (s ListPredictorBacktestExportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPredictorBacktestExportJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListPredictorBacktestExportJobsOutput) SetPredictorBacktestExportJobs 

func (s *ListPredictorBacktestExportJobsOutput) SetPredictorBacktestExportJobs(v []*PredictorBacktestExportJobSummary) *ListPredictorBacktestExportJobsOutput

SetPredictorBacktestExportJobs sets the PredictorBacktestExportJobs field's value.

func (ListPredictorBacktestExportJobsOutput) String 

func (s ListPredictorBacktestExportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPredictorsInput 

type ListPredictorsInput struct {

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPredictorsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListPredictorsOutput) SetPredictors 

func (s *ListPredictorsOutput) SetPredictors(v []*PredictorSummary) *ListPredictorsOutput

SetPredictors sets the Predictors field's value.

func (ListPredictorsOutput) String 

func (s ListPredictorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource for which to
	// list the tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags for the resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWhatIfAnalysesInput added in v1.42.9 

type ListWhatIfAnalysesInput struct {

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

	// The number of items to return in the response.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListWhatIfAnalysesInput) GoString added in v1.42.9 

func (s ListWhatIfAnalysesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWhatIfAnalysesInput) SetFilters added in v1.42.9 

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

SetFilters sets the Filters field's value.

func (*ListWhatIfAnalysesInput) SetMaxResults added in v1.42.9 

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

SetMaxResults sets the MaxResults field's value.

func (*ListWhatIfAnalysesInput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListWhatIfAnalysesInput) String added in v1.42.9 

func (s ListWhatIfAnalysesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWhatIfAnalysesInput) Validate added in v1.42.9 

func (s *ListWhatIfAnalysesInput) Validate() error

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

type ListWhatIfAnalysesOutput added in v1.42.9 

type ListWhatIfAnalysesOutput struct {

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

	// An array of WhatIfAnalysisSummary objects that describe the matched analyses.
	WhatIfAnalyses []*WhatIfAnalysisSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListWhatIfAnalysesOutput) GoString added in v1.42.9 

func (s ListWhatIfAnalysesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWhatIfAnalysesOutput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (*ListWhatIfAnalysesOutput) SetWhatIfAnalyses added in v1.42.9 

func (s *ListWhatIfAnalysesOutput) SetWhatIfAnalyses(v []*WhatIfAnalysisSummary) *ListWhatIfAnalysesOutput

SetWhatIfAnalyses sets the WhatIfAnalyses field's value.

func (ListWhatIfAnalysesOutput) String added in v1.42.9 

func (s ListWhatIfAnalysesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWhatIfForecastExportsInput added in v1.42.9 

type ListWhatIfForecastExportsInput struct {

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

	// The number of items to return in the response.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListWhatIfForecastExportsInput) GoString added in v1.42.9 

func (s ListWhatIfForecastExportsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWhatIfForecastExportsInput) SetFilters added in v1.42.9 

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

SetFilters sets the Filters field's value.

func (*ListWhatIfForecastExportsInput) SetMaxResults added in v1.42.9 

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

SetMaxResults sets the MaxResults field's value.

func (*ListWhatIfForecastExportsInput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListWhatIfForecastExportsInput) String added in v1.42.9 

func (s ListWhatIfForecastExportsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWhatIfForecastExportsInput) Validate added in v1.42.9 

func (s *ListWhatIfForecastExportsInput) Validate() error

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

type ListWhatIfForecastExportsOutput added in v1.42.9 

type ListWhatIfForecastExportsOutput struct {

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

	// An array of WhatIfForecastExports objects that describe the matched forecast
	// exports.
	WhatIfForecastExports []*WhatIfForecastExportSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListWhatIfForecastExportsOutput) GoString added in v1.42.9 

func (s ListWhatIfForecastExportsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWhatIfForecastExportsOutput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (*ListWhatIfForecastExportsOutput) SetWhatIfForecastExports added in v1.42.9 

func (s *ListWhatIfForecastExportsOutput) SetWhatIfForecastExports(v []*WhatIfForecastExportSummary) *ListWhatIfForecastExportsOutput

SetWhatIfForecastExports sets the WhatIfForecastExports field's value.

func (ListWhatIfForecastExportsOutput) String added in v1.42.9 

func (s ListWhatIfForecastExportsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWhatIfForecastsInput added in v1.42.9 

type ListWhatIfForecastsInput struct {

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

	// The number of items to return in the response.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListWhatIfForecastsInput) GoString added in v1.42.9 

func (s ListWhatIfForecastsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWhatIfForecastsInput) SetFilters added in v1.42.9 

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

SetFilters sets the Filters field's value.

func (*ListWhatIfForecastsInput) SetMaxResults added in v1.42.9 

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

SetMaxResults sets the MaxResults field's value.

func (*ListWhatIfForecastsInput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (ListWhatIfForecastsInput) String added in v1.42.9 

func (s ListWhatIfForecastsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWhatIfForecastsInput) Validate added in v1.42.9 

func (s *ListWhatIfForecastsInput) Validate() error

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

type ListWhatIfForecastsOutput added in v1.42.9 

type ListWhatIfForecastsOutput struct {

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

	// An array of WhatIfForecasts objects that describe the matched forecasts.
	WhatIfForecasts []*WhatIfForecastSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListWhatIfForecastsOutput) GoString added in v1.42.9 

func (s ListWhatIfForecastsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWhatIfForecastsOutput) SetNextToken added in v1.42.9 

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

SetNextToken sets the NextToken field's value.

func (*ListWhatIfForecastsOutput) SetWhatIfForecasts added in v1.42.9 

func (s *ListWhatIfForecastsOutput) SetWhatIfForecasts(v []*WhatIfForecastSummary) *ListWhatIfForecastsOutput

SetWhatIfForecasts sets the WhatIfForecasts field's value.

func (ListWhatIfForecastsOutput) String added in v1.42.9 

func (s ListWhatIfForecastsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricResult added in v1.42.9 

type MetricResult struct {

	// The name of the metric.
	MetricName *string `type:"string"`

	// The value for the metric.
	MetricValue *float64 `type:"double"`
	// contains filtered or unexported fields
}

An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric's value in the Baseline to see how your predictor's performance is changing.

For more information about metrics generated by Forecast see Evaluating Predictor Accuracy (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)

func (MetricResult) GoString added in v1.42.9 

func (s MetricResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricResult) SetMetricName added in v1.42.9 

func (s *MetricResult) SetMetricName(v string) *MetricResult

SetMetricName sets the MetricName field's value.

func (*MetricResult) SetMetricValue added in v1.42.9 

func (s *MetricResult) SetMetricValue(v float64) *MetricResult

SetMetricValue sets the MetricValue field's value.

func (MetricResult) String added in v1.42.9 

func (s MetricResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Metrics 

type Metrics struct {

	// The average value of all weighted quantile losses.
	AverageWeightedQuantileLoss *float64 `type:"double"`

	// Provides detailed error metrics for each forecast type. Metrics include root-mean
	// square-error (RMSE), mean absolute percentage error (MAPE), mean absolute
	// scaled error (MASE), and weighted average percentage error (WAPE).
	ErrorMetrics []*ErrorMetric `type:"list"`

	// The root-mean-square error (RMSE).
	//
	// Deprecated: This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE
	RMSE *float64 `deprecated:"true" type:"double"`

	// An array of weighted quantile losses. Quantiles divide a probability distribution
	// into regions of equal probability. The distribution in this case is the loss
	// function.
	WeightedQuantileLosses []*WeightedQuantileLoss `type:"list"`
	// contains filtered or unexported fields
}

Provides metrics that are 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Metrics) SetAverageWeightedQuantileLoss 

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

SetAverageWeightedQuantileLoss sets the AverageWeightedQuantileLoss field's value.

func (*Metrics) SetErrorMetrics 

func (s *Metrics) SetErrorMetrics(v []*ErrorMetric) *Metrics

SetErrorMetrics sets the ErrorMetrics field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MonitorConfig added in v1.42.9 

type MonitorConfig struct {

	// The name of the monitor resource.
	//
	// MonitorName is a required field
	MonitorName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration details for the predictor monitor.

func (MonitorConfig) GoString added in v1.42.9 

func (s MonitorConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MonitorConfig) SetMonitorName added in v1.42.9 

func (s *MonitorConfig) SetMonitorName(v string) *MonitorConfig

SetMonitorName sets the MonitorName field's value.

func (MonitorConfig) String added in v1.42.9 

func (s MonitorConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MonitorConfig) Validate added in v1.42.9 

func (s *MonitorConfig) Validate() error

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

type MonitorDataSource added in v1.42.9 

type MonitorDataSource struct {

	// The Amazon Resource Name (ARN) of the dataset import job used to import the
	// data that initiated the monitor evaluation.
	DatasetImportJobArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the forecast the monitor used during the
	// evaluation.
	ForecastArn *string `type:"string"`

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

The source of the data the monitor used during the evaluation.

func (MonitorDataSource) GoString added in v1.42.9 

func (s MonitorDataSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MonitorDataSource) SetDatasetImportJobArn added in v1.42.9 

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

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (*MonitorDataSource) SetForecastArn added in v1.42.9 

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

SetForecastArn sets the ForecastArn field's value.

func (*MonitorDataSource) SetPredictorArn added in v1.42.9 

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

SetPredictorArn sets the PredictorArn field's value.

func (MonitorDataSource) String added in v1.42.9 

func (s MonitorDataSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MonitorInfo added in v1.42.9 

type MonitorInfo struct {

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

	// The status of the monitor. States include:
	//
	//    * ACTIVE
	//
	//    * ACTIVE_STOPPING, ACTIVE_STOPPED
	//
	//    * UPDATE_IN_PROGRESS
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the monitor resource.

func (MonitorInfo) GoString added in v1.42.9 

func (s MonitorInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MonitorInfo) SetMonitorArn added in v1.42.9 

func (s *MonitorInfo) SetMonitorArn(v string) *MonitorInfo

SetMonitorArn sets the MonitorArn field's value.

func (*MonitorInfo) SetStatus added in v1.42.9 

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

SetStatus sets the Status field's value.

func (MonitorInfo) String added in v1.42.9 

func (s MonitorInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MonitorSummary added in v1.42.9 

type MonitorSummary struct {

	// When the monitor resource was created.
	CreationTime *time.Time `type:"timestamp"`

	// The last time the monitor resource was modified. The timestamp depends on
	// the status of the job:
	//
	//    * CREATE_PENDING - The CreationTime.
	//
	//    * CREATE_IN_PROGRESS - The current timestamp.
	//
	//    * STOPPED - When the resource stopped.
	//
	//    * ACTIVE or CREATE_FAILED - When the monitor creation finished or failed.
	LastModificationTime *time.Time `type:"timestamp"`

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

	// The name of the monitor resource.
	MonitorName *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the predictor being monitored.
	ResourceArn *string `type:"string"`

	// The status of the monitor. States include:
	//
	//    * ACTIVE
	//
	//    * ACTIVE_STOPPING, ACTIVE_STOPPED
	//
	//    * UPDATE_IN_PROGRESS
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the monitor properties used in the ListMonitors operation. To get a complete set of properties, call the DescribeMonitor operation, and provide the listed MonitorArn.

func (MonitorSummary) GoString added in v1.42.9 

func (s MonitorSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MonitorSummary) SetCreationTime added in v1.42.9 

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

SetCreationTime sets the CreationTime field's value.

func (*MonitorSummary) SetLastModificationTime added in v1.42.9 

func (s *MonitorSummary) SetLastModificationTime(v time.Time) *MonitorSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (*MonitorSummary) SetMonitorArn added in v1.42.9 

func (s *MonitorSummary) SetMonitorArn(v string) *MonitorSummary

SetMonitorArn sets the MonitorArn field's value.

func (*MonitorSummary) SetMonitorName added in v1.42.9 

func (s *MonitorSummary) SetMonitorName(v string) *MonitorSummary

SetMonitorName sets the MonitorName field's value.

func (*MonitorSummary) SetResourceArn added in v1.42.9 

func (s *MonitorSummary) SetResourceArn(v string) *MonitorSummary

SetResourceArn sets the ResourceArn field's value.

func (*MonitorSummary) SetStatus added in v1.42.9 

func (s *MonitorSummary) SetStatus(v string) *MonitorSummary

SetStatus sets the Status field's value.

func (MonitorSummary) String added in v1.42.9 

func (s MonitorSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParameterRanges) Validate 

func (s *ParameterRanges) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PredictorBacktestExportJobSummary 

type PredictorBacktestExportJobSummary struct {

	// When the predictor backtest export job was created.
	CreationTime *time.Time `type:"timestamp"`

	// The destination for an export job. Provide an S3 path, an Identity and Access
	// Management (IAM) role that allows Amazon Forecast to access the location,
	// and an Key Management Service (KMS) key (optional).
	Destination *DataDestination `type:"structure"`

	// The last time the resource was modified. The timestamp depends on the status
	// of the job:
	//
	//    * CREATE_PENDING - The CreationTime.
	//
	//    * CREATE_IN_PROGRESS - The current timestamp.
	//
	//    * CREATE_STOPPING - The current timestamp.
	//
	//    * CREATE_STOPPED - When the job stopped.
	//
	//    * ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time `type:"timestamp"`

	// Information about any errors that may have occurred during the backtest export.
	Message *string `type:"string"`

	// The Amazon Resource Name (ARN) of the predictor backtest export job.
	PredictorBacktestExportJobArn *string `type:"string"`

	// The name of the predictor backtest export job.
	PredictorBacktestExportJobName *string `min:"1" type:"string"`

	// The status of the predictor backtest export job. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs operation. To get a complete set of properties, call the DescribePredictorBacktestExportJob operation, and provide the listed PredictorBacktestExportJobArn.

func (PredictorBacktestExportJobSummary) GoString 

func (s PredictorBacktestExportJobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictorBacktestExportJobSummary) SetCreationTime 

func (s *PredictorBacktestExportJobSummary) SetCreationTime(v time.Time) *PredictorBacktestExportJobSummary

SetCreationTime sets the CreationTime field's value.

func (*PredictorBacktestExportJobSummary) SetDestination 

func (s *PredictorBacktestExportJobSummary) SetDestination(v *DataDestination) *PredictorBacktestExportJobSummary

SetDestination sets the Destination field's value.

func (*PredictorBacktestExportJobSummary) SetLastModificationTime 

func (s *PredictorBacktestExportJobSummary) SetLastModificationTime(v time.Time) *PredictorBacktestExportJobSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (*PredictorBacktestExportJobSummary) SetMessage 

func (s *PredictorBacktestExportJobSummary) SetMessage(v string) *PredictorBacktestExportJobSummary

SetMessage sets the Message field's value.

func (*PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobArn 

func (s *PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobArn(v string) *PredictorBacktestExportJobSummary

SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value.

func (*PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobName 

func (s *PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobName(v string) *PredictorBacktestExportJobSummary

SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value.

func (*PredictorBacktestExportJobSummary) SetStatus 

func (s *PredictorBacktestExportJobSummary) SetStatus(v string) *PredictorBacktestExportJobSummary

SetStatus sets the Status field's value.

func (PredictorBacktestExportJobSummary) String 

func (s PredictorBacktestExportJobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PredictorBaseline added in v1.42.9 

type PredictorBaseline struct {

	// The initial accuracy metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html)
	// for the predictor. Use these metrics as a baseline for comparison purposes
	// as you use your predictor and the metrics change.
	BaselineMetrics []*BaselineMetric `type:"list"`
	// contains filtered or unexported fields
}

Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.

func (PredictorBaseline) GoString added in v1.42.9 

func (s PredictorBaseline) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictorBaseline) SetBaselineMetrics added in v1.42.9 

func (s *PredictorBaseline) SetBaselineMetrics(v []*BaselineMetric) *PredictorBaseline

SetBaselineMetrics sets the BaselineMetrics field's value.

func (PredictorBaseline) String added in v1.42.9 

func (s PredictorBaseline) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PredictorEvent added in v1.42.9 

type PredictorEvent struct {

	// The timestamp for when the event occurred.
	Datetime *time.Time `type:"timestamp"`

	// The type of event. For example, Retrain. A retraining event denotes the timepoint
	// when a predictor was retrained. Any monitor results from before the Datetime
	// are from the previous predictor. Any new metrics are for the newly retrained
	// predictor.
	Detail *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about a predictor event, such as a retraining.

func (PredictorEvent) GoString added in v1.42.9 

func (s PredictorEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictorEvent) SetDatetime added in v1.42.9 

func (s *PredictorEvent) SetDatetime(v time.Time) *PredictorEvent

SetDatetime sets the Datetime field's value.

func (*PredictorEvent) SetDetail added in v1.42.9 

func (s *PredictorEvent) SetDetail(v string) *PredictorEvent

SetDetail sets the Detail field's value.

func (PredictorEvent) String added in v1.42.9 

func (s PredictorEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PredictorExecution 

type PredictorExecution struct {

	// The ARN of the algorithm used to test the predictor.
	AlgorithmArn *string `type:"string"`

	// An array of test windows used to evaluate the algorithm. The NumberOfBacktestWindows
	// from the object determines the number of windows in the array.
	TestWindows []*TestWindowSummary `type:"list"`
	// contains filtered or unexported fields
}

The algorithm used to perform a backtest and the status of those tests.

func (PredictorExecution) GoString 

func (s PredictorExecution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictorExecution) SetAlgorithmArn 

func (s *PredictorExecution) SetAlgorithmArn(v string) *PredictorExecution

SetAlgorithmArn sets the AlgorithmArn field's value.

func (*PredictorExecution) SetTestWindows 

func (s *PredictorExecution) SetTestWindows(v []*TestWindowSummary) *PredictorExecution

SetTestWindows sets the TestWindows field's value.

func (PredictorExecution) String 

func (s PredictorExecution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PredictorExecutionDetails 

type PredictorExecutionDetails struct {

	// An array of the backtests performed to evaluate the accuracy of the predictor
	// against a particular algorithm. The NumberOfBacktestWindows from the object
	// determines the number of windows in the array.
	PredictorExecutions []*PredictorExecution `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Contains details on the backtests performed to evaluate the accuracy of the predictor. The tests are returned in descending order of accuracy, with the most accurate backtest appearing first. You specify the number of backtests to perform when you call the operation.

func (PredictorExecutionDetails) GoString 

func (s PredictorExecutionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictorExecutionDetails) SetPredictorExecutions 

func (s *PredictorExecutionDetails) SetPredictorExecutions(v []*PredictorExecution) *PredictorExecutionDetails

SetPredictorExecutions sets the PredictorExecutions field's value.

func (PredictorExecutionDetails) String 

func (s PredictorExecutionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PredictorMonitorEvaluation added in v1.42.9 

type PredictorMonitorEvaluation struct {

	// The status of the monitor evaluation. The state can be SUCCESS or FAILURE.
	EvaluationState *string `type:"string"`

	// The timestamp that indicates when the monitor evaluation was started.
	EvaluationTime *time.Time `type:"timestamp"`

	// Information about any errors that may have occurred during the monitor evaluation.
	Message *string `type:"string"`

	// A list of metrics Forecast calculated when monitoring a predictor. You can
	// compare the value for each metric in the list to the metric's value in the
	// Baseline to see how your predictor's performance is changing.
	MetricResults []*MetricResult `type:"list"`

	// The Amazon Resource Name (ARN) of the monitor resource.
	MonitorArn *string `type:"string"`

	// The source of the data the monitor resource used during the evaluation.
	MonitorDataSource *MonitorDataSource `type:"structure"`

	// The number of items considered during the evaluation.
	NumItemsEvaluated *int64 `type:"long"`

	// Provides details about a predictor event, such as a retraining.
	PredictorEvent *PredictorEvent `type:"structure"`

	// The Amazon Resource Name (ARN) of the resource to monitor.
	ResourceArn *string `type:"string"`

	// The timestamp that indicates the end of the window that is used for monitor
	// evaluation.
	WindowEndDatetime *time.Time `type:"timestamp"`

	// The timestamp that indicates the start of the window that is used for monitor
	// evaluation.
	WindowStartDatetime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Describes the results of a monitor evaluation.

func (PredictorMonitorEvaluation) GoString added in v1.42.9 

func (s PredictorMonitorEvaluation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PredictorMonitorEvaluation) SetEvaluationState added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetEvaluationState(v string) *PredictorMonitorEvaluation

SetEvaluationState sets the EvaluationState field's value.

func (*PredictorMonitorEvaluation) SetEvaluationTime added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetEvaluationTime(v time.Time) *PredictorMonitorEvaluation

SetEvaluationTime sets the EvaluationTime field's value.

func (*PredictorMonitorEvaluation) SetMessage added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetMessage(v string) *PredictorMonitorEvaluation

SetMessage sets the Message field's value.

func (*PredictorMonitorEvaluation) SetMetricResults added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetMetricResults(v []*MetricResult) *PredictorMonitorEvaluation

SetMetricResults sets the MetricResults field's value.

func (*PredictorMonitorEvaluation) SetMonitorArn added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetMonitorArn(v string) *PredictorMonitorEvaluation

SetMonitorArn sets the MonitorArn field's value.

func (*PredictorMonitorEvaluation) SetMonitorDataSource added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetMonitorDataSource(v *MonitorDataSource) *PredictorMonitorEvaluation

SetMonitorDataSource sets the MonitorDataSource field's value.

func (*PredictorMonitorEvaluation) SetNumItemsEvaluated added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetNumItemsEvaluated(v int64) *PredictorMonitorEvaluation

SetNumItemsEvaluated sets the NumItemsEvaluated field's value.

func (*PredictorMonitorEvaluation) SetPredictorEvent added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetPredictorEvent(v *PredictorEvent) *PredictorMonitorEvaluation

SetPredictorEvent sets the PredictorEvent field's value.

func (*PredictorMonitorEvaluation) SetResourceArn added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetResourceArn(v string) *PredictorMonitorEvaluation

SetResourceArn sets the ResourceArn field's value.

func (*PredictorMonitorEvaluation) SetWindowEndDatetime added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetWindowEndDatetime(v time.Time) *PredictorMonitorEvaluation

SetWindowEndDatetime sets the WindowEndDatetime field's value.

func (*PredictorMonitorEvaluation) SetWindowStartDatetime added in v1.42.9 

func (s *PredictorMonitorEvaluation) SetWindowStartDatetime(v time.Time) *PredictorMonitorEvaluation

SetWindowStartDatetime sets the WindowStartDatetime field's value.

func (PredictorMonitorEvaluation) String added in v1.42.9 

func (s PredictorMonitorEvaluation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Whether AutoPredictor was used to create the predictor.
	IsAutoPredictor *bool `type:"boolean"`

	// The last time the resource was modified. The timestamp depends on the status
	// of the job:
	//
	//    * CREATE_PENDING - The CreationTime.
	//
	//    * CREATE_IN_PROGRESS - The current timestamp.
	//
	//    * CREATE_STOPPING - The current timestamp.
	//
	//    * CREATE_STOPPED - When the job stopped.
	//
	//    * ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time `type:"timestamp"`

	// If an error occurred, an informational message about the error.
	Message *string `type:"string"`

	// The ARN of the predictor.
	PredictorArn *string `type:"string"`

	// The name of the predictor.
	PredictorName *string `min:"1" type:"string"`

	// A summary of the reference predictor used if the predictor was retrained
	// or upgraded.
	ReferencePredictorSummary *ReferencePredictorSummary `type:"structure"`

	// The status of the predictor. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	// The Status of the predictor must be ACTIVE before you can use the predictor
	// to create a forecast.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

func (PredictorSummary) GoString 

func (s PredictorSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetIsAutoPredictor added in v1.42.9 

func (s *PredictorSummary) SetIsAutoPredictor(v bool) *PredictorSummary

SetIsAutoPredictor sets the IsAutoPredictor 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) SetReferencePredictorSummary added in v1.42.9 

func (s *PredictorSummary) SetReferencePredictorSummary(v *ReferencePredictorSummary) *PredictorSummary

SetReferencePredictorSummary sets the ReferencePredictorSummary 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReferencePredictorSummary added in v1.42.9 

type ReferencePredictorSummary struct {

	// The ARN of the reference predictor.
	Arn *string `type:"string"`

	// Whether the reference predictor is Active or Deleted.
	State *string `type:"string" enum:"State"`
	// contains filtered or unexported fields
}

Provides a summary of the reference predictor used when retraining or upgrading a predictor.

func (ReferencePredictorSummary) GoString added in v1.42.9 

func (s ReferencePredictorSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReferencePredictorSummary) SetArn added in v1.42.9 

func (s *ReferencePredictorSummary) SetArn(v string) *ReferencePredictorSummary

SetArn sets the Arn field's value.

func (*ReferencePredictorSummary) SetState added in v1.42.9 

func (s *ReferencePredictorSummary) SetState(v string) *ReferencePredictorSummary

SetState sets the State field's value.

func (ReferencePredictorSummary) String added in v1.42.9 

func (s ReferencePredictorSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

There is already a resource with this name. Try again with a different name.

func (*ResourceAlreadyExistsException) Code 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException 

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource is in use.

func (*ResourceInUseException) Code 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode 

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String 

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResumeResourceInput added in v1.42.9 

type ResumeResourceInput struct {

	// The Amazon Resource Name (ARN) of the monitor resource to resume.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResumeResourceInput) GoString added in v1.42.9 

func (s ResumeResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResumeResourceInput) SetResourceArn added in v1.42.9 

func (s *ResumeResourceInput) SetResourceArn(v string) *ResumeResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ResumeResourceInput) String added in v1.42.9 

func (s ResumeResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResumeResourceInput) Validate added in v1.42.9 

func (s *ResumeResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResumeResourceOutput added in v1.42.9 

type ResumeResourceOutput struct {
	// contains filtered or unexported fields
}

func (ResumeResourceOutput) GoString added in v1.42.9 

func (s ResumeResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ResumeResourceOutput) String added in v1.42.9 

func (s ResumeResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3Config 

type S3Config struct {

	// The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
	KMSKeyArn *string `type:"string"`

	// The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s)
	// in an Amazon S3 bucket.
	//
	// Path is a required field
	Path *string `min:"7" type:"string" required:"true"`

	// The ARN of the Identity and Access Management (IAM) role that Amazon Forecast
	// can assume to access the Amazon S3 bucket or files. If you provide a value
	// for the KMSKeyArn key, the role must allow access to the key.
	//
	// Passing a role across Amazon Web Services accounts is not allowed. If you
	// pass a role that isn't in your account, you get an InvalidInputException
	// error.
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.

func (S3Config) GoString 

func (s S3Config) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Defines the fields of a dataset.

func (Schema) GoString 

func (s Schema) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// For a related time series dataset, other than date, item_id, and forecast
	// dimensions attributes, all attributes should be of numerical type (integer/float).
	AttributeType *string `type:"string" enum:"AttributeType"`
	// contains filtered or unexported fields
}

An attribute of a schema, which defines a dataset field. A schema attribute is required for every field in a dataset. The Schema (https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html) object contains an array of SchemaAttribute objects.

func (SchemaAttribute) GoString 

func (s SchemaAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. If the response value is -1, refer to
	// CountLong.
	Count *int64 `type:"integer"`

	// The number of distinct values in the field. If the response value is -1,
	// refer to CountDistinctLong.
	CountDistinct *int64 `type:"integer"`

	// The number of distinct values in the field. CountDistinctLong is used instead
	// of CountDistinct if the value is greater than 2,147,483,647.
	CountDistinctLong *int64 `type:"long"`

	// The number of values in the field. CountLong is used instead of Count if
	// the value is greater than 2,147,483,647.
	CountLong *int64 `type:"long"`

	// The number of NAN (not a number) values in the field. If the response value
	// is -1, refer to CountNanLong.
	CountNan *int64 `type:"integer"`

	// The number of NAN (not a number) values in the field. CountNanLong is used
	// instead of CountNan if the value is greater than 2,147,483,647.
	CountNanLong *int64 `type:"long"`

	// The number of null values in the field. If the response value is -1, refer
	// to CountNullLong.
	CountNull *int64 `type:"integer"`

	// The number of null values in the field. CountNullLong is used instead of
	// CountNull if the value is greater than 2,147,483,647.
	CountNullLong *int64 `type:"long"`

	// For a numeric field, the maximum value in the field.
	Max *string `type:"string"`

	// For a numeric field, the minimum value in the field.
	Min *string `type:"string"`

	// For a numeric field, the standard deviation.
	Stddev *float64 `type:"double"`
	// contains filtered or unexported fields
}

Provides statistics for each data field imported into to an Amazon Forecast dataset with the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation.

func (Statistics) GoString 

func (s Statistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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) SetCountDistinctLong 

func (s *Statistics) SetCountDistinctLong(v int64) *Statistics

SetCountDistinctLong sets the CountDistinctLong field's value.

func (*Statistics) SetCountLong 

func (s *Statistics) SetCountLong(v int64) *Statistics

SetCountLong sets the CountLong field's value.

func (*Statistics) SetCountNan 

func (s *Statistics) SetCountNan(v int64) *Statistics

SetCountNan sets the CountNan field's value.

func (*Statistics) SetCountNanLong 

func (s *Statistics) SetCountNanLong(v int64) *Statistics

SetCountNanLong sets the CountNanLong field's value.

func (*Statistics) SetCountNull 

func (s *Statistics) SetCountNull(v int64) *Statistics

SetCountNull sets the CountNull field's value.

func (*Statistics) SetCountNullLong 

func (s *Statistics) SetCountNullLong(v int64) *Statistics

SetCountNullLong sets the CountNullLong 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopResourceInput 

type StopResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource to stop. The
	// supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn,
	// ForecastArn, ForecastExportJobArn, ExplainabilityArn, and ExplainabilityExportArn.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopResourceInput) GoString 

func (s StopResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopResourceInput) SetResourceArn 

func (s *StopResourceInput) SetResourceArn(v string) *StopResourceInput

SetResourceArn sets the ResourceArn field's value.

func (StopResourceInput) String 

func (s StopResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopResourceInput) Validate 

func (s *StopResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopResourceOutput 

type StopResourceOutput struct {
	// contains filtered or unexported fields
}

func (StopResourceOutput) GoString 

func (s StopResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopResourceOutput) String 

func (s StopResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SupplementaryFeature 

type SupplementaryFeature struct {

	// The name of the feature. Valid values: "holiday" and "weather".
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Weather Index
	//
	// To enable the Weather Index, set the value to "true"
	//
	// Holidays
	//
	// To enable Holidays, specify a country with one of the following two-letter
	// country codes:
	//
	//    * "AL" - ALBANIA
	//
	//    * "AR" - ARGENTINA
	//
	//    * "AT" - AUSTRIA
	//
	//    * "AU" - AUSTRALIA
	//
	//    * "BA" - BOSNIA HERZEGOVINA
	//
	//    * "BE" - BELGIUM
	//
	//    * "BG" - BULGARIA
	//
	//    * "BO" - BOLIVIA
	//
	//    * "BR" - BRAZIL
	//
	//    * "BY" - BELARUS
	//
	//    * "CA" - CANADA
	//
	//    * "CL" - CHILE
	//
	//    * "CO" - COLOMBIA
	//
	//    * "CR" - COSTA RICA
	//
	//    * "HR" - CROATIA
	//
	//    * "CZ" - CZECH REPUBLIC
	//
	//    * "DK" - DENMARK
	//
	//    * "EC" - ECUADOR
	//
	//    * "EE" - ESTONIA
	//
	//    * "ET" - ETHIOPIA
	//
	//    * "FI" - FINLAND
	//
	//    * "FR" - FRANCE
	//
	//    * "DE" - GERMANY
	//
	//    * "GR" - GREECE
	//
	//    * "HU" - HUNGARY
	//
	//    * "IS" - ICELAND
	//
	//    * "IN" - INDIA
	//
	//    * "IE" - IRELAND
	//
	//    * "IT" - ITALY
	//
	//    * "JP" - JAPAN
	//
	//    * "KZ" - KAZAKHSTAN
	//
	//    * "KR" - KOREA
	//
	//    * "LV" - LATVIA
	//
	//    * "LI" - LIECHTENSTEIN
	//
	//    * "LT" - LITHUANIA
	//
	//    * "LU" - LUXEMBOURG
	//
	//    * "MK" - MACEDONIA
	//
	//    * "MT" - MALTA
	//
	//    * "MX" - MEXICO
	//
	//    * "MD" - MOLDOVA
	//
	//    * "ME" - MONTENEGRO
	//
	//    * "NL" - NETHERLANDS
	//
	//    * "NZ" - NEW ZEALAND
	//
	//    * "NI" - NICARAGUA
	//
	//    * "NG" - NIGERIA
	//
	//    * "NO" - NORWAY
	//
	//    * "PA" - PANAMA
	//
	//    * "PY" - PARAGUAY
	//
	//    * "PE" - PERU
	//
	//    * "PL" - POLAND
	//
	//    * "PT" - PORTUGAL
	//
	//    * "RO" - ROMANIA
	//
	//    * "RU" - RUSSIA
	//
	//    * "RS" - SERBIA
	//
	//    * "SK" - SLOVAKIA
	//
	//    * "SI" - SLOVENIA
	//
	//    * "ZA" - SOUTH AFRICA
	//
	//    * "ES" - SPAIN
	//
	//    * "SE" - SWEDEN
	//
	//    * "CH" - SWITZERLAND
	//
	//    * "UA" - UKRAINE
	//
	//    * "AE" - UNITED ARAB EMIRATES
	//
	//    * "US" - UNITED STATES
	//
	//    * "UK" - UNITED KINGDOM
	//
	//    * "UY" - URUGUAY
	//
	//    * "VE" - VENEZUELA
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AdditionalDataset.

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in featurizations.

Weather Index

The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index (https://docs.aws.amazon.com/forecast/latest/dg/weather.html).

Holidays

Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday (http://jollyday.sourceforge.net/data.html) library. For more information, see Holidays Featurization (https://docs.aws.amazon.com/forecast/latest/dg/holidays.html).

func (SupplementaryFeature) GoString 

func (s SupplementaryFeature) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SupplementaryFeature) SetName 

func (s *SupplementaryFeature) SetName(v string) *SupplementaryFeature

SetName sets the Name field's value.

func (*SupplementaryFeature) SetValue 

func (s *SupplementaryFeature) SetValue(v string) *SupplementaryFeature

SetValue sets the Value field's value.

func (SupplementaryFeature) String 

func (s SupplementaryFeature) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SupplementaryFeature) Validate 

func (s *SupplementaryFeature) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tag 

type Tag struct {

	// One part of a key-value pair that makes up a tag. A key is a general label
	// that acts like a category for more specific tag values.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Tag's
	// String and GoString methods.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The optional part of a key-value pair that makes up a tag. A value acts as
	// a descriptor within a tag category (key).
	//
	// Value is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Tag's
	// String and GoString methods.
	//
	// Value is a required field
	Value *string `type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource for which to
	// list the tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The tags to add to the resource. A tag is an array of key-value pairs.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50.
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8.
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8.
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for keys as it is reserved for Amazon Web Services use. You
	//    cannot edit or delete tag keys with this prefix. Values can have this
	//    prefix. If a tag value has aws as its prefix but the key does not, then
	//    Forecast considers it to be a user tag and will count against the limit
	//    of 50 tags. Tags with only the key prefix of aws do not count against
	//    your tags per resource limit.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TestWindowSummary 

type TestWindowSummary struct {

	// If the test failed, the reason why it failed.
	Message *string `type:"string"`

	// The status of the test. Possible status values are:
	//
	//    * ACTIVE
	//
	//    * CREATE_IN_PROGRESS
	//
	//    * CREATE_FAILED
	Status *string `type:"string"`

	// The time at which the test ended.
	TestWindowEnd *time.Time `type:"timestamp"`

	// The time at which the test began.
	TestWindowStart *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The status, start time, and end time of a backtest, as well as a failure reason if applicable.

func (TestWindowSummary) GoString 

func (s TestWindowSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestWindowSummary) SetMessage 

func (s *TestWindowSummary) SetMessage(v string) *TestWindowSummary

SetMessage sets the Message field's value.

func (*TestWindowSummary) SetStatus 

func (s *TestWindowSummary) SetStatus(v string) *TestWindowSummary

SetStatus sets the Status field's value.

func (*TestWindowSummary) SetTestWindowEnd 

func (s *TestWindowSummary) SetTestWindowEnd(v time.Time) *TestWindowSummary

SetTestWindowEnd sets the TestWindowEnd field's value.

func (*TestWindowSummary) SetTestWindowStart 

func (s *TestWindowSummary) SetTestWindowStart(v time.Time) *TestWindowSummary

SetTestWindowStart sets the TestWindowStart field's value.

func (TestWindowSummary) String 

func (s TestWindowSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimeAlignmentBoundary added in v1.42.9 

type TimeAlignmentBoundary struct {

	// The day of the month to use for time alignment during aggregation.
	DayOfMonth *int64 `min:"1" type:"integer"`

	// The day of week to use for time alignment during aggregation. The day must
	// be in uppercase.
	DayOfWeek *string `type:"string" enum:"DayOfWeek"`

	// The hour of day to use for time alignment during aggregation.
	Hour *int64 `type:"integer"`

	// The month to use for time alignment during aggregation. The month must be
	// in uppercase.
	Month *string `type:"string" enum:"Month"`
	// contains filtered or unexported fields
}

The time boundary Forecast uses to align and aggregate your data to match your forecast frequency. Provide the unit of time and the time boundary as a key value pair. If you don't provide a time boundary, Forecast uses a set of Default Time Boundaries (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries).

For more information about aggregation, see Data Aggregation for Different Forecast Frequencies (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html). For more information setting a custom time boundary, see Specifying a Time Boundary (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary).

func (TimeAlignmentBoundary) GoString added in v1.42.9 

func (s TimeAlignmentBoundary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeAlignmentBoundary) SetDayOfMonth added in v1.42.9 

func (s *TimeAlignmentBoundary) SetDayOfMonth(v int64) *TimeAlignmentBoundary

SetDayOfMonth sets the DayOfMonth field's value.

func (*TimeAlignmentBoundary) SetDayOfWeek added in v1.42.9 

func (s *TimeAlignmentBoundary) SetDayOfWeek(v string) *TimeAlignmentBoundary

SetDayOfWeek sets the DayOfWeek field's value.

func (*TimeAlignmentBoundary) SetHour added in v1.42.9 

func (s *TimeAlignmentBoundary) SetHour(v int64) *TimeAlignmentBoundary

SetHour sets the Hour field's value.

func (*TimeAlignmentBoundary) SetMonth added in v1.42.9 

func (s *TimeAlignmentBoundary) SetMonth(v string) *TimeAlignmentBoundary

SetMonth sets the Month field's value.

func (TimeAlignmentBoundary) String added in v1.42.9 

func (s TimeAlignmentBoundary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeAlignmentBoundary) Validate added in v1.42.9 

func (s *TimeAlignmentBoundary) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TimeSeriesCondition added in v1.42.9 

type TimeSeriesCondition struct {

	// The item_id, dimension name, IM name, or timestamp that you are modifying.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// The value that is applied for the chosen Condition.
	//
	// AttributeValue is a required field
	AttributeValue *string `type:"string" required:"true"`

	// The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and
	// GREATER_THAN.
	//
	// Condition is a required field
	Condition *string `type:"string" required:"true" enum:"Condition"`
	// contains filtered or unexported fields
}

Creates a subset of items within an attribute that are modified. For example, you can use this operation to create a subset of items that cost $5 or less. To do this, you specify "AttributeName": "price", "AttributeValue": "5", and "Condition": "LESS_THAN". Pair this operation with the Action operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define how the attribute is modified.

func (TimeSeriesCondition) GoString added in v1.42.9 

func (s TimeSeriesCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesCondition) SetAttributeName added in v1.42.9 

func (s *TimeSeriesCondition) SetAttributeName(v string) *TimeSeriesCondition

SetAttributeName sets the AttributeName field's value.

func (*TimeSeriesCondition) SetAttributeValue added in v1.42.9 

func (s *TimeSeriesCondition) SetAttributeValue(v string) *TimeSeriesCondition

SetAttributeValue sets the AttributeValue field's value.

func (*TimeSeriesCondition) SetCondition added in v1.42.9 

func (s *TimeSeriesCondition) SetCondition(v string) *TimeSeriesCondition

SetCondition sets the Condition field's value.

func (TimeSeriesCondition) String added in v1.42.9 

func (s TimeSeriesCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesCondition) Validate added in v1.42.9 

func (s *TimeSeriesCondition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TimeSeriesIdentifiers added in v1.42.9 

type TimeSeriesIdentifiers struct {

	// The source of your data, an Identity and Access Management (IAM) role that
	// allows Amazon Forecast to access the data and, optionally, an Key Management
	// Service (KMS) key.
	DataSource *DataSource `type:"structure"`

	// The format of the data, either CSV or PARQUET.
	Format *string `type:"string"`

	// Defines the fields of a dataset.
	Schema *Schema `type:"structure"`
	// contains filtered or unexported fields
}

Details about the import file that contains the time series for which you want to create forecasts.

func (TimeSeriesIdentifiers) GoString added in v1.42.9 

func (s TimeSeriesIdentifiers) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesIdentifiers) SetDataSource added in v1.42.9 

func (s *TimeSeriesIdentifiers) SetDataSource(v *DataSource) *TimeSeriesIdentifiers

SetDataSource sets the DataSource field's value.

func (*TimeSeriesIdentifiers) SetFormat added in v1.42.9 

func (s *TimeSeriesIdentifiers) SetFormat(v string) *TimeSeriesIdentifiers

SetFormat sets the Format field's value.

func (*TimeSeriesIdentifiers) SetSchema added in v1.42.9 

func (s *TimeSeriesIdentifiers) SetSchema(v *Schema) *TimeSeriesIdentifiers

SetSchema sets the Schema field's value.

func (TimeSeriesIdentifiers) String added in v1.42.9 

func (s TimeSeriesIdentifiers) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesIdentifiers) Validate added in v1.42.9 

func (s *TimeSeriesIdentifiers) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TimeSeriesReplacementsDataSource added in v1.42.9 

type TimeSeriesReplacementsDataSource struct {

	// The format of the replacement data, CSV or PARQUET.
	Format *string `type:"string"`

	// The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket,
	// and an Identity and Access Management (IAM) role that Amazon Forecast can
	// assume to access the file(s). Optionally, includes an Key Management Service
	// (KMS) key. This object is part of the DataSource object that is submitted
	// in the CreateDatasetImportJob request, and part of the DataDestination object.
	//
	// S3Config is a required field
	S3Config *S3Config `type:"structure" required:"true"`

	// Defines the fields of a dataset.
	//
	// Schema is a required field
	Schema *Schema `type:"structure" required:"true"`

	// The timestamp format of the replacement data.
	TimestampFormat *string `type:"string"`
	// contains filtered or unexported fields
}

A replacement dataset is a modified version of the baseline related time series that contains only the values that you want to include in a what-if forecast. The replacement dataset must contain the forecast dimensions and item identifiers in the baseline related time series as well as at least 1 changed time series. This dataset is merged with the baseline related time series to create a transformed dataset that is used for the what-if forecast.

func (TimeSeriesReplacementsDataSource) GoString added in v1.42.9 

func (s TimeSeriesReplacementsDataSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesReplacementsDataSource) SetFormat added in v1.42.9 

func (s *TimeSeriesReplacementsDataSource) SetFormat(v string) *TimeSeriesReplacementsDataSource

SetFormat sets the Format field's value.

func (*TimeSeriesReplacementsDataSource) SetS3Config added in v1.42.9 

func (s *TimeSeriesReplacementsDataSource) SetS3Config(v *S3Config) *TimeSeriesReplacementsDataSource

SetS3Config sets the S3Config field's value.

func (*TimeSeriesReplacementsDataSource) SetSchema added in v1.42.9 

func (s *TimeSeriesReplacementsDataSource) SetSchema(v *Schema) *TimeSeriesReplacementsDataSource

SetSchema sets the Schema field's value.

func (*TimeSeriesReplacementsDataSource) SetTimestampFormat added in v1.42.9 

func (s *TimeSeriesReplacementsDataSource) SetTimestampFormat(v string) *TimeSeriesReplacementsDataSource

SetTimestampFormat sets the TimestampFormat field's value.

func (TimeSeriesReplacementsDataSource) String added in v1.42.9 

func (s TimeSeriesReplacementsDataSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesReplacementsDataSource) Validate added in v1.42.9 

func (s *TimeSeriesReplacementsDataSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TimeSeriesSelector added in v1.42.9 

type TimeSeriesSelector struct {

	// Details about the import file that contains the time series for which you
	// want to create forecasts.
	TimeSeriesIdentifiers *TimeSeriesIdentifiers `type:"structure"`
	// contains filtered or unexported fields
}

Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

The TimeSeriesIdentifiers object needs the following information:

  • DataSource

  • Format

  • Schema

func (TimeSeriesSelector) GoString added in v1.42.9 

func (s TimeSeriesSelector) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesSelector) SetTimeSeriesIdentifiers added in v1.42.9 

func (s *TimeSeriesSelector) SetTimeSeriesIdentifiers(v *TimeSeriesIdentifiers) *TimeSeriesSelector

SetTimeSeriesIdentifiers sets the TimeSeriesIdentifiers field's value.

func (TimeSeriesSelector) String added in v1.42.9 

func (s TimeSeriesSelector) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesSelector) Validate added in v1.42.9 

func (s *TimeSeriesSelector) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TimeSeriesTransformation added in v1.42.9 

type TimeSeriesTransformation struct {

	// An array of actions that define a time series and how it is transformed.
	// These transformations create a new time series that is used for the what-if
	// analysis.
	Action *Action `type:"structure"`

	// An array of conditions that define which members of the related time series
	// are transformed.
	TimeSeriesConditions []*TimeSeriesCondition `type:"list"`
	// contains filtered or unexported fields
}

A transformation function is a pair of operations that select and modify the rows in a related time series. You select the rows that you want with a condition operation and you modify the rows with a transformation operation. All conditions are joined with an AND operation, meaning that all conditions must be true for the transformation to be applied. Transformations are applied in the order that they are listed.

func (TimeSeriesTransformation) GoString added in v1.42.9 

func (s TimeSeriesTransformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesTransformation) SetAction added in v1.42.9 

func (s *TimeSeriesTransformation) SetAction(v *Action) *TimeSeriesTransformation

SetAction sets the Action field's value.

func (*TimeSeriesTransformation) SetTimeSeriesConditions added in v1.42.9 

func (s *TimeSeriesTransformation) SetTimeSeriesConditions(v []*TimeSeriesCondition) *TimeSeriesTransformation

SetTimeSeriesConditions sets the TimeSeriesConditions field's value.

func (TimeSeriesTransformation) String added in v1.42.9 

func (s TimeSeriesTransformation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesTransformation) Validate added in v1.42.9 

func (s *TimeSeriesTransformation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource for which to
	// list the tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The keys of the tags to be removed.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDatasetGroupInput 

type UpdateDatasetGroupInput struct {

	// An array of the Amazon Resource Names (ARNs) of the datasets to add to the
	// dataset group.
	//
	// DatasetArns is a required field
	DatasetArns []*string `type:"list" required:"true"`

	// The ARN of the dataset group.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDatasetGroupInput) GoString 

func (s UpdateDatasetGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateDatasetGroupOutput) String 

func (s UpdateDatasetGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WeightedQuantileLoss 

type WeightedQuantileLoss struct {

	// The difference between the predicted value and the actual value over the
	// quantile, weighted (normalized) by dividing by the sum over all quantiles.
	LossValue *float64 `type:"double"`

	// The quantile. Quantiles divide a probability distribution into regions of
	// equal probability. For example, if the distribution was divided into 5 regions
	// of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.
	Quantile *float64 `type:"double"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WeightedQuantileLoss) SetLossValue 

func (s *WeightedQuantileLoss) SetLossValue(v float64) *WeightedQuantileLoss

SetLossValue sets the LossValue field's value.

func (*WeightedQuantileLoss) SetQuantile 

func (s *WeightedQuantileLoss) SetQuantile(v float64) *WeightedQuantileLoss

SetQuantile sets the Quantile field's value.

func (WeightedQuantileLoss) String 

func (s WeightedQuantileLoss) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WhatIfAnalysisSummary added in v1.42.9 

type WhatIfAnalysisSummary struct {

	// When the what-if analysis was created.
	CreationTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the baseline forecast that is being used
	// in this what-if analysis.
	ForecastArn *string `type:"string"`

	// The last time the resource was modified. The timestamp depends on the status
	// of the job:
	//
	//    * CREATE_PENDING - The CreationTime.
	//
	//    * CREATE_IN_PROGRESS - The current timestamp.
	//
	//    * CREATE_STOPPING - The current timestamp.
	//
	//    * CREATE_STOPPED - When the job stopped.
	//
	//    * ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time `type:"timestamp"`

	// If an error occurred, an informational message about the error.
	Message *string `type:"string"`

	// The status of the what-if analysis. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	//
	// The Status of the what-if analysis must be ACTIVE before you can access the
	// analysis.
	Status *string `type:"string"`

	// The Amazon Resource Name (ARN) of the what-if analysis.
	WhatIfAnalysisArn *string `type:"string"`

	// The name of the what-if analysis.
	WhatIfAnalysisName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the what-if analysis properties used in the ListWhatIfAnalyses operation. To get the complete set of properties, call the DescribeWhatIfAnalysis operation, and provide the WhatIfAnalysisArn that is listed in the summary.

func (WhatIfAnalysisSummary) GoString added in v1.42.9 

func (s WhatIfAnalysisSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WhatIfAnalysisSummary) SetCreationTime added in v1.42.9 

func (s *WhatIfAnalysisSummary) SetCreationTime(v time.Time) *WhatIfAnalysisSummary

SetCreationTime sets the CreationTime field's value.

func (*WhatIfAnalysisSummary) SetForecastArn added in v1.42.9 

func (s *WhatIfAnalysisSummary) SetForecastArn(v string) *WhatIfAnalysisSummary

SetForecastArn sets the ForecastArn field's value.

func (*WhatIfAnalysisSummary) SetLastModificationTime added in v1.42.9 

func (s *WhatIfAnalysisSummary) SetLastModificationTime(v time.Time) *WhatIfAnalysisSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (*WhatIfAnalysisSummary) SetMessage added in v1.42.9 

func (s *WhatIfAnalysisSummary) SetMessage(v string) *WhatIfAnalysisSummary

SetMessage sets the Message field's value.

func (*WhatIfAnalysisSummary) SetStatus added in v1.42.9 

func (s *WhatIfAnalysisSummary) SetStatus(v string) *WhatIfAnalysisSummary

SetStatus sets the Status field's value.

func (*WhatIfAnalysisSummary) SetWhatIfAnalysisArn added in v1.42.9 

func (s *WhatIfAnalysisSummary) SetWhatIfAnalysisArn(v string) *WhatIfAnalysisSummary

SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.

func (*WhatIfAnalysisSummary) SetWhatIfAnalysisName added in v1.42.9 

func (s *WhatIfAnalysisSummary) SetWhatIfAnalysisName(v string) *WhatIfAnalysisSummary

SetWhatIfAnalysisName sets the WhatIfAnalysisName field's value.

func (WhatIfAnalysisSummary) String added in v1.42.9 

func (s WhatIfAnalysisSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WhatIfForecastExportSummary added in v1.42.9 

type WhatIfForecastExportSummary struct {

	// When the what-if forecast export was created.
	CreationTime *time.Time `type:"timestamp"`

	// The path to the Amazon Simple Storage Service (Amazon S3) bucket where the
	// forecast is exported.
	Destination *DataDestination `type:"structure"`

	// The last time the resource was modified. The timestamp depends on the status
	// of the job:
	//
	//    * CREATE_PENDING - The CreationTime.
	//
	//    * CREATE_IN_PROGRESS - The current timestamp.
	//
	//    * CREATE_STOPPING - The current timestamp.
	//
	//    * CREATE_STOPPED - When the job stopped.
	//
	//    * ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time `type:"timestamp"`

	// If an error occurred, an informational message about the error.
	Message *string `type:"string"`

	// The status of the what-if forecast export. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	//
	// The Status of the what-if analysis must be ACTIVE before you can access the
	// analysis.
	Status *string `type:"string"`

	// An array of Amazon Resource Names (ARNs) that define the what-if forecasts
	// included in the export.
	WhatIfForecastArns []*string `min:"1" type:"list"`

	// The Amazon Resource Name (ARN) of the what-if forecast export.
	WhatIfForecastExportArn *string `type:"string"`

	// The what-if forecast export name.
	WhatIfForecastExportName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the what-if forecast export properties used in the ListWhatIfForecastExports operation. To get the complete set of properties, call the DescribeWhatIfForecastExport operation, and provide the WhatIfForecastExportArn that is listed in the summary.

func (WhatIfForecastExportSummary) GoString added in v1.42.9 

func (s WhatIfForecastExportSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WhatIfForecastExportSummary) SetCreationTime added in v1.42.9 

func (s *WhatIfForecastExportSummary) SetCreationTime(v time.Time) *WhatIfForecastExportSummary

SetCreationTime sets the CreationTime field's value.

func (*WhatIfForecastExportSummary) SetDestination added in v1.42.9 

func (s *WhatIfForecastExportSummary) SetDestination(v *DataDestination) *WhatIfForecastExportSummary

SetDestination sets the Destination field's value.

func (*WhatIfForecastExportSummary) SetLastModificationTime added in v1.42.9 

func (s *WhatIfForecastExportSummary) SetLastModificationTime(v time.Time) *WhatIfForecastExportSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (*WhatIfForecastExportSummary) SetMessage added in v1.42.9 

func (s *WhatIfForecastExportSummary) SetMessage(v string) *WhatIfForecastExportSummary

SetMessage sets the Message field's value.

func (*WhatIfForecastExportSummary) SetStatus added in v1.42.9 

func (s *WhatIfForecastExportSummary) SetStatus(v string) *WhatIfForecastExportSummary

SetStatus sets the Status field's value.

func (*WhatIfForecastExportSummary) SetWhatIfForecastArns added in v1.42.9 

func (s *WhatIfForecastExportSummary) SetWhatIfForecastArns(v []*string) *WhatIfForecastExportSummary

SetWhatIfForecastArns sets the WhatIfForecastArns field's value.

func (*WhatIfForecastExportSummary) SetWhatIfForecastExportArn added in v1.42.9 

func (s *WhatIfForecastExportSummary) SetWhatIfForecastExportArn(v string) *WhatIfForecastExportSummary

SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value.

func (*WhatIfForecastExportSummary) SetWhatIfForecastExportName added in v1.42.9 

func (s *WhatIfForecastExportSummary) SetWhatIfForecastExportName(v string) *WhatIfForecastExportSummary

SetWhatIfForecastExportName sets the WhatIfForecastExportName field's value.

func (WhatIfForecastExportSummary) String added in v1.42.9 

func (s WhatIfForecastExportSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WhatIfForecastSummary added in v1.42.9 

type WhatIfForecastSummary struct {

	// When the what-if forecast was created.
	CreationTime *time.Time `type:"timestamp"`

	// The last time the resource was modified. The timestamp depends on the status
	// of the job:
	//
	//    * CREATE_PENDING - The CreationTime.
	//
	//    * CREATE_IN_PROGRESS - The current timestamp.
	//
	//    * CREATE_STOPPING - The current timestamp.
	//
	//    * CREATE_STOPPED - When the job stopped.
	//
	//    * ACTIVE or CREATE_FAILED - When the job finished or failed.
	LastModificationTime *time.Time `type:"timestamp"`

	// If an error occurred, an informational message about the error.
	Message *string `type:"string"`

	// The status of the what-if forecast. States include:
	//
	//    * ACTIVE
	//
	//    * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
	//
	//    * CREATE_STOPPING, CREATE_STOPPED
	//
	//    * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
	//
	// The Status of the what-if analysis must be ACTIVE before you can access the
	// analysis.
	Status *string `type:"string"`

	// The Amazon Resource Name (ARN) of the what-if analysis that contains this
	// what-if forecast.
	WhatIfAnalysisArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the what-if forecast.
	WhatIfForecastArn *string `type:"string"`

	// The name of the what-if forecast.
	WhatIfForecastName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of the what-if forecast properties used in the ListWhatIfForecasts operation. To get the complete set of properties, call the DescribeWhatIfForecast operation, and provide the WhatIfForecastArn that is listed in the summary.

func (WhatIfForecastSummary) GoString added in v1.42.9 

func (s WhatIfForecastSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WhatIfForecastSummary) SetCreationTime added in v1.42.9 

func (s *WhatIfForecastSummary) SetCreationTime(v time.Time) *WhatIfForecastSummary

SetCreationTime sets the CreationTime field's value.

func (*WhatIfForecastSummary) SetLastModificationTime added in v1.42.9 

func (s *WhatIfForecastSummary) SetLastModificationTime(v time.Time) *WhatIfForecastSummary

SetLastModificationTime sets the LastModificationTime field's value.

func (*WhatIfForecastSummary) SetMessage added in v1.42.9 

func (s *WhatIfForecastSummary) SetMessage(v string) *WhatIfForecastSummary

SetMessage sets the Message field's value.

func (*WhatIfForecastSummary) SetStatus added in v1.42.9 

func (s *WhatIfForecastSummary) SetStatus(v string) *WhatIfForecastSummary

SetStatus sets the Status field's value.

func (*WhatIfForecastSummary) SetWhatIfAnalysisArn added in v1.42.9 

func (s *WhatIfForecastSummary) SetWhatIfAnalysisArn(v string) *WhatIfForecastSummary

SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value.

func (*WhatIfForecastSummary) SetWhatIfForecastArn added in v1.42.9 

func (s *WhatIfForecastSummary) SetWhatIfForecastArn(v string) *WhatIfForecastSummary

SetWhatIfForecastArn sets the WhatIfForecastArn field's value.

func (*WhatIfForecastSummary) SetWhatIfForecastName added in v1.42.9 

func (s *WhatIfForecastSummary) SetWhatIfForecastName(v string) *WhatIfForecastSummary

SetWhatIfForecastName sets the WhatIfForecastName field's value.

func (WhatIfForecastSummary) String added in v1.42.9 

func (s WhatIfForecastSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.