|
12 | 12 | "uid":"sagemaker-edge-2020-09-23"
|
13 | 13 | },
|
14 | 14 | "operations":{
|
| 15 | + "GetDeployments":{ |
| 16 | + "name":"GetDeployments", |
| 17 | + "http":{ |
| 18 | + "method":"POST", |
| 19 | + "requestUri":"/GetDeployments" |
| 20 | + }, |
| 21 | + "input":{"shape":"GetDeploymentsRequest"}, |
| 22 | + "output":{"shape":"GetDeploymentsResult"}, |
| 23 | + "errors":[ |
| 24 | + {"shape":"InternalServiceException"} |
| 25 | + ], |
| 26 | + "documentation":"<p>Use to get the active deployments from a device.</p>" |
| 27 | + }, |
15 | 28 | "GetDeviceRegistration":{
|
16 | 29 | "name":"GetDeviceRegistration",
|
17 | 30 | "http":{
|
|
44 | 57 | "max":1000,
|
45 | 58 | "min":1
|
46 | 59 | },
|
| 60 | + "Checksum":{ |
| 61 | + "type":"structure", |
| 62 | + "members":{ |
| 63 | + "Type":{ |
| 64 | + "shape":"ChecksumType", |
| 65 | + "documentation":"<p>The type of the checksum.</p>" |
| 66 | + }, |
| 67 | + "Sum":{ |
| 68 | + "shape":"ChecksumString", |
| 69 | + "documentation":"<p>The checksum of the model.</p>" |
| 70 | + } |
| 71 | + }, |
| 72 | + "documentation":"<p>Information about the checksum of a model deployed on a device.</p>" |
| 73 | + }, |
| 74 | + "ChecksumString":{ |
| 75 | + "type":"string", |
| 76 | + "max":63, |
| 77 | + "min":1, |
| 78 | + "pattern":"^[a-z0-9](-*[a-z0-9])*$" |
| 79 | + }, |
| 80 | + "ChecksumType":{ |
| 81 | + "type":"string", |
| 82 | + "enum":["SHA1"] |
| 83 | + }, |
| 84 | + "Definition":{ |
| 85 | + "type":"structure", |
| 86 | + "members":{ |
| 87 | + "ModelHandle":{ |
| 88 | + "shape":"EntityName", |
| 89 | + "documentation":"<p>The unique model handle.</p>" |
| 90 | + }, |
| 91 | + "S3Url":{ |
| 92 | + "shape":"S3Uri", |
| 93 | + "documentation":"<p>The absolute S3 location of the model.</p>" |
| 94 | + }, |
| 95 | + "Checksum":{ |
| 96 | + "shape":"Checksum", |
| 97 | + "documentation":"<p>The checksum information of the model.</p>" |
| 98 | + }, |
| 99 | + "State":{ |
| 100 | + "shape":"ModelState", |
| 101 | + "documentation":"<p>The desired state of the model.</p>" |
| 102 | + } |
| 103 | + }, |
| 104 | + "documentation":"<p/>" |
| 105 | + }, |
| 106 | + "Definitions":{ |
| 107 | + "type":"list", |
| 108 | + "member":{"shape":"Definition"} |
| 109 | + }, |
| 110 | + "DeploymentModel":{ |
| 111 | + "type":"structure", |
| 112 | + "members":{ |
| 113 | + "ModelHandle":{ |
| 114 | + "shape":"EntityName", |
| 115 | + "documentation":"<p>The unique handle of the model.</p>" |
| 116 | + }, |
| 117 | + "ModelName":{ |
| 118 | + "shape":"ModelName", |
| 119 | + "documentation":"<p>The name of the model.</p>" |
| 120 | + }, |
| 121 | + "ModelVersion":{ |
| 122 | + "shape":"Version", |
| 123 | + "documentation":"<p>The version of the model.</p>" |
| 124 | + }, |
| 125 | + "DesiredState":{ |
| 126 | + "shape":"ModelState", |
| 127 | + "documentation":"<p>The desired state of the model.</p>" |
| 128 | + }, |
| 129 | + "State":{ |
| 130 | + "shape":"ModelState", |
| 131 | + "documentation":"<p>Returns the current state of the model.</p>" |
| 132 | + }, |
| 133 | + "Status":{ |
| 134 | + "shape":"DeploymentStatus", |
| 135 | + "documentation":"<p>Returns the deployment status of the model.</p>" |
| 136 | + }, |
| 137 | + "StatusReason":{ |
| 138 | + "shape":"String", |
| 139 | + "documentation":"<p>Returns the error message for the deployment status result.</p>" |
| 140 | + }, |
| 141 | + "RollbackFailureReason":{ |
| 142 | + "shape":"String", |
| 143 | + "documentation":"<p>Returns the error message if there is a rollback.</p>" |
| 144 | + } |
| 145 | + }, |
| 146 | + "documentation":"<p/>" |
| 147 | + }, |
| 148 | + "DeploymentModels":{ |
| 149 | + "type":"list", |
| 150 | + "member":{"shape":"DeploymentModel"} |
| 151 | + }, |
| 152 | + "DeploymentResult":{ |
| 153 | + "type":"structure", |
| 154 | + "members":{ |
| 155 | + "DeploymentName":{ |
| 156 | + "shape":"EntityName", |
| 157 | + "documentation":"<p>The name and unique ID of the deployment.</p>" |
| 158 | + }, |
| 159 | + "DeploymentStatus":{ |
| 160 | + "shape":"EntityName", |
| 161 | + "documentation":"<p>Returns the bucket error code.</p>" |
| 162 | + }, |
| 163 | + "DeploymentStatusMessage":{ |
| 164 | + "shape":"String", |
| 165 | + "documentation":"<p>Returns the detailed error message.</p>" |
| 166 | + }, |
| 167 | + "DeploymentStartTime":{ |
| 168 | + "shape":"Timestamp", |
| 169 | + "documentation":"<p>The timestamp of when the deployment was started on the agent.</p>" |
| 170 | + }, |
| 171 | + "DeploymentEndTime":{ |
| 172 | + "shape":"Timestamp", |
| 173 | + "documentation":"<p>The timestamp of when the deployment was ended, and the agent got the deployment results.</p>" |
| 174 | + }, |
| 175 | + "DeploymentModels":{ |
| 176 | + "shape":"DeploymentModels", |
| 177 | + "documentation":"<p>Returns a list of models deployed on the agent.</p>" |
| 178 | + } |
| 179 | + }, |
| 180 | + "documentation":"<p>Information about the result of a deployment on an edge device that is registered with SageMaker Edge Manager.</p>" |
| 181 | + }, |
| 182 | + "DeploymentStatus":{ |
| 183 | + "type":"string", |
| 184 | + "enum":[ |
| 185 | + "SUCCESS", |
| 186 | + "FAIL" |
| 187 | + ] |
| 188 | + }, |
| 189 | + "DeploymentType":{ |
| 190 | + "type":"string", |
| 191 | + "enum":["Model"] |
| 192 | + }, |
47 | 193 | "DeviceFleetName":{
|
48 | 194 | "type":"string",
|
49 | 195 | "max":63,
|
|
67 | 213 | "min":1,
|
68 | 214 | "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9\\/])*$"
|
69 | 215 | },
|
| 216 | + "EdgeDeployment":{ |
| 217 | + "type":"structure", |
| 218 | + "members":{ |
| 219 | + "DeploymentName":{ |
| 220 | + "shape":"EntityName", |
| 221 | + "documentation":"<p>The name and unique ID of the deployment.</p>" |
| 222 | + }, |
| 223 | + "Type":{ |
| 224 | + "shape":"DeploymentType", |
| 225 | + "documentation":"<p>The type of the deployment.</p>" |
| 226 | + }, |
| 227 | + "FailureHandlingPolicy":{ |
| 228 | + "shape":"FailureHandlingPolicy", |
| 229 | + "documentation":"<p>Determines whether to rollback to previous configuration if deployment fails.</p>" |
| 230 | + }, |
| 231 | + "Definitions":{ |
| 232 | + "shape":"Definitions", |
| 233 | + "documentation":"<p>Returns a list of Definition objects.</p>" |
| 234 | + } |
| 235 | + }, |
| 236 | + "documentation":"<p>Information about a deployment on an edge device that is registered with SageMaker Edge Manager.</p>" |
| 237 | + }, |
| 238 | + "EdgeDeployments":{ |
| 239 | + "type":"list", |
| 240 | + "member":{"shape":"EdgeDeployment"} |
| 241 | + }, |
70 | 242 | "EdgeMetric":{
|
71 | 243 | "type":"structure",
|
72 | 244 | "members":{
|
|
93 | 265 | "type":"list",
|
94 | 266 | "member":{"shape":"EdgeMetric"}
|
95 | 267 | },
|
| 268 | + "EntityName":{ |
| 269 | + "type":"string", |
| 270 | + "max":63, |
| 271 | + "min":1, |
| 272 | + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" |
| 273 | + }, |
96 | 274 | "ErrorMessage":{"type":"string"},
|
| 275 | + "FailureHandlingPolicy":{ |
| 276 | + "type":"string", |
| 277 | + "enum":[ |
| 278 | + "ROLLBACK_ON_FAILURE", |
| 279 | + "DO_NOTHING" |
| 280 | + ] |
| 281 | + }, |
| 282 | + "GetDeploymentsRequest":{ |
| 283 | + "type":"structure", |
| 284 | + "required":[ |
| 285 | + "DeviceName", |
| 286 | + "DeviceFleetName" |
| 287 | + ], |
| 288 | + "members":{ |
| 289 | + "DeviceName":{ |
| 290 | + "shape":"DeviceName", |
| 291 | + "documentation":"<p>The unique name of the device you want to get the configuration of active deployments from.</p>" |
| 292 | + }, |
| 293 | + "DeviceFleetName":{ |
| 294 | + "shape":"DeviceFleetName", |
| 295 | + "documentation":"<p>The name of the fleet that the device belongs to.</p>" |
| 296 | + } |
| 297 | + } |
| 298 | + }, |
| 299 | + "GetDeploymentsResult":{ |
| 300 | + "type":"structure", |
| 301 | + "members":{ |
| 302 | + "Deployments":{ |
| 303 | + "shape":"EdgeDeployments", |
| 304 | + "documentation":"<p>Returns a list of the configurations of the active deployments on the device.</p>" |
| 305 | + } |
| 306 | + } |
| 307 | + }, |
97 | 308 | "GetDeviceRegistrationRequest":{
|
98 | 309 | "type":"structure",
|
99 | 310 | "required":[
|
|
129 | 340 | "members":{
|
130 | 341 | "Message":{"shape":"ErrorMessage"}
|
131 | 342 | },
|
132 |
| - "documentation":"<p>An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.</p>", |
| 343 | + "documentation":"<p>An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.</p>", |
133 | 344 | "exception":true
|
134 | 345 | },
|
135 | 346 | "Metric":{
|
|
170 | 381 | "min":4,
|
171 | 382 | "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$"
|
172 | 383 | },
|
| 384 | + "ModelState":{ |
| 385 | + "type":"string", |
| 386 | + "enum":[ |
| 387 | + "DEPLOY", |
| 388 | + "UNDEPLOY" |
| 389 | + ] |
| 390 | + }, |
173 | 391 | "Models":{
|
174 | 392 | "type":"list",
|
175 | 393 | "member":{"shape":"Model"}
|
176 | 394 | },
|
| 395 | + "S3Uri":{ |
| 396 | + "type":"string", |
| 397 | + "max":1024, |
| 398 | + "pattern":"^s3://([^/]+)/?(.*)$" |
| 399 | + }, |
177 | 400 | "SendHeartbeatRequest":{
|
178 | 401 | "type":"structure",
|
179 | 402 | "required":[
|
|
201 | 424 | "DeviceFleetName":{
|
202 | 425 | "shape":"DeviceFleetName",
|
203 | 426 | "documentation":"<p>The name of the fleet that the device belongs to.</p>"
|
| 427 | + }, |
| 428 | + "DeploymentResult":{ |
| 429 | + "shape":"DeploymentResult", |
| 430 | + "documentation":"<p>Returns the result of a deployment on the device.</p>" |
204 | 431 | }
|
205 | 432 | }
|
206 | 433 | },
|
| 434 | + "String":{"type":"string"}, |
207 | 435 | "Timestamp":{"type":"timestamp"},
|
208 | 436 | "Value":{"type":"double"},
|
209 | 437 | "Version":{
|
|
0 commit comments