SageMakerMetricsClient

Index > SageMakerMetrics > SageMakerMetricsClient

Auto-generated documentation for SageMakerMetrics type annotations stubs module types-aiobotocore-sagemaker-metrics.

SageMakerMetricsClient

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

# SageMakerMetricsClient usage example

from aioboto3.session import Session
from types_aiobotocore_sagemaker_metrics.client import SageMakerMetricsClient

session = Session()
async with session.client("sagemaker-metrics") as client:
    client: SageMakerMetricsClient

Exceptions

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

# SageMakerMetricsClient.exceptions usage example

async with session.client("sagemaker-metrics") as client:
    try:
        do_something(client)
    except (
            client.exceptions.ClientError,
    ) as e:
        print(e)

# SageMakerMetricsClient.exceptions type checking example

from types_aiobotocore_sagemaker_metrics.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

# generate_presigned_url method definition

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

batch_get_metrics

Used to retrieve training metrics from SageMaker.

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

# batch_get_metrics method definition

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

1. See Sequence[MetricQueryTypeDef]
2. See BatchGetMetricsResponseTypeDef

# batch_get_metrics method usage example with argument unpacking

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

parent.batch_get_metrics(**kwargs)

1. See BatchGetMetricsRequestTypeDef

batch_put_metrics

Used to ingest training metrics into SageMaker.

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

# batch_put_metrics method definition

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

1. See Sequence[RawMetricDataTypeDef]
2. See BatchPutMetricsResponseTypeDef

# batch_put_metrics method usage example with argument unpacking

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

parent.batch_put_metrics(**kwargs)

1. See BatchPutMetricsRequestTypeDef

__aenter__

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

# __aenter__ method definition

await def __aenter__(
    self,
) -> Self:
    ...

__aexit__

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

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Type[BaseException] | None,
    exc_val: BaseException | None,
    exc_tb: types.TracebackType | None,
) -> None:
    ...