Documentation

Overview

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

Provides APIs for creating and managing Amazon Forecast resources.

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

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

Using the Client

To contact Amazon Forecast Query 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 Query Service client ForecastQueryService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/forecastqueryservice/#New

Index

Constants

View Source
const (

	// ErrCodeInvalidInputException for service response error code
	// "InvalidInputException".
	//
	// The value is invalid or is too long.
	ErrCodeInvalidInputException = "InvalidInputException"

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

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

	// 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 that resource. Check the information that you've provided and
	// try again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source
const (
	ServiceName = "forecastquery" // Name of service.
	EndpointsID = ServiceName     // ID to lookup a service endpoint with.
	ServiceID   = "forecastquery" // ServiceID is a unique identifier of a specific service.
)

    Service information constants

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type DataPoint

    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 (DataPoint) GoString

      func (s DataPoint) GoString() string

        GoString returns the string representation

        func (*DataPoint) SetTimestamp

        func (s *DataPoint) SetTimestamp(v string) *DataPoint

          SetTimestamp sets the Timestamp field's value.

          func (*DataPoint) SetValue

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

            SetValue sets the Value field's value.

            func (DataPoint) String

            func (s DataPoint) String() string

              String returns the string representation

              type Forecast

              type Forecast struct {
              
              	// The forecast.
              	//
              	// The string of the string-to-array map is one of the following values:
              	//
              	//    * p10
              	//
              	//    * p50
              	//
              	//    * p90
              	Predictions map[string][]*DataPoint `type:"map"`
              	// contains filtered or unexported fields
              }

                Provides information about a forecast. Returned as part of the QueryForecast response.

                func (Forecast) GoString

                func (s Forecast) GoString() string

                  GoString returns the string representation

                  func (*Forecast) SetPredictions

                  func (s *Forecast) SetPredictions(v map[string][]*DataPoint) *Forecast

                    SetPredictions sets the Predictions field's value.

                    func (Forecast) String

                    func (s Forecast) String() string

                      String returns the string representation

                      type ForecastQueryService

                      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

                          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 (*ForecastQueryService) QueryForecast

                            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 (*ForecastQueryService) QueryForecastRequest

                            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 (*ForecastQueryService) QueryForecastWithContext

                              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.

                                type InvalidInputException

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

                                      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

                                                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

                                                    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

                                                      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

                                                                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 requests per second 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

                                                                      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

                                                                                type QueryForecastInput

                                                                                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 (QueryForecastInput) GoString

                                                                                func (s QueryForecastInput) GoString() string

                                                                                  GoString returns the string representation

                                                                                  func (*QueryForecastInput) SetEndDate

                                                                                  func (s *QueryForecastInput) SetEndDate(v string) *QueryForecastInput

                                                                                    SetEndDate sets the EndDate field's value.

                                                                                    func (*QueryForecastInput) SetFilters

                                                                                    func (s *QueryForecastInput) SetFilters(v map[string]*string) *QueryForecastInput

                                                                                      SetFilters sets the Filters field's value.

                                                                                      func (*QueryForecastInput) SetForecastArn

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

                                                                                        SetForecastArn sets the ForecastArn field's value.

                                                                                        func (*QueryForecastInput) SetNextToken

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

                                                                                          SetNextToken sets the NextToken field's value.

                                                                                          func (*QueryForecastInput) SetStartDate

                                                                                          func (s *QueryForecastInput) SetStartDate(v string) *QueryForecastInput

                                                                                            SetStartDate sets the StartDate field's value.

                                                                                            func (QueryForecastInput) String

                                                                                            func (s QueryForecastInput) String() string

                                                                                              String returns the string representation

                                                                                              func (*QueryForecastInput) Validate

                                                                                              func (s *QueryForecastInput) Validate() error

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

                                                                                                type QueryForecastOutput

                                                                                                type QueryForecastOutput struct {
                                                                                                
                                                                                                	// The forecast.
                                                                                                	Forecast *Forecast `type:"structure"`
                                                                                                	// contains filtered or unexported fields
                                                                                                }

                                                                                                func (QueryForecastOutput) GoString

                                                                                                func (s QueryForecastOutput) GoString() string

                                                                                                  GoString returns the string representation

                                                                                                  func (*QueryForecastOutput) SetForecast

                                                                                                  func (s *QueryForecastOutput) SetForecast(v *Forecast) *QueryForecastOutput

                                                                                                    SetForecast sets the Forecast field's value.

                                                                                                    func (QueryForecastOutput) String

                                                                                                    func (s QueryForecastOutput) String() string

                                                                                                      String returns the string representation

                                                                                                      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

                                                                                                            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

                                                                                                                      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 that resource. Check the information that you've provided and try again.

                                                                                                                        func (*ResourceNotFoundException) Code

                                                                                                                          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

                                                                                                                            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

                                                                                                                                      Directories

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