1{
2  "version":"2.0",
3  "metadata":{
4    "apiVersion":"2022-09-30",
5    "endpointPrefix":"metrics.sagemaker",
6    "protocol":"rest-json",
7    "serviceAbbreviation":"SageMaker Metrics",
8    "serviceFullName":"Amazon SageMaker Metrics Service",
9    "serviceId":"SageMaker Metrics",
10    "signatureVersion":"v4",
11    "signingName":"sagemaker",
12    "uid":"sagemaker-metrics-2022-09-30"
13  },
14  "operations":{
15    "BatchPutMetrics":{
16      "name":"BatchPutMetrics",
17      "http":{
18        "method":"PUT",
19        "requestUri":"/BatchPutMetrics"
20      },
21      "input":{"shape":"BatchPutMetricsRequest"},
22      "output":{"shape":"BatchPutMetricsResponse"},
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>"
24    }
25  },
26  "shapes":{
27    "BatchPutMetricsError":{
28      "type":"structure",
29      "members":{
30        "Code":{
31          "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 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>"
33        },
34        "MetricIndex":{
35          "shape":"Integer",
36          "documentation":"<p>An index that corresponds to the metric in the request.</p>"
37        }
38      },
39      "documentation":"<p>An error that occured when putting the metric data.</p>"
40    },
41    "BatchPutMetricsErrorList":{
42      "type":"list",
43      "member":{"shape":"BatchPutMetricsError"},
44      "max":10,
45      "min":1
46    },
47    "BatchPutMetricsRequest":{
48      "type":"structure",
49      "required":[
50        "TrialComponentName",
51        "MetricData"
52      ],
53      "members":{
54        "TrialComponentName":{
55          "shape":"ExperimentEntityName",
56          "documentation":"<p>The name of the Trial Component to associate with the metrics.</p>"
57        },
58        "MetricData":{
59          "shape":"RawMetricDataList",
60          "documentation":"<p>A list of raw metric values to put.</p>"
61        }
62      }
63    },
64    "BatchPutMetricsResponse":{
65      "type":"structure",
66      "members":{
67        "Errors":{
68          "shape":"BatchPutMetricsErrorList",
69          "documentation":"<p>Lists any errors that occur when inserting metric data.</p>"
70        }
71      }
72    },
73    "Double":{"type":"double"},
74    "ExperimentEntityName":{
75      "type":"string",
76      "max":120,
77      "min":1,
78      "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}"
79    },
80    "Integer":{"type":"integer"},
81    "MetricName":{
82      "type":"string",
83      "max":255,
84      "min":1,
85      "pattern":".+"
86    },
87    "PutMetricsErrorCode":{
88      "type":"string",
89      "enum":[
90        "METRIC_LIMIT_EXCEEDED",
91        "INTERNAL_ERROR",
92        "VALIDATION_ERROR",
93        "CONFLICT_ERROR"
94      ]
95    },
96    "RawMetricData":{
97      "type":"structure",
98      "required":[
99        "MetricName",
100        "Timestamp",
101        "Value"
102      ],
103      "members":{
104        "MetricName":{
105          "shape":"MetricName",
106          "documentation":"<p>The name of the metric.</p>"
107        },
108        "Timestamp":{
109          "shape":"Timestamp",
110          "documentation":"<p>The time that the metric was recorded.</p>"
111        },
112        "Step":{
113          "shape":"Step",
114          "documentation":"<p>The metric step (epoch). </p>"
115        },
116        "Value":{
117          "shape":"Double",
118          "documentation":"<p>The metric value.</p>"
119        }
120      },
121      "documentation":"<p>The raw metric data to associate with the resource.</p>"
122    },
123    "RawMetricDataList":{
124      "type":"list",
125      "member":{"shape":"RawMetricData"},
126      "max":10,
127      "min":1
128    },
129    "Step":{
130      "type":"integer",
131      "min":0
132    },
133    "Timestamp":{"type":"timestamp"}
134  },
135  "documentation":"<p>Contains all data plane API operations and data types for Amazon SageMaker Metrics. Use these APIs to put and retrieve (get) features related to your training run.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_metrics_BatchPutMetrics.html\">BatchPutMetrics</a> </p> </li> </ul>"
136}
137