/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / sagemakeredge.d.ts
sagemakeredge.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class SagemakerEdge extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: SagemakerEdge.Types.ClientConfiguration) 13 config: Config & SagemakerEdge.Types.ClientConfiguration; 14 /** 15 * Use to check if a device is registered with SageMaker Edge Manager. 16 */ 17 getDeviceRegistration(params: SagemakerEdge.Types.GetDeviceRegistrationRequest, callback?: (err: AWSError, data: SagemakerEdge.Types.GetDeviceRegistrationResult) => void): Request<SagemakerEdge.Types.GetDeviceRegistrationResult, AWSError>; 18 /** 19 * Use to check if a device is registered with SageMaker Edge Manager. 20 */ 21 getDeviceRegistration(callback?: (err: AWSError, data: SagemakerEdge.Types.GetDeviceRegistrationResult) => void): Request<SagemakerEdge.Types.GetDeviceRegistrationResult, AWSError>; 22 /** 23 * Use to get the current status of devices registered on SageMaker Edge Manager. 24 */ 25 sendHeartbeat(params: SagemakerEdge.Types.SendHeartbeatRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 26 /** 27 * Use to get the current status of devices registered on SageMaker Edge Manager. 28 */ 29 sendHeartbeat(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 30 } 31 declare namespace SagemakerEdge { 32 export type CacheTTLSeconds = string; 33 export type DeviceFleetName = string; 34 export type DeviceName = string; 35 export type DeviceRegistration = string; 36 export type Dimension = string; 37 export interface EdgeMetric { 38 /** 39 * The dimension of metrics published. 40 */ 41 Dimension?: Dimension; 42 /** 43 * Returns the name of the metric. 44 */ 45 MetricName?: Metric; 46 /** 47 * Returns the value of the metric. 48 */ 49 Value?: Value; 50 /** 51 * Timestamp of when the metric was requested. 52 */ 53 Timestamp?: Timestamp; 54 } 55 export type EdgeMetrics = EdgeMetric[]; 56 export interface GetDeviceRegistrationRequest { 57 /** 58 * The unique name of the device you want to get the registration status from. 59 */ 60 DeviceName: DeviceName; 61 /** 62 * The name of the fleet that the device belongs to. 63 */ 64 DeviceFleetName: DeviceFleetName; 65 } 66 export interface GetDeviceRegistrationResult { 67 /** 68 * Describes if the device is currently registered with SageMaker Edge Manager. 69 */ 70 DeviceRegistration?: DeviceRegistration; 71 /** 72 * The amount of time, in seconds, that the registration status is stored on the device’s cache before it is refreshed. 73 */ 74 CacheTTL?: CacheTTLSeconds; 75 } 76 export type Metric = string; 77 export interface Model { 78 /** 79 * The name of the model. 80 */ 81 ModelName?: ModelName; 82 /** 83 * The version of the model. 84 */ 85 ModelVersion?: Version; 86 /** 87 * The timestamp of the last data sample taken. 88 */ 89 LatestSampleTime?: Timestamp; 90 /** 91 * The timestamp of the last inference that was made. 92 */ 93 LatestInference?: Timestamp; 94 /** 95 * Information required for model metrics. 96 */ 97 ModelMetrics?: EdgeMetrics; 98 } 99 export type ModelName = string; 100 export type Models = Model[]; 101 export interface SendHeartbeatRequest { 102 /** 103 * For internal use. Returns a list of SageMaker Edge Manager agent operating metrics. 104 */ 105 AgentMetrics?: EdgeMetrics; 106 /** 107 * Returns a list of models deployed on the the device. 108 */ 109 Models?: Models; 110 /** 111 * Returns the version of the agent. 112 */ 113 AgentVersion: Version; 114 /** 115 * The unique name of the device. 116 */ 117 DeviceName: DeviceName; 118 /** 119 * The name of the fleet that the device belongs to. 120 */ 121 DeviceFleetName: DeviceFleetName; 122 } 123 export type Timestamp = Date; 124 export type Value = number; 125 export type Version = string; 126 /** 127 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 128 */ 129 export type apiVersion = "2020-09-23"|"latest"|string; 130 export interface ClientApiVersions { 131 /** 132 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 133 */ 134 apiVersion?: apiVersion; 135 } 136 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 137 /** 138 * Contains interfaces for use with the SagemakerEdge client. 139 */ 140 export import Types = SagemakerEdge; 141 } 142 export = SagemakerEdge;