@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Amazon Sagemaker Edge Manager
@version 2020-09-23
@auth AWS SigV4
@endpoints 3
@toc GetDeployments(1), GetDeviceRegistration(1), SendHeartbeat(1)

@group GetDeployments
@endpoint POST /GetDeployments
@required {DeviceName: str, DeviceFleetName: str}
@returns(200) {Deployments: [EdgeDeployment]?}

@endgroup

@group GetDeviceRegistration
@endpoint POST /GetDeviceRegistration
@required {DeviceName: str, DeviceFleetName: str}
@returns(200) {DeviceRegistration: str?, CacheTTL: str?}

@endgroup

@group SendHeartbeat
@endpoint POST /SendHeartbeat
@required {AgentVersion: str, DeviceName: str, DeviceFleetName: str}
@optional {AgentMetrics: [EdgeMetric], Models: [Model], DeploymentResult: DeploymentResult}

@endgroup

@end