Type definitions

Index > SageMakerMetrics > Type definitions

Auto-generated documentation for SageMakerMetrics type annotations stubs module mypy-boto3-sagemaker-metrics.

TimestampTypeDef

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

MetricQueryTypeDef

# MetricQueryTypeDef definition

class MetricQueryTypeDef(TypedDict):
    MetricName: str,
    ResourceArn: str,
    MetricStat: MetricStatisticType,  # (1)
    Period: PeriodType,  # (2)
    XAxisType: XAxisTypeType,  # (3)
    Start: NotRequired[int],
    End: NotRequired[int],

1. See MetricStatisticType
2. See PeriodType
3. See XAxisTypeType

MetricQueryResultTypeDef

# MetricQueryResultTypeDef definition

class MetricQueryResultTypeDef(TypedDict):
    Status: MetricQueryResultStatusType,  # (1)
    XAxisValues: List[int],
    MetricValues: List[float],
    Message: NotRequired[str],

1. See MetricQueryResultStatusType

ResponseMetadataTypeDef

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BatchPutMetricsErrorTypeDef

# BatchPutMetricsErrorTypeDef definition

class BatchPutMetricsErrorTypeDef(TypedDict):
    Code: NotRequired[PutMetricsErrorCodeType],  # (1)
    MetricIndex: NotRequired[int],

1. See PutMetricsErrorCodeType

BatchGetMetricsRequestRequestTypeDef

# BatchGetMetricsRequestRequestTypeDef definition

class BatchGetMetricsRequestRequestTypeDef(TypedDict):
    MetricQueries: Sequence[MetricQueryTypeDef],  # (1)

1. See MetricQueryTypeDef

BatchGetMetricsResponseTypeDef

# BatchGetMetricsResponseTypeDef definition

class BatchGetMetricsResponseTypeDef(TypedDict):
    MetricQueryResults: List[MetricQueryResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MetricQueryResultTypeDef
2. See ResponseMetadataTypeDef

BatchPutMetricsResponseTypeDef

# BatchPutMetricsResponseTypeDef definition

class BatchPutMetricsResponseTypeDef(TypedDict):
    Errors: List[BatchPutMetricsErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See BatchPutMetricsErrorTypeDef
2. See ResponseMetadataTypeDef

RawMetricDataTypeDef

# RawMetricDataTypeDef definition

class RawMetricDataTypeDef(TypedDict):
    MetricName: str,
    Timestamp: Union[datetime, str],
    Value: float,
    Step: NotRequired[int],

BatchPutMetricsRequestRequestTypeDef

# BatchPutMetricsRequestRequestTypeDef definition

class BatchPutMetricsRequestRequestTypeDef(TypedDict):
    TrialComponentName: str,
    MetricData: Sequence[RawMetricDataTypeDef],  # (1)

1. See RawMetricDataTypeDef