aws-sdk-iotwireless 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,175 @@
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::IoTWireless
11
+
12
+ # When IoTWireless returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::IoTWireless::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all IoTWireless errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::IoTWireless::Errors::ServiceError
20
+ # # rescues all IoTWireless 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
+ # * {AccessDeniedException}
31
+ # * {ConflictException}
32
+ # * {InternalServerException}
33
+ # * {ResourceNotFoundException}
34
+ # * {ThrottlingException}
35
+ # * {TooManyTagsException}
36
+ # * {ValidationException}
37
+ #
38
+ # Additionally, error classes are dynamically generated for service errors based on the error code
39
+ # if they are not defined above.
40
+ module Errors
41
+
42
+ extend Aws::Errors::DynamicErrors
43
+
44
+ class AccessDeniedException < ServiceError
45
+
46
+ # @param [Seahorse::Client::RequestContext] context
47
+ # @param [String] message
48
+ # @param [Aws::IoTWireless::Types::AccessDeniedException] data
49
+ def initialize(context, message, data = Aws::EmptyStructure.new)
50
+ super(context, message, data)
51
+ end
52
+
53
+ # @return [String]
54
+ def message
55
+ @message || @data[:message]
56
+ end
57
+ end
58
+
59
+ class ConflictException < ServiceError
60
+
61
+ # @param [Seahorse::Client::RequestContext] context
62
+ # @param [String] message
63
+ # @param [Aws::IoTWireless::Types::ConflictException] data
64
+ def initialize(context, message, data = Aws::EmptyStructure.new)
65
+ super(context, message, data)
66
+ end
67
+
68
+ # @return [String]
69
+ def message
70
+ @message || @data[:message]
71
+ end
72
+
73
+ # @return [String]
74
+ def resource_id
75
+ @data[:resource_id]
76
+ end
77
+
78
+ # @return [String]
79
+ def resource_type
80
+ @data[:resource_type]
81
+ end
82
+ end
83
+
84
+ class InternalServerException < ServiceError
85
+
86
+ # @param [Seahorse::Client::RequestContext] context
87
+ # @param [String] message
88
+ # @param [Aws::IoTWireless::Types::InternalServerException] data
89
+ def initialize(context, message, data = Aws::EmptyStructure.new)
90
+ super(context, message, data)
91
+ end
92
+
93
+ # @return [String]
94
+ def message
95
+ @message || @data[:message]
96
+ end
97
+ end
98
+
99
+ class ResourceNotFoundException < ServiceError
100
+
101
+ # @param [Seahorse::Client::RequestContext] context
102
+ # @param [String] message
103
+ # @param [Aws::IoTWireless::Types::ResourceNotFoundException] data
104
+ def initialize(context, message, data = Aws::EmptyStructure.new)
105
+ super(context, message, data)
106
+ end
107
+
108
+ # @return [String]
109
+ def message
110
+ @message || @data[:message]
111
+ end
112
+
113
+ # @return [String]
114
+ def resource_id
115
+ @data[:resource_id]
116
+ end
117
+
118
+ # @return [String]
119
+ def resource_type
120
+ @data[:resource_type]
121
+ end
122
+ end
123
+
124
+ class ThrottlingException < ServiceError
125
+
126
+ # @param [Seahorse::Client::RequestContext] context
127
+ # @param [String] message
128
+ # @param [Aws::IoTWireless::Types::ThrottlingException] data
129
+ def initialize(context, message, data = Aws::EmptyStructure.new)
130
+ super(context, message, data)
131
+ end
132
+
133
+ # @return [String]
134
+ def message
135
+ @message || @data[:message]
136
+ end
137
+ end
138
+
139
+ class TooManyTagsException < ServiceError
140
+
141
+ # @param [Seahorse::Client::RequestContext] context
142
+ # @param [String] message
143
+ # @param [Aws::IoTWireless::Types::TooManyTagsException] data
144
+ def initialize(context, message, data = Aws::EmptyStructure.new)
145
+ super(context, message, data)
146
+ end
147
+
148
+ # @return [String]
149
+ def message
150
+ @message || @data[:message]
151
+ end
152
+
153
+ # @return [String]
154
+ def resource_name
155
+ @data[:resource_name]
156
+ end
157
+ end
158
+
159
+ class ValidationException < ServiceError
160
+
161
+ # @param [Seahorse::Client::RequestContext] context
162
+ # @param [String] message
163
+ # @param [Aws::IoTWireless::Types::ValidationException] data
164
+ def initialize(context, message, data = Aws::EmptyStructure.new)
165
+ super(context, message, data)
166
+ end
167
+
168
+ # @return [String]
169
+ def message
170
+ @message || @data[:message]
171
+ end
172
+ end
173
+
174
+ end
175
+ 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::IoTWireless
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,3281 @@
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::IoTWireless
11
+ module Types
12
+
13
+ # ABP device object for LoRaWAN specification v1.0.x
14
+ #
15
+ # @note When making an API call, you may pass AbpV1_0_x
16
+ # data as a hash:
17
+ #
18
+ # {
19
+ # dev_addr: "DevAddr",
20
+ # session_keys: {
21
+ # nwk_s_key: "NwkSKey",
22
+ # app_s_key: "AppSKey",
23
+ # },
24
+ # }
25
+ #
26
+ # @!attribute [rw] dev_addr
27
+ # The DevAddr value.
28
+ # @return [String]
29
+ #
30
+ # @!attribute [rw] session_keys
31
+ # Session keys for ABP v1.0.x
32
+ # @return [Types::SessionKeysAbpV1_0_x]
33
+ #
34
+ class AbpV1_0_x < Struct.new(
35
+ :dev_addr,
36
+ :session_keys)
37
+ SENSITIVE = []
38
+ include Aws::Structure
39
+ end
40
+
41
+ # ABP device object for LoRaWAN specification v1.1
42
+ #
43
+ # @note When making an API call, you may pass AbpV1_1
44
+ # data as a hash:
45
+ #
46
+ # {
47
+ # dev_addr: "DevAddr",
48
+ # session_keys: {
49
+ # f_nwk_s_int_key: "FNwkSIntKey",
50
+ # s_nwk_s_int_key: "SNwkSIntKey",
51
+ # nwk_s_enc_key: "NwkSEncKey",
52
+ # app_s_key: "AppSKey",
53
+ # },
54
+ # }
55
+ #
56
+ # @!attribute [rw] dev_addr
57
+ # The DevAddr value.
58
+ # @return [String]
59
+ #
60
+ # @!attribute [rw] session_keys
61
+ # Session keys for ABP v1.1
62
+ # @return [Types::SessionKeysAbpV1_1]
63
+ #
64
+ class AbpV1_1 < Struct.new(
65
+ :dev_addr,
66
+ :session_keys)
67
+ SENSITIVE = []
68
+ include Aws::Structure
69
+ end
70
+
71
+ # User does not have permission to perform this action.
72
+ #
73
+ # @!attribute [rw] message
74
+ # @return [String]
75
+ #
76
+ class AccessDeniedException < Struct.new(
77
+ :message)
78
+ SENSITIVE = []
79
+ include Aws::Structure
80
+ end
81
+
82
+ # @note When making an API call, you may pass AssociateAwsAccountWithPartnerAccountRequest
83
+ # data as a hash:
84
+ #
85
+ # {
86
+ # sidewalk: { # required
87
+ # amazon_id: "AmazonId",
88
+ # app_server_private_key: "AppServerPrivateKey",
89
+ # },
90
+ # client_request_token: "ClientRequestToken",
91
+ # }
92
+ #
93
+ # @!attribute [rw] sidewalk
94
+ # The Sidewalk account credentials.
95
+ # @return [Types::SidewalkAccountInfo]
96
+ #
97
+ # @!attribute [rw] client_request_token
98
+ # Each resource must have a unique client request token. If you try to
99
+ # create a new resource with the same token as a resource that already
100
+ # exists, an exception occurs. If you omit this value, AWS SDKs will
101
+ # automatically generate a unique client request.
102
+ #
103
+ # **A suitable default value is auto-generated.** You should normally
104
+ # not need to pass this option.
105
+ # @return [String]
106
+ #
107
+ class AssociateAwsAccountWithPartnerAccountRequest < Struct.new(
108
+ :sidewalk,
109
+ :client_request_token)
110
+ SENSITIVE = []
111
+ include Aws::Structure
112
+ end
113
+
114
+ # @!attribute [rw] sidewalk
115
+ # The Sidewalk account credentials.
116
+ # @return [Types::SidewalkAccountInfo]
117
+ #
118
+ class AssociateAwsAccountWithPartnerAccountResponse < Struct.new(
119
+ :sidewalk)
120
+ SENSITIVE = []
121
+ include Aws::Structure
122
+ end
123
+
124
+ # @note When making an API call, you may pass AssociateWirelessDeviceWithThingRequest
125
+ # data as a hash:
126
+ #
127
+ # {
128
+ # id: "WirelessDeviceId", # required
129
+ # thing_arn: "ThingArn", # required
130
+ # }
131
+ #
132
+ # @!attribute [rw] id
133
+ # The ID of the resource to update.
134
+ # @return [String]
135
+ #
136
+ # @!attribute [rw] thing_arn
137
+ # The ARN of the thing to associate with the wireless device.
138
+ # @return [String]
139
+ #
140
+ class AssociateWirelessDeviceWithThingRequest < Struct.new(
141
+ :id,
142
+ :thing_arn)
143
+ SENSITIVE = []
144
+ include Aws::Structure
145
+ end
146
+
147
+ class AssociateWirelessDeviceWithThingResponse < Aws::EmptyStructure; end
148
+
149
+ # @note When making an API call, you may pass AssociateWirelessGatewayWithCertificateRequest
150
+ # data as a hash:
151
+ #
152
+ # {
153
+ # id: "WirelessGatewayId", # required
154
+ # iot_certificate_id: "IotCertificateId", # required
155
+ # }
156
+ #
157
+ # @!attribute [rw] id
158
+ # The ID of the resource to update.
159
+ # @return [String]
160
+ #
161
+ # @!attribute [rw] iot_certificate_id
162
+ # The ID of the certificate to associate with the wireless gateway.
163
+ # @return [String]
164
+ #
165
+ class AssociateWirelessGatewayWithCertificateRequest < Struct.new(
166
+ :id,
167
+ :iot_certificate_id)
168
+ SENSITIVE = []
169
+ include Aws::Structure
170
+ end
171
+
172
+ # @!attribute [rw] iot_certificate_id
173
+ # The ID of the certificate associated with the wireless gateway.
174
+ # @return [String]
175
+ #
176
+ class AssociateWirelessGatewayWithCertificateResponse < Struct.new(
177
+ :iot_certificate_id)
178
+ SENSITIVE = []
179
+ include Aws::Structure
180
+ end
181
+
182
+ # @note When making an API call, you may pass AssociateWirelessGatewayWithThingRequest
183
+ # data as a hash:
184
+ #
185
+ # {
186
+ # id: "WirelessGatewayId", # required
187
+ # thing_arn: "ThingArn", # required
188
+ # }
189
+ #
190
+ # @!attribute [rw] id
191
+ # The ID of the resource to update.
192
+ # @return [String]
193
+ #
194
+ # @!attribute [rw] thing_arn
195
+ # The ARN of the thing to associate with the wireless gateway.
196
+ # @return [String]
197
+ #
198
+ class AssociateWirelessGatewayWithThingRequest < Struct.new(
199
+ :id,
200
+ :thing_arn)
201
+ SENSITIVE = []
202
+ include Aws::Structure
203
+ end
204
+
205
+ class AssociateWirelessGatewayWithThingResponse < Aws::EmptyStructure; end
206
+
207
+ # Adding, updating, or deleting the resource can cause an inconsistent
208
+ # state.
209
+ #
210
+ # @!attribute [rw] message
211
+ # @return [String]
212
+ #
213
+ # @!attribute [rw] resource_id
214
+ # @return [String]
215
+ #
216
+ # @!attribute [rw] resource_type
217
+ # @return [String]
218
+ #
219
+ class ConflictException < Struct.new(
220
+ :message,
221
+ :resource_id,
222
+ :resource_type)
223
+ SENSITIVE = []
224
+ include Aws::Structure
225
+ end
226
+
227
+ # @note When making an API call, you may pass CreateDestinationRequest
228
+ # data as a hash:
229
+ #
230
+ # {
231
+ # name: "DestinationName", # required
232
+ # expression_type: "RuleName", # required, accepts RuleName
233
+ # expression: "Expression", # required
234
+ # description: "Description",
235
+ # role_arn: "RoleArn", # required
236
+ # tags: [
237
+ # {
238
+ # key: "TagKey", # required
239
+ # value: "TagValue", # required
240
+ # },
241
+ # ],
242
+ # client_request_token: "ClientRequestToken",
243
+ # }
244
+ #
245
+ # @!attribute [rw] name
246
+ # The name of the new resource.
247
+ # @return [String]
248
+ #
249
+ # @!attribute [rw] expression_type
250
+ # The type of value in `Expression`.
251
+ # @return [String]
252
+ #
253
+ # @!attribute [rw] expression
254
+ # The rule name or topic rule to send messages to.
255
+ # @return [String]
256
+ #
257
+ # @!attribute [rw] description
258
+ # The description of the new resource.
259
+ # @return [String]
260
+ #
261
+ # @!attribute [rw] role_arn
262
+ # The ARN of the IAM Role that authorizes the destination.
263
+ # @return [String]
264
+ #
265
+ # @!attribute [rw] tags
266
+ # The tags to attach to the new destination. Tags are metadata that
267
+ # can be used to manage a resource.
268
+ # @return [Array<Types::Tag>]
269
+ #
270
+ # @!attribute [rw] client_request_token
271
+ # Each resource must have a unique client request token. If you try to
272
+ # create a new resource with the same token as a resource that already
273
+ # exists, an exception occurs. If you omit this value, AWS SDKs will
274
+ # automatically generate a unique client request.
275
+ #
276
+ # **A suitable default value is auto-generated.** You should normally
277
+ # not need to pass this option.
278
+ # @return [String]
279
+ #
280
+ class CreateDestinationRequest < Struct.new(
281
+ :name,
282
+ :expression_type,
283
+ :expression,
284
+ :description,
285
+ :role_arn,
286
+ :tags,
287
+ :client_request_token)
288
+ SENSITIVE = []
289
+ include Aws::Structure
290
+ end
291
+
292
+ # @!attribute [rw] arn
293
+ # The Amazon Resource Name of the new resource.
294
+ # @return [String]
295
+ #
296
+ # @!attribute [rw] name
297
+ # The name of the new resource.
298
+ # @return [String]
299
+ #
300
+ class CreateDestinationResponse < Struct.new(
301
+ :arn,
302
+ :name)
303
+ SENSITIVE = []
304
+ include Aws::Structure
305
+ end
306
+
307
+ # @note When making an API call, you may pass CreateDeviceProfileRequest
308
+ # data as a hash:
309
+ #
310
+ # {
311
+ # name: "DeviceProfileName",
312
+ # lo_ra_wan: {
313
+ # supports_class_b: false,
314
+ # class_b_timeout: 1,
315
+ # ping_slot_period: 1,
316
+ # ping_slot_dr: 1,
317
+ # ping_slot_freq: 1,
318
+ # supports_class_c: false,
319
+ # class_c_timeout: 1,
320
+ # mac_version: "MacVersion",
321
+ # reg_params_revision: "RegParamsRevision",
322
+ # rx_delay_1: 1,
323
+ # rx_dr_offset_1: 1,
324
+ # rx_data_rate_2: 1,
325
+ # rx_freq_2: 1,
326
+ # factory_preset_freqs_list: [1],
327
+ # max_eirp: 1,
328
+ # max_duty_cycle: 1,
329
+ # rf_region: "RfRegion",
330
+ # supports_join: false,
331
+ # supports_32_bit_f_cnt: false,
332
+ # },
333
+ # tags: [
334
+ # {
335
+ # key: "TagKey", # required
336
+ # value: "TagValue", # required
337
+ # },
338
+ # ],
339
+ # client_request_token: "ClientRequestToken",
340
+ # }
341
+ #
342
+ # @!attribute [rw] name
343
+ # The name of the new resource.
344
+ # @return [String]
345
+ #
346
+ # @!attribute [rw] lo_ra_wan
347
+ # The device profile information to use to create the device profile.
348
+ # @return [Types::LoRaWANDeviceProfile]
349
+ #
350
+ # @!attribute [rw] tags
351
+ # The tags to attach to the new device profile Tags are metadata that
352
+ # can be used to manage a resource.
353
+ # @return [Array<Types::Tag>]
354
+ #
355
+ # @!attribute [rw] client_request_token
356
+ # Each resource must have a unique client request token. If you try to
357
+ # create a new resource with the same token as a resource that already
358
+ # exists, an exception occurs. If you omit this value, AWS SDKs will
359
+ # automatically generate a unique client request.
360
+ #
361
+ # **A suitable default value is auto-generated.** You should normally
362
+ # not need to pass this option.
363
+ # @return [String]
364
+ #
365
+ class CreateDeviceProfileRequest < Struct.new(
366
+ :name,
367
+ :lo_ra_wan,
368
+ :tags,
369
+ :client_request_token)
370
+ SENSITIVE = []
371
+ include Aws::Structure
372
+ end
373
+
374
+ # @!attribute [rw] arn
375
+ # The Amazon Resource Name of the new resource.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] id
379
+ # The ID of the new device profile.
380
+ # @return [String]
381
+ #
382
+ class CreateDeviceProfileResponse < Struct.new(
383
+ :arn,
384
+ :id)
385
+ SENSITIVE = []
386
+ include Aws::Structure
387
+ end
388
+
389
+ # @note When making an API call, you may pass CreateServiceProfileRequest
390
+ # data as a hash:
391
+ #
392
+ # {
393
+ # name: "ServiceProfileName",
394
+ # lo_ra_wan: {
395
+ # add_gw_metadata: false,
396
+ # },
397
+ # tags: [
398
+ # {
399
+ # key: "TagKey", # required
400
+ # value: "TagValue", # required
401
+ # },
402
+ # ],
403
+ # client_request_token: "ClientRequestToken",
404
+ # }
405
+ #
406
+ # @!attribute [rw] name
407
+ # The name of the new resource.
408
+ # @return [String]
409
+ #
410
+ # @!attribute [rw] lo_ra_wan
411
+ # The service profile information to use to create the service
412
+ # profile.
413
+ # @return [Types::LoRaWANServiceProfile]
414
+ #
415
+ # @!attribute [rw] tags
416
+ # The tags to attach to the new service profile. Tags are metadata
417
+ # that can be used to manage a resource.
418
+ # @return [Array<Types::Tag>]
419
+ #
420
+ # @!attribute [rw] client_request_token
421
+ # Each resource must have a unique client request token. If you try to
422
+ # create a new resource with the same token as a resource that already
423
+ # exists, an exception occurs. If you omit this value, AWS SDKs will
424
+ # automatically generate a unique client request.
425
+ #
426
+ # **A suitable default value is auto-generated.** You should normally
427
+ # not need to pass this option.
428
+ # @return [String]
429
+ #
430
+ class CreateServiceProfileRequest < Struct.new(
431
+ :name,
432
+ :lo_ra_wan,
433
+ :tags,
434
+ :client_request_token)
435
+ SENSITIVE = []
436
+ include Aws::Structure
437
+ end
438
+
439
+ # @!attribute [rw] arn
440
+ # The Amazon Resource Name of the new resource.
441
+ # @return [String]
442
+ #
443
+ # @!attribute [rw] id
444
+ # The ID of the new service profile.
445
+ # @return [String]
446
+ #
447
+ class CreateServiceProfileResponse < Struct.new(
448
+ :arn,
449
+ :id)
450
+ SENSITIVE = []
451
+ include Aws::Structure
452
+ end
453
+
454
+ # @note When making an API call, you may pass CreateWirelessDeviceRequest
455
+ # data as a hash:
456
+ #
457
+ # {
458
+ # type: "Sidewalk", # required, accepts Sidewalk, LoRaWAN
459
+ # name: "WirelessDeviceName",
460
+ # description: "Description",
461
+ # destination_name: "DestinationName", # required
462
+ # client_request_token: "ClientRequestToken",
463
+ # lo_ra_wan: {
464
+ # dev_eui: "DevEui",
465
+ # device_profile_id: "DeviceProfileId",
466
+ # service_profile_id: "ServiceProfileId",
467
+ # otaa_v1_1: {
468
+ # app_key: "AppKey",
469
+ # nwk_key: "NwkKey",
470
+ # join_eui: "JoinEui",
471
+ # },
472
+ # otaa_v1_0_x: {
473
+ # app_key: "AppKey",
474
+ # app_eui: "AppEui",
475
+ # },
476
+ # abp_v1_1: {
477
+ # dev_addr: "DevAddr",
478
+ # session_keys: {
479
+ # f_nwk_s_int_key: "FNwkSIntKey",
480
+ # s_nwk_s_int_key: "SNwkSIntKey",
481
+ # nwk_s_enc_key: "NwkSEncKey",
482
+ # app_s_key: "AppSKey",
483
+ # },
484
+ # },
485
+ # abp_v1_0_x: {
486
+ # dev_addr: "DevAddr",
487
+ # session_keys: {
488
+ # nwk_s_key: "NwkSKey",
489
+ # app_s_key: "AppSKey",
490
+ # },
491
+ # },
492
+ # },
493
+ # }
494
+ #
495
+ # @!attribute [rw] type
496
+ # The wireless device type.
497
+ # @return [String]
498
+ #
499
+ # @!attribute [rw] name
500
+ # The name of the new resource.
501
+ # @return [String]
502
+ #
503
+ # @!attribute [rw] description
504
+ # The description of the new resource.
505
+ # @return [String]
506
+ #
507
+ # @!attribute [rw] destination_name
508
+ # The name of the destination to assign to the new wireless device.
509
+ # @return [String]
510
+ #
511
+ # @!attribute [rw] client_request_token
512
+ # Each resource must have a unique client request token. If you try to
513
+ # create a new resource with the same token as a resource that already
514
+ # exists, an exception occurs. If you omit this value, AWS SDKs will
515
+ # automatically generate a unique client request.
516
+ #
517
+ # **A suitable default value is auto-generated.** You should normally
518
+ # not need to pass this option.
519
+ # @return [String]
520
+ #
521
+ # @!attribute [rw] lo_ra_wan
522
+ # The device configuration information to use to create the wireless
523
+ # device.
524
+ # @return [Types::LoRaWANDevice]
525
+ #
526
+ class CreateWirelessDeviceRequest < Struct.new(
527
+ :type,
528
+ :name,
529
+ :description,
530
+ :destination_name,
531
+ :client_request_token,
532
+ :lo_ra_wan)
533
+ SENSITIVE = []
534
+ include Aws::Structure
535
+ end
536
+
537
+ # @!attribute [rw] arn
538
+ # The Amazon Resource Name of the new resource.
539
+ # @return [String]
540
+ #
541
+ # @!attribute [rw] id
542
+ # The ID of the new wireless device.
543
+ # @return [String]
544
+ #
545
+ class CreateWirelessDeviceResponse < Struct.new(
546
+ :arn,
547
+ :id)
548
+ SENSITIVE = []
549
+ include Aws::Structure
550
+ end
551
+
552
+ # @note When making an API call, you may pass CreateWirelessGatewayRequest
553
+ # data as a hash:
554
+ #
555
+ # {
556
+ # name: "WirelessGatewayName",
557
+ # description: "Description",
558
+ # lo_ra_wan: { # required
559
+ # gateway_eui: "GatewayEui",
560
+ # rf_region: "RfRegion",
561
+ # },
562
+ # tags: [
563
+ # {
564
+ # key: "TagKey", # required
565
+ # value: "TagValue", # required
566
+ # },
567
+ # ],
568
+ # client_request_token: "ClientRequestToken",
569
+ # }
570
+ #
571
+ # @!attribute [rw] name
572
+ # The name of the new resource.
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] description
576
+ # The description of the new resource.
577
+ # @return [String]
578
+ #
579
+ # @!attribute [rw] lo_ra_wan
580
+ # The gateway configuration information to use to create the wireless
581
+ # gateway.
582
+ # @return [Types::LoRaWANGateway]
583
+ #
584
+ # @!attribute [rw] tags
585
+ # The tags to attach to the new wireless gateway. Tags are metadata
586
+ # that can be used to manage a resource.
587
+ # @return [Array<Types::Tag>]
588
+ #
589
+ # @!attribute [rw] client_request_token
590
+ # Each resource must have a unique client request token. If you try to
591
+ # create a new resource with the same token as a resource that already
592
+ # exists, an exception occurs. If you omit this value, AWS SDKs will
593
+ # automatically generate a unique client request.
594
+ #
595
+ # **A suitable default value is auto-generated.** You should normally
596
+ # not need to pass this option.
597
+ # @return [String]
598
+ #
599
+ class CreateWirelessGatewayRequest < Struct.new(
600
+ :name,
601
+ :description,
602
+ :lo_ra_wan,
603
+ :tags,
604
+ :client_request_token)
605
+ SENSITIVE = []
606
+ include Aws::Structure
607
+ end
608
+
609
+ # @!attribute [rw] arn
610
+ # The Amazon Resource Name of the new resource.
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] id
614
+ # The ID of the new wireless gateway.
615
+ # @return [String]
616
+ #
617
+ class CreateWirelessGatewayResponse < Struct.new(
618
+ :arn,
619
+ :id)
620
+ SENSITIVE = []
621
+ include Aws::Structure
622
+ end
623
+
624
+ # @note When making an API call, you may pass CreateWirelessGatewayTaskDefinitionRequest
625
+ # data as a hash:
626
+ #
627
+ # {
628
+ # auto_create_tasks: false, # required
629
+ # name: "WirelessGatewayTaskName",
630
+ # update: {
631
+ # update_data_source: "UpdateDataSource",
632
+ # update_data_role: "UpdateDataSource",
633
+ # lo_ra_wan: {
634
+ # update_signature: "UpdateSignature",
635
+ # sig_key_crc: 1,
636
+ # current_version: {
637
+ # package_version: "PackageVersion",
638
+ # model: "Model",
639
+ # station: "Station",
640
+ # },
641
+ # update_version: {
642
+ # package_version: "PackageVersion",
643
+ # model: "Model",
644
+ # station: "Station",
645
+ # },
646
+ # },
647
+ # },
648
+ # client_request_token: "ClientRequestToken",
649
+ # }
650
+ #
651
+ # @!attribute [rw] auto_create_tasks
652
+ # Whether to automatically create tasks using this task definition for
653
+ # all gateways with the specified current version. If `false`, the
654
+ # task must me created by calling `CreateWirelessGatewayTask`.
655
+ # @return [Boolean]
656
+ #
657
+ # @!attribute [rw] name
658
+ # The name of the new resource.
659
+ # @return [String]
660
+ #
661
+ # @!attribute [rw] update
662
+ # Information about the gateways to update.
663
+ # @return [Types::UpdateWirelessGatewayTaskCreate]
664
+ #
665
+ # @!attribute [rw] client_request_token
666
+ # Each resource must have a unique client request token. If you try to
667
+ # create a new resource with the same token as a resource that already
668
+ # exists, an exception occurs. If you omit this value, AWS SDKs will
669
+ # automatically generate a unique client request.
670
+ #
671
+ # **A suitable default value is auto-generated.** You should normally
672
+ # not need to pass this option.
673
+ # @return [String]
674
+ #
675
+ class CreateWirelessGatewayTaskDefinitionRequest < Struct.new(
676
+ :auto_create_tasks,
677
+ :name,
678
+ :update,
679
+ :client_request_token)
680
+ SENSITIVE = []
681
+ include Aws::Structure
682
+ end
683
+
684
+ # @!attribute [rw] id
685
+ # The ID of the new wireless gateway task definition.
686
+ # @return [String]
687
+ #
688
+ class CreateWirelessGatewayTaskDefinitionResponse < Struct.new(
689
+ :id)
690
+ SENSITIVE = []
691
+ include Aws::Structure
692
+ end
693
+
694
+ # @note When making an API call, you may pass CreateWirelessGatewayTaskRequest
695
+ # data as a hash:
696
+ #
697
+ # {
698
+ # id: "WirelessGatewayId", # required
699
+ # wireless_gateway_task_definition_id: "WirelessGatewayTaskDefinitionId", # required
700
+ # }
701
+ #
702
+ # @!attribute [rw] id
703
+ # The ID of the resource to update.
704
+ # @return [String]
705
+ #
706
+ # @!attribute [rw] wireless_gateway_task_definition_id
707
+ # The ID of the WirelessGatewayTaskDefinition.
708
+ # @return [String]
709
+ #
710
+ class CreateWirelessGatewayTaskRequest < Struct.new(
711
+ :id,
712
+ :wireless_gateway_task_definition_id)
713
+ SENSITIVE = []
714
+ include Aws::Structure
715
+ end
716
+
717
+ # @!attribute [rw] wireless_gateway_task_definition_id
718
+ # The ID of the WirelessGatewayTaskDefinition.
719
+ # @return [String]
720
+ #
721
+ # @!attribute [rw] status
722
+ # The status of the request.
723
+ # @return [String]
724
+ #
725
+ class CreateWirelessGatewayTaskResponse < Struct.new(
726
+ :wireless_gateway_task_definition_id,
727
+ :status)
728
+ SENSITIVE = []
729
+ include Aws::Structure
730
+ end
731
+
732
+ # @note When making an API call, you may pass DeleteDestinationRequest
733
+ # data as a hash:
734
+ #
735
+ # {
736
+ # name: "DestinationName", # required
737
+ # }
738
+ #
739
+ # @!attribute [rw] name
740
+ # The name of the resource to delete.
741
+ # @return [String]
742
+ #
743
+ class DeleteDestinationRequest < Struct.new(
744
+ :name)
745
+ SENSITIVE = []
746
+ include Aws::Structure
747
+ end
748
+
749
+ class DeleteDestinationResponse < Aws::EmptyStructure; end
750
+
751
+ # @note When making an API call, you may pass DeleteDeviceProfileRequest
752
+ # data as a hash:
753
+ #
754
+ # {
755
+ # id: "DeviceProfileId", # required
756
+ # }
757
+ #
758
+ # @!attribute [rw] id
759
+ # The ID of the resource to delete.
760
+ # @return [String]
761
+ #
762
+ class DeleteDeviceProfileRequest < Struct.new(
763
+ :id)
764
+ SENSITIVE = []
765
+ include Aws::Structure
766
+ end
767
+
768
+ class DeleteDeviceProfileResponse < Aws::EmptyStructure; end
769
+
770
+ # @note When making an API call, you may pass DeleteServiceProfileRequest
771
+ # data as a hash:
772
+ #
773
+ # {
774
+ # id: "ServiceProfileId", # required
775
+ # }
776
+ #
777
+ # @!attribute [rw] id
778
+ # The ID of the resource to delete.
779
+ # @return [String]
780
+ #
781
+ class DeleteServiceProfileRequest < Struct.new(
782
+ :id)
783
+ SENSITIVE = []
784
+ include Aws::Structure
785
+ end
786
+
787
+ class DeleteServiceProfileResponse < Aws::EmptyStructure; end
788
+
789
+ # @note When making an API call, you may pass DeleteWirelessDeviceRequest
790
+ # data as a hash:
791
+ #
792
+ # {
793
+ # id: "WirelessDeviceId", # required
794
+ # }
795
+ #
796
+ # @!attribute [rw] id
797
+ # The ID of the resource to delete.
798
+ # @return [String]
799
+ #
800
+ class DeleteWirelessDeviceRequest < Struct.new(
801
+ :id)
802
+ SENSITIVE = []
803
+ include Aws::Structure
804
+ end
805
+
806
+ class DeleteWirelessDeviceResponse < Aws::EmptyStructure; end
807
+
808
+ # @note When making an API call, you may pass DeleteWirelessGatewayRequest
809
+ # data as a hash:
810
+ #
811
+ # {
812
+ # id: "WirelessGatewayId", # required
813
+ # }
814
+ #
815
+ # @!attribute [rw] id
816
+ # The ID of the resource to delete.
817
+ # @return [String]
818
+ #
819
+ class DeleteWirelessGatewayRequest < Struct.new(
820
+ :id)
821
+ SENSITIVE = []
822
+ include Aws::Structure
823
+ end
824
+
825
+ class DeleteWirelessGatewayResponse < Aws::EmptyStructure; end
826
+
827
+ # @note When making an API call, you may pass DeleteWirelessGatewayTaskDefinitionRequest
828
+ # data as a hash:
829
+ #
830
+ # {
831
+ # id: "WirelessGatewayTaskDefinitionId", # required
832
+ # }
833
+ #
834
+ # @!attribute [rw] id
835
+ # The ID of the resource to delete.
836
+ # @return [String]
837
+ #
838
+ class DeleteWirelessGatewayTaskDefinitionRequest < Struct.new(
839
+ :id)
840
+ SENSITIVE = []
841
+ include Aws::Structure
842
+ end
843
+
844
+ class DeleteWirelessGatewayTaskDefinitionResponse < Aws::EmptyStructure; end
845
+
846
+ # @note When making an API call, you may pass DeleteWirelessGatewayTaskRequest
847
+ # data as a hash:
848
+ #
849
+ # {
850
+ # id: "WirelessGatewayId", # required
851
+ # }
852
+ #
853
+ # @!attribute [rw] id
854
+ # The ID of the resource to delete.
855
+ # @return [String]
856
+ #
857
+ class DeleteWirelessGatewayTaskRequest < Struct.new(
858
+ :id)
859
+ SENSITIVE = []
860
+ include Aws::Structure
861
+ end
862
+
863
+ class DeleteWirelessGatewayTaskResponse < Aws::EmptyStructure; end
864
+
865
+ # Describes a destination.
866
+ #
867
+ # @!attribute [rw] arn
868
+ # The Amazon Resource Name of the resource.
869
+ # @return [String]
870
+ #
871
+ # @!attribute [rw] name
872
+ # The name of the resource.
873
+ # @return [String]
874
+ #
875
+ # @!attribute [rw] expression_type
876
+ # The type of value in `Expression`.
877
+ # @return [String]
878
+ #
879
+ # @!attribute [rw] expression
880
+ # The rule name or topic rule to send messages to.
881
+ # @return [String]
882
+ #
883
+ # @!attribute [rw] description
884
+ # The description of the resource.
885
+ # @return [String]
886
+ #
887
+ # @!attribute [rw] role_arn
888
+ # The ARN of the IAM Role that authorizes the destination.
889
+ # @return [String]
890
+ #
891
+ class Destinations < Struct.new(
892
+ :arn,
893
+ :name,
894
+ :expression_type,
895
+ :expression,
896
+ :description,
897
+ :role_arn)
898
+ SENSITIVE = []
899
+ include Aws::Structure
900
+ end
901
+
902
+ # Describes a device profile.
903
+ #
904
+ # @!attribute [rw] arn
905
+ # The Amazon Resource Name of the resource.
906
+ # @return [String]
907
+ #
908
+ # @!attribute [rw] name
909
+ # The name of the resource.
910
+ # @return [String]
911
+ #
912
+ # @!attribute [rw] id
913
+ # The ID of the device profile.
914
+ # @return [String]
915
+ #
916
+ class DeviceProfile < Struct.new(
917
+ :arn,
918
+ :name,
919
+ :id)
920
+ SENSITIVE = []
921
+ include Aws::Structure
922
+ end
923
+
924
+ # @note When making an API call, you may pass DisassociateAwsAccountFromPartnerAccountRequest
925
+ # data as a hash:
926
+ #
927
+ # {
928
+ # partner_account_id: "PartnerAccountId", # required
929
+ # partner_type: "Sidewalk", # required, accepts Sidewalk
930
+ # }
931
+ #
932
+ # @!attribute [rw] partner_account_id
933
+ # The partner account ID to disassociate from the AWS account.
934
+ # @return [String]
935
+ #
936
+ # @!attribute [rw] partner_type
937
+ # The partner type.
938
+ # @return [String]
939
+ #
940
+ class DisassociateAwsAccountFromPartnerAccountRequest < Struct.new(
941
+ :partner_account_id,
942
+ :partner_type)
943
+ SENSITIVE = []
944
+ include Aws::Structure
945
+ end
946
+
947
+ class DisassociateAwsAccountFromPartnerAccountResponse < Aws::EmptyStructure; end
948
+
949
+ # @note When making an API call, you may pass DisassociateWirelessDeviceFromThingRequest
950
+ # data as a hash:
951
+ #
952
+ # {
953
+ # id: "WirelessDeviceId", # required
954
+ # }
955
+ #
956
+ # @!attribute [rw] id
957
+ # The ID of the resource to update.
958
+ # @return [String]
959
+ #
960
+ class DisassociateWirelessDeviceFromThingRequest < Struct.new(
961
+ :id)
962
+ SENSITIVE = []
963
+ include Aws::Structure
964
+ end
965
+
966
+ class DisassociateWirelessDeviceFromThingResponse < Aws::EmptyStructure; end
967
+
968
+ # @note When making an API call, you may pass DisassociateWirelessGatewayFromCertificateRequest
969
+ # data as a hash:
970
+ #
971
+ # {
972
+ # id: "WirelessGatewayId", # required
973
+ # }
974
+ #
975
+ # @!attribute [rw] id
976
+ # The ID of the resource to update.
977
+ # @return [String]
978
+ #
979
+ class DisassociateWirelessGatewayFromCertificateRequest < Struct.new(
980
+ :id)
981
+ SENSITIVE = []
982
+ include Aws::Structure
983
+ end
984
+
985
+ class DisassociateWirelessGatewayFromCertificateResponse < Aws::EmptyStructure; end
986
+
987
+ # @note When making an API call, you may pass DisassociateWirelessGatewayFromThingRequest
988
+ # data as a hash:
989
+ #
990
+ # {
991
+ # id: "WirelessGatewayId", # required
992
+ # }
993
+ #
994
+ # @!attribute [rw] id
995
+ # The ID of the resource to update.
996
+ # @return [String]
997
+ #
998
+ class DisassociateWirelessGatewayFromThingRequest < Struct.new(
999
+ :id)
1000
+ SENSITIVE = []
1001
+ include Aws::Structure
1002
+ end
1003
+
1004
+ class DisassociateWirelessGatewayFromThingResponse < Aws::EmptyStructure; end
1005
+
1006
+ # @note When making an API call, you may pass GetDestinationRequest
1007
+ # data as a hash:
1008
+ #
1009
+ # {
1010
+ # name: "DestinationName", # required
1011
+ # }
1012
+ #
1013
+ # @!attribute [rw] name
1014
+ # The name of the resource to get.
1015
+ # @return [String]
1016
+ #
1017
+ class GetDestinationRequest < Struct.new(
1018
+ :name)
1019
+ SENSITIVE = []
1020
+ include Aws::Structure
1021
+ end
1022
+
1023
+ # @!attribute [rw] arn
1024
+ # The Amazon Resource Name of the resource.
1025
+ # @return [String]
1026
+ #
1027
+ # @!attribute [rw] name
1028
+ # The name of the resource.
1029
+ # @return [String]
1030
+ #
1031
+ # @!attribute [rw] expression
1032
+ # The rule name or topic rule to send messages to.
1033
+ # @return [String]
1034
+ #
1035
+ # @!attribute [rw] expression_type
1036
+ # The type of value in `Expression`.
1037
+ # @return [String]
1038
+ #
1039
+ # @!attribute [rw] description
1040
+ # The description of the resource.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] role_arn
1044
+ # The ARN of the IAM Role that authorizes the destination.
1045
+ # @return [String]
1046
+ #
1047
+ class GetDestinationResponse < Struct.new(
1048
+ :arn,
1049
+ :name,
1050
+ :expression,
1051
+ :expression_type,
1052
+ :description,
1053
+ :role_arn)
1054
+ SENSITIVE = []
1055
+ include Aws::Structure
1056
+ end
1057
+
1058
+ # @note When making an API call, you may pass GetDeviceProfileRequest
1059
+ # data as a hash:
1060
+ #
1061
+ # {
1062
+ # id: "DeviceProfileId", # required
1063
+ # }
1064
+ #
1065
+ # @!attribute [rw] id
1066
+ # The ID of the resource to get.
1067
+ # @return [String]
1068
+ #
1069
+ class GetDeviceProfileRequest < Struct.new(
1070
+ :id)
1071
+ SENSITIVE = []
1072
+ include Aws::Structure
1073
+ end
1074
+
1075
+ # @!attribute [rw] arn
1076
+ # The Amazon Resource Name of the resource.
1077
+ # @return [String]
1078
+ #
1079
+ # @!attribute [rw] name
1080
+ # The name of the resource.
1081
+ # @return [String]
1082
+ #
1083
+ # @!attribute [rw] id
1084
+ # The ID of the device profile.
1085
+ # @return [String]
1086
+ #
1087
+ # @!attribute [rw] lo_ra_wan
1088
+ # Information about the device profile.
1089
+ # @return [Types::LoRaWANDeviceProfile]
1090
+ #
1091
+ class GetDeviceProfileResponse < Struct.new(
1092
+ :arn,
1093
+ :name,
1094
+ :id,
1095
+ :lo_ra_wan)
1096
+ SENSITIVE = []
1097
+ include Aws::Structure
1098
+ end
1099
+
1100
+ # @note When making an API call, you may pass GetPartnerAccountRequest
1101
+ # data as a hash:
1102
+ #
1103
+ # {
1104
+ # partner_account_id: "PartnerAccountId", # required
1105
+ # partner_type: "Sidewalk", # required, accepts Sidewalk
1106
+ # }
1107
+ #
1108
+ # @!attribute [rw] partner_account_id
1109
+ # The partner account ID to disassociate from the AWS account.
1110
+ # @return [String]
1111
+ #
1112
+ # @!attribute [rw] partner_type
1113
+ # The partner type.
1114
+ # @return [String]
1115
+ #
1116
+ class GetPartnerAccountRequest < Struct.new(
1117
+ :partner_account_id,
1118
+ :partner_type)
1119
+ SENSITIVE = []
1120
+ include Aws::Structure
1121
+ end
1122
+
1123
+ # @!attribute [rw] sidewalk
1124
+ # The Sidewalk account credentials.
1125
+ #
1126
+ # The `AppServerPrivateKey` value is empty to protect its security.
1127
+ # @return [Types::SidewalkAccountInfoWithFingerprint]
1128
+ #
1129
+ # @!attribute [rw] account_linked
1130
+ # Whether the partner account is linked to the AWS account.
1131
+ # @return [Boolean]
1132
+ #
1133
+ class GetPartnerAccountResponse < Struct.new(
1134
+ :sidewalk,
1135
+ :account_linked)
1136
+ SENSITIVE = []
1137
+ include Aws::Structure
1138
+ end
1139
+
1140
+ # @note When making an API call, you may pass GetServiceEndpointRequest
1141
+ # data as a hash:
1142
+ #
1143
+ # {
1144
+ # service_type: "CUPS", # accepts CUPS, LNS
1145
+ # }
1146
+ #
1147
+ # @!attribute [rw] service_type
1148
+ # The service type for which to get endpoint information about. Can be
1149
+ # `CUPS` for the Configuration and Update Server endpoint, or `LNS`
1150
+ # for the LoRaWAN Network Server endpoint.
1151
+ # @return [String]
1152
+ #
1153
+ class GetServiceEndpointRequest < Struct.new(
1154
+ :service_type)
1155
+ SENSITIVE = []
1156
+ include Aws::Structure
1157
+ end
1158
+
1159
+ # @!attribute [rw] service_type
1160
+ # The endpoint's service type.
1161
+ # @return [String]
1162
+ #
1163
+ # @!attribute [rw] service_endpoint
1164
+ # The service endpoint value.
1165
+ # @return [String]
1166
+ #
1167
+ # @!attribute [rw] server_trust
1168
+ # The Root CA of the server trust certificate.
1169
+ # @return [String]
1170
+ #
1171
+ class GetServiceEndpointResponse < Struct.new(
1172
+ :service_type,
1173
+ :service_endpoint,
1174
+ :server_trust)
1175
+ SENSITIVE = []
1176
+ include Aws::Structure
1177
+ end
1178
+
1179
+ # @note When making an API call, you may pass GetServiceProfileRequest
1180
+ # data as a hash:
1181
+ #
1182
+ # {
1183
+ # id: "ServiceProfileId", # required
1184
+ # }
1185
+ #
1186
+ # @!attribute [rw] id
1187
+ # The ID of the resource to get.
1188
+ # @return [String]
1189
+ #
1190
+ class GetServiceProfileRequest < Struct.new(
1191
+ :id)
1192
+ SENSITIVE = []
1193
+ include Aws::Structure
1194
+ end
1195
+
1196
+ # @!attribute [rw] arn
1197
+ # The Amazon Resource Name of the resource.
1198
+ # @return [String]
1199
+ #
1200
+ # @!attribute [rw] name
1201
+ # The name of the resource.
1202
+ # @return [String]
1203
+ #
1204
+ # @!attribute [rw] id
1205
+ # The ID of the service profile.
1206
+ # @return [String]
1207
+ #
1208
+ # @!attribute [rw] lo_ra_wan
1209
+ # Information about the service profile.
1210
+ # @return [Types::LoRaWANGetServiceProfileInfo]
1211
+ #
1212
+ class GetServiceProfileResponse < Struct.new(
1213
+ :arn,
1214
+ :name,
1215
+ :id,
1216
+ :lo_ra_wan)
1217
+ SENSITIVE = []
1218
+ include Aws::Structure
1219
+ end
1220
+
1221
+ # @note When making an API call, you may pass GetWirelessDeviceRequest
1222
+ # data as a hash:
1223
+ #
1224
+ # {
1225
+ # identifier: "Identifier", # required
1226
+ # identifier_type: "WirelessDeviceId", # required, accepts WirelessDeviceId, DevEui, ThingName
1227
+ # }
1228
+ #
1229
+ # @!attribute [rw] identifier
1230
+ # The identifier of the wireless device to get.
1231
+ # @return [String]
1232
+ #
1233
+ # @!attribute [rw] identifier_type
1234
+ # The type of identifier used in `identifier`.
1235
+ # @return [String]
1236
+ #
1237
+ class GetWirelessDeviceRequest < Struct.new(
1238
+ :identifier,
1239
+ :identifier_type)
1240
+ SENSITIVE = []
1241
+ include Aws::Structure
1242
+ end
1243
+
1244
+ # @!attribute [rw] type
1245
+ # The wireless device type.
1246
+ # @return [String]
1247
+ #
1248
+ # @!attribute [rw] name
1249
+ # The name of the resource.
1250
+ # @return [String]
1251
+ #
1252
+ # @!attribute [rw] description
1253
+ # The description of the resource.
1254
+ # @return [String]
1255
+ #
1256
+ # @!attribute [rw] destination_name
1257
+ # The name of the destination to which the device is assigned.
1258
+ # @return [String]
1259
+ #
1260
+ # @!attribute [rw] id
1261
+ # The ID of the wireless device.
1262
+ # @return [String]
1263
+ #
1264
+ # @!attribute [rw] arn
1265
+ # The Amazon Resource Name of the resource.
1266
+ # @return [String]
1267
+ #
1268
+ # @!attribute [rw] thing_name
1269
+ # The name of the thing associated with the wireless device.
1270
+ # @return [String]
1271
+ #
1272
+ # @!attribute [rw] thing_arn
1273
+ # The ARN of the thing associated with the wireless device.
1274
+ # @return [String]
1275
+ #
1276
+ # @!attribute [rw] lo_ra_wan
1277
+ # Information about the wireless device.
1278
+ # @return [Types::LoRaWANDevice]
1279
+ #
1280
+ class GetWirelessDeviceResponse < Struct.new(
1281
+ :type,
1282
+ :name,
1283
+ :description,
1284
+ :destination_name,
1285
+ :id,
1286
+ :arn,
1287
+ :thing_name,
1288
+ :thing_arn,
1289
+ :lo_ra_wan)
1290
+ SENSITIVE = []
1291
+ include Aws::Structure
1292
+ end
1293
+
1294
+ # @note When making an API call, you may pass GetWirelessDeviceStatisticsRequest
1295
+ # data as a hash:
1296
+ #
1297
+ # {
1298
+ # wireless_device_id: "WirelessDeviceId", # required
1299
+ # }
1300
+ #
1301
+ # @!attribute [rw] wireless_device_id
1302
+ # The ID of the wireless device for which to get the data.
1303
+ # @return [String]
1304
+ #
1305
+ class GetWirelessDeviceStatisticsRequest < Struct.new(
1306
+ :wireless_device_id)
1307
+ SENSITIVE = []
1308
+ include Aws::Structure
1309
+ end
1310
+
1311
+ # @!attribute [rw] wireless_device_id
1312
+ # The ID of the wireless device.
1313
+ # @return [String]
1314
+ #
1315
+ # @!attribute [rw] last_uplink_received_at
1316
+ # The date and time when the most recent uplink was received.
1317
+ # @return [String]
1318
+ #
1319
+ # @!attribute [rw] lo_ra_wan
1320
+ # Information about the wireless device's operations.
1321
+ # @return [Types::LoRaWANDeviceMetadata]
1322
+ #
1323
+ class GetWirelessDeviceStatisticsResponse < Struct.new(
1324
+ :wireless_device_id,
1325
+ :last_uplink_received_at,
1326
+ :lo_ra_wan)
1327
+ SENSITIVE = []
1328
+ include Aws::Structure
1329
+ end
1330
+
1331
+ # @note When making an API call, you may pass GetWirelessGatewayCertificateRequest
1332
+ # data as a hash:
1333
+ #
1334
+ # {
1335
+ # id: "WirelessGatewayId", # required
1336
+ # }
1337
+ #
1338
+ # @!attribute [rw] id
1339
+ # The ID of the resource to get.
1340
+ # @return [String]
1341
+ #
1342
+ class GetWirelessGatewayCertificateRequest < Struct.new(
1343
+ :id)
1344
+ SENSITIVE = []
1345
+ include Aws::Structure
1346
+ end
1347
+
1348
+ # @!attribute [rw] iot_certificate_id
1349
+ # The ID of the certificate associated with the wireless gateway.
1350
+ # @return [String]
1351
+ #
1352
+ class GetWirelessGatewayCertificateResponse < Struct.new(
1353
+ :iot_certificate_id)
1354
+ SENSITIVE = []
1355
+ include Aws::Structure
1356
+ end
1357
+
1358
+ # @note When making an API call, you may pass GetWirelessGatewayFirmwareInformationRequest
1359
+ # data as a hash:
1360
+ #
1361
+ # {
1362
+ # id: "WirelessGatewayId", # required
1363
+ # }
1364
+ #
1365
+ # @!attribute [rw] id
1366
+ # The ID of the resource to get.
1367
+ # @return [String]
1368
+ #
1369
+ class GetWirelessGatewayFirmwareInformationRequest < Struct.new(
1370
+ :id)
1371
+ SENSITIVE = []
1372
+ include Aws::Structure
1373
+ end
1374
+
1375
+ # @!attribute [rw] lo_ra_wan
1376
+ # Information about the wireless gateway's firmware.
1377
+ # @return [Types::LoRaWANGatewayCurrentVersion]
1378
+ #
1379
+ class GetWirelessGatewayFirmwareInformationResponse < Struct.new(
1380
+ :lo_ra_wan)
1381
+ SENSITIVE = []
1382
+ include Aws::Structure
1383
+ end
1384
+
1385
+ # @note When making an API call, you may pass GetWirelessGatewayRequest
1386
+ # data as a hash:
1387
+ #
1388
+ # {
1389
+ # identifier: "Identifier", # required
1390
+ # identifier_type: "GatewayEui", # required, accepts GatewayEui, WirelessGatewayId, ThingName
1391
+ # }
1392
+ #
1393
+ # @!attribute [rw] identifier
1394
+ # The identifier of the wireless gateway to get.
1395
+ # @return [String]
1396
+ #
1397
+ # @!attribute [rw] identifier_type
1398
+ # The type of identifier used in `identifier`.
1399
+ # @return [String]
1400
+ #
1401
+ class GetWirelessGatewayRequest < Struct.new(
1402
+ :identifier,
1403
+ :identifier_type)
1404
+ SENSITIVE = []
1405
+ include Aws::Structure
1406
+ end
1407
+
1408
+ # @!attribute [rw] name
1409
+ # The name of the resource.
1410
+ # @return [String]
1411
+ #
1412
+ # @!attribute [rw] id
1413
+ # The ID of the wireless gateway.
1414
+ # @return [String]
1415
+ #
1416
+ # @!attribute [rw] description
1417
+ # The description of the resource.
1418
+ # @return [String]
1419
+ #
1420
+ # @!attribute [rw] lo_ra_wan
1421
+ # Information about the wireless gateway.
1422
+ # @return [Types::LoRaWANGateway]
1423
+ #
1424
+ # @!attribute [rw] arn
1425
+ # The Amazon Resource Name of the resource.
1426
+ # @return [String]
1427
+ #
1428
+ # @!attribute [rw] thing_name
1429
+ # The name of the thing associated with the wireless gateway.
1430
+ # @return [String]
1431
+ #
1432
+ # @!attribute [rw] thing_arn
1433
+ # The ARN of the thing associated with the wireless gateway.
1434
+ # @return [String]
1435
+ #
1436
+ class GetWirelessGatewayResponse < Struct.new(
1437
+ :name,
1438
+ :id,
1439
+ :description,
1440
+ :lo_ra_wan,
1441
+ :arn,
1442
+ :thing_name,
1443
+ :thing_arn)
1444
+ SENSITIVE = []
1445
+ include Aws::Structure
1446
+ end
1447
+
1448
+ # @note When making an API call, you may pass GetWirelessGatewayStatisticsRequest
1449
+ # data as a hash:
1450
+ #
1451
+ # {
1452
+ # wireless_gateway_id: "WirelessGatewayId", # required
1453
+ # }
1454
+ #
1455
+ # @!attribute [rw] wireless_gateway_id
1456
+ # The ID of the wireless gateway for which to get the data.
1457
+ # @return [String]
1458
+ #
1459
+ class GetWirelessGatewayStatisticsRequest < Struct.new(
1460
+ :wireless_gateway_id)
1461
+ SENSITIVE = []
1462
+ include Aws::Structure
1463
+ end
1464
+
1465
+ # @!attribute [rw] wireless_gateway_id
1466
+ # The ID of the wireless gateway.
1467
+ # @return [String]
1468
+ #
1469
+ # @!attribute [rw] last_uplink_received_at
1470
+ # The date and time when the most recent uplink was received.
1471
+ # @return [String]
1472
+ #
1473
+ class GetWirelessGatewayStatisticsResponse < Struct.new(
1474
+ :wireless_gateway_id,
1475
+ :last_uplink_received_at)
1476
+ SENSITIVE = []
1477
+ include Aws::Structure
1478
+ end
1479
+
1480
+ # @note When making an API call, you may pass GetWirelessGatewayTaskDefinitionRequest
1481
+ # data as a hash:
1482
+ #
1483
+ # {
1484
+ # id: "WirelessGatewayTaskDefinitionId", # required
1485
+ # }
1486
+ #
1487
+ # @!attribute [rw] id
1488
+ # The ID of the resource to get.
1489
+ # @return [String]
1490
+ #
1491
+ class GetWirelessGatewayTaskDefinitionRequest < Struct.new(
1492
+ :id)
1493
+ SENSITIVE = []
1494
+ include Aws::Structure
1495
+ end
1496
+
1497
+ # @!attribute [rw] auto_create_tasks
1498
+ # Whether to automatically create tasks using this task definition for
1499
+ # all gateways with the specified current version. If `false`, the
1500
+ # task must me created by calling `CreateWirelessGatewayTask`.
1501
+ # @return [Boolean]
1502
+ #
1503
+ # @!attribute [rw] name
1504
+ # The name of the resource.
1505
+ # @return [String]
1506
+ #
1507
+ # @!attribute [rw] update
1508
+ # Information about the gateways to update.
1509
+ # @return [Types::UpdateWirelessGatewayTaskCreate]
1510
+ #
1511
+ class GetWirelessGatewayTaskDefinitionResponse < Struct.new(
1512
+ :auto_create_tasks,
1513
+ :name,
1514
+ :update)
1515
+ SENSITIVE = []
1516
+ include Aws::Structure
1517
+ end
1518
+
1519
+ # @note When making an API call, you may pass GetWirelessGatewayTaskRequest
1520
+ # data as a hash:
1521
+ #
1522
+ # {
1523
+ # id: "WirelessGatewayId", # required
1524
+ # }
1525
+ #
1526
+ # @!attribute [rw] id
1527
+ # The ID of the resource to get.
1528
+ # @return [String]
1529
+ #
1530
+ class GetWirelessGatewayTaskRequest < Struct.new(
1531
+ :id)
1532
+ SENSITIVE = []
1533
+ include Aws::Structure
1534
+ end
1535
+
1536
+ # @!attribute [rw] wireless_gateway_id
1537
+ # The ID of the wireless gateway.
1538
+ # @return [String]
1539
+ #
1540
+ # @!attribute [rw] wireless_gateway_task_definition_id
1541
+ # The ID of the WirelessGatewayTask.
1542
+ # @return [String]
1543
+ #
1544
+ # @!attribute [rw] last_uplink_received_at
1545
+ # The date and time when the most recent uplink was received.
1546
+ # @return [String]
1547
+ #
1548
+ # @!attribute [rw] task_created_at
1549
+ # The date and time when the task was created.
1550
+ # @return [String]
1551
+ #
1552
+ # @!attribute [rw] status
1553
+ # The status of the request.
1554
+ # @return [String]
1555
+ #
1556
+ class GetWirelessGatewayTaskResponse < Struct.new(
1557
+ :wireless_gateway_id,
1558
+ :wireless_gateway_task_definition_id,
1559
+ :last_uplink_received_at,
1560
+ :task_created_at,
1561
+ :status)
1562
+ SENSITIVE = []
1563
+ include Aws::Structure
1564
+ end
1565
+
1566
+ # An unexpected error occurred while processing a request.
1567
+ #
1568
+ # @!attribute [rw] message
1569
+ # @return [String]
1570
+ #
1571
+ class InternalServerException < Struct.new(
1572
+ :message)
1573
+ SENSITIVE = []
1574
+ include Aws::Structure
1575
+ end
1576
+
1577
+ # @note When making an API call, you may pass ListDestinationsRequest
1578
+ # data as a hash:
1579
+ #
1580
+ # {
1581
+ # max_results: 1,
1582
+ # next_token: "NextToken",
1583
+ # }
1584
+ #
1585
+ # @!attribute [rw] max_results
1586
+ # The maximum number of results to return in this operation.
1587
+ # @return [Integer]
1588
+ #
1589
+ # @!attribute [rw] next_token
1590
+ # To retrieve the next set of results, the `nextToken` value from a
1591
+ # previous response; otherwise **null** to receive the first set of
1592
+ # results.
1593
+ # @return [String]
1594
+ #
1595
+ class ListDestinationsRequest < Struct.new(
1596
+ :max_results,
1597
+ :next_token)
1598
+ SENSITIVE = []
1599
+ include Aws::Structure
1600
+ end
1601
+
1602
+ # @!attribute [rw] next_token
1603
+ # The token to use to get the next set of results, or **null** if
1604
+ # there are no additional results.
1605
+ # @return [String]
1606
+ #
1607
+ # @!attribute [rw] destination_list
1608
+ # The list of destinations.
1609
+ # @return [Array<Types::Destinations>]
1610
+ #
1611
+ class ListDestinationsResponse < Struct.new(
1612
+ :next_token,
1613
+ :destination_list)
1614
+ SENSITIVE = []
1615
+ include Aws::Structure
1616
+ end
1617
+
1618
+ # @note When making an API call, you may pass ListDeviceProfilesRequest
1619
+ # data as a hash:
1620
+ #
1621
+ # {
1622
+ # next_token: "NextToken",
1623
+ # max_results: 1,
1624
+ # }
1625
+ #
1626
+ # @!attribute [rw] next_token
1627
+ # To retrieve the next set of results, the `nextToken` value from a
1628
+ # previous response; otherwise **null** to receive the first set of
1629
+ # results.
1630
+ # @return [String]
1631
+ #
1632
+ # @!attribute [rw] max_results
1633
+ # The maximum number of results to return in this operation.
1634
+ # @return [Integer]
1635
+ #
1636
+ class ListDeviceProfilesRequest < Struct.new(
1637
+ :next_token,
1638
+ :max_results)
1639
+ SENSITIVE = []
1640
+ include Aws::Structure
1641
+ end
1642
+
1643
+ # @!attribute [rw] next_token
1644
+ # The token to use to get the next set of results, or **null** if
1645
+ # there are no additional results.
1646
+ # @return [String]
1647
+ #
1648
+ # @!attribute [rw] device_profile_list
1649
+ # The list of device profiles.
1650
+ # @return [Array<Types::DeviceProfile>]
1651
+ #
1652
+ class ListDeviceProfilesResponse < Struct.new(
1653
+ :next_token,
1654
+ :device_profile_list)
1655
+ SENSITIVE = []
1656
+ include Aws::Structure
1657
+ end
1658
+
1659
+ # @note When making an API call, you may pass ListPartnerAccountsRequest
1660
+ # data as a hash:
1661
+ #
1662
+ # {
1663
+ # next_token: "NextToken",
1664
+ # max_results: 1,
1665
+ # }
1666
+ #
1667
+ # @!attribute [rw] next_token
1668
+ # To retrieve the next set of results, the `nextToken` value from a
1669
+ # previous response; otherwise **null** to receive the first set of
1670
+ # results.
1671
+ # @return [String]
1672
+ #
1673
+ # @!attribute [rw] max_results
1674
+ # The maximum number of results to return in this operation.
1675
+ # @return [Integer]
1676
+ #
1677
+ class ListPartnerAccountsRequest < Struct.new(
1678
+ :next_token,
1679
+ :max_results)
1680
+ SENSITIVE = []
1681
+ include Aws::Structure
1682
+ end
1683
+
1684
+ # @!attribute [rw] next_token
1685
+ # The token to use to get the next set of results, or **null** if
1686
+ # there are no additional results.
1687
+ # @return [String]
1688
+ #
1689
+ # @!attribute [rw] sidewalk
1690
+ # The Sidewalk account credentials.
1691
+ #
1692
+ # The `AppServerPrivateKey` value is empty to protect its security.
1693
+ # @return [Array<Types::SidewalkAccountInfoWithFingerprint>]
1694
+ #
1695
+ class ListPartnerAccountsResponse < Struct.new(
1696
+ :next_token,
1697
+ :sidewalk)
1698
+ SENSITIVE = []
1699
+ include Aws::Structure
1700
+ end
1701
+
1702
+ # @note When making an API call, you may pass ListServiceProfilesRequest
1703
+ # data as a hash:
1704
+ #
1705
+ # {
1706
+ # next_token: "NextToken",
1707
+ # max_results: 1,
1708
+ # }
1709
+ #
1710
+ # @!attribute [rw] next_token
1711
+ # To retrieve the next set of results, the `nextToken` value from a
1712
+ # previous response; otherwise **null** to receive the first set of
1713
+ # results.
1714
+ # @return [String]
1715
+ #
1716
+ # @!attribute [rw] max_results
1717
+ # The maximum number of results to return in this operation.
1718
+ # @return [Integer]
1719
+ #
1720
+ class ListServiceProfilesRequest < Struct.new(
1721
+ :next_token,
1722
+ :max_results)
1723
+ SENSITIVE = []
1724
+ include Aws::Structure
1725
+ end
1726
+
1727
+ # @!attribute [rw] next_token
1728
+ # The token to use to get the next set of results, or **null** if
1729
+ # there are no additional results.
1730
+ # @return [String]
1731
+ #
1732
+ # @!attribute [rw] service_profile_list
1733
+ # The list of service profiles.
1734
+ # @return [Array<Types::ServiceProfile>]
1735
+ #
1736
+ class ListServiceProfilesResponse < Struct.new(
1737
+ :next_token,
1738
+ :service_profile_list)
1739
+ SENSITIVE = []
1740
+ include Aws::Structure
1741
+ end
1742
+
1743
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1744
+ # data as a hash:
1745
+ #
1746
+ # {
1747
+ # resource_arn: "AmazonResourceName", # required
1748
+ # }
1749
+ #
1750
+ # @!attribute [rw] resource_arn
1751
+ # The ARN of the resource for which to list tags.
1752
+ # @return [String]
1753
+ #
1754
+ class ListTagsForResourceRequest < Struct.new(
1755
+ :resource_arn)
1756
+ SENSITIVE = []
1757
+ include Aws::Structure
1758
+ end
1759
+
1760
+ # @!attribute [rw] tags
1761
+ # The tags attached to the specified resource. Tags are metadata that
1762
+ # can be used to manage a resource
1763
+ # @return [Array<Types::Tag>]
1764
+ #
1765
+ class ListTagsForResourceResponse < Struct.new(
1766
+ :tags)
1767
+ SENSITIVE = []
1768
+ include Aws::Structure
1769
+ end
1770
+
1771
+ # @note When making an API call, you may pass ListWirelessDevicesRequest
1772
+ # data as a hash:
1773
+ #
1774
+ # {
1775
+ # max_results: 1,
1776
+ # next_token: "NextToken",
1777
+ # destination_name: "DestinationName",
1778
+ # device_profile_id: "DeviceProfileId",
1779
+ # service_profile_id: "ServiceProfileId",
1780
+ # wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
1781
+ # }
1782
+ #
1783
+ # @!attribute [rw] max_results
1784
+ # The maximum number of results to return in this operation.
1785
+ # @return [Integer]
1786
+ #
1787
+ # @!attribute [rw] next_token
1788
+ # To retrieve the next set of results, the `nextToken` value from a
1789
+ # previous response; otherwise **null** to receive the first set of
1790
+ # results.
1791
+ # @return [String]
1792
+ #
1793
+ # @!attribute [rw] destination_name
1794
+ # A filter to list only the wireless devices that use this
1795
+ # destination.
1796
+ # @return [String]
1797
+ #
1798
+ # @!attribute [rw] device_profile_id
1799
+ # A filter to list only the wireless devices that use this device
1800
+ # profile.
1801
+ # @return [String]
1802
+ #
1803
+ # @!attribute [rw] service_profile_id
1804
+ # A filter to list only the wireless devices that use this service
1805
+ # profile.
1806
+ # @return [String]
1807
+ #
1808
+ # @!attribute [rw] wireless_device_type
1809
+ # A filter to list only the wireless devices that use this wireless
1810
+ # device type.
1811
+ # @return [String]
1812
+ #
1813
+ class ListWirelessDevicesRequest < Struct.new(
1814
+ :max_results,
1815
+ :next_token,
1816
+ :destination_name,
1817
+ :device_profile_id,
1818
+ :service_profile_id,
1819
+ :wireless_device_type)
1820
+ SENSITIVE = []
1821
+ include Aws::Structure
1822
+ end
1823
+
1824
+ # @!attribute [rw] next_token
1825
+ # The token to use to get the next set of results, or **null** if
1826
+ # there are no additional results.
1827
+ # @return [String]
1828
+ #
1829
+ # @!attribute [rw] wireless_device_list
1830
+ # The ID of the wireless device.
1831
+ # @return [Array<Types::WirelessDeviceStatistics>]
1832
+ #
1833
+ class ListWirelessDevicesResponse < Struct.new(
1834
+ :next_token,
1835
+ :wireless_device_list)
1836
+ SENSITIVE = []
1837
+ include Aws::Structure
1838
+ end
1839
+
1840
+ # @note When making an API call, you may pass ListWirelessGatewayTaskDefinitionsRequest
1841
+ # data as a hash:
1842
+ #
1843
+ # {
1844
+ # max_results: 1,
1845
+ # next_token: "NextToken",
1846
+ # task_definition_type: "UPDATE", # accepts UPDATE
1847
+ # }
1848
+ #
1849
+ # @!attribute [rw] max_results
1850
+ # The maximum number of results to return in this operation.
1851
+ # @return [Integer]
1852
+ #
1853
+ # @!attribute [rw] next_token
1854
+ # To retrieve the next set of results, the `nextToken` value from a
1855
+ # previous response; otherwise **null** to receive the first set of
1856
+ # results.
1857
+ # @return [String]
1858
+ #
1859
+ # @!attribute [rw] task_definition_type
1860
+ # A filter to list only the wireless gateway task definitions that use
1861
+ # this task definition type.
1862
+ # @return [String]
1863
+ #
1864
+ class ListWirelessGatewayTaskDefinitionsRequest < Struct.new(
1865
+ :max_results,
1866
+ :next_token,
1867
+ :task_definition_type)
1868
+ SENSITIVE = []
1869
+ include Aws::Structure
1870
+ end
1871
+
1872
+ # @!attribute [rw] next_token
1873
+ # The token to use to get the next set of results, or **null** if
1874
+ # there are no additional results.
1875
+ # @return [String]
1876
+ #
1877
+ # @!attribute [rw] task_definitions
1878
+ # The list of task definitions.
1879
+ # @return [Array<Types::UpdateWirelessGatewayTaskEntry>]
1880
+ #
1881
+ class ListWirelessGatewayTaskDefinitionsResponse < Struct.new(
1882
+ :next_token,
1883
+ :task_definitions)
1884
+ SENSITIVE = []
1885
+ include Aws::Structure
1886
+ end
1887
+
1888
+ # @note When making an API call, you may pass ListWirelessGatewaysRequest
1889
+ # data as a hash:
1890
+ #
1891
+ # {
1892
+ # next_token: "NextToken",
1893
+ # max_results: 1,
1894
+ # }
1895
+ #
1896
+ # @!attribute [rw] next_token
1897
+ # To retrieve the next set of results, the `nextToken` value from a
1898
+ # previous response; otherwise **null** to receive the first set of
1899
+ # results.
1900
+ # @return [String]
1901
+ #
1902
+ # @!attribute [rw] max_results
1903
+ # The maximum number of results to return in this operation.
1904
+ # @return [Integer]
1905
+ #
1906
+ class ListWirelessGatewaysRequest < Struct.new(
1907
+ :next_token,
1908
+ :max_results)
1909
+ SENSITIVE = []
1910
+ include Aws::Structure
1911
+ end
1912
+
1913
+ # @!attribute [rw] next_token
1914
+ # The token to use to get the next set of results, or **null** if
1915
+ # there are no additional results.
1916
+ # @return [String]
1917
+ #
1918
+ # @!attribute [rw] wireless_gateway_list
1919
+ # The ID of the wireless gateway.
1920
+ # @return [Array<Types::WirelessGatewayStatistics>]
1921
+ #
1922
+ class ListWirelessGatewaysResponse < Struct.new(
1923
+ :next_token,
1924
+ :wireless_gateway_list)
1925
+ SENSITIVE = []
1926
+ include Aws::Structure
1927
+ end
1928
+
1929
+ # LoRa object for create functions.
1930
+ #
1931
+ # @note When making an API call, you may pass LoRaWANDevice
1932
+ # data as a hash:
1933
+ #
1934
+ # {
1935
+ # dev_eui: "DevEui",
1936
+ # device_profile_id: "DeviceProfileId",
1937
+ # service_profile_id: "ServiceProfileId",
1938
+ # otaa_v1_1: {
1939
+ # app_key: "AppKey",
1940
+ # nwk_key: "NwkKey",
1941
+ # join_eui: "JoinEui",
1942
+ # },
1943
+ # otaa_v1_0_x: {
1944
+ # app_key: "AppKey",
1945
+ # app_eui: "AppEui",
1946
+ # },
1947
+ # abp_v1_1: {
1948
+ # dev_addr: "DevAddr",
1949
+ # session_keys: {
1950
+ # f_nwk_s_int_key: "FNwkSIntKey",
1951
+ # s_nwk_s_int_key: "SNwkSIntKey",
1952
+ # nwk_s_enc_key: "NwkSEncKey",
1953
+ # app_s_key: "AppSKey",
1954
+ # },
1955
+ # },
1956
+ # abp_v1_0_x: {
1957
+ # dev_addr: "DevAddr",
1958
+ # session_keys: {
1959
+ # nwk_s_key: "NwkSKey",
1960
+ # app_s_key: "AppSKey",
1961
+ # },
1962
+ # },
1963
+ # }
1964
+ #
1965
+ # @!attribute [rw] dev_eui
1966
+ # The DevEUI value.
1967
+ # @return [String]
1968
+ #
1969
+ # @!attribute [rw] device_profile_id
1970
+ # The ID of the device profile for the new wireless device.
1971
+ # @return [String]
1972
+ #
1973
+ # @!attribute [rw] service_profile_id
1974
+ # The ID of the service profile.
1975
+ # @return [String]
1976
+ #
1977
+ # @!attribute [rw] otaa_v1_1
1978
+ # OTAA device object for v1.1 for create APIs
1979
+ # @return [Types::OtaaV1_1]
1980
+ #
1981
+ # @!attribute [rw] otaa_v1_0_x
1982
+ # OTAA device object for create APIs for v1.0.x
1983
+ # @return [Types::OtaaV1_0_x]
1984
+ #
1985
+ # @!attribute [rw] abp_v1_1
1986
+ # ABP device object for create APIs for v1.1
1987
+ # @return [Types::AbpV1_1]
1988
+ #
1989
+ # @!attribute [rw] abp_v1_0_x
1990
+ # LoRa object for create APIs
1991
+ # @return [Types::AbpV1_0_x]
1992
+ #
1993
+ class LoRaWANDevice < Struct.new(
1994
+ :dev_eui,
1995
+ :device_profile_id,
1996
+ :service_profile_id,
1997
+ :otaa_v1_1,
1998
+ :otaa_v1_0_x,
1999
+ :abp_v1_1,
2000
+ :abp_v1_0_x)
2001
+ SENSITIVE = []
2002
+ include Aws::Structure
2003
+ end
2004
+
2005
+ # LoRaWAN device metatdata.
2006
+ #
2007
+ # @!attribute [rw] dev_eui
2008
+ # The DevEUI value.
2009
+ # @return [String]
2010
+ #
2011
+ # @!attribute [rw] f_port
2012
+ # The FPort value.
2013
+ # @return [Integer]
2014
+ #
2015
+ # @!attribute [rw] data_rate
2016
+ # The DataRate value.
2017
+ # @return [Integer]
2018
+ #
2019
+ # @!attribute [rw] frequency
2020
+ # The device's channel frequency in Hz.
2021
+ # @return [Integer]
2022
+ #
2023
+ # @!attribute [rw] timestamp
2024
+ # The date and time of the metadata.
2025
+ # @return [String]
2026
+ #
2027
+ # @!attribute [rw] gateways
2028
+ # Information about the gateways accessed by the device.
2029
+ # @return [Array<Types::LoRaWANGatewayMetadata>]
2030
+ #
2031
+ class LoRaWANDeviceMetadata < Struct.new(
2032
+ :dev_eui,
2033
+ :f_port,
2034
+ :data_rate,
2035
+ :frequency,
2036
+ :timestamp,
2037
+ :gateways)
2038
+ SENSITIVE = []
2039
+ include Aws::Structure
2040
+ end
2041
+
2042
+ # LoRaWANDeviceProfile object.
2043
+ #
2044
+ # @note When making an API call, you may pass LoRaWANDeviceProfile
2045
+ # data as a hash:
2046
+ #
2047
+ # {
2048
+ # supports_class_b: false,
2049
+ # class_b_timeout: 1,
2050
+ # ping_slot_period: 1,
2051
+ # ping_slot_dr: 1,
2052
+ # ping_slot_freq: 1,
2053
+ # supports_class_c: false,
2054
+ # class_c_timeout: 1,
2055
+ # mac_version: "MacVersion",
2056
+ # reg_params_revision: "RegParamsRevision",
2057
+ # rx_delay_1: 1,
2058
+ # rx_dr_offset_1: 1,
2059
+ # rx_data_rate_2: 1,
2060
+ # rx_freq_2: 1,
2061
+ # factory_preset_freqs_list: [1],
2062
+ # max_eirp: 1,
2063
+ # max_duty_cycle: 1,
2064
+ # rf_region: "RfRegion",
2065
+ # supports_join: false,
2066
+ # supports_32_bit_f_cnt: false,
2067
+ # }
2068
+ #
2069
+ # @!attribute [rw] supports_class_b
2070
+ # The SupportsClassB value.
2071
+ # @return [Boolean]
2072
+ #
2073
+ # @!attribute [rw] class_b_timeout
2074
+ # The ClassBTimeout value.
2075
+ # @return [Integer]
2076
+ #
2077
+ # @!attribute [rw] ping_slot_period
2078
+ # The PingSlotPeriod value.
2079
+ # @return [Integer]
2080
+ #
2081
+ # @!attribute [rw] ping_slot_dr
2082
+ # The PingSlotDR value.
2083
+ # @return [Integer]
2084
+ #
2085
+ # @!attribute [rw] ping_slot_freq
2086
+ # The PingSlotFreq value.
2087
+ # @return [Integer]
2088
+ #
2089
+ # @!attribute [rw] supports_class_c
2090
+ # The SupportsClassC value.
2091
+ # @return [Boolean]
2092
+ #
2093
+ # @!attribute [rw] class_c_timeout
2094
+ # The ClassCTimeout value.
2095
+ # @return [Integer]
2096
+ #
2097
+ # @!attribute [rw] mac_version
2098
+ # The MAC version (such as OTAA 1.1 or OTA 1.0.3) to use with this
2099
+ # device profile.
2100
+ # @return [String]
2101
+ #
2102
+ # @!attribute [rw] reg_params_revision
2103
+ # The version of regional parameters.
2104
+ # @return [String]
2105
+ #
2106
+ # @!attribute [rw] rx_delay_1
2107
+ # The RXDelay1 value.
2108
+ # @return [Integer]
2109
+ #
2110
+ # @!attribute [rw] rx_dr_offset_1
2111
+ # The RXDROffset1 value.
2112
+ # @return [Integer]
2113
+ #
2114
+ # @!attribute [rw] rx_data_rate_2
2115
+ # The RXDataRate2 value.
2116
+ # @return [Integer]
2117
+ #
2118
+ # @!attribute [rw] rx_freq_2
2119
+ # The RXFreq2 value.
2120
+ # @return [Integer]
2121
+ #
2122
+ # @!attribute [rw] factory_preset_freqs_list
2123
+ # The list of values that make up the FactoryPresetFreqs value.
2124
+ # @return [Array<Integer>]
2125
+ #
2126
+ # @!attribute [rw] max_eirp
2127
+ # The MaxEIRP value.
2128
+ # @return [Integer]
2129
+ #
2130
+ # @!attribute [rw] max_duty_cycle
2131
+ # The MaxDutyCycle value.
2132
+ # @return [Integer]
2133
+ #
2134
+ # @!attribute [rw] rf_region
2135
+ # The frequency band (RFRegion) value.
2136
+ # @return [String]
2137
+ #
2138
+ # @!attribute [rw] supports_join
2139
+ # The SupportsJoin value.
2140
+ # @return [Boolean]
2141
+ #
2142
+ # @!attribute [rw] supports_32_bit_f_cnt
2143
+ # The Supports32BitFCnt value.
2144
+ # @return [Boolean]
2145
+ #
2146
+ class LoRaWANDeviceProfile < Struct.new(
2147
+ :supports_class_b,
2148
+ :class_b_timeout,
2149
+ :ping_slot_period,
2150
+ :ping_slot_dr,
2151
+ :ping_slot_freq,
2152
+ :supports_class_c,
2153
+ :class_c_timeout,
2154
+ :mac_version,
2155
+ :reg_params_revision,
2156
+ :rx_delay_1,
2157
+ :rx_dr_offset_1,
2158
+ :rx_data_rate_2,
2159
+ :rx_freq_2,
2160
+ :factory_preset_freqs_list,
2161
+ :max_eirp,
2162
+ :max_duty_cycle,
2163
+ :rf_region,
2164
+ :supports_join,
2165
+ :supports_32_bit_f_cnt)
2166
+ SENSITIVE = []
2167
+ include Aws::Structure
2168
+ end
2169
+
2170
+ # LoRaWANGateway object.
2171
+ #
2172
+ # @note When making an API call, you may pass LoRaWANGateway
2173
+ # data as a hash:
2174
+ #
2175
+ # {
2176
+ # gateway_eui: "GatewayEui",
2177
+ # rf_region: "RfRegion",
2178
+ # }
2179
+ #
2180
+ # @!attribute [rw] gateway_eui
2181
+ # The gateway's EUI value.
2182
+ # @return [String]
2183
+ #
2184
+ # @!attribute [rw] rf_region
2185
+ # The frequency band (RFRegion) value.
2186
+ # @return [String]
2187
+ #
2188
+ class LoRaWANGateway < Struct.new(
2189
+ :gateway_eui,
2190
+ :rf_region)
2191
+ SENSITIVE = []
2192
+ include Aws::Structure
2193
+ end
2194
+
2195
+ # LoRaWANGatewayCurrentVersion object.
2196
+ #
2197
+ # @!attribute [rw] current_version
2198
+ # The version of the gateways that should receive the update.
2199
+ # @return [Types::LoRaWANGatewayVersion]
2200
+ #
2201
+ class LoRaWANGatewayCurrentVersion < Struct.new(
2202
+ :current_version)
2203
+ SENSITIVE = []
2204
+ include Aws::Structure
2205
+ end
2206
+
2207
+ # LoRaWAN gateway metatdata.
2208
+ #
2209
+ # @!attribute [rw] gateway_eui
2210
+ # The gateway's EUI value.
2211
+ # @return [String]
2212
+ #
2213
+ # @!attribute [rw] snr
2214
+ # The SNR value.
2215
+ # @return [Float]
2216
+ #
2217
+ # @!attribute [rw] rssi
2218
+ # The RSSI value.
2219
+ # @return [Float]
2220
+ #
2221
+ class LoRaWANGatewayMetadata < Struct.new(
2222
+ :gateway_eui,
2223
+ :snr,
2224
+ :rssi)
2225
+ SENSITIVE = []
2226
+ include Aws::Structure
2227
+ end
2228
+
2229
+ # LoRaWANGatewayVersion object.
2230
+ #
2231
+ # @note When making an API call, you may pass LoRaWANGatewayVersion
2232
+ # data as a hash:
2233
+ #
2234
+ # {
2235
+ # package_version: "PackageVersion",
2236
+ # model: "Model",
2237
+ # station: "Station",
2238
+ # }
2239
+ #
2240
+ # @!attribute [rw] package_version
2241
+ # The version of the wireless gateway firmware.
2242
+ # @return [String]
2243
+ #
2244
+ # @!attribute [rw] model
2245
+ # The model number of the wireless gateway.
2246
+ # @return [String]
2247
+ #
2248
+ # @!attribute [rw] station
2249
+ # The basic station version of the wireless gateway.
2250
+ # @return [String]
2251
+ #
2252
+ class LoRaWANGatewayVersion < Struct.new(
2253
+ :package_version,
2254
+ :model,
2255
+ :station)
2256
+ SENSITIVE = []
2257
+ include Aws::Structure
2258
+ end
2259
+
2260
+ # LoRaWANGetServiceProfileInfo object.
2261
+ #
2262
+ # @!attribute [rw] ul_rate
2263
+ # The ULRate value.
2264
+ # @return [Integer]
2265
+ #
2266
+ # @!attribute [rw] ul_bucket_size
2267
+ # The ULBucketSize value.
2268
+ # @return [Integer]
2269
+ #
2270
+ # @!attribute [rw] ul_rate_policy
2271
+ # The ULRatePolicy value.
2272
+ # @return [String]
2273
+ #
2274
+ # @!attribute [rw] dl_rate
2275
+ # The DLRate value.
2276
+ # @return [Integer]
2277
+ #
2278
+ # @!attribute [rw] dl_bucket_size
2279
+ # The DLBucketSize value.
2280
+ # @return [Integer]
2281
+ #
2282
+ # @!attribute [rw] dl_rate_policy
2283
+ # The DLRatePolicy value.
2284
+ # @return [String]
2285
+ #
2286
+ # @!attribute [rw] add_gw_metadata
2287
+ # The AddGWMetaData value.
2288
+ # @return [Boolean]
2289
+ #
2290
+ # @!attribute [rw] dev_status_req_freq
2291
+ # The DevStatusReqFreq value.
2292
+ # @return [Integer]
2293
+ #
2294
+ # @!attribute [rw] report_dev_status_battery
2295
+ # The ReportDevStatusBattery value.
2296
+ # @return [Boolean]
2297
+ #
2298
+ # @!attribute [rw] report_dev_status_margin
2299
+ # The ReportDevStatusMargin value.
2300
+ # @return [Boolean]
2301
+ #
2302
+ # @!attribute [rw] dr_min
2303
+ # The DRMin value.
2304
+ # @return [Integer]
2305
+ #
2306
+ # @!attribute [rw] dr_max
2307
+ # The DRMax value.
2308
+ # @return [Integer]
2309
+ #
2310
+ # @!attribute [rw] channel_mask
2311
+ # The ChannelMask value.
2312
+ # @return [String]
2313
+ #
2314
+ # @!attribute [rw] pr_allowed
2315
+ # The PRAllowed value that describes whether passive roaming is
2316
+ # allowed.
2317
+ # @return [Boolean]
2318
+ #
2319
+ # @!attribute [rw] hr_allowed
2320
+ # The HRAllowed value that describes whether handover roaming is
2321
+ # allowed.
2322
+ # @return [Boolean]
2323
+ #
2324
+ # @!attribute [rw] ra_allowed
2325
+ # The RAAllowed value that describes whether roaming activation is
2326
+ # allowed.
2327
+ # @return [Boolean]
2328
+ #
2329
+ # @!attribute [rw] nwk_geo_loc
2330
+ # The NwkGeoLoc value.
2331
+ # @return [Boolean]
2332
+ #
2333
+ # @!attribute [rw] target_per
2334
+ # The TargetPER value.
2335
+ # @return [Integer]
2336
+ #
2337
+ # @!attribute [rw] min_gw_diversity
2338
+ # The MinGwDiversity value.
2339
+ # @return [Integer]
2340
+ #
2341
+ class LoRaWANGetServiceProfileInfo < Struct.new(
2342
+ :ul_rate,
2343
+ :ul_bucket_size,
2344
+ :ul_rate_policy,
2345
+ :dl_rate,
2346
+ :dl_bucket_size,
2347
+ :dl_rate_policy,
2348
+ :add_gw_metadata,
2349
+ :dev_status_req_freq,
2350
+ :report_dev_status_battery,
2351
+ :report_dev_status_margin,
2352
+ :dr_min,
2353
+ :dr_max,
2354
+ :channel_mask,
2355
+ :pr_allowed,
2356
+ :hr_allowed,
2357
+ :ra_allowed,
2358
+ :nwk_geo_loc,
2359
+ :target_per,
2360
+ :min_gw_diversity)
2361
+ SENSITIVE = []
2362
+ include Aws::Structure
2363
+ end
2364
+
2365
+ # LoRaWAN object for list functions.
2366
+ #
2367
+ # @!attribute [rw] dev_eui
2368
+ # The DevEUI value.
2369
+ # @return [String]
2370
+ #
2371
+ class LoRaWANListDevice < Struct.new(
2372
+ :dev_eui)
2373
+ SENSITIVE = []
2374
+ include Aws::Structure
2375
+ end
2376
+
2377
+ # LoRaWAN router info.
2378
+ #
2379
+ # @note When making an API call, you may pass LoRaWANSendDataToDevice
2380
+ # data as a hash:
2381
+ #
2382
+ # {
2383
+ # f_port: 1,
2384
+ # }
2385
+ #
2386
+ # @!attribute [rw] f_port
2387
+ # The Fport value.
2388
+ # @return [Integer]
2389
+ #
2390
+ class LoRaWANSendDataToDevice < Struct.new(
2391
+ :f_port)
2392
+ SENSITIVE = []
2393
+ include Aws::Structure
2394
+ end
2395
+
2396
+ # LoRaWANServiceProfile object.
2397
+ #
2398
+ # @note When making an API call, you may pass LoRaWANServiceProfile
2399
+ # data as a hash:
2400
+ #
2401
+ # {
2402
+ # add_gw_metadata: false,
2403
+ # }
2404
+ #
2405
+ # @!attribute [rw] add_gw_metadata
2406
+ # The AddGWMetaData value.
2407
+ # @return [Boolean]
2408
+ #
2409
+ class LoRaWANServiceProfile < Struct.new(
2410
+ :add_gw_metadata)
2411
+ SENSITIVE = []
2412
+ include Aws::Structure
2413
+ end
2414
+
2415
+ # LoRa object for update functions.
2416
+ #
2417
+ # @note When making an API call, you may pass LoRaWANUpdateDevice
2418
+ # data as a hash:
2419
+ #
2420
+ # {
2421
+ # device_profile_id: "DeviceProfileId",
2422
+ # service_profile_id: "ServiceProfileId",
2423
+ # }
2424
+ #
2425
+ # @!attribute [rw] device_profile_id
2426
+ # The ID of the device profile for the wireless device.
2427
+ # @return [String]
2428
+ #
2429
+ # @!attribute [rw] service_profile_id
2430
+ # The ID of the service profile.
2431
+ # @return [String]
2432
+ #
2433
+ class LoRaWANUpdateDevice < Struct.new(
2434
+ :device_profile_id,
2435
+ :service_profile_id)
2436
+ SENSITIVE = []
2437
+ include Aws::Structure
2438
+ end
2439
+
2440
+ # LoRaWANUpdateGatewayTaskCreate object.
2441
+ #
2442
+ # @note When making an API call, you may pass LoRaWANUpdateGatewayTaskCreate
2443
+ # data as a hash:
2444
+ #
2445
+ # {
2446
+ # update_signature: "UpdateSignature",
2447
+ # sig_key_crc: 1,
2448
+ # current_version: {
2449
+ # package_version: "PackageVersion",
2450
+ # model: "Model",
2451
+ # station: "Station",
2452
+ # },
2453
+ # update_version: {
2454
+ # package_version: "PackageVersion",
2455
+ # model: "Model",
2456
+ # station: "Station",
2457
+ # },
2458
+ # }
2459
+ #
2460
+ # @!attribute [rw] update_signature
2461
+ # The signature used to verify the update firmware.
2462
+ # @return [String]
2463
+ #
2464
+ # @!attribute [rw] sig_key_crc
2465
+ # The CRC of the signature private key to check.
2466
+ # @return [Integer]
2467
+ #
2468
+ # @!attribute [rw] current_version
2469
+ # The version of the gateways that should receive the update.
2470
+ # @return [Types::LoRaWANGatewayVersion]
2471
+ #
2472
+ # @!attribute [rw] update_version
2473
+ # The firmware version to update the gateway to.
2474
+ # @return [Types::LoRaWANGatewayVersion]
2475
+ #
2476
+ class LoRaWANUpdateGatewayTaskCreate < Struct.new(
2477
+ :update_signature,
2478
+ :sig_key_crc,
2479
+ :current_version,
2480
+ :update_version)
2481
+ SENSITIVE = []
2482
+ include Aws::Structure
2483
+ end
2484
+
2485
+ # LoRaWANUpdateGatewayTaskEntry object.
2486
+ #
2487
+ # @!attribute [rw] current_version
2488
+ # The version of the gateways that should receive the update.
2489
+ # @return [Types::LoRaWANGatewayVersion]
2490
+ #
2491
+ # @!attribute [rw] update_version
2492
+ # The firmware version to update the gateway to.
2493
+ # @return [Types::LoRaWANGatewayVersion]
2494
+ #
2495
+ class LoRaWANUpdateGatewayTaskEntry < Struct.new(
2496
+ :current_version,
2497
+ :update_version)
2498
+ SENSITIVE = []
2499
+ include Aws::Structure
2500
+ end
2501
+
2502
+ # OTAA device object for v1.0.x
2503
+ #
2504
+ # @note When making an API call, you may pass OtaaV1_0_x
2505
+ # data as a hash:
2506
+ #
2507
+ # {
2508
+ # app_key: "AppKey",
2509
+ # app_eui: "AppEui",
2510
+ # }
2511
+ #
2512
+ # @!attribute [rw] app_key
2513
+ # The AppKey value.
2514
+ # @return [String]
2515
+ #
2516
+ # @!attribute [rw] app_eui
2517
+ # The AppEUI value.
2518
+ # @return [String]
2519
+ #
2520
+ class OtaaV1_0_x < Struct.new(
2521
+ :app_key,
2522
+ :app_eui)
2523
+ SENSITIVE = []
2524
+ include Aws::Structure
2525
+ end
2526
+
2527
+ # OTAA device object for v1.1
2528
+ #
2529
+ # @note When making an API call, you may pass OtaaV1_1
2530
+ # data as a hash:
2531
+ #
2532
+ # {
2533
+ # app_key: "AppKey",
2534
+ # nwk_key: "NwkKey",
2535
+ # join_eui: "JoinEui",
2536
+ # }
2537
+ #
2538
+ # @!attribute [rw] app_key
2539
+ # The AppKey value.
2540
+ # @return [String]
2541
+ #
2542
+ # @!attribute [rw] nwk_key
2543
+ # The NwkKey value.
2544
+ # @return [String]
2545
+ #
2546
+ # @!attribute [rw] join_eui
2547
+ # The JoinEUI value.
2548
+ # @return [String]
2549
+ #
2550
+ class OtaaV1_1 < Struct.new(
2551
+ :app_key,
2552
+ :nwk_key,
2553
+ :join_eui)
2554
+ SENSITIVE = []
2555
+ include Aws::Structure
2556
+ end
2557
+
2558
+ # Resource does not exist.
2559
+ #
2560
+ # @!attribute [rw] message
2561
+ # @return [String]
2562
+ #
2563
+ # @!attribute [rw] resource_id
2564
+ # @return [String]
2565
+ #
2566
+ # @!attribute [rw] resource_type
2567
+ # @return [String]
2568
+ #
2569
+ class ResourceNotFoundException < Struct.new(
2570
+ :message,
2571
+ :resource_id,
2572
+ :resource_type)
2573
+ SENSITIVE = []
2574
+ include Aws::Structure
2575
+ end
2576
+
2577
+ # @note When making an API call, you may pass SendDataToWirelessDeviceRequest
2578
+ # data as a hash:
2579
+ #
2580
+ # {
2581
+ # id: "WirelessDeviceId", # required
2582
+ # transmit_mode: 1, # required
2583
+ # payload_data: "PayloadData", # required
2584
+ # wireless_metadata: {
2585
+ # lo_ra_wan: {
2586
+ # f_port: 1,
2587
+ # },
2588
+ # sidewalk: {
2589
+ # seq: 1,
2590
+ # },
2591
+ # },
2592
+ # }
2593
+ #
2594
+ # @!attribute [rw] id
2595
+ # The ID of the wireless device to receive the data.
2596
+ # @return [String]
2597
+ #
2598
+ # @!attribute [rw] transmit_mode
2599
+ # The transmit mode to use to send data to the wireless device. Can
2600
+ # be: `0` for UM (unacknowledge mode), `1` for AM (acknowledge mode),
2601
+ # or `2` for (TM) transparent mode.
2602
+ # @return [Integer]
2603
+ #
2604
+ # @!attribute [rw] payload_data
2605
+ # The message payload to send.
2606
+ # @return [String]
2607
+ #
2608
+ # @!attribute [rw] wireless_metadata
2609
+ # Metadata about the message request.
2610
+ # @return [Types::WirelessMetadata]
2611
+ #
2612
+ class SendDataToWirelessDeviceRequest < Struct.new(
2613
+ :id,
2614
+ :transmit_mode,
2615
+ :payload_data,
2616
+ :wireless_metadata)
2617
+ SENSITIVE = []
2618
+ include Aws::Structure
2619
+ end
2620
+
2621
+ # @!attribute [rw] message_id
2622
+ # The ID of the message sent to the wireless device.
2623
+ # @return [String]
2624
+ #
2625
+ class SendDataToWirelessDeviceResponse < Struct.new(
2626
+ :message_id)
2627
+ SENSITIVE = []
2628
+ include Aws::Structure
2629
+ end
2630
+
2631
+ # Information about a service profile.
2632
+ #
2633
+ # @!attribute [rw] arn
2634
+ # The Amazon Resource Name of the resource.
2635
+ # @return [String]
2636
+ #
2637
+ # @!attribute [rw] name
2638
+ # The name of the resource.
2639
+ # @return [String]
2640
+ #
2641
+ # @!attribute [rw] id
2642
+ # The ID of the service profile.
2643
+ # @return [String]
2644
+ #
2645
+ class ServiceProfile < Struct.new(
2646
+ :arn,
2647
+ :name,
2648
+ :id)
2649
+ SENSITIVE = []
2650
+ include Aws::Structure
2651
+ end
2652
+
2653
+ # Session keys for ABP v1.1
2654
+ #
2655
+ # @note When making an API call, you may pass SessionKeysAbpV1_0_x
2656
+ # data as a hash:
2657
+ #
2658
+ # {
2659
+ # nwk_s_key: "NwkSKey",
2660
+ # app_s_key: "AppSKey",
2661
+ # }
2662
+ #
2663
+ # @!attribute [rw] nwk_s_key
2664
+ # The NwkSKey value.
2665
+ # @return [String]
2666
+ #
2667
+ # @!attribute [rw] app_s_key
2668
+ # The AppSKey value.
2669
+ # @return [String]
2670
+ #
2671
+ class SessionKeysAbpV1_0_x < Struct.new(
2672
+ :nwk_s_key,
2673
+ :app_s_key)
2674
+ SENSITIVE = []
2675
+ include Aws::Structure
2676
+ end
2677
+
2678
+ # Session keys for ABP v1.1
2679
+ #
2680
+ # @note When making an API call, you may pass SessionKeysAbpV1_1
2681
+ # data as a hash:
2682
+ #
2683
+ # {
2684
+ # f_nwk_s_int_key: "FNwkSIntKey",
2685
+ # s_nwk_s_int_key: "SNwkSIntKey",
2686
+ # nwk_s_enc_key: "NwkSEncKey",
2687
+ # app_s_key: "AppSKey",
2688
+ # }
2689
+ #
2690
+ # @!attribute [rw] f_nwk_s_int_key
2691
+ # The FNwkSIntKey value.
2692
+ # @return [String]
2693
+ #
2694
+ # @!attribute [rw] s_nwk_s_int_key
2695
+ # The SNwkSIntKey value.
2696
+ # @return [String]
2697
+ #
2698
+ # @!attribute [rw] nwk_s_enc_key
2699
+ # The NwkSEncKey value.
2700
+ # @return [String]
2701
+ #
2702
+ # @!attribute [rw] app_s_key
2703
+ # The AppSKey value.
2704
+ # @return [String]
2705
+ #
2706
+ class SessionKeysAbpV1_1 < Struct.new(
2707
+ :f_nwk_s_int_key,
2708
+ :s_nwk_s_int_key,
2709
+ :nwk_s_enc_key,
2710
+ :app_s_key)
2711
+ SENSITIVE = []
2712
+ include Aws::Structure
2713
+ end
2714
+
2715
+ # Information about a Sidewalk account.
2716
+ #
2717
+ # @note When making an API call, you may pass SidewalkAccountInfo
2718
+ # data as a hash:
2719
+ #
2720
+ # {
2721
+ # amazon_id: "AmazonId",
2722
+ # app_server_private_key: "AppServerPrivateKey",
2723
+ # }
2724
+ #
2725
+ # @!attribute [rw] amazon_id
2726
+ # The Sidewalk Amazon ID.
2727
+ # @return [String]
2728
+ #
2729
+ # @!attribute [rw] app_server_private_key
2730
+ # The Sidewalk application server private key.
2731
+ # @return [String]
2732
+ #
2733
+ class SidewalkAccountInfo < Struct.new(
2734
+ :amazon_id,
2735
+ :app_server_private_key)
2736
+ SENSITIVE = [:app_server_private_key]
2737
+ include Aws::Structure
2738
+ end
2739
+
2740
+ # Information about a Sidewalk account.
2741
+ #
2742
+ # @!attribute [rw] amazon_id
2743
+ # The Sidewalk Amazon ID.
2744
+ # @return [String]
2745
+ #
2746
+ # @!attribute [rw] app_server_private_key
2747
+ # The Sidewalk application server private key.
2748
+ # @return [String]
2749
+ #
2750
+ class SidewalkAccountInfoWithFingerprint < Struct.new(
2751
+ :amazon_id,
2752
+ :app_server_private_key)
2753
+ SENSITIVE = [:app_server_private_key]
2754
+ include Aws::Structure
2755
+ end
2756
+
2757
+ # Sidewalk object used by list functions.
2758
+ #
2759
+ # @!attribute [rw] amazon_id
2760
+ # The Sidewalk Amazon ID.
2761
+ # @return [String]
2762
+ #
2763
+ class SidewalkListDevice < Struct.new(
2764
+ :amazon_id)
2765
+ SENSITIVE = []
2766
+ include Aws::Structure
2767
+ end
2768
+
2769
+ # Information about a Sidewalk router.
2770
+ #
2771
+ # @note When making an API call, you may pass SidewalkSendDataToDevice
2772
+ # data as a hash:
2773
+ #
2774
+ # {
2775
+ # seq: 1,
2776
+ # }
2777
+ #
2778
+ # @!attribute [rw] seq
2779
+ # The sequence number.
2780
+ # @return [Integer]
2781
+ #
2782
+ class SidewalkSendDataToDevice < Struct.new(
2783
+ :seq)
2784
+ SENSITIVE = []
2785
+ include Aws::Structure
2786
+ end
2787
+
2788
+ # Sidewalk update.
2789
+ #
2790
+ # @note When making an API call, you may pass SidewalkUpdateAccount
2791
+ # data as a hash:
2792
+ #
2793
+ # {
2794
+ # app_server_private_key: "AppServerPrivateKey",
2795
+ # }
2796
+ #
2797
+ # @!attribute [rw] app_server_private_key
2798
+ # The new Sidewalk application server private key.
2799
+ # @return [String]
2800
+ #
2801
+ class SidewalkUpdateAccount < Struct.new(
2802
+ :app_server_private_key)
2803
+ SENSITIVE = [:app_server_private_key]
2804
+ include Aws::Structure
2805
+ end
2806
+
2807
+ # A simple label consisting of a customer-defined key-value pair
2808
+ #
2809
+ # @note When making an API call, you may pass Tag
2810
+ # data as a hash:
2811
+ #
2812
+ # {
2813
+ # key: "TagKey", # required
2814
+ # value: "TagValue", # required
2815
+ # }
2816
+ #
2817
+ # @!attribute [rw] key
2818
+ # The tag's key value.
2819
+ # @return [String]
2820
+ #
2821
+ # @!attribute [rw] value
2822
+ # The tag's value.
2823
+ # @return [String]
2824
+ #
2825
+ class Tag < Struct.new(
2826
+ :key,
2827
+ :value)
2828
+ SENSITIVE = []
2829
+ include Aws::Structure
2830
+ end
2831
+
2832
+ # @note When making an API call, you may pass TagResourceRequest
2833
+ # data as a hash:
2834
+ #
2835
+ # {
2836
+ # resource_arn: "AmazonResourceName", # required
2837
+ # tags: [ # required
2838
+ # {
2839
+ # key: "TagKey", # required
2840
+ # value: "TagValue", # required
2841
+ # },
2842
+ # ],
2843
+ # }
2844
+ #
2845
+ # @!attribute [rw] resource_arn
2846
+ # The ARN of the resource to add tags to.
2847
+ # @return [String]
2848
+ #
2849
+ # @!attribute [rw] tags
2850
+ # Adds to or modifies the tags of the given resource. Tags are
2851
+ # metadata that can be used to manage a resource.
2852
+ # @return [Array<Types::Tag>]
2853
+ #
2854
+ class TagResourceRequest < Struct.new(
2855
+ :resource_arn,
2856
+ :tags)
2857
+ SENSITIVE = []
2858
+ include Aws::Structure
2859
+ end
2860
+
2861
+ class TagResourceResponse < Aws::EmptyStructure; end
2862
+
2863
+ # @note When making an API call, you may pass TestWirelessDeviceRequest
2864
+ # data as a hash:
2865
+ #
2866
+ # {
2867
+ # id: "WirelessDeviceId", # required
2868
+ # }
2869
+ #
2870
+ # @!attribute [rw] id
2871
+ # The ID of the wireless device to test.
2872
+ # @return [String]
2873
+ #
2874
+ class TestWirelessDeviceRequest < Struct.new(
2875
+ :id)
2876
+ SENSITIVE = []
2877
+ include Aws::Structure
2878
+ end
2879
+
2880
+ # @!attribute [rw] result
2881
+ # The result returned by the test.
2882
+ # @return [String]
2883
+ #
2884
+ class TestWirelessDeviceResponse < Struct.new(
2885
+ :result)
2886
+ SENSITIVE = []
2887
+ include Aws::Structure
2888
+ end
2889
+
2890
+ # The request was denied because it exceeded the allowed API request
2891
+ # rate.
2892
+ #
2893
+ # @!attribute [rw] message
2894
+ # @return [String]
2895
+ #
2896
+ class ThrottlingException < Struct.new(
2897
+ :message)
2898
+ SENSITIVE = []
2899
+ include Aws::Structure
2900
+ end
2901
+
2902
+ # The request was denied because the resource can't have any more tags.
2903
+ #
2904
+ # @!attribute [rw] message
2905
+ # @return [String]
2906
+ #
2907
+ # @!attribute [rw] resource_name
2908
+ # @return [String]
2909
+ #
2910
+ class TooManyTagsException < Struct.new(
2911
+ :message,
2912
+ :resource_name)
2913
+ SENSITIVE = []
2914
+ include Aws::Structure
2915
+ end
2916
+
2917
+ # @note When making an API call, you may pass UntagResourceRequest
2918
+ # data as a hash:
2919
+ #
2920
+ # {
2921
+ # resource_arn: "AmazonResourceName", # required
2922
+ # tag_keys: ["TagKey"], # required
2923
+ # }
2924
+ #
2925
+ # @!attribute [rw] resource_arn
2926
+ # The ARN of the resource to remove tags from.
2927
+ # @return [String]
2928
+ #
2929
+ # @!attribute [rw] tag_keys
2930
+ # A list of the keys of the tags to remove from the resource.
2931
+ # @return [Array<String>]
2932
+ #
2933
+ class UntagResourceRequest < Struct.new(
2934
+ :resource_arn,
2935
+ :tag_keys)
2936
+ SENSITIVE = []
2937
+ include Aws::Structure
2938
+ end
2939
+
2940
+ class UntagResourceResponse < Aws::EmptyStructure; end
2941
+
2942
+ # @note When making an API call, you may pass UpdateDestinationRequest
2943
+ # data as a hash:
2944
+ #
2945
+ # {
2946
+ # name: "DestinationName", # required
2947
+ # expression_type: "RuleName", # accepts RuleName
2948
+ # expression: "Expression",
2949
+ # description: "Description",
2950
+ # role_arn: "RoleArn",
2951
+ # }
2952
+ #
2953
+ # @!attribute [rw] name
2954
+ # The new name of the resource.
2955
+ # @return [String]
2956
+ #
2957
+ # @!attribute [rw] expression_type
2958
+ # The type of value in `Expression`.
2959
+ # @return [String]
2960
+ #
2961
+ # @!attribute [rw] expression
2962
+ # The new rule name or topic rule to send messages to.
2963
+ # @return [String]
2964
+ #
2965
+ # @!attribute [rw] description
2966
+ # A new description of the resource.
2967
+ # @return [String]
2968
+ #
2969
+ # @!attribute [rw] role_arn
2970
+ # The ARN of the IAM Role that authorizes the destination.
2971
+ # @return [String]
2972
+ #
2973
+ class UpdateDestinationRequest < Struct.new(
2974
+ :name,
2975
+ :expression_type,
2976
+ :expression,
2977
+ :description,
2978
+ :role_arn)
2979
+ SENSITIVE = []
2980
+ include Aws::Structure
2981
+ end
2982
+
2983
+ class UpdateDestinationResponse < Aws::EmptyStructure; end
2984
+
2985
+ # @note When making an API call, you may pass UpdatePartnerAccountRequest
2986
+ # data as a hash:
2987
+ #
2988
+ # {
2989
+ # sidewalk: { # required
2990
+ # app_server_private_key: "AppServerPrivateKey",
2991
+ # },
2992
+ # partner_account_id: "PartnerAccountId", # required
2993
+ # partner_type: "Sidewalk", # required, accepts Sidewalk
2994
+ # }
2995
+ #
2996
+ # @!attribute [rw] sidewalk
2997
+ # The Sidewalk account credentials.
2998
+ # @return [Types::SidewalkUpdateAccount]
2999
+ #
3000
+ # @!attribute [rw] partner_account_id
3001
+ # The ID of the partner account to update.
3002
+ # @return [String]
3003
+ #
3004
+ # @!attribute [rw] partner_type
3005
+ # The partner type.
3006
+ # @return [String]
3007
+ #
3008
+ class UpdatePartnerAccountRequest < Struct.new(
3009
+ :sidewalk,
3010
+ :partner_account_id,
3011
+ :partner_type)
3012
+ SENSITIVE = []
3013
+ include Aws::Structure
3014
+ end
3015
+
3016
+ class UpdatePartnerAccountResponse < Aws::EmptyStructure; end
3017
+
3018
+ # @note When making an API call, you may pass UpdateWirelessDeviceRequest
3019
+ # data as a hash:
3020
+ #
3021
+ # {
3022
+ # id: "WirelessDeviceId", # required
3023
+ # destination_name: "DestinationName",
3024
+ # name: "WirelessDeviceName",
3025
+ # description: "Description",
3026
+ # lo_ra_wan: {
3027
+ # device_profile_id: "DeviceProfileId",
3028
+ # service_profile_id: "ServiceProfileId",
3029
+ # },
3030
+ # }
3031
+ #
3032
+ # @!attribute [rw] id
3033
+ # The ID of the resource to update.
3034
+ # @return [String]
3035
+ #
3036
+ # @!attribute [rw] destination_name
3037
+ # The name of the new destination for the device.
3038
+ # @return [String]
3039
+ #
3040
+ # @!attribute [rw] name
3041
+ # The new name of the resource.
3042
+ # @return [String]
3043
+ #
3044
+ # @!attribute [rw] description
3045
+ # A new description of the resource.
3046
+ # @return [String]
3047
+ #
3048
+ # @!attribute [rw] lo_ra_wan
3049
+ # The updated wireless device's configuration.
3050
+ # @return [Types::LoRaWANUpdateDevice]
3051
+ #
3052
+ class UpdateWirelessDeviceRequest < Struct.new(
3053
+ :id,
3054
+ :destination_name,
3055
+ :name,
3056
+ :description,
3057
+ :lo_ra_wan)
3058
+ SENSITIVE = []
3059
+ include Aws::Structure
3060
+ end
3061
+
3062
+ class UpdateWirelessDeviceResponse < Aws::EmptyStructure; end
3063
+
3064
+ # @note When making an API call, you may pass UpdateWirelessGatewayRequest
3065
+ # data as a hash:
3066
+ #
3067
+ # {
3068
+ # id: "WirelessGatewayId", # required
3069
+ # name: "WirelessGatewayName",
3070
+ # description: "Description",
3071
+ # }
3072
+ #
3073
+ # @!attribute [rw] id
3074
+ # The ID of the resource to update.
3075
+ # @return [String]
3076
+ #
3077
+ # @!attribute [rw] name
3078
+ # The new name of the resource.
3079
+ # @return [String]
3080
+ #
3081
+ # @!attribute [rw] description
3082
+ # A new description of the resource.
3083
+ # @return [String]
3084
+ #
3085
+ class UpdateWirelessGatewayRequest < Struct.new(
3086
+ :id,
3087
+ :name,
3088
+ :description)
3089
+ SENSITIVE = []
3090
+ include Aws::Structure
3091
+ end
3092
+
3093
+ class UpdateWirelessGatewayResponse < Aws::EmptyStructure; end
3094
+
3095
+ # UpdateWirelessGatewayTaskCreate object.
3096
+ #
3097
+ # @note When making an API call, you may pass UpdateWirelessGatewayTaskCreate
3098
+ # data as a hash:
3099
+ #
3100
+ # {
3101
+ # update_data_source: "UpdateDataSource",
3102
+ # update_data_role: "UpdateDataSource",
3103
+ # lo_ra_wan: {
3104
+ # update_signature: "UpdateSignature",
3105
+ # sig_key_crc: 1,
3106
+ # current_version: {
3107
+ # package_version: "PackageVersion",
3108
+ # model: "Model",
3109
+ # station: "Station",
3110
+ # },
3111
+ # update_version: {
3112
+ # package_version: "PackageVersion",
3113
+ # model: "Model",
3114
+ # station: "Station",
3115
+ # },
3116
+ # },
3117
+ # }
3118
+ #
3119
+ # @!attribute [rw] update_data_source
3120
+ # The link to the S3 bucket.
3121
+ # @return [String]
3122
+ #
3123
+ # @!attribute [rw] update_data_role
3124
+ # The IAM role used to read data from the S3 bucket.
3125
+ # @return [String]
3126
+ #
3127
+ # @!attribute [rw] lo_ra_wan
3128
+ # The properties that relate to the LoRaWAN wireless gateway.
3129
+ # @return [Types::LoRaWANUpdateGatewayTaskCreate]
3130
+ #
3131
+ class UpdateWirelessGatewayTaskCreate < Struct.new(
3132
+ :update_data_source,
3133
+ :update_data_role,
3134
+ :lo_ra_wan)
3135
+ SENSITIVE = []
3136
+ include Aws::Structure
3137
+ end
3138
+
3139
+ # UpdateWirelessGatewayTaskEntry object.
3140
+ #
3141
+ # @!attribute [rw] id
3142
+ # The ID of the new wireless gateway task entry.
3143
+ # @return [String]
3144
+ #
3145
+ # @!attribute [rw] lo_ra_wan
3146
+ # The properties that relate to the LoRaWAN wireless gateway.
3147
+ # @return [Types::LoRaWANUpdateGatewayTaskEntry]
3148
+ #
3149
+ class UpdateWirelessGatewayTaskEntry < Struct.new(
3150
+ :id,
3151
+ :lo_ra_wan)
3152
+ SENSITIVE = []
3153
+ include Aws::Structure
3154
+ end
3155
+
3156
+ # The input did not meet the specified constraints.
3157
+ #
3158
+ # @!attribute [rw] message
3159
+ # @return [String]
3160
+ #
3161
+ class ValidationException < Struct.new(
3162
+ :message)
3163
+ SENSITIVE = []
3164
+ include Aws::Structure
3165
+ end
3166
+
3167
+ # Information about a wireless device's operation.
3168
+ #
3169
+ # @!attribute [rw] arn
3170
+ # The Amazon Resource Name of the resource.
3171
+ # @return [String]
3172
+ #
3173
+ # @!attribute [rw] id
3174
+ # The ID of the wireless device reporting the data.
3175
+ # @return [String]
3176
+ #
3177
+ # @!attribute [rw] type
3178
+ # The wireless device type.
3179
+ # @return [String]
3180
+ #
3181
+ # @!attribute [rw] name
3182
+ # The name of the resource.
3183
+ # @return [String]
3184
+ #
3185
+ # @!attribute [rw] destination_name
3186
+ # The name of the destination to which the device is assigned.
3187
+ # @return [String]
3188
+ #
3189
+ # @!attribute [rw] last_uplink_received_at
3190
+ # The date and time when the most recent uplink was received.
3191
+ # @return [String]
3192
+ #
3193
+ # @!attribute [rw] lo_ra_wan
3194
+ # LoRaWAN device info.
3195
+ # @return [Types::LoRaWANListDevice]
3196
+ #
3197
+ # @!attribute [rw] sidewalk
3198
+ # The Sidewalk account credentials.
3199
+ # @return [Types::SidewalkListDevice]
3200
+ #
3201
+ class WirelessDeviceStatistics < Struct.new(
3202
+ :arn,
3203
+ :id,
3204
+ :type,
3205
+ :name,
3206
+ :destination_name,
3207
+ :last_uplink_received_at,
3208
+ :lo_ra_wan,
3209
+ :sidewalk)
3210
+ SENSITIVE = []
3211
+ include Aws::Structure
3212
+ end
3213
+
3214
+ # Information about a wireless gateway's operation.
3215
+ #
3216
+ # @!attribute [rw] arn
3217
+ # The Amazon Resource Name of the resource.
3218
+ # @return [String]
3219
+ #
3220
+ # @!attribute [rw] id
3221
+ # The ID of the wireless gateway reporting the data.
3222
+ # @return [String]
3223
+ #
3224
+ # @!attribute [rw] name
3225
+ # The name of the resource.
3226
+ # @return [String]
3227
+ #
3228
+ # @!attribute [rw] description
3229
+ # The description of the resource.
3230
+ # @return [String]
3231
+ #
3232
+ # @!attribute [rw] lo_ra_wan
3233
+ # LoRaWAN gateway info.
3234
+ # @return [Types::LoRaWANGateway]
3235
+ #
3236
+ # @!attribute [rw] last_uplink_received_at
3237
+ # The date and time when the most recent uplink was received.
3238
+ # @return [String]
3239
+ #
3240
+ class WirelessGatewayStatistics < Struct.new(
3241
+ :arn,
3242
+ :id,
3243
+ :name,
3244
+ :description,
3245
+ :lo_ra_wan,
3246
+ :last_uplink_received_at)
3247
+ SENSITIVE = []
3248
+ include Aws::Structure
3249
+ end
3250
+
3251
+ # WirelessMetadata object.
3252
+ #
3253
+ # @note When making an API call, you may pass WirelessMetadata
3254
+ # data as a hash:
3255
+ #
3256
+ # {
3257
+ # lo_ra_wan: {
3258
+ # f_port: 1,
3259
+ # },
3260
+ # sidewalk: {
3261
+ # seq: 1,
3262
+ # },
3263
+ # }
3264
+ #
3265
+ # @!attribute [rw] lo_ra_wan
3266
+ # LoRaWAN device info.
3267
+ # @return [Types::LoRaWANSendDataToDevice]
3268
+ #
3269
+ # @!attribute [rw] sidewalk
3270
+ # The Sidewalk account credentials.
3271
+ # @return [Types::SidewalkSendDataToDevice]
3272
+ #
3273
+ class WirelessMetadata < Struct.new(
3274
+ :lo_ra_wan,
3275
+ :sidewalk)
3276
+ SENSITIVE = []
3277
+ include Aws::Structure
3278
+ end
3279
+
3280
+ end
3281
+ end