aws-sdk-sagemakeredgemanager 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: b31feb40b755d22f05ed0f817a57479845a244a01d7e6a729e587f0cc4a72609
4
+ data.tar.gz: c2b58357a6082bb143be854dc083cd848ede1dedd0cd4d579695f6d610043ec0
5
+ SHA512:
6
+ metadata.gz: e9e9a7909dc82f684ced45746c8fc48ff2d8c515ef3c5029493a34051adcc048b50fe641ad844dfcf545d496b025fc583f294384c4653fa888d545b134299819
7
+ data.tar.gz: 8b530303ac2e393671a743348da963f193bd177ebb60a0adab83cd0ba85b1f023d97e6921f386ef64f25d78edddb81460e34a019a03db3a081a8daef0e507605
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-sagemakeredgemanager/types'
15
+ require_relative 'aws-sdk-sagemakeredgemanager/client_api'
16
+ require_relative 'aws-sdk-sagemakeredgemanager/client'
17
+ require_relative 'aws-sdk-sagemakeredgemanager/errors'
18
+ require_relative 'aws-sdk-sagemakeredgemanager/resource'
19
+ require_relative 'aws-sdk-sagemakeredgemanager/customizations'
20
+
21
+ # This module provides support for Amazon Sagemaker Edge Manager. This module is available in the
22
+ # `aws-sdk-sagemakeredgemanager` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # sagemaker_edge_manager = Aws::SagemakerEdgeManager::Client.new
31
+ # resp = sagemaker_edge_manager.get_device_registration(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from Amazon Sagemaker Edge Manager are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::SagemakerEdgeManager::Errors::ServiceError
43
+ # # rescues all Amazon Sagemaker Edge Manager API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::SagemakerEdgeManager
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,462 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:sagemakeredgemanager)
34
+
35
+ module Aws::SagemakerEdgeManager
36
+ # An API client for SagemakerEdgeManager. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::SagemakerEdgeManager::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :sagemakeredgemanager
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # Use to check if a device is registered with SageMaker Edge Manager.
331
+ #
332
+ # @option params [required, String] :device_name
333
+ # The unique name of the device you want to get the registration status
334
+ # from.
335
+ #
336
+ # @option params [required, String] :device_fleet_name
337
+ # The name of the fleet that the device belongs to.
338
+ #
339
+ # @return [Types::GetDeviceRegistrationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
340
+ #
341
+ # * {Types::GetDeviceRegistrationResult#device_registration #device_registration} => String
342
+ # * {Types::GetDeviceRegistrationResult#cache_ttl #cache_ttl} => String
343
+ #
344
+ # @example Request syntax with placeholder values
345
+ #
346
+ # resp = client.get_device_registration({
347
+ # device_name: "DeviceName", # required
348
+ # device_fleet_name: "DeviceFleetName", # required
349
+ # })
350
+ #
351
+ # @example Response structure
352
+ #
353
+ # resp.device_registration #=> String
354
+ # resp.cache_ttl #=> String
355
+ #
356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/GetDeviceRegistration AWS API Documentation
357
+ #
358
+ # @overload get_device_registration(params = {})
359
+ # @param [Hash] params ({})
360
+ def get_device_registration(params = {}, options = {})
361
+ req = build_request(:get_device_registration, params)
362
+ req.send_request(options)
363
+ end
364
+
365
+ # Use to get the current status of devices registered on SageMaker Edge
366
+ # Manager.
367
+ #
368
+ # @option params [Array<Types::EdgeMetric>] :agent_metrics
369
+ # For internal use. Returns a list of SageMaker Edge Manager agent
370
+ # operating metrics.
371
+ #
372
+ # @option params [Array<Types::Model>] :models
373
+ # Returns a list of models deployed on the the device.
374
+ #
375
+ # @option params [required, String] :agent_version
376
+ # Returns the version of the agent.
377
+ #
378
+ # @option params [required, String] :device_name
379
+ # The unique name of the device.
380
+ #
381
+ # @option params [required, String] :device_fleet_name
382
+ # The name of the fleet that the device belongs to.
383
+ #
384
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
385
+ #
386
+ # @example Request syntax with placeholder values
387
+ #
388
+ # resp = client.send_heartbeat({
389
+ # agent_metrics: [
390
+ # {
391
+ # dimension: "Dimension",
392
+ # metric_name: "Metric",
393
+ # value: 1.0,
394
+ # timestamp: Time.now,
395
+ # },
396
+ # ],
397
+ # models: [
398
+ # {
399
+ # model_name: "ModelName",
400
+ # model_version: "Version",
401
+ # latest_sample_time: Time.now,
402
+ # latest_inference: Time.now,
403
+ # model_metrics: [
404
+ # {
405
+ # dimension: "Dimension",
406
+ # metric_name: "Metric",
407
+ # value: 1.0,
408
+ # timestamp: Time.now,
409
+ # },
410
+ # ],
411
+ # },
412
+ # ],
413
+ # agent_version: "Version", # required
414
+ # device_name: "DeviceName", # required
415
+ # device_fleet_name: "DeviceFleetName", # required
416
+ # })
417
+ #
418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/SendHeartbeat AWS API Documentation
419
+ #
420
+ # @overload send_heartbeat(params = {})
421
+ # @param [Hash] params ({})
422
+ def send_heartbeat(params = {}, options = {})
423
+ req = build_request(:send_heartbeat, params)
424
+ req.send_request(options)
425
+ end
426
+
427
+ # @!endgroup
428
+
429
+ # @param params ({})
430
+ # @api private
431
+ def build_request(operation_name, params = {})
432
+ handlers = @handlers.for(operation_name)
433
+ context = Seahorse::Client::RequestContext.new(
434
+ operation_name: operation_name,
435
+ operation: config.api.operation(operation_name),
436
+ client: self,
437
+ params: params,
438
+ config: config)
439
+ context[:gem_name] = 'aws-sdk-sagemakeredgemanager'
440
+ context[:gem_version] = '1.0.0'
441
+ Seahorse::Client::Request.new(handlers, context)
442
+ end
443
+
444
+ # @api private
445
+ # @deprecated
446
+ def waiter_names
447
+ []
448
+ end
449
+
450
+ class << self
451
+
452
+ # @api private
453
+ attr_reader :identifier
454
+
455
+ # @api private
456
+ def errors_module
457
+ Errors
458
+ end
459
+
460
+ end
461
+ end
462
+ end
@@ -0,0 +1,109 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::SagemakerEdgeManager
11
+ # @api private
12
+ module ClientApi
13
+
14
+ include Seahorse::Model
15
+
16
+ CacheTTLSeconds = Shapes::StringShape.new(name: 'CacheTTLSeconds')
17
+ DeviceFleetName = Shapes::StringShape.new(name: 'DeviceFleetName')
18
+ DeviceName = Shapes::StringShape.new(name: 'DeviceName')
19
+ DeviceRegistration = Shapes::StringShape.new(name: 'DeviceRegistration')
20
+ Dimension = Shapes::StringShape.new(name: 'Dimension')
21
+ EdgeMetric = Shapes::StructureShape.new(name: 'EdgeMetric')
22
+ EdgeMetrics = Shapes::ListShape.new(name: 'EdgeMetrics')
23
+ ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
24
+ GetDeviceRegistrationRequest = Shapes::StructureShape.new(name: 'GetDeviceRegistrationRequest')
25
+ GetDeviceRegistrationResult = Shapes::StructureShape.new(name: 'GetDeviceRegistrationResult')
26
+ InternalServiceException = Shapes::StructureShape.new(name: 'InternalServiceException')
27
+ Metric = Shapes::StringShape.new(name: 'Metric')
28
+ Model = Shapes::StructureShape.new(name: 'Model')
29
+ ModelName = Shapes::StringShape.new(name: 'ModelName')
30
+ Models = Shapes::ListShape.new(name: 'Models')
31
+ SendHeartbeatRequest = Shapes::StructureShape.new(name: 'SendHeartbeatRequest')
32
+ Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
33
+ Value = Shapes::FloatShape.new(name: 'Value')
34
+ Version = Shapes::StringShape.new(name: 'Version')
35
+
36
+ EdgeMetric.add_member(:dimension, Shapes::ShapeRef.new(shape: Dimension, location_name: "Dimension"))
37
+ EdgeMetric.add_member(:metric_name, Shapes::ShapeRef.new(shape: Metric, location_name: "MetricName"))
38
+ EdgeMetric.add_member(:value, Shapes::ShapeRef.new(shape: Value, location_name: "Value"))
39
+ EdgeMetric.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp"))
40
+ EdgeMetric.struct_class = Types::EdgeMetric
41
+
42
+ EdgeMetrics.member = Shapes::ShapeRef.new(shape: EdgeMetric)
43
+
44
+ GetDeviceRegistrationRequest.add_member(:device_name, Shapes::ShapeRef.new(shape: DeviceName, required: true, location_name: "DeviceName"))
45
+ GetDeviceRegistrationRequest.add_member(:device_fleet_name, Shapes::ShapeRef.new(shape: DeviceFleetName, required: true, location_name: "DeviceFleetName"))
46
+ GetDeviceRegistrationRequest.struct_class = Types::GetDeviceRegistrationRequest
47
+
48
+ GetDeviceRegistrationResult.add_member(:device_registration, Shapes::ShapeRef.new(shape: DeviceRegistration, location_name: "DeviceRegistration"))
49
+ GetDeviceRegistrationResult.add_member(:cache_ttl, Shapes::ShapeRef.new(shape: CacheTTLSeconds, location_name: "CacheTTL"))
50
+ GetDeviceRegistrationResult.struct_class = Types::GetDeviceRegistrationResult
51
+
52
+ InternalServiceException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
53
+ InternalServiceException.struct_class = Types::InternalServiceException
54
+
55
+ Model.add_member(:model_name, Shapes::ShapeRef.new(shape: ModelName, location_name: "ModelName"))
56
+ Model.add_member(:model_version, Shapes::ShapeRef.new(shape: Version, location_name: "ModelVersion"))
57
+ Model.add_member(:latest_sample_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LatestSampleTime"))
58
+ Model.add_member(:latest_inference, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LatestInference"))
59
+ Model.add_member(:model_metrics, Shapes::ShapeRef.new(shape: EdgeMetrics, location_name: "ModelMetrics"))
60
+ Model.struct_class = Types::Model
61
+
62
+ Models.member = Shapes::ShapeRef.new(shape: Model)
63
+
64
+ SendHeartbeatRequest.add_member(:agent_metrics, Shapes::ShapeRef.new(shape: EdgeMetrics, location_name: "AgentMetrics"))
65
+ SendHeartbeatRequest.add_member(:models, Shapes::ShapeRef.new(shape: Models, location_name: "Models"))
66
+ SendHeartbeatRequest.add_member(:agent_version, Shapes::ShapeRef.new(shape: Version, required: true, location_name: "AgentVersion"))
67
+ SendHeartbeatRequest.add_member(:device_name, Shapes::ShapeRef.new(shape: DeviceName, required: true, location_name: "DeviceName"))
68
+ SendHeartbeatRequest.add_member(:device_fleet_name, Shapes::ShapeRef.new(shape: DeviceFleetName, required: true, location_name: "DeviceFleetName"))
69
+ SendHeartbeatRequest.struct_class = Types::SendHeartbeatRequest
70
+
71
+
72
+ # @api private
73
+ API = Seahorse::Model::Api.new.tap do |api|
74
+
75
+ api.version = "2020-09-23"
76
+
77
+ api.metadata = {
78
+ "apiVersion" => "2020-09-23",
79
+ "endpointPrefix" => "edge.sagemaker",
80
+ "jsonVersion" => "1.1",
81
+ "protocol" => "rest-json",
82
+ "serviceFullName" => "Amazon Sagemaker Edge Manager",
83
+ "serviceId" => "Sagemaker Edge",
84
+ "signatureVersion" => "v4",
85
+ "signingName" => "sagemaker",
86
+ "uid" => "sagemaker-edge-2020-09-23",
87
+ }
88
+
89
+ api.add_operation(:get_device_registration, Seahorse::Model::Operation.new.tap do |o|
90
+ o.name = "GetDeviceRegistration"
91
+ o.http_method = "POST"
92
+ o.http_request_uri = "/GetDeviceRegistration"
93
+ o.input = Shapes::ShapeRef.new(shape: GetDeviceRegistrationRequest)
94
+ o.output = Shapes::ShapeRef.new(shape: GetDeviceRegistrationResult)
95
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
96
+ end)
97
+
98
+ api.add_operation(:send_heartbeat, Seahorse::Model::Operation.new.tap do |o|
99
+ o.name = "SendHeartbeat"
100
+ o.http_method = "POST"
101
+ o.http_request_uri = "/SendHeartbeat"
102
+ o.input = Shapes::ShapeRef.new(shape: SendHeartbeatRequest)
103
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
104
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
105
+ end)
106
+ end
107
+
108
+ end
109
+ end
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::SagemakerEdgeManager
11
+
12
+ # When SagemakerEdgeManager returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::SagemakerEdgeManager::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all SagemakerEdgeManager errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::SagemakerEdgeManager::Errors::ServiceError
20
+ # # rescues all SagemakerEdgeManager API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {InternalServiceException}
31
+ #
32
+ # Additionally, error classes are dynamically generated for service errors based on the error code
33
+ # if they are not defined above.
34
+ module Errors
35
+
36
+ extend Aws::Errors::DynamicErrors
37
+
38
+ class InternalServiceException < ServiceError
39
+
40
+ # @param [Seahorse::Client::RequestContext] context
41
+ # @param [String] message
42
+ # @param [Aws::SagemakerEdgeManager::Types::InternalServiceException] data
43
+ def initialize(context, message, data = Aws::EmptyStructure.new)
44
+ super(context, message, data)
45
+ end
46
+
47
+ # @return [String]
48
+ def message
49
+ @message || @data[:message]
50
+ end
51
+ end
52
+
53
+ end
54
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::SagemakerEdgeManager
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,231 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::SagemakerEdgeManager
11
+ module Types
12
+
13
+ # Information required for edge device metrics.
14
+ #
15
+ # @note When making an API call, you may pass EdgeMetric
16
+ # data as a hash:
17
+ #
18
+ # {
19
+ # dimension: "Dimension",
20
+ # metric_name: "Metric",
21
+ # value: 1.0,
22
+ # timestamp: Time.now,
23
+ # }
24
+ #
25
+ # @!attribute [rw] dimension
26
+ # The dimension of metrics published.
27
+ # @return [String]
28
+ #
29
+ # @!attribute [rw] metric_name
30
+ # Returns the name of the metric.
31
+ # @return [String]
32
+ #
33
+ # @!attribute [rw] value
34
+ # Returns the value of the metric.
35
+ # @return [Float]
36
+ #
37
+ # @!attribute [rw] timestamp
38
+ # Timestamp of when the metric was requested.
39
+ # @return [Time]
40
+ #
41
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/EdgeMetric AWS API Documentation
42
+ #
43
+ class EdgeMetric < Struct.new(
44
+ :dimension,
45
+ :metric_name,
46
+ :value,
47
+ :timestamp)
48
+ SENSITIVE = []
49
+ include Aws::Structure
50
+ end
51
+
52
+ # @note When making an API call, you may pass GetDeviceRegistrationRequest
53
+ # data as a hash:
54
+ #
55
+ # {
56
+ # device_name: "DeviceName", # required
57
+ # device_fleet_name: "DeviceFleetName", # required
58
+ # }
59
+ #
60
+ # @!attribute [rw] device_name
61
+ # The unique name of the device you want to get the registration
62
+ # status from.
63
+ # @return [String]
64
+ #
65
+ # @!attribute [rw] device_fleet_name
66
+ # The name of the fleet that the device belongs to.
67
+ # @return [String]
68
+ #
69
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/GetDeviceRegistrationRequest AWS API Documentation
70
+ #
71
+ class GetDeviceRegistrationRequest < Struct.new(
72
+ :device_name,
73
+ :device_fleet_name)
74
+ SENSITIVE = []
75
+ include Aws::Structure
76
+ end
77
+
78
+ # @!attribute [rw] device_registration
79
+ # Describes if the device is currently registered with SageMaker Edge
80
+ # Manager.
81
+ # @return [String]
82
+ #
83
+ # @!attribute [rw] cache_ttl
84
+ # The amount of time, in seconds, that the registration status is
85
+ # stored on the device’s cache before it is refreshed.
86
+ # @return [String]
87
+ #
88
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/GetDeviceRegistrationResult AWS API Documentation
89
+ #
90
+ class GetDeviceRegistrationResult < Struct.new(
91
+ :device_registration,
92
+ :cache_ttl)
93
+ SENSITIVE = []
94
+ include Aws::Structure
95
+ end
96
+
97
+ # An internal failure occurred. Try your request again. If the problem
98
+ # persists, contact AWS customer support.
99
+ #
100
+ # @!attribute [rw] message
101
+ # @return [String]
102
+ #
103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/InternalServiceException AWS API Documentation
104
+ #
105
+ class InternalServiceException < Struct.new(
106
+ :message)
107
+ SENSITIVE = []
108
+ include Aws::Structure
109
+ end
110
+
111
+ # Information about a model deployed on an edge device that is
112
+ # registered with SageMaker Edge Manager.
113
+ #
114
+ # @note When making an API call, you may pass Model
115
+ # data as a hash:
116
+ #
117
+ # {
118
+ # model_name: "ModelName",
119
+ # model_version: "Version",
120
+ # latest_sample_time: Time.now,
121
+ # latest_inference: Time.now,
122
+ # model_metrics: [
123
+ # {
124
+ # dimension: "Dimension",
125
+ # metric_name: "Metric",
126
+ # value: 1.0,
127
+ # timestamp: Time.now,
128
+ # },
129
+ # ],
130
+ # }
131
+ #
132
+ # @!attribute [rw] model_name
133
+ # The name of the model.
134
+ # @return [String]
135
+ #
136
+ # @!attribute [rw] model_version
137
+ # The version of the model.
138
+ # @return [String]
139
+ #
140
+ # @!attribute [rw] latest_sample_time
141
+ # The timestamp of the last data sample taken.
142
+ # @return [Time]
143
+ #
144
+ # @!attribute [rw] latest_inference
145
+ # The timestamp of the last inference that was made.
146
+ # @return [Time]
147
+ #
148
+ # @!attribute [rw] model_metrics
149
+ # Information required for model metrics.
150
+ # @return [Array<Types::EdgeMetric>]
151
+ #
152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/Model AWS API Documentation
153
+ #
154
+ class Model < Struct.new(
155
+ :model_name,
156
+ :model_version,
157
+ :latest_sample_time,
158
+ :latest_inference,
159
+ :model_metrics)
160
+ SENSITIVE = []
161
+ include Aws::Structure
162
+ end
163
+
164
+ # @note When making an API call, you may pass SendHeartbeatRequest
165
+ # data as a hash:
166
+ #
167
+ # {
168
+ # agent_metrics: [
169
+ # {
170
+ # dimension: "Dimension",
171
+ # metric_name: "Metric",
172
+ # value: 1.0,
173
+ # timestamp: Time.now,
174
+ # },
175
+ # ],
176
+ # models: [
177
+ # {
178
+ # model_name: "ModelName",
179
+ # model_version: "Version",
180
+ # latest_sample_time: Time.now,
181
+ # latest_inference: Time.now,
182
+ # model_metrics: [
183
+ # {
184
+ # dimension: "Dimension",
185
+ # metric_name: "Metric",
186
+ # value: 1.0,
187
+ # timestamp: Time.now,
188
+ # },
189
+ # ],
190
+ # },
191
+ # ],
192
+ # agent_version: "Version", # required
193
+ # device_name: "DeviceName", # required
194
+ # device_fleet_name: "DeviceFleetName", # required
195
+ # }
196
+ #
197
+ # @!attribute [rw] agent_metrics
198
+ # For internal use. Returns a list of SageMaker Edge Manager agent
199
+ # operating metrics.
200
+ # @return [Array<Types::EdgeMetric>]
201
+ #
202
+ # @!attribute [rw] models
203
+ # Returns a list of models deployed on the the device.
204
+ # @return [Array<Types::Model>]
205
+ #
206
+ # @!attribute [rw] agent_version
207
+ # Returns the version of the agent.
208
+ # @return [String]
209
+ #
210
+ # @!attribute [rw] device_name
211
+ # The unique name of the device.
212
+ # @return [String]
213
+ #
214
+ # @!attribute [rw] device_fleet_name
215
+ # The name of the fleet that the device belongs to.
216
+ # @return [String]
217
+ #
218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/SendHeartbeatRequest AWS API Documentation
219
+ #
220
+ class SendHeartbeatRequest < Struct.new(
221
+ :agent_metrics,
222
+ :models,
223
+ :agent_version,
224
+ :device_name,
225
+ :device_fleet_name)
226
+ SENSITIVE = []
227
+ include Aws::Structure
228
+ end
229
+
230
+ end
231
+ end
metadata ADDED
@@ -0,0 +1,88 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: aws-sdk-sagemakeredgemanager
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Amazon Web Services
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2020-12-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: aws-sdk-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 3.109.0
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - "~>"
28
+ - !ruby/object:Gem::Version
29
+ version: '3'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 3.109.0
33
+ - !ruby/object:Gem::Dependency
34
+ name: aws-sigv4
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '1.1'
40
+ type: :runtime
41
+ prerelease: false
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '1.1'
47
+ description: Official AWS Ruby gem for Amazon Sagemaker Edge Manager. This gem is
48
+ part of the AWS SDK for Ruby.
49
+ email:
50
+ - trevrowe@amazon.com
51
+ executables: []
52
+ extensions: []
53
+ extra_rdoc_files: []
54
+ files:
55
+ - lib/aws-sdk-sagemakeredgemanager.rb
56
+ - lib/aws-sdk-sagemakeredgemanager/client.rb
57
+ - lib/aws-sdk-sagemakeredgemanager/client_api.rb
58
+ - lib/aws-sdk-sagemakeredgemanager/customizations.rb
59
+ - lib/aws-sdk-sagemakeredgemanager/errors.rb
60
+ - lib/aws-sdk-sagemakeredgemanager/resource.rb
61
+ - lib/aws-sdk-sagemakeredgemanager/types.rb
62
+ homepage: https://github.com/aws/aws-sdk-ruby
63
+ licenses:
64
+ - Apache-2.0
65
+ metadata:
66
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-sagemakeredgemanager
67
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-sagemakeredgemanager/CHANGELOG.md
68
+ post_install_message:
69
+ rdoc_options: []
70
+ require_paths:
71
+ - lib
72
+ required_ruby_version: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - ">="
75
+ - !ruby/object:Gem::Version
76
+ version: '0'
77
+ required_rubygems_version: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - ">="
80
+ - !ruby/object:Gem::Version
81
+ version: '0'
82
+ requirements: []
83
+ rubyforge_project:
84
+ rubygems_version: 2.7.6.2
85
+ signing_key:
86
+ specification_version: 4
87
+ summary: AWS SDK for Ruby - Amazon Sagemaker Edge Manager
88
+ test_files: []