SagemakerEdgeManagerClient

Index > SagemakerEdgeManager > SagemakerEdgeManagerClient

Auto-generated documentation for SagemakerEdgeManager type annotations stubs module mypy-boto3-sagemaker-edge.

SagemakerEdgeManagerClient

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

Usage example

from boto3.session import Session
from mypy_boto3_sagemaker_edge.client import SagemakerEdgeManagerClient

def get_sagemaker-edge_client() -> SagemakerEdgeManagerClient:
    return Session().client("sagemaker-edge")

Exceptions

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

Usage example

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

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

Type checking example

from mypy_boto3_sagemaker_edge.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

Method definition

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

close

Closes underlying endpoint connections.

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

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-edge").generate_presigned_url method. boto3 documentation

Method definition

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

get_deployments

Use to get the active deployments from a device.

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

Method definition

def get_deployments(
    self,
    *,
    DeviceName: str,
    DeviceFleetName: str,
) -> GetDeploymentsResultTypeDef:  # (1)
    ...

1. See GetDeploymentsResultTypeDef

Usage example with kwargs

kwargs: GetDeploymentsRequestRequestTypeDef = {  # (1)
    "DeviceName": ...,
    "DeviceFleetName": ...,
}

parent.get_deployments(**kwargs)

1. See GetDeploymentsRequestRequestTypeDef

get_device_registration

Use to check if a device is registered with SageMaker Edge Manager.

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

Method definition

def get_device_registration(
    self,
    *,
    DeviceName: str,
    DeviceFleetName: str,
) -> GetDeviceRegistrationResultTypeDef:  # (1)
    ...

1. See GetDeviceRegistrationResultTypeDef

Usage example with kwargs

kwargs: GetDeviceRegistrationRequestRequestTypeDef = {  # (1)
    "DeviceName": ...,
    "DeviceFleetName": ...,
}

parent.get_device_registration(**kwargs)

1. See GetDeviceRegistrationRequestRequestTypeDef

send_heartbeat

Use to get the current status of devices registered on SageMaker Edge Manager.

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

Method definition

def send_heartbeat(
    self,
    *,
    AgentVersion: str,
    DeviceName: str,
    DeviceFleetName: str,
    AgentMetrics: Sequence[EdgeMetricTypeDef] = ...,  # (1)
    Models: Sequence[ModelTypeDef] = ...,  # (2)
    DeploymentResult: DeploymentResultTypeDef = ...,  # (3)
) -> EmptyResponseMetadataTypeDef:  # (4)
    ...

1. See EdgeMetricTypeDef
2. See ModelTypeDef
3. See DeploymentResultTypeDef
4. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: SendHeartbeatRequestRequestTypeDef = {  # (1)
    "AgentVersion": ...,
    "DeviceName": ...,
    "DeviceFleetName": ...,
}

parent.send_heartbeat(**kwargs)

1. See SendHeartbeatRequestRequestTypeDef