github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/sagemaker-edge/2020-09-23/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<p>SageMaker Edge Manager dataplane service for communicating with active agents.</p>",
     4    "operations": {
     5      "GetDeviceRegistration": "<p>Use to check if a device is registered with SageMaker Edge Manager.</p>",
     6      "SendHeartbeat": "<p>Use to get the current status of devices registered on SageMaker Edge Manager.</p>"
     7    },
     8    "shapes": {
     9      "CacheTTLSeconds": {
    10        "base": null,
    11        "refs": {
    12          "GetDeviceRegistrationResult$CacheTTL": "<p>The amount of time, in seconds, that the registration status is stored on the device’s cache before it is refreshed.</p>"
    13        }
    14      },
    15      "DeviceFleetName": {
    16        "base": null,
    17        "refs": {
    18          "GetDeviceRegistrationRequest$DeviceFleetName": "<p>The name of the fleet that the device belongs to.</p>",
    19          "SendHeartbeatRequest$DeviceFleetName": "<p>The name of the fleet that the device belongs to.</p>"
    20        }
    21      },
    22      "DeviceName": {
    23        "base": null,
    24        "refs": {
    25          "GetDeviceRegistrationRequest$DeviceName": "<p>The unique name of the device you want to get the registration status from.</p>",
    26          "SendHeartbeatRequest$DeviceName": "<p>The unique name of the device.</p>"
    27        }
    28      },
    29      "DeviceRegistration": {
    30        "base": null,
    31        "refs": {
    32          "GetDeviceRegistrationResult$DeviceRegistration": "<p>Describes if the device is currently registered with SageMaker Edge Manager.</p>"
    33        }
    34      },
    35      "Dimension": {
    36        "base": null,
    37        "refs": {
    38          "EdgeMetric$Dimension": "<p>The dimension of metrics published.</p>"
    39        }
    40      },
    41      "EdgeMetric": {
    42        "base": "<p>Information required for edge device metrics.</p>",
    43        "refs": {
    44          "EdgeMetrics$member": null
    45        }
    46      },
    47      "EdgeMetrics": {
    48        "base": null,
    49        "refs": {
    50          "Model$ModelMetrics": "<p>Information required for model metrics.</p>",
    51          "SendHeartbeatRequest$AgentMetrics": "<p>For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.</p>"
    52        }
    53      },
    54      "ErrorMessage": {
    55        "base": null,
    56        "refs": {
    57          "InternalServiceException$Message": null
    58        }
    59      },
    60      "GetDeviceRegistrationRequest": {
    61        "base": null,
    62        "refs": {
    63        }
    64      },
    65      "GetDeviceRegistrationResult": {
    66        "base": null,
    67        "refs": {
    68        }
    69      },
    70      "InternalServiceException": {
    71        "base": "<p>An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.</p>",
    72        "refs": {
    73        }
    74      },
    75      "Metric": {
    76        "base": null,
    77        "refs": {
    78          "EdgeMetric$MetricName": "<p>Returns the name of the metric.</p>"
    79        }
    80      },
    81      "Model": {
    82        "base": "<p>Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.</p>",
    83        "refs": {
    84          "Models$member": null
    85        }
    86      },
    87      "ModelName": {
    88        "base": null,
    89        "refs": {
    90          "Model$ModelName": "<p>The name of the model.</p>"
    91        }
    92      },
    93      "Models": {
    94        "base": null,
    95        "refs": {
    96          "SendHeartbeatRequest$Models": "<p>Returns a list of models deployed on the the device.</p>"
    97        }
    98      },
    99      "SendHeartbeatRequest": {
   100        "base": null,
   101        "refs": {
   102        }
   103      },
   104      "Timestamp": {
   105        "base": null,
   106        "refs": {
   107          "EdgeMetric$Timestamp": "<p>Timestamp of when the metric was requested.</p>",
   108          "Model$LatestSampleTime": "<p>The timestamp of the last data sample taken.</p>",
   109          "Model$LatestInference": "<p>The timestamp of the last inference that was made.</p>"
   110        }
   111      },
   112      "Value": {
   113        "base": null,
   114        "refs": {
   115          "EdgeMetric$Value": "<p>Returns the value of the metric.</p>"
   116        }
   117      },
   118      "Version": {
   119        "base": null,
   120        "refs": {
   121          "Model$ModelVersion": "<p>The version of the model.</p>",
   122          "SendHeartbeatRequest$AgentVersion": "<p>Returns the version of the agent.</p>"
   123        }
   124      }
   125    }
   126  }