{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.sagemakermetrics#BatchGetMetrics": { "type": "operation", "input": { "target": "com.amazonaws.sagemakermetrics#BatchGetMetricsRequest" }, "output": { "target": "com.amazonaws.sagemakermetrics#BatchGetMetricsResponse" }, "traits": { "smithy.api#documentation": "
Used to retrieve training metrics from SageMaker.
", "smithy.api#http": { "method": "POST", "uri": "/BatchGetMetrics", "code": 200 } } }, "com.amazonaws.sagemakermetrics#BatchGetMetricsRequest": { "type": "structure", "members": { "MetricQueries": { "target": "com.amazonaws.sagemakermetrics#MetricQueryList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Queries made to retrieve training metrics from SageMaker.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakermetrics#BatchGetMetricsResponse": { "type": "structure", "members": { "MetricQueryResults": { "target": "com.amazonaws.sagemakermetrics#MetricQueryResultList", "traits": { "smithy.api#documentation": "The results of a query to retrieve training metrics from SageMaker.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakermetrics#BatchPutMetrics": { "type": "operation", "input": { "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsRequest" }, "output": { "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsResponse" }, "traits": { "smithy.api#documentation": "Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio.\n
", "smithy.api#http": { "method": "PUT", "uri": "/BatchPutMetrics", "code": 200 } } }, "com.amazonaws.sagemakermetrics#BatchPutMetricsError": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.sagemakermetrics#PutMetricsErrorCode", "traits": { "smithy.api#documentation": "The error code of an error that occured when attempting to put metrics.
\n\n METRIC_LIMIT_EXCEEDED: The maximum amount of metrics per resource is\n exceeded.
\n INTERNAL_ERROR: An internal error occured.
\n VALIDATION_ERROR: The metric data failed validation.
\n CONFLICT_ERROR: Multiple requests attempted to modify the same data\n simultaneously.
An index that corresponds to the metric in the request.
" } } }, "traits": { "smithy.api#documentation": "An error that occured when putting the metric data.
" } }, "com.amazonaws.sagemakermetrics#BatchPutMetricsErrorList": { "type": "list", "member": { "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsError" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.sagemakermetrics#BatchPutMetricsRequest": { "type": "structure", "members": { "TrialComponentName": { "target": "com.amazonaws.sagemakermetrics#ExperimentEntityName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.
", "smithy.api#required": {} } }, "MetricData": { "target": "com.amazonaws.sagemakermetrics#RawMetricDataList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A list of raw metric values to put.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sagemakermetrics#BatchPutMetricsResponse": { "type": "structure", "members": { "Errors": { "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsErrorList", "traits": { "smithy.api#documentation": "Lists any errors that occur when inserting metric data.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sagemakermetrics#Double": { "type": "double" }, "com.amazonaws.sagemakermetrics#ExperimentEntityName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 120 }, "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9]){0,119}$" } }, "com.amazonaws.sagemakermetrics#Integer": { "type": "integer" }, "com.amazonaws.sagemakermetrics#Long": { "type": "long" }, "com.amazonaws.sagemakermetrics#Message": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.sagemakermetrics#MetricName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^.+$" } }, "com.amazonaws.sagemakermetrics#MetricQuery": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.sagemakermetrics#MetricName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the metric to retrieve.
", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.sagemakermetrics#SageMakerResourceArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ARN of the SageMaker resource to retrieve metrics for.
", "smithy.api#required": {} } }, "MetricStat": { "target": "com.amazonaws.sagemakermetrics#MetricStatistic", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The metrics stat type of metrics to retrieve.
", "smithy.api#required": {} } }, "Period": { "target": "com.amazonaws.sagemakermetrics#Period", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The time period of metrics to retrieve.
", "smithy.api#required": {} } }, "XAxisType": { "target": "com.amazonaws.sagemakermetrics#XAxisType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The x-axis type of metrics to retrieve.
", "smithy.api#required": {} } }, "Start": { "target": "com.amazonaws.sagemakermetrics#Long", "traits": { "smithy.api#documentation": "The start time of metrics to retrieve.
" } }, "End": { "target": "com.amazonaws.sagemakermetrics#Long", "traits": { "smithy.api#documentation": "The end time of metrics to retrieve.
" } } }, "traits": { "smithy.api#documentation": "Specifies a query to retrieve training metrics from SageMaker.
" } }, "com.amazonaws.sagemakermetrics#MetricQueryList": { "type": "list", "member": { "target": "com.amazonaws.sagemakermetrics#MetricQuery" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.sagemakermetrics#MetricQueryResult": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.sagemakermetrics#MetricQueryResultStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The status of the metric query.
", "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.sagemakermetrics#Message", "traits": { "smithy.api#documentation": "A message describing the status of the metric query.
" } }, "XAxisValues": { "target": "com.amazonaws.sagemakermetrics#XAxisValues", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The values for the x-axis of the metrics.
", "smithy.api#required": {} } }, "MetricValues": { "target": "com.amazonaws.sagemakermetrics#MetricValues", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The metric values retrieved by the query.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result of a query to retrieve training metrics from SageMaker.
" } }, "com.amazonaws.sagemakermetrics#MetricQueryResultList": { "type": "list", "member": { "target": "com.amazonaws.sagemakermetrics#MetricQueryResult" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.sagemakermetrics#MetricQueryResultStatus": { "type": "enum", "members": { "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Complete" } }, "TRUNCATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Truncated" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InternalError" } }, "VALIDATION_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ValidationError" } } } }, "com.amazonaws.sagemakermetrics#MetricStatistic": { "type": "enum", "members": { "MIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Min" } }, "MAX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Max" } }, "AVG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Avg" } }, "COUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Count" } }, "STD_DEV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StdDev" } }, "LAST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Last" } } } }, "com.amazonaws.sagemakermetrics#MetricValues": { "type": "list", "member": { "target": "com.amazonaws.sagemakermetrics#Double" } }, "com.amazonaws.sagemakermetrics#Period": { "type": "enum", "members": { "ONE_MINUTE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OneMinute" } }, "FIVE_MINUTE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FiveMinute" } }, "ONE_HOUR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OneHour" } }, "ITERATION_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IterationNumber" } } } }, "com.amazonaws.sagemakermetrics#PutMetricsErrorCode": { "type": "enum", "members": { "METRIC_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "METRIC_LIMIT_EXCEEDED" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_ERROR" } }, "VALIDATION_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION_ERROR" } }, "CONFLICT_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONFLICT_ERROR" } } } }, "com.amazonaws.sagemakermetrics#RawMetricData": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.sagemakermetrics#MetricName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the metric.
", "smithy.api#required": {} } }, "Timestamp": { "target": "com.amazonaws.sagemakermetrics#Timestamp", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The time that the metric was recorded.
", "smithy.api#required": {} } }, "Step": { "target": "com.amazonaws.sagemakermetrics#Step", "traits": { "smithy.api#documentation": "The metric step (epoch).\n
" } }, "Value": { "target": "com.amazonaws.sagemakermetrics#Double", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The metric value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The raw metric data to associate with the resource.
" } }, "com.amazonaws.sagemakermetrics#RawMetricDataList": { "type": "list", "member": { "target": "com.amazonaws.sagemakermetrics#RawMetricData" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.sagemakermetrics#SageMakerMetricsService": { "type": "service", "version": "2022-09-30", "operations": [ { "target": "com.amazonaws.sagemakermetrics#BatchGetMetrics" }, { "target": "com.amazonaws.sagemakermetrics#BatchPutMetrics" } ], "traits": { "aws.api#service": { "sdkId": "SageMaker Metrics", "arnNamespace": "sagemaker", "cloudFormationName": "SageMakerMetrics", "cloudTrailEventSource": "sagemakermetrics.amazonaws.com", "endpointPrefix": "metrics.sagemaker" }, "aws.auth#sigv4": { "name": "sagemaker" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Contains all data plane API operations and data types for Amazon SageMaker Metrics. \n Use these APIs to put and retrieve (get) features related to your training run.
\n\n BatchPutMetrics\n
\n