codegen-resources.service-2.json Maven / Gradle / Ivy
Show all versions of sagemakeredge Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2020-09-23",
"endpointPrefix":"edge.sagemaker",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"Amazon Sagemaker Edge Manager",
"serviceId":"Sagemaker Edge",
"signatureVersion":"v4",
"signingName":"sagemaker",
"uid":"sagemaker-edge-2020-09-23"
},
"operations":{
"GetDeviceRegistration":{
"name":"GetDeviceRegistration",
"http":{
"method":"POST",
"requestUri":"/GetDeviceRegistration"
},
"input":{"shape":"GetDeviceRegistrationRequest"},
"output":{"shape":"GetDeviceRegistrationResult"},
"errors":[
{"shape":"InternalServiceException"}
],
"documentation":"Use to check if a device is registered with SageMaker Edge Manager.
"
},
"SendHeartbeat":{
"name":"SendHeartbeat",
"http":{
"method":"POST",
"requestUri":"/SendHeartbeat"
},
"input":{"shape":"SendHeartbeatRequest"},
"errors":[
{"shape":"InternalServiceException"}
],
"documentation":"Use to get the current status of devices registered on SageMaker Edge Manager.
"
}
},
"shapes":{
"CacheTTLSeconds":{
"type":"string",
"max":1000,
"min":1
},
"DeviceFleetName":{
"type":"string",
"max":63,
"min":1,
"pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$"
},
"DeviceName":{
"type":"string",
"max":63,
"min":1,
"pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$"
},
"DeviceRegistration":{
"type":"string",
"max":1000,
"min":1
},
"Dimension":{
"type":"string",
"max":1000,
"min":1,
"pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9\\/])*$"
},
"EdgeMetric":{
"type":"structure",
"members":{
"Dimension":{
"shape":"Dimension",
"documentation":"The dimension of metrics published.
"
},
"MetricName":{
"shape":"Metric",
"documentation":"Returns the name of the metric.
"
},
"Value":{
"shape":"Value",
"documentation":"Returns the value of the metric.
"
},
"Timestamp":{
"shape":"Timestamp",
"documentation":"Timestamp of when the metric was requested.
"
}
},
"documentation":"Information required for edge device metrics.
"
},
"EdgeMetrics":{
"type":"list",
"member":{"shape":"EdgeMetric"}
},
"ErrorMessage":{"type":"string"},
"GetDeviceRegistrationRequest":{
"type":"structure",
"required":[
"DeviceName",
"DeviceFleetName"
],
"members":{
"DeviceName":{
"shape":"DeviceName",
"documentation":"The unique name of the device you want to get the registration status from.
"
},
"DeviceFleetName":{
"shape":"DeviceFleetName",
"documentation":"The name of the fleet that the device belongs to.
"
}
}
},
"GetDeviceRegistrationResult":{
"type":"structure",
"members":{
"DeviceRegistration":{
"shape":"DeviceRegistration",
"documentation":"Describes if the device is currently registered with SageMaker Edge Manager.
"
},
"CacheTTL":{
"shape":"CacheTTLSeconds",
"documentation":"The amount of time, in seconds, that the registration status is stored on the device’s cache before it is refreshed.
"
}
}
},
"InternalServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.
",
"exception":true
},
"Metric":{
"type":"string",
"max":100,
"min":4,
"pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$"
},
"Model":{
"type":"structure",
"members":{
"ModelName":{
"shape":"ModelName",
"documentation":"The name of the model.
"
},
"ModelVersion":{
"shape":"Version",
"documentation":"The version of the model.
"
},
"LatestSampleTime":{
"shape":"Timestamp",
"documentation":"The timestamp of the last data sample taken.
"
},
"LatestInference":{
"shape":"Timestamp",
"documentation":"The timestamp of the last inference that was made.
"
},
"ModelMetrics":{
"shape":"EdgeMetrics",
"documentation":"Information required for model metrics.
"
}
},
"documentation":"Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.
"
},
"ModelName":{
"type":"string",
"max":255,
"min":4,
"pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$"
},
"Models":{
"type":"list",
"member":{"shape":"Model"}
},
"SendHeartbeatRequest":{
"type":"structure",
"required":[
"AgentVersion",
"DeviceName",
"DeviceFleetName"
],
"members":{
"AgentMetrics":{
"shape":"EdgeMetrics",
"documentation":"For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
"
},
"Models":{
"shape":"Models",
"documentation":"Returns a list of models deployed on the the device.
"
},
"AgentVersion":{
"shape":"Version",
"documentation":"Returns the version of the agent.
"
},
"DeviceName":{
"shape":"DeviceName",
"documentation":"The unique name of the device.
"
},
"DeviceFleetName":{
"shape":"DeviceFleetName",
"documentation":"The name of the fleet that the device belongs to.
"
}
}
},
"Timestamp":{"type":"timestamp"},
"Value":{"type":"double"},
"Version":{
"type":"string",
"max":64,
"min":1,
"pattern":"[a-zA-Z0-9\\ \\_\\.]+"
}
},
"documentation":"SageMaker Edge Manager dataplane service for communicating with active agents.
"
}