Skip to content

Type definitions#

Index > SageMakerMetrics > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef Union usage example

from mypy_boto3_sagemaker_metrics.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

MetricQueryTypeDef#

# MetricQueryTypeDef TypedDict usage example

from mypy_boto3_sagemaker_metrics.type_defs import MetricQueryTypeDef


def get_value() -> MetricQueryTypeDef:
    return {
        "MetricName": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_sagemaker_metrics.type_defs import MetricQueryResultTypeDef


def get_value() -> MetricQueryResultTypeDef:
    return {
        "Status": ...,
    }


# MetricQueryResultTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_sagemaker_metrics.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

BatchPutMetricsErrorTypeDef#

# BatchPutMetricsErrorTypeDef TypedDict usage example

from mypy_boto3_sagemaker_metrics.type_defs import BatchPutMetricsErrorTypeDef


def get_value() -> BatchPutMetricsErrorTypeDef:
    return {
        "Code": ...,
    }


# BatchPutMetricsErrorTypeDef definition

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

BatchGetMetricsRequestTypeDef#

# BatchGetMetricsRequestTypeDef TypedDict usage example

from mypy_boto3_sagemaker_metrics.type_defs import BatchGetMetricsRequestTypeDef


def get_value() -> BatchGetMetricsRequestTypeDef:
    return {
        "MetricQueries": ...,
    }


# BatchGetMetricsRequestTypeDef definition

class BatchGetMetricsRequestTypeDef(TypedDict):
    MetricQueries: Sequence[MetricQueryTypeDef],  # (1)
  1. See Sequence[MetricQueryTypeDef]

BatchGetMetricsResponseTypeDef#

# BatchGetMetricsResponseTypeDef TypedDict usage example

from mypy_boto3_sagemaker_metrics.type_defs import BatchGetMetricsResponseTypeDef


def get_value() -> BatchGetMetricsResponseTypeDef:
    return {
        "MetricQueryResults": ...,
    }


# BatchGetMetricsResponseTypeDef definition

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

BatchPutMetricsResponseTypeDef#

# BatchPutMetricsResponseTypeDef TypedDict usage example

from mypy_boto3_sagemaker_metrics.type_defs import BatchPutMetricsResponseTypeDef


def get_value() -> BatchPutMetricsResponseTypeDef:
    return {
        "Errors": ...,
    }


# BatchPutMetricsResponseTypeDef definition

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

RawMetricDataTypeDef#

# RawMetricDataTypeDef TypedDict usage example

from mypy_boto3_sagemaker_metrics.type_defs import RawMetricDataTypeDef


def get_value() -> RawMetricDataTypeDef:
    return {
        "MetricName": ...,
    }


# RawMetricDataTypeDef definition

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

BatchPutMetricsRequestTypeDef#

# BatchPutMetricsRequestTypeDef TypedDict usage example

from mypy_boto3_sagemaker_metrics.type_defs import BatchPutMetricsRequestTypeDef


def get_value() -> BatchPutMetricsRequestTypeDef:
    return {
        "TrialComponentName": ...,
    }


# BatchPutMetricsRequestTypeDef definition

class BatchPutMetricsRequestTypeDef(TypedDict):
    TrialComponentName: str,
    MetricData: Sequence[RawMetricDataTypeDef],  # (1)
  1. See Sequence[RawMetricDataTypeDef]