<?php
// This file was auto-generated from sdk-root/src/data/sagemaker-metrics/2022-09-30/docs-2.json
return [ '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>', ], ], ],];
