1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package forecast
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/forecast/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// 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
func (c *Client) DescribeWhatIfForecast(ctx context.Context, params *DescribeWhatIfForecastInput, optFns ...func(*Options)) (*DescribeWhatIfForecastOutput, error) {
if params == nil {
params = &DescribeWhatIfForecastInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeWhatIfForecast", params, optFns, c.addOperationDescribeWhatIfForecastMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeWhatIfForecastOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeWhatIfForecastInput struct {
// The Amazon Resource Name (ARN) of the what-if forecast that you are interested
// in.
//
// This member is required.
WhatIfForecastArn *string
noSmithyDocumentSerde
}
type DescribeWhatIfForecastOutput struct {
// When the what-if forecast was created.
CreationTime *time.Time
// The approximate time remaining to complete the what-if forecast, in minutes.
EstimatedTimeRemainingInMinutes *int64
// 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
// 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
// If an error occurred, an informational message about the error.
Message *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
// An array of S3Config , Schema , and Format elements that describe the
// replacement time series.
TimeSeriesReplacementsDataSource *types.TimeSeriesReplacementsDataSource
// An array of Action and TimeSeriesConditions elements that describe what
// transformations were applied to which time series.
TimeSeriesTransformations []types.TimeSeriesTransformation
// The Amazon Resource Name (ARN) of the what-if analysis that contains this
// forecast.
WhatIfAnalysisArn *string
// The Amazon Resource Name (ARN) of the what-if forecast.
WhatIfForecastArn *string
// The name of the what-if forecast.
WhatIfForecastName *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeWhatIfForecastMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeWhatIfForecast{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeWhatIfForecast{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeWhatIfForecast"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeWhatIfForecastValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeWhatIfForecast(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeWhatIfForecast(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeWhatIfForecast",
}
}
|
