-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
api.go
355 lines (307 loc) · 11.3 KB
/
api.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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package sagemakermetrics
import (
"fmt"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
)
const opBatchPutMetrics = "BatchPutMetrics"
// BatchPutMetricsRequest generates a "aws/request.Request" representing the
// client's request for the BatchPutMetrics 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 BatchPutMetrics for more information on using the BatchPutMetrics
// 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 BatchPutMetricsRequest method.
// req, resp := client.BatchPutMetricsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-metrics-2022-09-30/BatchPutMetrics
func (c *SageMakerMetrics) BatchPutMetricsRequest(input *BatchPutMetricsInput) (req *request.Request, output *BatchPutMetricsOutput) {
op := &request.Operation{
Name: opBatchPutMetrics,
HTTPMethod: "PUT",
HTTPPath: "/BatchPutMetrics",
}
if input == nil {
input = &BatchPutMetricsInput{}
}
output = &BatchPutMetricsOutput{}
req = c.newRequest(op, input, output)
return
}
// BatchPutMetrics API operation for Amazon SageMaker Metrics Service.
//
// Used to ingest training metrics into SageMaker. These metrics can be visualized
// in SageMaker Studio and retrieved with the GetMetrics API.
//
// 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 SageMaker Metrics Service's
// API operation BatchPutMetrics for usage and error information.
// See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-metrics-2022-09-30/BatchPutMetrics
func (c *SageMakerMetrics) BatchPutMetrics(input *BatchPutMetricsInput) (*BatchPutMetricsOutput, error) {
req, out := c.BatchPutMetricsRequest(input)
return out, req.Send()
}
// BatchPutMetricsWithContext is the same as BatchPutMetrics with the addition of
// the ability to pass a context and additional request options.
//
// See BatchPutMetrics 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 *SageMakerMetrics) BatchPutMetricsWithContext(ctx aws.Context, input *BatchPutMetricsInput, opts ...request.Option) (*BatchPutMetricsOutput, error) {
req, out := c.BatchPutMetricsRequest(input)
req.SetContext(ctx)
req.ApplyOptions(opts...)
return out, req.Send()
}
// An error that occured when putting the metric data.
type BatchPutMetricsError struct {
_ struct{} `type:"structure"`
// The error code of an error that occured when attempting to put metrics.
//
// * METRIC_LIMIT_EXCEEDED: The maximum amount of metrics per resource is
// exceeded.
//
// * INTERNAL_ERROR: An internal error occured.
//
// * VALIDATION_ERROR: The metric data failed validation.
//
// * CONFLICT_ERROR: Multiple requests attempted to modify the same data
// simultaneously.
Code *string `type:"string" enum:"PutMetricsErrorCode"`
// An index that corresponds to the metric in the request.
MetricIndex *int64 `type:"integer"`
}
// 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 BatchPutMetricsError) String() string {
return awsutil.Prettify(s)
}
// 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 BatchPutMetricsError) GoString() string {
return s.String()
}
// SetCode sets the Code field's value.
func (s *BatchPutMetricsError) SetCode(v string) *BatchPutMetricsError {
s.Code = &v
return s
}
// SetMetricIndex sets the MetricIndex field's value.
func (s *BatchPutMetricsError) SetMetricIndex(v int64) *BatchPutMetricsError {
s.MetricIndex = &v
return s
}
type BatchPutMetricsInput struct {
_ struct{} `type:"structure"`
// A list of raw metric values to put.
//
// MetricData is a required field
MetricData []*RawMetricData `min:"1" type:"list" required:"true"`
// The name of the Trial Component to associate with the metrics.
//
// TrialComponentName is a required field
TrialComponentName *string `min:"1" type:"string" required:"true"`
}
// 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 BatchPutMetricsInput) String() string {
return awsutil.Prettify(s)
}
// 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 BatchPutMetricsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *BatchPutMetricsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "BatchPutMetricsInput"}
if s.MetricData == nil {
invalidParams.Add(request.NewErrParamRequired("MetricData"))
}
if s.MetricData != nil && len(s.MetricData) < 1 {
invalidParams.Add(request.NewErrParamMinLen("MetricData", 1))
}
if s.TrialComponentName == nil {
invalidParams.Add(request.NewErrParamRequired("TrialComponentName"))
}
if s.TrialComponentName != nil && len(*s.TrialComponentName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("TrialComponentName", 1))
}
if s.MetricData != nil {
for i, v := range s.MetricData {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "MetricData", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMetricData sets the MetricData field's value.
func (s *BatchPutMetricsInput) SetMetricData(v []*RawMetricData) *BatchPutMetricsInput {
s.MetricData = v
return s
}
// SetTrialComponentName sets the TrialComponentName field's value.
func (s *BatchPutMetricsInput) SetTrialComponentName(v string) *BatchPutMetricsInput {
s.TrialComponentName = &v
return s
}
type BatchPutMetricsOutput struct {
_ struct{} `type:"structure"`
// Lists any errors that occur when inserting metric data.
Errors []*BatchPutMetricsError `min:"1" type:"list"`
}
// 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 BatchPutMetricsOutput) String() string {
return awsutil.Prettify(s)
}
// 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 BatchPutMetricsOutput) GoString() string {
return s.String()
}
// SetErrors sets the Errors field's value.
func (s *BatchPutMetricsOutput) SetErrors(v []*BatchPutMetricsError) *BatchPutMetricsOutput {
s.Errors = v
return s
}
// The raw metric data to associate with the resource.
type RawMetricData struct {
_ struct{} `type:"structure"`
// The name of the metric.
//
// MetricName is a required field
MetricName *string `min:"1" type:"string" required:"true"`
// The metric step (epoch).
Step *int64 `type:"integer"`
// The time that the metric was recorded.
//
// Timestamp is a required field
Timestamp *time.Time `type:"timestamp" required:"true"`
// The metric value.
//
// Value is a required field
Value *float64 `type:"double" required:"true"`
}
// 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 RawMetricData) String() string {
return awsutil.Prettify(s)
}
// 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 RawMetricData) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *RawMetricData) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "RawMetricData"}
if s.MetricName == nil {
invalidParams.Add(request.NewErrParamRequired("MetricName"))
}
if s.MetricName != nil && len(*s.MetricName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("MetricName", 1))
}
if s.Timestamp == nil {
invalidParams.Add(request.NewErrParamRequired("Timestamp"))
}
if s.Value == nil {
invalidParams.Add(request.NewErrParamRequired("Value"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMetricName sets the MetricName field's value.
func (s *RawMetricData) SetMetricName(v string) *RawMetricData {
s.MetricName = &v
return s
}
// SetStep sets the Step field's value.
func (s *RawMetricData) SetStep(v int64) *RawMetricData {
s.Step = &v
return s
}
// SetTimestamp sets the Timestamp field's value.
func (s *RawMetricData) SetTimestamp(v time.Time) *RawMetricData {
s.Timestamp = &v
return s
}
// SetValue sets the Value field's value.
func (s *RawMetricData) SetValue(v float64) *RawMetricData {
s.Value = &v
return s
}
const (
// PutMetricsErrorCodeMetricLimitExceeded is a PutMetricsErrorCode enum value
PutMetricsErrorCodeMetricLimitExceeded = "METRIC_LIMIT_EXCEEDED"
// PutMetricsErrorCodeInternalError is a PutMetricsErrorCode enum value
PutMetricsErrorCodeInternalError = "INTERNAL_ERROR"
// PutMetricsErrorCodeValidationError is a PutMetricsErrorCode enum value
PutMetricsErrorCodeValidationError = "VALIDATION_ERROR"
// PutMetricsErrorCodeConflictError is a PutMetricsErrorCode enum value
PutMetricsErrorCodeConflictError = "CONFLICT_ERROR"
)
// PutMetricsErrorCode_Values returns all elements of the PutMetricsErrorCode enum
func PutMetricsErrorCode_Values() []string {
return []string{
PutMetricsErrorCodeMetricLimitExceeded,
PutMetricsErrorCodeInternalError,
PutMetricsErrorCodeValidationError,
PutMetricsErrorCodeConflictError,
}
}