SageMakerMetricsClient

Index > SageMakerMetrics > SageMakerMetricsClient

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

SageMakerMetricsClient

Type annotations and code completion for boto3.client("sagemaker-metrics"). boto3 documentation

# SageMakerMetricsClient usage example

from boto3.session import Session
from mypy_boto3_sagemaker_metrics.client import SageMakerMetricsClient

def get_sagemaker-metrics_client() -> SageMakerMetricsClient:
    return Session().client("sagemaker-metrics")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("sagemaker-metrics").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("sagemaker-metrics")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_sagemaker_metrics.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

batch_get_metrics

Used to retrieve training metrics from SageMaker.

Type annotations and code completion for boto3.client("sagemaker-metrics").batch_get_metrics method. boto3 documentation

# batch_get_metrics method definition

def batch_get_metrics(
    self,
    *,
    MetricQueries: Sequence[MetricQueryTypeDef],  # (1)
) -> BatchGetMetricsResponseTypeDef:  # (2)
    ...

1. See MetricQueryTypeDef
2. See BatchGetMetricsResponseTypeDef

# batch_get_metrics method usage example with argument unpacking

kwargs: BatchGetMetricsRequestRequestTypeDef = {  # (1)
    "MetricQueries": ...,
}

parent.batch_get_metrics(**kwargs)

1. See BatchGetMetricsRequestRequestTypeDef

batch_put_metrics

Used to ingest training metrics into SageMaker.

Type annotations and code completion for boto3.client("sagemaker-metrics").batch_put_metrics method. boto3 documentation

# batch_put_metrics method definition

def batch_put_metrics(
    self,
    *,
    TrialComponentName: str,
    MetricData: Sequence[RawMetricDataTypeDef],  # (1)
) -> BatchPutMetricsResponseTypeDef:  # (2)
    ...

1. See RawMetricDataTypeDef
2. See BatchPutMetricsResponseTypeDef

# batch_put_metrics method usage example with argument unpacking

kwargs: BatchPutMetricsRequestRequestTypeDef = {  # (1)
    "TrialComponentName": ...,
    "MetricData": ...,
}

parent.batch_put_metrics(**kwargs)

1. See BatchPutMetricsRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("sagemaker-metrics").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("sagemaker-metrics").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("sagemaker-metrics").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...