-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_DescribePredictor.go
235 lines (198 loc) · 7.86 KB
/
api_op_DescribePredictor.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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
// 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"
)
// 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.
func (c *Client) DescribePredictor(ctx context.Context, params *DescribePredictorInput, optFns ...func(*Options)) (*DescribePredictorOutput, error) {
if params == nil {
params = &DescribePredictorInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribePredictor", params, optFns, c.addOperationDescribePredictorMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribePredictorOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribePredictorInput struct {
// The Amazon Resource Name (ARN) of the predictor that you want information about.
//
// This member is required.
PredictorArn *string
noSmithyDocumentSerde
}
type DescribePredictorOutput struct {
// The Amazon Resource Name (ARN) of the algorithm used for model training.
AlgorithmArn *string
// When PerformAutoML is specified, the ARN of the chosen algorithm.
AutoMLAlgorithmArns []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. 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 types.AutoMLOverrideStrategy
// When the model training task was created.
CreationTime *time.Time
// 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 the Identity and Access Management
// (IAM) role that Amazon Forecast can assume to access the key.
EncryptionConfig *types.EncryptionConfig
// The estimated time remaining in minutes for the predictor training job to
// complete.
EstimatedTimeRemainingInMinutes *int64
// 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 *types.EvaluationParameters
// The featurization configuration.
FeaturizationConfig *types.FeaturizationConfig
// The number of time-steps of the forecast. 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 hyperparameter override values for the algorithm.
HPOConfig *types.HyperParameterTuningJobConfig
// Describes the dataset group that contains the data to use to train the
// predictor.
InputDataConfig *types.InputDataConfig
// Whether the predictor was created with CreateAutoPredictor .
IsAutoPredictor *bool
// 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 accuracy metric used to optimize the predictor.
OptimizationMetric types.OptimizationMetric
// Whether the predictor is set to perform AutoML.
PerformAutoML *bool
// Whether the predictor is set to perform hyperparameter optimization (HPO).
PerformHPO *bool
// The ARN of the predictor.
PredictorArn *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 *types.PredictorExecutionDetails
// The name of the predictor.
PredictorName *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
// 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
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribePredictorMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribePredictor{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribePredictor{}, 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 = addOpDescribePredictorValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribePredictor(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
}
return nil
}
func newServiceMetadataMiddleware_opDescribePredictor(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "forecast",
OperationName: "DescribePredictor",
}
}