{
  "version": "2.0",
  "service": "<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>",
  "operations": {
    "BatchGetMetrics": "<p>Used to retrieve training metrics from SageMaker.</p>",
    "BatchPutMetrics": "<p>Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio. </p>"
  },
  "shapes": {
    "BatchGetMetricsRequest": {
      "base": null,
      "refs": {}
    },
    "BatchGetMetricsResponse": {
      "base": null,
      "refs": {}
    },
    "BatchPutMetricsError": {
      "base": "<p>An error that occured when putting the metric data.</p>",
      "refs": {
        "BatchPutMetricsErrorList$member": null
      }
    },
    "BatchPutMetricsErrorList": {
      "base": null,
      "refs": {
        "BatchPutMetricsResponse$Errors": "<p>Lists any errors that occur when inserting metric data.</p>"
      }
    },
    "BatchPutMetricsRequest": {
      "base": null,
      "refs": {}
    },
    "BatchPutMetricsResponse": {
      "base": null,
      "refs": {}
    },
    "Double": {
      "base": null,
      "refs": {
        "MetricValues$member": null,
        "RawMetricData$Value": "<p>The metric value.</p>"
      }
    },
    "ExperimentEntityName": {
      "base": null,
      "refs": {
        "BatchPutMetricsRequest$TrialComponentName": "<p>The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.</p>"
      }
    },
    "Integer": {
      "base": null,
      "refs": {
        "BatchPutMetricsError$MetricIndex": "<p>An index that corresponds to the metric in the request.</p>"
      }
    },
    "Long": {
      "base": null,
      "refs": {
        "MetricQuery$Start": "<p>The start time of metrics to retrieve.</p>",
        "MetricQuery$End": "<p>The end time of metrics to retrieve.</p>",
        "XAxisValues$member": null
      }
    },
    "Message": {
      "base": null,
      "refs": {
        "MetricQueryResult$Message": "<p>A message describing the status of the metric query.</p>"
      }
    },
    "MetricName": {
      "base": null,
      "refs": {
        "MetricQuery$MetricName": "<p>The name of the metric to retrieve.</p>",
        "RawMetricData$MetricName": "<p>The name of the metric.</p>"
      }
    },
    "MetricQuery": {
      "base": "<p>Specifies a query to retrieve training metrics from SageMaker.</p>",
      "refs": {
        "MetricQueryList$member": null
      }
    },
    "MetricQueryList": {
      "base": null,
      "refs": {
        "BatchGetMetricsRequest$MetricQueries": "<p>Queries made to retrieve training metrics from SageMaker.</p>"
      }
    },
    "MetricQueryResult": {
      "base": "<p>The result of a query to retrieve training metrics from SageMaker.</p>",
      "refs": {
        "MetricQueryResultList$member": null
      }
    },
    "MetricQueryResultList": {
      "base": null,
      "refs": {
        "BatchGetMetricsResponse$MetricQueryResults": "<p>The results of a query to retrieve training metrics from SageMaker.</p>"
      }
    },
    "MetricQueryResultStatus": {
      "base": null,
      "refs": {
        "MetricQueryResult$Status": "<p>The status of the metric query.</p>"
      }
    },
    "MetricStatistic": {
      "base": null,
      "refs": {
        "MetricQuery$MetricStat": "<p>The metrics stat type of metrics to retrieve.</p>"
      }
    },
    "MetricValues": {
      "base": null,
      "refs": {
        "MetricQueryResult$MetricValues": "<p>The metric values retrieved by the query.</p>"
      }
    },
    "Period": {
      "base": null,
      "refs": {
        "MetricQuery$Period": "<p>The time period of metrics to retrieve.</p>"
      }
    },
    "PutMetricsErrorCode": {
      "base": null,
      "refs": {
        "BatchPutMetricsError$Code": "<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>"
      }
    },
    "RawMetricData": {
      "base": "<p>The raw metric data to associate with the resource.</p>",
      "refs": {
        "RawMetricDataList$member": null
      }
    },
    "RawMetricDataList": {
      "base": null,
      "refs": {
        "BatchPutMetricsRequest$MetricData": "<p>A list of raw metric values to put.</p>"
      }
    },
    "SageMakerResourceArn": {
      "base": null,
      "refs": {
        "MetricQuery$ResourceArn": "<p>The ARN of the SageMaker resource to retrieve metrics for.</p>"
      }
    },
    "Step": {
      "base": null,
      "refs": {
        "RawMetricData$Step": "<p>The metric step (epoch). </p>"
      }
    },
    "Timestamp": {
      "base": null,
      "refs": {
        "RawMetricData$Timestamp": "<p>The time that the metric was recorded.</p>"
      }
    },
    "XAxisType": {
      "base": null,
      "refs": {
        "MetricQuery$XAxisType": "<p>The x-axis type of metrics to retrieve.</p>"
      }
    },
    "XAxisValues": {
      "base": null,
      "refs": {
        "MetricQueryResult$XAxisValues": "<p>The values for the x-axis of the metrics.</p>"
      }
    }
  }
}