Skip to content

Commit 3719f5a

Browse files
author
AWS
committed
Amazon SageMaker Metrics Service Update: Update SageMaker Metrics documentation.
1 parent 71bbf0f commit 3719f5a

File tree

3 files changed

+55
-49
lines changed

3 files changed

+55
-49
lines changed

‎.changes/next-release/feature-AmazonSageMakerMetricsService-273d461.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon SageMaker Metrics Service",
4+
"contributor": "",
5+
"description": "Update SageMaker Metrics documentation."
6+
}

‎services/sagemakermetrics/src/main/resources/codegen-resources/endpoint-tests.json‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
},
1010
"params": {
1111
"UseFIPS": true,
12-
"UseDualStack": true,
13-
"Region": "us-gov-east-1"
12+
"Region": "us-gov-east-1",
13+
"UseDualStack": true
1414
}
1515
},
1616
{
@@ -22,8 +22,8 @@
2222
},
2323
"params": {
2424
"UseFIPS": true,
25-
"UseDualStack": false,
26-
"Region": "us-gov-east-1"
25+
"Region": "us-gov-east-1",
26+
"UseDualStack": false
2727
}
2828
},
2929
{
@@ -35,8 +35,8 @@
3535
},
3636
"params": {
3737
"UseFIPS": false,
38-
"UseDualStack": true,
39-
"Region": "us-gov-east-1"
38+
"Region": "us-gov-east-1",
39+
"UseDualStack": true
4040
}
4141
},
4242
{
@@ -48,8 +48,8 @@
4848
},
4949
"params": {
5050
"UseFIPS": false,
51-
"UseDualStack": false,
52-
"Region": "us-gov-east-1"
51+
"Region": "us-gov-east-1",
52+
"UseDualStack": false
5353
}
5454
},
5555
{
@@ -61,8 +61,8 @@
6161
},
6262
"params": {
6363
"UseFIPS": true,
64-
"UseDualStack": true,
65-
"Region": "cn-north-1"
64+
"Region": "cn-north-1",
65+
"UseDualStack": true
6666
}
6767
},
6868
{
@@ -74,8 +74,8 @@
7474
},
7575
"params": {
7676
"UseFIPS": true,
77-
"UseDualStack": false,
78-
"Region": "cn-north-1"
77+
"Region": "cn-north-1",
78+
"UseDualStack": false
7979
}
8080
},
8181
{
@@ -87,8 +87,8 @@
8787
},
8888
"params": {
8989
"UseFIPS": false,
90-
"UseDualStack": true,
91-
"Region": "cn-north-1"
90+
"Region": "cn-north-1",
91+
"UseDualStack": true
9292
}
9393
},
9494
{
@@ -100,8 +100,8 @@
100100
},
101101
"params": {
102102
"UseFIPS": false,
103-
"UseDualStack": false,
104-
"Region": "cn-north-1"
103+
"Region": "cn-north-1",
104+
"UseDualStack": false
105105
}
106106
},
107107
{
@@ -111,8 +111,8 @@
111111
},
112112
"params": {
113113
"UseFIPS": true,
114-
"UseDualStack": true,
115-
"Region": "us-iso-east-1"
114+
"Region": "us-iso-east-1",
115+
"UseDualStack": true
116116
}
117117
},
118118
{
@@ -124,8 +124,8 @@
124124
},
125125
"params": {
126126
"UseFIPS": true,
127-
"UseDualStack": false,
128-
"Region": "us-iso-east-1"
127+
"Region": "us-iso-east-1",
128+
"UseDualStack": false
129129
}
130130
},
131131
{
@@ -135,8 +135,8 @@
135135
},
136136
"params": {
137137
"UseFIPS": false,
138-
"UseDualStack": true,
139-
"Region": "us-iso-east-1"
138+
"Region": "us-iso-east-1",
139+
"UseDualStack": true
140140
}
141141
},
142142
{
@@ -148,8 +148,8 @@
148148
},
149149
"params": {
150150
"UseFIPS": false,
151-
"UseDualStack": false,
152-
"Region": "us-iso-east-1"
151+
"Region": "us-iso-east-1",
152+
"UseDualStack": false
153153
}
154154
},
155155
{
@@ -161,8 +161,8 @@
161161
},
162162
"params": {
163163
"UseFIPS": true,
164-
"UseDualStack": true,
165-
"Region": "us-east-1"
164+
"Region": "us-east-1",
165+
"UseDualStack": true
166166
}
167167
},
168168
{
@@ -174,8 +174,8 @@
174174
},
175175
"params": {
176176
"UseFIPS": true,
177-
"UseDualStack": false,
178-
"Region": "us-east-1"
177+
"Region": "us-east-1",
178+
"UseDualStack": false
179179
}
180180
},
181181
{
@@ -187,8 +187,8 @@
187187
},
188188
"params": {
189189
"UseFIPS": false,
190-
"UseDualStack": true,
191-
"Region": "us-east-1"
190+
"Region": "us-east-1",
191+
"UseDualStack": true
192192
}
193193
},
194194
{
@@ -200,8 +200,8 @@
200200
},
201201
"params": {
202202
"UseFIPS": false,
203-
"UseDualStack": false,
204-
"Region": "us-east-1"
203+
"Region": "us-east-1",
204+
"UseDualStack": false
205205
}
206206
},
207207
{
@@ -211,8 +211,8 @@
211211
},
212212
"params": {
213213
"UseFIPS": true,
214-
"UseDualStack": true,
215-
"Region": "us-isob-east-1"
214+
"Region": "us-isob-east-1",
215+
"UseDualStack": true
216216
}
217217
},
218218
{
@@ -224,8 +224,8 @@
224224
},
225225
"params": {
226226
"UseFIPS": true,
227-
"UseDualStack": false,
228-
"Region": "us-isob-east-1"
227+
"Region": "us-isob-east-1",
228+
"UseDualStack": false
229229
}
230230
},
231231
{
@@ -235,8 +235,8 @@
235235
},
236236
"params": {
237237
"UseFIPS": false,
238-
"UseDualStack": true,
239-
"Region": "us-isob-east-1"
238+
"Region": "us-isob-east-1",
239+
"UseDualStack": true
240240
}
241241
},
242242
{
@@ -248,8 +248,8 @@
248248
},
249249
"params": {
250250
"UseFIPS": false,
251-
"UseDualStack": false,
252-
"Region": "us-isob-east-1"
251+
"Region": "us-isob-east-1",
252+
"UseDualStack": false
253253
}
254254
},
255255
{
@@ -261,8 +261,8 @@
261261
},
262262
"params": {
263263
"UseFIPS": false,
264-
"UseDualStack": false,
265264
"Region": "us-east-1",
265+
"UseDualStack": false,
266266
"Endpoint": "https://example.com"
267267
}
268268
},
@@ -273,8 +273,8 @@
273273
},
274274
"params": {
275275
"UseFIPS": true,
276-
"UseDualStack": false,
277276
"Region": "us-east-1",
277+
"UseDualStack": false,
278278
"Endpoint": "https://example.com"
279279
}
280280
},
@@ -285,8 +285,8 @@
285285
},
286286
"params": {
287287
"UseFIPS": false,
288-
"UseDualStack": true,
289288
"Region": "us-east-1",
289+
"UseDualStack": true,
290290
"Endpoint": "https://example.com"
291291
}
292292
}

‎services/sagemakermetrics/src/main/resources/codegen-resources/service-2.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
},
2121
"input":{"shape":"BatchPutMetricsRequest"},
2222
"output":{"shape":"BatchPutMetricsResponse"},
23-
"documentation":"<p>Used to ingest training metrics into SageMaker which can be visualized in SageMaker Studio and retrieved with the <code>GetMetrics</code> API. </p>"
23+
"documentation":"<p>Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and retrieved with the <code>GetMetrics</code> API. </p>"
2424
}
2525
},
2626
"shapes":{
@@ -29,7 +29,7 @@
2929
"members":{
3030
"Code":{
3131
"shape":"PutMetricsErrorCode",
32-
"documentation":"<p>The error code of an error that occured when attempting to put metrics.</p> <ul> <li> <p> <code>METRIC_LIMIT_EXCEEDED</code> - The max amount of metrics per resource has been exceeded.</p> </li> <li> <p> <code>INTERNAL_ERROR</code> - An internal error occured.</p> </li> <li> <p> <code>VALIDATION_ERROR</code> - The metric data failed validation.</p> </li> <li> <p> <code>CONFLICT_ERROR</code> - Multiple requests attempted to modify the same data simultaneously.</p> </li> </ul>"
32+
"documentation":"<p>The error code of an error that occured when attempting to put metrics.</p> <ul> <li> <p> <code>METRIC_LIMIT_EXCEEDED</code>: The maximum amount of metrics per resource is exceeded.</p> </li> <li> <p> <code>INTERNAL_ERROR</code>: An internal error occured.</p> </li> <li> <p> <code>VALIDATION_ERROR</code>: The metric data failed validation.</p> </li> <li> <p> <code>CONFLICT_ERROR</code>: Multiple requests attempted to modify the same data simultaneously.</p> </li> </ul>"
3333
},
3434
"MetricIndex":{
3535
"shape":"Integer",
@@ -53,7 +53,7 @@
5353
"members":{
5454
"TrialComponentName":{
5555
"shape":"ExperimentEntityName",
56-
"documentation":"<p>The name of Trial Component to associate the metrics with.</p>"
56+
"documentation":"<p>The name of the Trial Component to associate with the metrics.</p>"
5757
},
5858
"MetricData":{
5959
"shape":"RawMetricDataList",
@@ -66,7 +66,7 @@
6666
"members":{
6767
"Errors":{
6868
"shape":"BatchPutMetricsErrorList",
69-
"documentation":"<p>Any errors that occur when inserting metric data will appear in this.</p>"
69+
"documentation":"<p>Lists any errors that occur when inserting metric data.</p>"
7070
}
7171
}
7272
},
@@ -107,11 +107,11 @@
107107
},
108108
"Timestamp":{
109109
"shape":"Timestamp",
110-
"documentation":"<p>The time when the metric was recorded.</p>"
110+
"documentation":"<p>The time that the metric was recorded.</p>"
111111
},
112112
"Step":{
113113
"shape":"Step",
114-
"documentation":"<p>Metric step (aka Epoch). </p>"
114+
"documentation":"<p>The metric step (epoch). </p>"
115115
},
116116
"Value":{
117117
"shape":"Double",

0 commit comments

Comments
 (0)