SagemakerEdgeManagerClient

Index > SagemakerEdgeManager > SagemakerEdgeManagerClient

Auto-generated documentation for SagemakerEdgeManager type annotations stubs module types-aiobotocore-sagemaker-edge.

SagemakerEdgeManagerClient

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

SagemakerEdgeManagerClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_sagemaker_edge.client import SagemakerEdgeManagerClient

session = get_session()
async with session.create_client("sagemaker-edge") as client:
    client: SagemakerEdgeManagerClient

Exceptions

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

SagemakerEdgeManagerClient.exceptions usage example

async with session.create_client("sagemaker-edge") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.InternalServiceException,
    ) as e:
        print(e)

SagemakerEdgeManagerClient usage type checking example

from types_aiobotocore_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 session.create_client("sagemaker-edge").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 session.create_client("sagemaker-edge").close method. boto3 documentation

# close method definition

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

generate_presigned_url

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

Type annotations and code completion for session.create_client("sagemaker-edge").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:
    ...

get_deployments

Use to get the active deployments from a device.

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

# get_deployments method definition

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

1. See GetDeploymentsResultTypeDef

# get_deployments method usage example with argument unpacking

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 session.create_client("sagemaker-edge").get_device_registration method. boto3 documentation

# get_device_registration method definition

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

1. See GetDeviceRegistrationResultTypeDef

# get_device_registration method usage example with argument unpacking

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 session.create_client("sagemaker-edge").send_heartbeat method. boto3 documentation

# send_heartbeat method definition

await 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

# send_heartbeat method usage example with argument unpacking

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

parent.send_heartbeat(**kwargs)

1. See SendHeartbeatRequestRequestTypeDef

__aenter__

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

# __aenter__ method definition

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

__aexit__

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

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...