type DataPoint struct {
// The timestamp of the specific forecast.
Timestamp *string `type:"string"`
// The forecast value.
Value *float64 `type:"double"`
// contains filtered or unexported fields
}
The forecast value for a specific date. Part of the Forecast object.
func (s DataPoint) 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 (s *DataPoint) SetTimestamp(v string) *DataPoint
SetTimestamp sets the Timestamp field's value.
func (s *DataPoint) SetValue(v float64) *DataPoint
SetValue sets the Value field's value.
func (s DataPoint) 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 Forecast struct {
// The forecast.
//
// The string of the string-to-array map is one of the following values:
//
// * p10
//
// * p50
//
// * p90
//
// The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes
// parameter of the CreateForecast (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html)
// operation to change the values. The values will vary depending on how this
// is set, with a minimum of 1 and a maximum of 5.
Predictions map[string][]*DataPoint `type:"map"`
// contains filtered or unexported fields
}
Provides information about a forecast. Returned as part of the QueryForecast response.
func (s Forecast) 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 (s *Forecast) SetPredictions(v map[string][]*DataPoint) *Forecast
SetPredictions sets the Predictions field's value.
func (s Forecast) 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 ForecastQueryService struct {
*client.Client
}
ForecastQueryService provides the API operation methods for making requests to Amazon Forecast Query Service. See this package's package overview docs for details on the service.
ForecastQueryService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *ForecastQueryService
New creates a new instance of the ForecastQueryService 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 ForecastQueryService client from just a session.
svc := forecastqueryservice.New(mySession)
// Create a ForecastQueryService client with additional configuration
svc := forecastqueryservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *ForecastQueryService) QueryForecast(input *QueryForecastInput) (*QueryForecastOutput, error)
QueryForecast API operation for Amazon Forecast Query Service.
Retrieves a forecast for a single item, filtered by the supplied criteria.
The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object.
By default, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.
To get the full forecast, use the CreateForecastExportJob (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) operation.
The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.
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 Query Service's API operation QueryForecast for usage and error information.
Returned Error Types:
ResourceNotFoundException We can't find that resource. Check the information that you've provided and try again.
ResourceInUseException The specified resource is in use.
InvalidInputException The value is invalid or is too long.
LimitExceededException The limit on the number of requests per second has been exceeded.
InvalidNextTokenException The token is not valid. Tokens expire after 24 hours.
See also, https://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryForecast
func (c *ForecastQueryService) QueryForecastRequest(input *QueryForecastInput) (req *request.Request, output *QueryForecastOutput)
QueryForecastRequest generates a "aws/request.Request" representing the client's request for the QueryForecast 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 QueryForecast for more information on using the QueryForecast 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 QueryForecastRequest method.
req, resp := client.QueryForecastRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryForecast
func (c *ForecastQueryService) QueryForecastWithContext(ctx aws.Context, input *QueryForecastInput, opts ...request.Option) (*QueryForecastOutput, error)
QueryForecastWithContext is the same as QueryForecast with the addition of the ability to pass a context and additional request options.
See QueryForecast for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *ForecastQueryService) QueryWhatIfForecast(input *QueryWhatIfForecastInput) (*QueryWhatIfForecastOutput, error)
QueryWhatIfForecast API operation for Amazon Forecast Query Service.
Retrieves a what-if 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 Query Service's API operation QueryWhatIfForecast for usage and error information.
Returned Error Types:
ResourceNotFoundException We can't find that resource. Check the information that you've provided and try again.
ResourceInUseException The specified resource is in use.
InvalidInputException The value is invalid or is too long.
LimitExceededException The limit on the number of requests per second has been exceeded.
InvalidNextTokenException The token is not valid. Tokens expire after 24 hours.
See also, https://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecast
func (c *ForecastQueryService) QueryWhatIfForecastRequest(input *QueryWhatIfForecastInput) (req *request.Request, output *QueryWhatIfForecastOutput)
QueryWhatIfForecastRequest generates a "aws/request.Request" representing the client's request for the QueryWhatIfForecast 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 QueryWhatIfForecast for more information on using the QueryWhatIfForecast 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 QueryWhatIfForecastRequest method.
req, resp := client.QueryWhatIfForecastRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecast
func (c *ForecastQueryService) QueryWhatIfForecastWithContext(ctx aws.Context, input *QueryWhatIfForecastInput, opts ...request.Option) (*QueryWhatIfForecastOutput, error)
QueryWhatIfForecastWithContext is the same as QueryWhatIfForecast with the addition of the ability to pass a context and additional request options.
See QueryWhatIfForecast 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 InvalidInputException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The value is invalid or is too long.
func (s *InvalidInputException) Code() string
Code returns the exception type name.
func (s *InvalidInputException) Error() string
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 (s *InvalidInputException) Message() string
Message returns the exception's message.
func (s *InvalidInputException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidInputException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidInputException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *InvalidNextTokenException) Code() string
Code returns the exception type name.
func (s *InvalidNextTokenException) Error() string
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 (s *InvalidNextTokenException) Message() string
Message returns the exception's message.
func (s *InvalidNextTokenException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidNextTokenException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidNextTokenException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The limit on the number of requests per second has been exceeded.
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (s *LimitExceededException) Error() string
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 (s *LimitExceededException) Message() string
Message returns the exception's message.
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 QueryForecastInput struct {
// The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss
// (ISO 8601 format). For example, 2015-01-01T20:00:00.
EndDate *string `type:"string"`
// The filtering criteria to apply when retrieving the forecast. For example,
// to get the forecast for client_21 in the electricity usage dataset, specify
// the following:
//
// {"item_id" : "client_21"}
//
// To get the full forecast, use the CreateForecastExportJob (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html)
// operation.
//
// Filters is a required field
Filters map[string]*string `min:"1" type:"map" required:"true"`
// The Amazon Resource Name (ARN) of the forecast to query.
//
// ForecastArn is a required field
ForecastArn *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"`
// The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss
// (ISO 8601 format). For example, 2015-01-01T08:00:00.
StartDate *string `type:"string"`
// contains filtered or unexported fields
}
func (s QueryForecastInput) 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 (s *QueryForecastInput) SetEndDate(v string) *QueryForecastInput
SetEndDate sets the EndDate field's value.
func (s *QueryForecastInput) SetFilters(v map[string]*string) *QueryForecastInput
SetFilters sets the Filters field's value.
func (s *QueryForecastInput) SetForecastArn(v string) *QueryForecastInput
SetForecastArn sets the ForecastArn field's value.
func (s *QueryForecastInput) SetNextToken(v string) *QueryForecastInput
SetNextToken sets the NextToken field's value.
func (s *QueryForecastInput) SetStartDate(v string) *QueryForecastInput
SetStartDate sets the StartDate field's value.
func (s QueryForecastInput) 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 (s *QueryForecastInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type QueryForecastOutput struct {
// The forecast.
Forecast *Forecast `type:"structure"`
// contains filtered or unexported fields
}
func (s QueryForecastOutput) 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 (s *QueryForecastOutput) SetForecast(v *Forecast) *QueryForecastOutput
SetForecast sets the Forecast field's value.
func (s QueryForecastOutput) 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 QueryWhatIfForecastInput struct {
// The end date for the what-if forecast. Specify the date using this format:
// yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.
EndDate *string `type:"string"`
// The filtering criteria to apply when retrieving the forecast. For example,
// to get the forecast for client_21 in the electricity usage dataset, specify
// the following:
//
// {"item_id" : "client_21"}
//
// To get the full what-if forecast, use the CreateForecastExportJob (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html)
// operation.
//
// Filters is a required field
Filters map[string]*string `min:"1" type:"map" 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"`
// The start date for the what-if forecast. Specify the date using this format:
// yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.
StartDate *string `type:"string"`
// The Amazon Resource Name (ARN) of the what-if forecast to query.
//
// WhatIfForecastArn is a required field
WhatIfForecastArn *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s QueryWhatIfForecastInput) 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 (s *QueryWhatIfForecastInput) SetEndDate(v string) *QueryWhatIfForecastInput
SetEndDate sets the EndDate field's value.
func (s *QueryWhatIfForecastInput) SetFilters(v map[string]*string) *QueryWhatIfForecastInput
SetFilters sets the Filters field's value.
func (s *QueryWhatIfForecastInput) SetNextToken(v string) *QueryWhatIfForecastInput
SetNextToken sets the NextToken field's value.
func (s *QueryWhatIfForecastInput) SetStartDate(v string) *QueryWhatIfForecastInput
SetStartDate sets the StartDate field's value.
func (s *QueryWhatIfForecastInput) SetWhatIfForecastArn(v string) *QueryWhatIfForecastInput
SetWhatIfForecastArn sets the WhatIfForecastArn field's value.
func (s QueryWhatIfForecastInput) 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 (s *QueryWhatIfForecastInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type QueryWhatIfForecastOutput struct {
// Provides information about a forecast. Returned as part of the QueryForecast
// response.
Forecast *Forecast `type:"structure"`
// contains filtered or unexported fields
}
func (s QueryWhatIfForecastOutput) 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 (s *QueryWhatIfForecastOutput) SetForecast(v *Forecast) *QueryWhatIfForecastOutput
SetForecast sets the Forecast field's value.
func (s QueryWhatIfForecastOutput) 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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The specified resource is in use.
func (s *ResourceInUseException) Code() string
Code returns the exception type name.
func (s *ResourceInUseException) Error() string
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 (s *ResourceInUseException) Message() string
Message returns the exception's message.
func (s *ResourceInUseException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceInUseException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceInUseException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
We can't find that resource. Check the information that you've provided and try again.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
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 (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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".