-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_DescribeAutoPredictor.go
211 lines (179 loc) · 6.27 KB
/
api_op_DescribeAutoPredictor.go
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
// Code generated by smithy-go-codegen DO NOT EDIT.
package forecast
import (
"context"
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 a predictor created using the CreateAutoPredictor operation.
func (c *Client) DescribeAutoPredictor(ctx context.Context, params *DescribeAutoPredictorInput, optFns ...func(*Options)) (*DescribeAutoPredictorOutput, error) {
if params == nil {
params = &DescribeAutoPredictorInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeAutoPredictor", params, optFns, c.addOperationDescribeAutoPredictorMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeAutoPredictorOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeAutoPredictorInput struct {
// The Amazon Resource Name (ARN) of the predictor.
//
// This member is required.
PredictorArn *string
noSmithyDocumentSerde
}
type DescribeAutoPredictorOutput struct {
// The timestamp of the CreateAutoPredictor request.
CreationTime *time.Time
// The data configuration for your dataset group and any additional datasets.
DataConfig *types.DataConfig
// An array of the ARNs of the dataset import jobs used to import training data for
// the predictor.
DatasetImportJobArns []string
// 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 *types.EncryptionConfig
// The estimated time remaining in minutes for the predictor training job to
// complete.
EstimatedTimeRemainingInMinutes *int64
// Provides the status and ARN of the Predictor Explainability.
ExplainabilityInfo *types.ExplainabilityInfo
// An array of dimension (field) names that specify the attributes used to group
// your time series.
ForecastDimensions []string
// 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
// The number of time-steps that the model predicts. The forecast horizon is also
// called the prediction length.
ForecastHorizon *int32
// The forecast types used during predictor training. Default value is
// ["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
// In the event of an error, a message detailing the cause of the error.
Message *string
// A object with the Amazon Resource Name (ARN) and status of the monitor resource.
MonitorInfo *types.MonitorInfo
// The accuracy metric used to optimize the predictor.
OptimizationMetric types.OptimizationMetric
// The Amazon Resource Name (ARN) of the predictor
PredictorArn *string
// The name of the predictor.
PredictorName *string
// The ARN and state of the reference predictor. This parameter is only valid for
// retrained or upgraded predictors.
ReferencePredictorSummary *types.ReferencePredictorSummary
// 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
// The time boundary Forecast uses when aggregating data.
TimeAlignmentBoundary *types.TimeAlignmentBoundary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeAutoPredictorMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeAutoPredictor{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeAutoPredictor{}, middleware.After)
if 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 = addHTTPSignerV4Middleware(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); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeAutoPredictorValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeAutoPredictor(options.Region), middleware.Before); 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
}
return nil
}
func newServiceMetadataMiddleware_opDescribeAutoPredictor(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "forecast",
OperationName: "DescribeAutoPredictor",
}
}