send_heartbeat `async` ¶

send_heartbeat(
    *,
    config_overrides: Optional[AsyncSagemakerEdgeClientConfig] = None,
    agent_metrics: Optional[EdgeMetrics] = None,
    models: Optional[Models] = None,
    agent_version: Optional[Version] = None,
    device_name: Optional[DeviceName] = None,
    device_fleet_name: Optional[DeviceFleetName] = None,
    deployment_result: Optional[DeploymentResult] = None,
) -> None

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

Parameters:

agent_metrics (Optional[EdgeMetrics], default: None ) –

For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
models (Optional[Models], default: None ) –

Returns a list of models deployed on the the device.
agent_version (Optional[Version], default: None ) –

Returns the version of the agent.
device_name (Optional[DeviceName], default: None ) –

The unique name of the device.
device_fleet_name (Optional[DeviceFleetName], default: None ) –

The name of the fleet that the device belongs to.
deployment_result (Optional[DeploymentResult], default: None ) –

Returns the result of a deployment on the device.

Raises:

InternalServiceException –

An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_sagemaker_edge/_services/async_sagemaker_edge.py

async def send_heartbeat(
    self,
    *,
    config_overrides: Optional[AsyncSagemakerEdgeClientConfig] = None,
    agent_metrics: Optional[
        "capo_sagemaker_edge.types.edge_metrics.EdgeMetrics"
    ] = None,
    models: Optional["capo_sagemaker_edge.types.models.Models"] = None,
    agent_version: Optional["capo_sagemaker_edge.types.version.Version"] = None,
    device_name: Optional[
        "capo_sagemaker_edge.types.device_name.DeviceName"
    ] = None,
    device_fleet_name: Optional[
        "capo_sagemaker_edge.types.device_fleet_name.DeviceFleetName"
    ] = None,
    deployment_result: Optional[
        "capo_sagemaker_edge.types.deployment_result.DeploymentResult"
    ] = None,
) -> None:
    """<p>Use to get the current status of devices registered on SageMaker Edge Manager.</p>

    Args:
        agent_metrics: <p>For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.</p>
        models: <p>Returns a list of models deployed on the the device.</p>
        agent_version: <p>Returns the version of the agent.</p>
        device_name: <p>The unique name of the device.</p>
        device_fleet_name: <p>The name of the fleet that the device belongs to.</p>
        deployment_result: <p>Returns the result of a deployment on the device.</p>

    Raises:
        capo_sagemaker_edge.errors.internal_service_exception.InternalServiceException: <p>An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.</p>
        capo_sagemaker_edge.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker_edge.types.send_heartbeat_request.SendHeartbeatRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_sagemaker_edge._operations.amazon_sage_maker_edge.send_heartbeat

        (
            output,
            http_response,
        ) = await capo_sagemaker_edge._operations.amazon_sage_maker_edge.send_heartbeat.async_send_heartbeat(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendHeartbeat")
    )
    input_: capo_sagemaker_edge.types.send_heartbeat_request.SendHeartbeatRequest = {}
    if agent_metrics is not None:
        input_["agent_metrics"] = agent_metrics
    if models is not None:
        input_["models"] = models
    if agent_version is not None:
        input_["agent_version"] = agent_version
    if device_name is not None:
        input_["device_name"] = device_name
    if device_fleet_name is not None:
        input_["device_fleet_name"] = device_fleet_name
    if deployment_result is not None:
        input_["deployment_result"] = deployment_result

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

send_heartbeat async ¶

send_heartbeat `async` ¶