aws-sdk-privatenetworks 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1903 @@
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/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::PrivateNetworks
11
+ module Types
12
+
13
+ # You do not have permission to perform this operation.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # @note When making an API call, you may pass AcknowledgeOrderReceiptRequest
27
+ # data as a hash:
28
+ #
29
+ # {
30
+ # order_arn: "Arn", # required
31
+ # }
32
+ #
33
+ # @!attribute [rw] order_arn
34
+ # The Amazon Resource Name (ARN) of the order.
35
+ # @return [String]
36
+ #
37
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/AcknowledgeOrderReceiptRequest AWS API Documentation
38
+ #
39
+ class AcknowledgeOrderReceiptRequest < Struct.new(
40
+ :order_arn)
41
+ SENSITIVE = []
42
+ include Aws::Structure
43
+ end
44
+
45
+ # @!attribute [rw] order
46
+ # Information about the order.
47
+ # @return [Types::Order]
48
+ #
49
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/AcknowledgeOrderReceiptResponse AWS API Documentation
50
+ #
51
+ class AcknowledgeOrderReceiptResponse < Struct.new(
52
+ :order)
53
+ SENSITIVE = []
54
+ include Aws::Structure
55
+ end
56
+
57
+ # @note When making an API call, you may pass ActivateDeviceIdentifierRequest
58
+ # data as a hash:
59
+ #
60
+ # {
61
+ # client_token: "ClientToken",
62
+ # device_identifier_arn: "Arn", # required
63
+ # }
64
+ #
65
+ # @!attribute [rw] client_token
66
+ # Unique, case-sensitive identifier that you provide to ensure the
67
+ # idempotency of the request. For more information, see [How to ensure
68
+ # idempotency][1].
69
+ #
70
+ #
71
+ #
72
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
73
+ # @return [String]
74
+ #
75
+ # @!attribute [rw] device_identifier_arn
76
+ # The Amazon Resource Name (ARN) of the device identifier.
77
+ # @return [String]
78
+ #
79
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ActivateDeviceIdentifierRequest AWS API Documentation
80
+ #
81
+ class ActivateDeviceIdentifierRequest < Struct.new(
82
+ :client_token,
83
+ :device_identifier_arn)
84
+ SENSITIVE = []
85
+ include Aws::Structure
86
+ end
87
+
88
+ # @!attribute [rw] device_identifier
89
+ # Information about the device identifier.
90
+ # @return [Types::DeviceIdentifier]
91
+ #
92
+ # @!attribute [rw] tags
93
+ # The tags on the device identifier.
94
+ # @return [Hash<String,String>]
95
+ #
96
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ActivateDeviceIdentifierResponse AWS API Documentation
97
+ #
98
+ class ActivateDeviceIdentifierResponse < Struct.new(
99
+ :device_identifier,
100
+ :tags)
101
+ SENSITIVE = [:tags]
102
+ include Aws::Structure
103
+ end
104
+
105
+ # @note When making an API call, you may pass ActivateNetworkSiteRequest
106
+ # data as a hash:
107
+ #
108
+ # {
109
+ # client_token: "ClientToken",
110
+ # network_site_arn: "Arn", # required
111
+ # shipping_address: { # required
112
+ # city: "AddressContent", # required
113
+ # company: "AddressContent",
114
+ # country: "AddressContent", # required
115
+ # name: "AddressContent", # required
116
+ # phone_number: "AddressContent",
117
+ # postal_code: "AddressContent", # required
118
+ # state_or_province: "AddressContent", # required
119
+ # street1: "AddressContent", # required
120
+ # street2: "AddressContent",
121
+ # street3: "AddressContent",
122
+ # },
123
+ # }
124
+ #
125
+ # @!attribute [rw] client_token
126
+ # Unique, case-sensitive identifier that you provide to ensure the
127
+ # idempotency of the request. For more information, see [How to ensure
128
+ # idempotency][1].
129
+ #
130
+ #
131
+ #
132
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] network_site_arn
136
+ # The Amazon Resource Name (ARN) of the network site.
137
+ # @return [String]
138
+ #
139
+ # @!attribute [rw] shipping_address
140
+ # The shipping address of the network site.
141
+ # @return [Types::Address]
142
+ #
143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ActivateNetworkSiteRequest AWS API Documentation
144
+ #
145
+ class ActivateNetworkSiteRequest < Struct.new(
146
+ :client_token,
147
+ :network_site_arn,
148
+ :shipping_address)
149
+ SENSITIVE = []
150
+ include Aws::Structure
151
+ end
152
+
153
+ # @!attribute [rw] network_site
154
+ # Information about the network site.
155
+ # @return [Types::NetworkSite]
156
+ #
157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ActivateNetworkSiteResponse AWS API Documentation
158
+ #
159
+ class ActivateNetworkSiteResponse < Struct.new(
160
+ :network_site)
161
+ SENSITIVE = []
162
+ include Aws::Structure
163
+ end
164
+
165
+ # Information about an address.
166
+ #
167
+ # @note When making an API call, you may pass Address
168
+ # data as a hash:
169
+ #
170
+ # {
171
+ # city: "AddressContent", # required
172
+ # company: "AddressContent",
173
+ # country: "AddressContent", # required
174
+ # name: "AddressContent", # required
175
+ # phone_number: "AddressContent",
176
+ # postal_code: "AddressContent", # required
177
+ # state_or_province: "AddressContent", # required
178
+ # street1: "AddressContent", # required
179
+ # street2: "AddressContent",
180
+ # street3: "AddressContent",
181
+ # }
182
+ #
183
+ # @!attribute [rw] city
184
+ # The city for this address.
185
+ # @return [String]
186
+ #
187
+ # @!attribute [rw] company
188
+ # The company name for this address.
189
+ # @return [String]
190
+ #
191
+ # @!attribute [rw] country
192
+ # The country for this address.
193
+ # @return [String]
194
+ #
195
+ # @!attribute [rw] name
196
+ # The recipient's name for this address.
197
+ # @return [String]
198
+ #
199
+ # @!attribute [rw] phone_number
200
+ # The phone number for this address.
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] postal_code
204
+ # The postal code for this address.
205
+ # @return [String]
206
+ #
207
+ # @!attribute [rw] state_or_province
208
+ # The state or province for this address.
209
+ # @return [String]
210
+ #
211
+ # @!attribute [rw] street1
212
+ # The first line of the street address.
213
+ # @return [String]
214
+ #
215
+ # @!attribute [rw] street2
216
+ # The second line of the street address.
217
+ # @return [String]
218
+ #
219
+ # @!attribute [rw] street3
220
+ # The third line of the street address.
221
+ # @return [String]
222
+ #
223
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/Address AWS API Documentation
224
+ #
225
+ class Address < Struct.new(
226
+ :city,
227
+ :company,
228
+ :country,
229
+ :name,
230
+ :phone_number,
231
+ :postal_code,
232
+ :state_or_province,
233
+ :street1,
234
+ :street2,
235
+ :street3)
236
+ SENSITIVE = [:city, :company, :country, :name, :phone_number, :postal_code, :state_or_province, :street1, :street2, :street3]
237
+ include Aws::Structure
238
+ end
239
+
240
+ # @note When making an API call, you may pass ConfigureAccessPointRequest
241
+ # data as a hash:
242
+ #
243
+ # {
244
+ # access_point_arn: "Arn", # required
245
+ # cpi_secret_key: "ConfigureAccessPointRequestCpiSecretKeyString",
246
+ # cpi_user_id: "ConfigureAccessPointRequestCpiUserIdString",
247
+ # cpi_user_password: "ConfigureAccessPointRequestCpiUserPasswordString",
248
+ # cpi_username: "ConfigureAccessPointRequestCpiUsernameString",
249
+ # position: {
250
+ # elevation: 1.0,
251
+ # elevation_reference: "AGL", # accepts AGL, AMSL
252
+ # elevation_unit: "FEET", # accepts FEET
253
+ # latitude: 1.0,
254
+ # longitude: 1.0,
255
+ # },
256
+ # }
257
+ #
258
+ # @!attribute [rw] access_point_arn
259
+ # The Amazon Resource Name (ARN) of the network resource.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] cpi_secret_key
263
+ # A Base64 encoded string of the CPI certificate associated with the
264
+ # CPI user who is certifying the coordinates of the network resource.
265
+ # @return [String]
266
+ #
267
+ # @!attribute [rw] cpi_user_id
268
+ # The CPI user ID of the CPI user who is certifying the coordinates of
269
+ # the network resource.
270
+ # @return [String]
271
+ #
272
+ # @!attribute [rw] cpi_user_password
273
+ # The CPI password associated with the CPI certificate in
274
+ # `cpiSecretKey`.
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] cpi_username
278
+ # The CPI user name of the CPI user who is certifying the coordinates
279
+ # of the radio unit.
280
+ # @return [String]
281
+ #
282
+ # @!attribute [rw] position
283
+ # The position of the network resource.
284
+ # @return [Types::Position]
285
+ #
286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ConfigureAccessPointRequest AWS API Documentation
287
+ #
288
+ class ConfigureAccessPointRequest < Struct.new(
289
+ :access_point_arn,
290
+ :cpi_secret_key,
291
+ :cpi_user_id,
292
+ :cpi_user_password,
293
+ :cpi_username,
294
+ :position)
295
+ SENSITIVE = [:cpi_secret_key, :cpi_user_id, :cpi_user_password, :cpi_username]
296
+ include Aws::Structure
297
+ end
298
+
299
+ # @!attribute [rw] access_point
300
+ # Information about the network resource.
301
+ # @return [Types::NetworkResource]
302
+ #
303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ConfigureAccessPointResponse AWS API Documentation
304
+ #
305
+ class ConfigureAccessPointResponse < Struct.new(
306
+ :access_point)
307
+ SENSITIVE = []
308
+ include Aws::Structure
309
+ end
310
+
311
+ # @note When making an API call, you may pass CreateNetworkRequest
312
+ # data as a hash:
313
+ #
314
+ # {
315
+ # client_token: "ClientToken",
316
+ # description: "Description",
317
+ # network_name: "Name", # required
318
+ # tags: {
319
+ # "TagKey" => "TagValue",
320
+ # },
321
+ # }
322
+ #
323
+ # @!attribute [rw] client_token
324
+ # Unique, case-sensitive identifier that you provide to ensure the
325
+ # idempotency of the request. For more information, see [How to ensure
326
+ # idempotency][1].
327
+ #
328
+ #
329
+ #
330
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] description
334
+ # The description of the network.
335
+ # @return [String]
336
+ #
337
+ # @!attribute [rw] network_name
338
+ # The name of the network. You can't change the name after you create
339
+ # the network.
340
+ # @return [String]
341
+ #
342
+ # @!attribute [rw] tags
343
+ # The tags to apply to the network.
344
+ # @return [Hash<String,String>]
345
+ #
346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/CreateNetworkRequest AWS API Documentation
347
+ #
348
+ class CreateNetworkRequest < Struct.new(
349
+ :client_token,
350
+ :description,
351
+ :network_name,
352
+ :tags)
353
+ SENSITIVE = [:tags]
354
+ include Aws::Structure
355
+ end
356
+
357
+ # @!attribute [rw] network
358
+ # Information about the network.
359
+ # @return [Types::Network]
360
+ #
361
+ # @!attribute [rw] tags
362
+ # The network tags.
363
+ # @return [Hash<String,String>]
364
+ #
365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/CreateNetworkResponse AWS API Documentation
366
+ #
367
+ class CreateNetworkResponse < Struct.new(
368
+ :network,
369
+ :tags)
370
+ SENSITIVE = [:tags]
371
+ include Aws::Structure
372
+ end
373
+
374
+ # @note When making an API call, you may pass CreateNetworkSiteRequest
375
+ # data as a hash:
376
+ #
377
+ # {
378
+ # availability_zone: "String",
379
+ # availability_zone_id: "String",
380
+ # client_token: "ClientToken",
381
+ # description: "Description",
382
+ # network_arn: "Arn", # required
383
+ # network_site_name: "Name", # required
384
+ # pending_plan: {
385
+ # options: [
386
+ # {
387
+ # name: "String", # required
388
+ # value: "String",
389
+ # },
390
+ # ],
391
+ # resource_definitions: [
392
+ # {
393
+ # count: 1, # required
394
+ # options: [
395
+ # {
396
+ # name: "String", # required
397
+ # value: "String",
398
+ # },
399
+ # ],
400
+ # type: "RADIO_UNIT", # required, accepts RADIO_UNIT, DEVICE_IDENTIFIER
401
+ # },
402
+ # ],
403
+ # },
404
+ # tags: {
405
+ # "TagKey" => "TagValue",
406
+ # },
407
+ # }
408
+ #
409
+ # @!attribute [rw] availability_zone
410
+ # The Availability Zone that is the parent of this site. You can't
411
+ # change the Availability Zone after you create the site.
412
+ # @return [String]
413
+ #
414
+ # @!attribute [rw] availability_zone_id
415
+ # The ID of the Availability Zone that is the parent of this site. You
416
+ # can't change the Availability Zone after you create the site.
417
+ # @return [String]
418
+ #
419
+ # @!attribute [rw] client_token
420
+ # Unique, case-sensitive identifier that you provide to ensure the
421
+ # idempotency of the request. For more information, see [How to ensure
422
+ # idempotency][1].
423
+ #
424
+ #
425
+ #
426
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
427
+ # @return [String]
428
+ #
429
+ # @!attribute [rw] description
430
+ # The description of the site.
431
+ # @return [String]
432
+ #
433
+ # @!attribute [rw] network_arn
434
+ # The Amazon Resource Name (ARN) of the network.
435
+ # @return [String]
436
+ #
437
+ # @!attribute [rw] network_site_name
438
+ # The name of the site. You can't change the name after you create
439
+ # the site.
440
+ # @return [String]
441
+ #
442
+ # @!attribute [rw] pending_plan
443
+ # Information about the pending plan for this site.
444
+ # @return [Types::SitePlan]
445
+ #
446
+ # @!attribute [rw] tags
447
+ # The tags to apply to the network site.
448
+ # @return [Hash<String,String>]
449
+ #
450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/CreateNetworkSiteRequest AWS API Documentation
451
+ #
452
+ class CreateNetworkSiteRequest < Struct.new(
453
+ :availability_zone,
454
+ :availability_zone_id,
455
+ :client_token,
456
+ :description,
457
+ :network_arn,
458
+ :network_site_name,
459
+ :pending_plan,
460
+ :tags)
461
+ SENSITIVE = [:tags]
462
+ include Aws::Structure
463
+ end
464
+
465
+ # @!attribute [rw] network_site
466
+ # Information about the network site.
467
+ # @return [Types::NetworkSite]
468
+ #
469
+ # @!attribute [rw] tags
470
+ # The network site tags.
471
+ # @return [Hash<String,String>]
472
+ #
473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/CreateNetworkSiteResponse AWS API Documentation
474
+ #
475
+ class CreateNetworkSiteResponse < Struct.new(
476
+ :network_site,
477
+ :tags)
478
+ SENSITIVE = [:tags]
479
+ include Aws::Structure
480
+ end
481
+
482
+ # @note When making an API call, you may pass DeactivateDeviceIdentifierRequest
483
+ # data as a hash:
484
+ #
485
+ # {
486
+ # client_token: "ClientToken",
487
+ # device_identifier_arn: "Arn", # required
488
+ # }
489
+ #
490
+ # @!attribute [rw] client_token
491
+ # Unique, case-sensitive identifier that you provide to ensure the
492
+ # idempotency of the request. For more information, see [How to ensure
493
+ # idempotency][1].
494
+ #
495
+ #
496
+ #
497
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
498
+ # @return [String]
499
+ #
500
+ # @!attribute [rw] device_identifier_arn
501
+ # The Amazon Resource Name (ARN) of the device identifier.
502
+ # @return [String]
503
+ #
504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeactivateDeviceIdentifierRequest AWS API Documentation
505
+ #
506
+ class DeactivateDeviceIdentifierRequest < Struct.new(
507
+ :client_token,
508
+ :device_identifier_arn)
509
+ SENSITIVE = []
510
+ include Aws::Structure
511
+ end
512
+
513
+ # @!attribute [rw] device_identifier
514
+ # Information about the device identifier.
515
+ # @return [Types::DeviceIdentifier]
516
+ #
517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeactivateDeviceIdentifierResponse AWS API Documentation
518
+ #
519
+ class DeactivateDeviceIdentifierResponse < Struct.new(
520
+ :device_identifier)
521
+ SENSITIVE = []
522
+ include Aws::Structure
523
+ end
524
+
525
+ # @note When making an API call, you may pass DeleteNetworkRequest
526
+ # data as a hash:
527
+ #
528
+ # {
529
+ # client_token: "ClientToken",
530
+ # network_arn: "Arn", # required
531
+ # }
532
+ #
533
+ # @!attribute [rw] client_token
534
+ # Unique, case-sensitive identifier that you provide to ensure the
535
+ # idempotency of the request. For more information, see [How to ensure
536
+ # idempotency][1].
537
+ #
538
+ #
539
+ #
540
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
541
+ # @return [String]
542
+ #
543
+ # @!attribute [rw] network_arn
544
+ # The Amazon Resource Name (ARN) of the network.
545
+ # @return [String]
546
+ #
547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeleteNetworkRequest AWS API Documentation
548
+ #
549
+ class DeleteNetworkRequest < Struct.new(
550
+ :client_token,
551
+ :network_arn)
552
+ SENSITIVE = []
553
+ include Aws::Structure
554
+ end
555
+
556
+ # @!attribute [rw] network
557
+ # Information about the network.
558
+ # @return [Types::Network]
559
+ #
560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeleteNetworkResponse AWS API Documentation
561
+ #
562
+ class DeleteNetworkResponse < Struct.new(
563
+ :network)
564
+ SENSITIVE = []
565
+ include Aws::Structure
566
+ end
567
+
568
+ # @note When making an API call, you may pass DeleteNetworkSiteRequest
569
+ # data as a hash:
570
+ #
571
+ # {
572
+ # client_token: "ClientToken",
573
+ # network_site_arn: "Arn", # required
574
+ # }
575
+ #
576
+ # @!attribute [rw] client_token
577
+ # Unique, case-sensitive identifier that you provide to ensure the
578
+ # idempotency of the request. For more information, see [How to ensure
579
+ # idempotency][1].
580
+ #
581
+ #
582
+ #
583
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
584
+ # @return [String]
585
+ #
586
+ # @!attribute [rw] network_site_arn
587
+ # The Amazon Resource Name (ARN) of the network site.
588
+ # @return [String]
589
+ #
590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeleteNetworkSiteRequest AWS API Documentation
591
+ #
592
+ class DeleteNetworkSiteRequest < Struct.new(
593
+ :client_token,
594
+ :network_site_arn)
595
+ SENSITIVE = []
596
+ include Aws::Structure
597
+ end
598
+
599
+ # @!attribute [rw] network_site
600
+ # Information about the network site.
601
+ # @return [Types::NetworkSite]
602
+ #
603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeleteNetworkSiteResponse AWS API Documentation
604
+ #
605
+ class DeleteNetworkSiteResponse < Struct.new(
606
+ :network_site)
607
+ SENSITIVE = []
608
+ include Aws::Structure
609
+ end
610
+
611
+ # Information about a subscriber of a device that can use a network.
612
+ #
613
+ # @!attribute [rw] created_at
614
+ # The creation time of this device identifier.
615
+ # @return [Time]
616
+ #
617
+ # @!attribute [rw] device_identifier_arn
618
+ # The Amazon Resource Name (ARN) of the device identifier.
619
+ # @return [String]
620
+ #
621
+ # @!attribute [rw] iccid
622
+ # The Integrated Circuit Card Identifier of the device identifier.
623
+ # @return [String]
624
+ #
625
+ # @!attribute [rw] imsi
626
+ # The International Mobile Subscriber Identity of the device
627
+ # identifier.
628
+ # @return [String]
629
+ #
630
+ # @!attribute [rw] network_arn
631
+ # The Amazon Resource Name (ARN) of the network on which the device
632
+ # identifier appears.
633
+ # @return [String]
634
+ #
635
+ # @!attribute [rw] order_arn
636
+ # The Amazon Resource Name (ARN) of the order used to purchase the
637
+ # device identifier.
638
+ # @return [String]
639
+ #
640
+ # @!attribute [rw] status
641
+ # The status of the device identifier.
642
+ # @return [String]
643
+ #
644
+ # @!attribute [rw] traffic_group_arn
645
+ # The Amazon Resource Name (ARN) of the traffic group to which the
646
+ # device identifier belongs.
647
+ # @return [String]
648
+ #
649
+ # @!attribute [rw] vendor
650
+ # The vendor of the device identifier.
651
+ # @return [String]
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/DeviceIdentifier AWS API Documentation
654
+ #
655
+ class DeviceIdentifier < Struct.new(
656
+ :created_at,
657
+ :device_identifier_arn,
658
+ :iccid,
659
+ :imsi,
660
+ :network_arn,
661
+ :order_arn,
662
+ :status,
663
+ :traffic_group_arn,
664
+ :vendor)
665
+ SENSITIVE = [:imsi]
666
+ include Aws::Structure
667
+ end
668
+
669
+ # @note When making an API call, you may pass GetDeviceIdentifierRequest
670
+ # data as a hash:
671
+ #
672
+ # {
673
+ # device_identifier_arn: "Arn", # required
674
+ # }
675
+ #
676
+ # @!attribute [rw] device_identifier_arn
677
+ # The Amazon Resource Name (ARN) of the device identifier.
678
+ # @return [String]
679
+ #
680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetDeviceIdentifierRequest AWS API Documentation
681
+ #
682
+ class GetDeviceIdentifierRequest < Struct.new(
683
+ :device_identifier_arn)
684
+ SENSITIVE = []
685
+ include Aws::Structure
686
+ end
687
+
688
+ # @!attribute [rw] device_identifier
689
+ # Information about the device identifier.
690
+ # @return [Types::DeviceIdentifier]
691
+ #
692
+ # @!attribute [rw] tags
693
+ # The device identifier tags.
694
+ # @return [Hash<String,String>]
695
+ #
696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetDeviceIdentifierResponse AWS API Documentation
697
+ #
698
+ class GetDeviceIdentifierResponse < Struct.new(
699
+ :device_identifier,
700
+ :tags)
701
+ SENSITIVE = [:tags]
702
+ include Aws::Structure
703
+ end
704
+
705
+ # @note When making an API call, you may pass GetNetworkRequest
706
+ # data as a hash:
707
+ #
708
+ # {
709
+ # network_arn: "Arn", # required
710
+ # }
711
+ #
712
+ # @!attribute [rw] network_arn
713
+ # The Amazon Resource Name (ARN) of the network.
714
+ # @return [String]
715
+ #
716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetNetworkRequest AWS API Documentation
717
+ #
718
+ class GetNetworkRequest < Struct.new(
719
+ :network_arn)
720
+ SENSITIVE = []
721
+ include Aws::Structure
722
+ end
723
+
724
+ # @note When making an API call, you may pass GetNetworkResourceRequest
725
+ # data as a hash:
726
+ #
727
+ # {
728
+ # network_resource_arn: "Arn", # required
729
+ # }
730
+ #
731
+ # @!attribute [rw] network_resource_arn
732
+ # The Amazon Resource Name (ARN) of the network resource.
733
+ # @return [String]
734
+ #
735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetNetworkResourceRequest AWS API Documentation
736
+ #
737
+ class GetNetworkResourceRequest < Struct.new(
738
+ :network_resource_arn)
739
+ SENSITIVE = []
740
+ include Aws::Structure
741
+ end
742
+
743
+ # @!attribute [rw] network_resource
744
+ # Information about the network resource.
745
+ # @return [Types::NetworkResource]
746
+ #
747
+ # @!attribute [rw] tags
748
+ # The network resource tags.
749
+ # @return [Hash<String,String>]
750
+ #
751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetNetworkResourceResponse AWS API Documentation
752
+ #
753
+ class GetNetworkResourceResponse < Struct.new(
754
+ :network_resource,
755
+ :tags)
756
+ SENSITIVE = [:tags]
757
+ include Aws::Structure
758
+ end
759
+
760
+ # @!attribute [rw] network
761
+ # Information about the network.
762
+ # @return [Types::Network]
763
+ #
764
+ # @!attribute [rw] tags
765
+ # The network tags.
766
+ # @return [Hash<String,String>]
767
+ #
768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetNetworkResponse AWS API Documentation
769
+ #
770
+ class GetNetworkResponse < Struct.new(
771
+ :network,
772
+ :tags)
773
+ SENSITIVE = [:tags]
774
+ include Aws::Structure
775
+ end
776
+
777
+ # @note When making an API call, you may pass GetNetworkSiteRequest
778
+ # data as a hash:
779
+ #
780
+ # {
781
+ # network_site_arn: "Arn", # required
782
+ # }
783
+ #
784
+ # @!attribute [rw] network_site_arn
785
+ # The Amazon Resource Name (ARN) of the network site.
786
+ # @return [String]
787
+ #
788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetNetworkSiteRequest AWS API Documentation
789
+ #
790
+ class GetNetworkSiteRequest < Struct.new(
791
+ :network_site_arn)
792
+ SENSITIVE = []
793
+ include Aws::Structure
794
+ end
795
+
796
+ # @!attribute [rw] network_site
797
+ # Information about the network site.
798
+ # @return [Types::NetworkSite]
799
+ #
800
+ # @!attribute [rw] tags
801
+ # The network site tags.
802
+ # @return [Hash<String,String>]
803
+ #
804
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetNetworkSiteResponse AWS API Documentation
805
+ #
806
+ class GetNetworkSiteResponse < Struct.new(
807
+ :network_site,
808
+ :tags)
809
+ SENSITIVE = [:tags]
810
+ include Aws::Structure
811
+ end
812
+
813
+ # @note When making an API call, you may pass GetOrderRequest
814
+ # data as a hash:
815
+ #
816
+ # {
817
+ # order_arn: "Arn", # required
818
+ # }
819
+ #
820
+ # @!attribute [rw] order_arn
821
+ # The Amazon Resource Name (ARN) of the order.
822
+ # @return [String]
823
+ #
824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetOrderRequest AWS API Documentation
825
+ #
826
+ class GetOrderRequest < Struct.new(
827
+ :order_arn)
828
+ SENSITIVE = []
829
+ include Aws::Structure
830
+ end
831
+
832
+ # @!attribute [rw] order
833
+ # Information about the order.
834
+ # @return [Types::Order]
835
+ #
836
+ # @!attribute [rw] tags
837
+ # The order tags.
838
+ # @return [Hash<String,String>]
839
+ #
840
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/GetOrderResponse AWS API Documentation
841
+ #
842
+ class GetOrderResponse < Struct.new(
843
+ :order,
844
+ :tags)
845
+ SENSITIVE = [:tags]
846
+ include Aws::Structure
847
+ end
848
+
849
+ # Information about an internal error.
850
+ #
851
+ # @!attribute [rw] message
852
+ # Description of the error.
853
+ # @return [String]
854
+ #
855
+ # @!attribute [rw] retry_after_seconds
856
+ # Advice to clients on when the call can be safely retried.
857
+ # @return [Integer]
858
+ #
859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/InternalServerException AWS API Documentation
860
+ #
861
+ class InternalServerException < Struct.new(
862
+ :message,
863
+ :retry_after_seconds)
864
+ SENSITIVE = []
865
+ include Aws::Structure
866
+ end
867
+
868
+ # The limit was exceeded.
869
+ #
870
+ # @!attribute [rw] message
871
+ # @return [String]
872
+ #
873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/LimitExceededException AWS API Documentation
874
+ #
875
+ class LimitExceededException < Struct.new(
876
+ :message)
877
+ SENSITIVE = []
878
+ include Aws::Structure
879
+ end
880
+
881
+ # @note When making an API call, you may pass ListDeviceIdentifiersRequest
882
+ # data as a hash:
883
+ #
884
+ # {
885
+ # filters: {
886
+ # "STATUS" => ["String"],
887
+ # },
888
+ # max_results: 1,
889
+ # network_arn: "Arn", # required
890
+ # start_token: "PaginationToken",
891
+ # }
892
+ #
893
+ # @!attribute [rw] filters
894
+ # The filters.
895
+ #
896
+ # * `ORDER` - The Amazon Resource Name (ARN) of the order.
897
+ #
898
+ # * `STATUS` - The status (`ACTIVE` \| `INACTIVE`).
899
+ #
900
+ # * `TRAFFIC_GROUP` - The Amazon Resource Name (ARN) of the traffic
901
+ # group.
902
+ #
903
+ # Filter values are case sensitive. If you specify multiple values for
904
+ # a filter, the values are joined with an `OR`, and the request
905
+ # returns all results that match any of the specified values.
906
+ # @return [Hash<String,Array<String>>]
907
+ #
908
+ # @!attribute [rw] max_results
909
+ # The maximum number of results to return.
910
+ # @return [Integer]
911
+ #
912
+ # @!attribute [rw] network_arn
913
+ # The Amazon Resource Name (ARN) of the network.
914
+ # @return [String]
915
+ #
916
+ # @!attribute [rw] start_token
917
+ # The token for the next page of results.
918
+ # @return [String]
919
+ #
920
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListDeviceIdentifiersRequest AWS API Documentation
921
+ #
922
+ class ListDeviceIdentifiersRequest < Struct.new(
923
+ :filters,
924
+ :max_results,
925
+ :network_arn,
926
+ :start_token)
927
+ SENSITIVE = []
928
+ include Aws::Structure
929
+ end
930
+
931
+ # @!attribute [rw] device_identifiers
932
+ # Information about the device identifiers.
933
+ # @return [Array<Types::DeviceIdentifier>]
934
+ #
935
+ # @!attribute [rw] next_token
936
+ # The token for the next page of results.
937
+ # @return [String]
938
+ #
939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListDeviceIdentifiersResponse AWS API Documentation
940
+ #
941
+ class ListDeviceIdentifiersResponse < Struct.new(
942
+ :device_identifiers,
943
+ :next_token)
944
+ SENSITIVE = []
945
+ include Aws::Structure
946
+ end
947
+
948
+ # @note When making an API call, you may pass ListNetworkResourcesRequest
949
+ # data as a hash:
950
+ #
951
+ # {
952
+ # filters: {
953
+ # "ORDER" => ["String"],
954
+ # },
955
+ # max_results: 1,
956
+ # network_arn: "Arn", # required
957
+ # start_token: "PaginationToken",
958
+ # }
959
+ #
960
+ # @!attribute [rw] filters
961
+ # The filters.
962
+ #
963
+ # * `ORDER` - The Amazon Resource Name (ARN) of the order.
964
+ #
965
+ # * `STATUS` - The status (`AVAILABLE` \| `DELETED` \| `DELETING` \|
966
+ # `PENDING` \| `PENDING_RETURN` \| `PROVISIONING` \| `SHIPPED`).
967
+ #
968
+ # Filter values are case sensitive. If you specify multiple values for
969
+ # a filter, the values are joined with an `OR`, and the request
970
+ # returns all results that match any of the specified values.
971
+ # @return [Hash<String,Array<String>>]
972
+ #
973
+ # @!attribute [rw] max_results
974
+ # The maximum number of results to return.
975
+ # @return [Integer]
976
+ #
977
+ # @!attribute [rw] network_arn
978
+ # The Amazon Resource Name (ARN) of the network.
979
+ # @return [String]
980
+ #
981
+ # @!attribute [rw] start_token
982
+ # The token for the next page of results.
983
+ # @return [String]
984
+ #
985
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListNetworkResourcesRequest AWS API Documentation
986
+ #
987
+ class ListNetworkResourcesRequest < Struct.new(
988
+ :filters,
989
+ :max_results,
990
+ :network_arn,
991
+ :start_token)
992
+ SENSITIVE = []
993
+ include Aws::Structure
994
+ end
995
+
996
+ # @!attribute [rw] network_resources
997
+ # Information about network resources.
998
+ # @return [Array<Types::NetworkResource>]
999
+ #
1000
+ # @!attribute [rw] next_token
1001
+ # The token for the next page of results.
1002
+ # @return [String]
1003
+ #
1004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListNetworkResourcesResponse AWS API Documentation
1005
+ #
1006
+ class ListNetworkResourcesResponse < Struct.new(
1007
+ :network_resources,
1008
+ :next_token)
1009
+ SENSITIVE = []
1010
+ include Aws::Structure
1011
+ end
1012
+
1013
+ # @note When making an API call, you may pass ListNetworkSitesRequest
1014
+ # data as a hash:
1015
+ #
1016
+ # {
1017
+ # filters: {
1018
+ # "STATUS" => ["String"],
1019
+ # },
1020
+ # max_results: 1,
1021
+ # network_arn: "Arn", # required
1022
+ # start_token: "PaginationToken",
1023
+ # }
1024
+ #
1025
+ # @!attribute [rw] filters
1026
+ # The filters. Add filters to your request to return a more specific
1027
+ # list of results. Use filters to match the status of the network
1028
+ # sites.
1029
+ #
1030
+ # * `STATUS` - The status (`AVAILABLE` \| `CREATED` \| `DELETED` \|
1031
+ # `DEPROVISIONING` \| `PROVISIONING`).
1032
+ #
1033
+ # ^
1034
+ #
1035
+ # Filter values are case sensitive. If you specify multiple values for
1036
+ # a filter, the values are joined with an `OR`, and the request
1037
+ # returns all results that match any of the specified values.
1038
+ # @return [Hash<String,Array<String>>]
1039
+ #
1040
+ # @!attribute [rw] max_results
1041
+ # The maximum number of results to return.
1042
+ # @return [Integer]
1043
+ #
1044
+ # @!attribute [rw] network_arn
1045
+ # The Amazon Resource Name (ARN) of the network.
1046
+ # @return [String]
1047
+ #
1048
+ # @!attribute [rw] start_token
1049
+ # The token for the next page of results.
1050
+ # @return [String]
1051
+ #
1052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListNetworkSitesRequest AWS API Documentation
1053
+ #
1054
+ class ListNetworkSitesRequest < Struct.new(
1055
+ :filters,
1056
+ :max_results,
1057
+ :network_arn,
1058
+ :start_token)
1059
+ SENSITIVE = []
1060
+ include Aws::Structure
1061
+ end
1062
+
1063
+ # @!attribute [rw] network_sites
1064
+ # Information about the network sites.
1065
+ # @return [Array<Types::NetworkSite>]
1066
+ #
1067
+ # @!attribute [rw] next_token
1068
+ # The token for the next page of results.
1069
+ # @return [String]
1070
+ #
1071
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListNetworkSitesResponse AWS API Documentation
1072
+ #
1073
+ class ListNetworkSitesResponse < Struct.new(
1074
+ :network_sites,
1075
+ :next_token)
1076
+ SENSITIVE = []
1077
+ include Aws::Structure
1078
+ end
1079
+
1080
+ # @note When making an API call, you may pass ListNetworksRequest
1081
+ # data as a hash:
1082
+ #
1083
+ # {
1084
+ # filters: {
1085
+ # "STATUS" => ["String"],
1086
+ # },
1087
+ # max_results: 1,
1088
+ # start_token: "PaginationToken",
1089
+ # }
1090
+ #
1091
+ # @!attribute [rw] filters
1092
+ # The filters.
1093
+ #
1094
+ # * `STATUS` - The status (`AVAILABLE` \| `CREATED` \| `DELETED` \|
1095
+ # `DEPROVISIONING` \| `PROVISIONING`).
1096
+ #
1097
+ # ^
1098
+ #
1099
+ # Filter values are case sensitive. If you specify multiple values for
1100
+ # a filter, the values are joined with an `OR`, and the request
1101
+ # returns all results that match any of the specified values.
1102
+ # @return [Hash<String,Array<String>>]
1103
+ #
1104
+ # @!attribute [rw] max_results
1105
+ # The maximum number of results to return.
1106
+ # @return [Integer]
1107
+ #
1108
+ # @!attribute [rw] start_token
1109
+ # The token for the next page of results.
1110
+ # @return [String]
1111
+ #
1112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListNetworksRequest AWS API Documentation
1113
+ #
1114
+ class ListNetworksRequest < Struct.new(
1115
+ :filters,
1116
+ :max_results,
1117
+ :start_token)
1118
+ SENSITIVE = []
1119
+ include Aws::Structure
1120
+ end
1121
+
1122
+ # @!attribute [rw] networks
1123
+ # The networks.
1124
+ # @return [Array<Types::Network>]
1125
+ #
1126
+ # @!attribute [rw] next_token
1127
+ # The token for the next page of results.
1128
+ # @return [String]
1129
+ #
1130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListNetworksResponse AWS API Documentation
1131
+ #
1132
+ class ListNetworksResponse < Struct.new(
1133
+ :networks,
1134
+ :next_token)
1135
+ SENSITIVE = []
1136
+ include Aws::Structure
1137
+ end
1138
+
1139
+ # @note When making an API call, you may pass ListOrdersRequest
1140
+ # data as a hash:
1141
+ #
1142
+ # {
1143
+ # filters: {
1144
+ # "STATUS" => ["String"],
1145
+ # },
1146
+ # max_results: 1,
1147
+ # network_arn: "Arn", # required
1148
+ # start_token: "PaginationToken",
1149
+ # }
1150
+ #
1151
+ # @!attribute [rw] filters
1152
+ # The filters.
1153
+ #
1154
+ # * `NETWORK_SITE` - The Amazon Resource Name (ARN) of the network
1155
+ # site.
1156
+ #
1157
+ # * `STATUS` - The status (`ACKNOWLEDGING` \| `ACKNOWLEDGED` \|
1158
+ # `UNACKNOWLEDGED`).
1159
+ #
1160
+ # Filter values are case sensitive. If you specify multiple values for
1161
+ # a filter, the values are joined with an `OR`, and the request
1162
+ # returns all results that match any of the specified values.
1163
+ # @return [Hash<String,Array<String>>]
1164
+ #
1165
+ # @!attribute [rw] max_results
1166
+ # The maximum number of results to return.
1167
+ # @return [Integer]
1168
+ #
1169
+ # @!attribute [rw] network_arn
1170
+ # The Amazon Resource Name (ARN) of the network.
1171
+ # @return [String]
1172
+ #
1173
+ # @!attribute [rw] start_token
1174
+ # The token for the next page of results.
1175
+ # @return [String]
1176
+ #
1177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListOrdersRequest AWS API Documentation
1178
+ #
1179
+ class ListOrdersRequest < Struct.new(
1180
+ :filters,
1181
+ :max_results,
1182
+ :network_arn,
1183
+ :start_token)
1184
+ SENSITIVE = []
1185
+ include Aws::Structure
1186
+ end
1187
+
1188
+ # @!attribute [rw] next_token
1189
+ # The token for the next page of results.
1190
+ # @return [String]
1191
+ #
1192
+ # @!attribute [rw] orders
1193
+ # Information about the orders.
1194
+ # @return [Array<Types::Order>]
1195
+ #
1196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListOrdersResponse AWS API Documentation
1197
+ #
1198
+ class ListOrdersResponse < Struct.new(
1199
+ :next_token,
1200
+ :orders)
1201
+ SENSITIVE = []
1202
+ include Aws::Structure
1203
+ end
1204
+
1205
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1206
+ # data as a hash:
1207
+ #
1208
+ # {
1209
+ # resource_arn: "Arn", # required
1210
+ # }
1211
+ #
1212
+ # @!attribute [rw] resource_arn
1213
+ # The Amazon Resource Name (ARN) of the resource.
1214
+ # @return [String]
1215
+ #
1216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListTagsForResourceRequest AWS API Documentation
1217
+ #
1218
+ class ListTagsForResourceRequest < Struct.new(
1219
+ :resource_arn)
1220
+ SENSITIVE = []
1221
+ include Aws::Structure
1222
+ end
1223
+
1224
+ # @!attribute [rw] tags
1225
+ # The resource tags.
1226
+ # @return [Hash<String,String>]
1227
+ #
1228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ListTagsForResourceResponse AWS API Documentation
1229
+ #
1230
+ class ListTagsForResourceResponse < Struct.new(
1231
+ :tags)
1232
+ SENSITIVE = [:tags]
1233
+ include Aws::Structure
1234
+ end
1235
+
1236
+ # Information about a name/value pair.
1237
+ #
1238
+ # @note When making an API call, you may pass NameValuePair
1239
+ # data as a hash:
1240
+ #
1241
+ # {
1242
+ # name: "String", # required
1243
+ # value: "String",
1244
+ # }
1245
+ #
1246
+ # @!attribute [rw] name
1247
+ # The name of the pair.
1248
+ # @return [String]
1249
+ #
1250
+ # @!attribute [rw] value
1251
+ # The value of the pair.
1252
+ # @return [String]
1253
+ #
1254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/NameValuePair AWS API Documentation
1255
+ #
1256
+ class NameValuePair < Struct.new(
1257
+ :name,
1258
+ :value)
1259
+ SENSITIVE = []
1260
+ include Aws::Structure
1261
+ end
1262
+
1263
+ # Information about a network.
1264
+ #
1265
+ # @!attribute [rw] created_at
1266
+ # The creation time of the network.
1267
+ # @return [Time]
1268
+ #
1269
+ # @!attribute [rw] description
1270
+ # The description of the network.
1271
+ # @return [String]
1272
+ #
1273
+ # @!attribute [rw] network_arn
1274
+ # The Amazon Resource Name (ARN) of the network.
1275
+ # @return [String]
1276
+ #
1277
+ # @!attribute [rw] network_name
1278
+ # The name of the network.
1279
+ # @return [String]
1280
+ #
1281
+ # @!attribute [rw] status
1282
+ # The status of the network.
1283
+ # @return [String]
1284
+ #
1285
+ # @!attribute [rw] status_reason
1286
+ # The status reason of the network.
1287
+ # @return [String]
1288
+ #
1289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/Network AWS API Documentation
1290
+ #
1291
+ class Network < Struct.new(
1292
+ :created_at,
1293
+ :description,
1294
+ :network_arn,
1295
+ :network_name,
1296
+ :status,
1297
+ :status_reason)
1298
+ SENSITIVE = []
1299
+ include Aws::Structure
1300
+ end
1301
+
1302
+ # Information about a network resource.
1303
+ #
1304
+ # @!attribute [rw] attributes
1305
+ # The attributes of the network resource.
1306
+ # @return [Array<Types::NameValuePair>]
1307
+ #
1308
+ # @!attribute [rw] created_at
1309
+ # The creation time of the network resource.
1310
+ # @return [Time]
1311
+ #
1312
+ # @!attribute [rw] description
1313
+ # The description of the network resource.
1314
+ # @return [String]
1315
+ #
1316
+ # @!attribute [rw] health
1317
+ # The health of the network resource.
1318
+ # @return [String]
1319
+ #
1320
+ # @!attribute [rw] model
1321
+ # The model of the network resource.
1322
+ # @return [String]
1323
+ #
1324
+ # @!attribute [rw] network_arn
1325
+ # The Amazon Resource Name (ARN) of the network on which this network
1326
+ # resource appears.
1327
+ # @return [String]
1328
+ #
1329
+ # @!attribute [rw] network_resource_arn
1330
+ # The Amazon Resource Name (ARN) of the network resource.
1331
+ # @return [String]
1332
+ #
1333
+ # @!attribute [rw] network_site_arn
1334
+ # The Amazon Resource Name (ARN) of the network site on which this
1335
+ # network resource appears.
1336
+ # @return [String]
1337
+ #
1338
+ # @!attribute [rw] order_arn
1339
+ # The Amazon Resource Name (ARN) of the order used to purchase this
1340
+ # network resource.
1341
+ # @return [String]
1342
+ #
1343
+ # @!attribute [rw] position
1344
+ # The position of the network resource.
1345
+ # @return [Types::Position]
1346
+ #
1347
+ # @!attribute [rw] serial_number
1348
+ # The serial number of the network resource.
1349
+ # @return [String]
1350
+ #
1351
+ # @!attribute [rw] status
1352
+ # The status of the network resource.
1353
+ # @return [String]
1354
+ #
1355
+ # @!attribute [rw] status_reason
1356
+ # The status reason of the network resource.
1357
+ # @return [String]
1358
+ #
1359
+ # @!attribute [rw] type
1360
+ # The type of the network resource.
1361
+ # @return [String]
1362
+ #
1363
+ # @!attribute [rw] vendor
1364
+ # The vendor of the network resource.
1365
+ # @return [String]
1366
+ #
1367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/NetworkResource AWS API Documentation
1368
+ #
1369
+ class NetworkResource < Struct.new(
1370
+ :attributes,
1371
+ :created_at,
1372
+ :description,
1373
+ :health,
1374
+ :model,
1375
+ :network_arn,
1376
+ :network_resource_arn,
1377
+ :network_site_arn,
1378
+ :order_arn,
1379
+ :position,
1380
+ :serial_number,
1381
+ :status,
1382
+ :status_reason,
1383
+ :type,
1384
+ :vendor)
1385
+ SENSITIVE = []
1386
+ include Aws::Structure
1387
+ end
1388
+
1389
+ # Information about a network resource definition.
1390
+ #
1391
+ # @note When making an API call, you may pass NetworkResourceDefinition
1392
+ # data as a hash:
1393
+ #
1394
+ # {
1395
+ # count: 1, # required
1396
+ # options: [
1397
+ # {
1398
+ # name: "String", # required
1399
+ # value: "String",
1400
+ # },
1401
+ # ],
1402
+ # type: "RADIO_UNIT", # required, accepts RADIO_UNIT, DEVICE_IDENTIFIER
1403
+ # }
1404
+ #
1405
+ # @!attribute [rw] count
1406
+ # The count in the network resource definition.
1407
+ # @return [Integer]
1408
+ #
1409
+ # @!attribute [rw] options
1410
+ # The options in the network resource definition.
1411
+ # @return [Array<Types::NameValuePair>]
1412
+ #
1413
+ # @!attribute [rw] type
1414
+ # The type in the network resource definition.
1415
+ # @return [String]
1416
+ #
1417
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/NetworkResourceDefinition AWS API Documentation
1418
+ #
1419
+ class NetworkResourceDefinition < Struct.new(
1420
+ :count,
1421
+ :options,
1422
+ :type)
1423
+ SENSITIVE = []
1424
+ include Aws::Structure
1425
+ end
1426
+
1427
+ # Information about a network site.
1428
+ #
1429
+ # @!attribute [rw] availability_zone
1430
+ # The parent Availability Zone for the network site.
1431
+ # @return [String]
1432
+ #
1433
+ # @!attribute [rw] availability_zone_id
1434
+ # The parent Availability Zone ID for the network site.
1435
+ # @return [String]
1436
+ #
1437
+ # @!attribute [rw] created_at
1438
+ # The creation time of the network site.
1439
+ # @return [Time]
1440
+ #
1441
+ # @!attribute [rw] current_plan
1442
+ # The current plan of the network site.
1443
+ # @return [Types::SitePlan]
1444
+ #
1445
+ # @!attribute [rw] description
1446
+ # The description of the network site.
1447
+ # @return [String]
1448
+ #
1449
+ # @!attribute [rw] network_arn
1450
+ # The Amazon Resource Name (ARN) of the network to which the network
1451
+ # site belongs.
1452
+ # @return [String]
1453
+ #
1454
+ # @!attribute [rw] network_site_arn
1455
+ # The Amazon Resource Name (ARN) of the network site.
1456
+ # @return [String]
1457
+ #
1458
+ # @!attribute [rw] network_site_name
1459
+ # The name of the network site.
1460
+ # @return [String]
1461
+ #
1462
+ # @!attribute [rw] pending_plan
1463
+ # The pending plan of the network site.
1464
+ # @return [Types::SitePlan]
1465
+ #
1466
+ # @!attribute [rw] status
1467
+ # The status of the network site.
1468
+ # @return [String]
1469
+ #
1470
+ # @!attribute [rw] status_reason
1471
+ # The status reason of the network site.
1472
+ # @return [String]
1473
+ #
1474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/NetworkSite AWS API Documentation
1475
+ #
1476
+ class NetworkSite < Struct.new(
1477
+ :availability_zone,
1478
+ :availability_zone_id,
1479
+ :created_at,
1480
+ :current_plan,
1481
+ :description,
1482
+ :network_arn,
1483
+ :network_site_arn,
1484
+ :network_site_name,
1485
+ :pending_plan,
1486
+ :status,
1487
+ :status_reason)
1488
+ SENSITIVE = []
1489
+ include Aws::Structure
1490
+ end
1491
+
1492
+ # Information about an order.
1493
+ #
1494
+ # @!attribute [rw] acknowledgment_status
1495
+ # The acknowledgement status of the order.
1496
+ # @return [String]
1497
+ #
1498
+ # @!attribute [rw] created_at
1499
+ # The creation time of the order.
1500
+ # @return [Time]
1501
+ #
1502
+ # @!attribute [rw] network_arn
1503
+ # The Amazon Resource Name (ARN) of the network associated with this
1504
+ # order.
1505
+ # @return [String]
1506
+ #
1507
+ # @!attribute [rw] network_site_arn
1508
+ # The Amazon Resource Name (ARN) of the network site associated with
1509
+ # this order.
1510
+ # @return [String]
1511
+ #
1512
+ # @!attribute [rw] order_arn
1513
+ # The Amazon Resource Name (ARN) of the order.
1514
+ # @return [String]
1515
+ #
1516
+ # @!attribute [rw] shipping_address
1517
+ # The shipping address of the order.
1518
+ # @return [Types::Address]
1519
+ #
1520
+ # @!attribute [rw] tracking_information
1521
+ # The tracking information of the order.
1522
+ # @return [Array<Types::TrackingInformation>]
1523
+ #
1524
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/Order AWS API Documentation
1525
+ #
1526
+ class Order < Struct.new(
1527
+ :acknowledgment_status,
1528
+ :created_at,
1529
+ :network_arn,
1530
+ :network_site_arn,
1531
+ :order_arn,
1532
+ :shipping_address,
1533
+ :tracking_information)
1534
+ SENSITIVE = []
1535
+ include Aws::Structure
1536
+ end
1537
+
1538
+ # @!attribute [rw] status
1539
+ # Information about the health of the service.
1540
+ # @return [String]
1541
+ #
1542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/PingResponse AWS API Documentation
1543
+ #
1544
+ class PingResponse < Struct.new(
1545
+ :status)
1546
+ SENSITIVE = []
1547
+ include Aws::Structure
1548
+ end
1549
+
1550
+ # Information about a position.
1551
+ #
1552
+ # @note When making an API call, you may pass Position
1553
+ # data as a hash:
1554
+ #
1555
+ # {
1556
+ # elevation: 1.0,
1557
+ # elevation_reference: "AGL", # accepts AGL, AMSL
1558
+ # elevation_unit: "FEET", # accepts FEET
1559
+ # latitude: 1.0,
1560
+ # longitude: 1.0,
1561
+ # }
1562
+ #
1563
+ # @!attribute [rw] elevation
1564
+ # The elevation of the equipment at this position.
1565
+ # @return [Float]
1566
+ #
1567
+ # @!attribute [rw] elevation_reference
1568
+ # The reference point from which elevation is reported.
1569
+ # @return [String]
1570
+ #
1571
+ # @!attribute [rw] elevation_unit
1572
+ # The units used to measure the elevation of the position.
1573
+ # @return [String]
1574
+ #
1575
+ # @!attribute [rw] latitude
1576
+ # The latitude of the position.
1577
+ # @return [Float]
1578
+ #
1579
+ # @!attribute [rw] longitude
1580
+ # The longitude of the position.
1581
+ # @return [Float]
1582
+ #
1583
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/Position AWS API Documentation
1584
+ #
1585
+ class Position < Struct.new(
1586
+ :elevation,
1587
+ :elevation_reference,
1588
+ :elevation_unit,
1589
+ :latitude,
1590
+ :longitude)
1591
+ SENSITIVE = []
1592
+ include Aws::Structure
1593
+ end
1594
+
1595
+ # The resource was not found.
1596
+ #
1597
+ # @!attribute [rw] message
1598
+ # Description of the error.
1599
+ # @return [String]
1600
+ #
1601
+ # @!attribute [rw] resource_id
1602
+ # Identifier of the affected resource.
1603
+ # @return [String]
1604
+ #
1605
+ # @!attribute [rw] resource_type
1606
+ # Type of the affected resource.
1607
+ # @return [String]
1608
+ #
1609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ResourceNotFoundException AWS API Documentation
1610
+ #
1611
+ class ResourceNotFoundException < Struct.new(
1612
+ :message,
1613
+ :resource_id,
1614
+ :resource_type)
1615
+ SENSITIVE = []
1616
+ include Aws::Structure
1617
+ end
1618
+
1619
+ # Information about a site plan.
1620
+ #
1621
+ # @note When making an API call, you may pass SitePlan
1622
+ # data as a hash:
1623
+ #
1624
+ # {
1625
+ # options: [
1626
+ # {
1627
+ # name: "String", # required
1628
+ # value: "String",
1629
+ # },
1630
+ # ],
1631
+ # resource_definitions: [
1632
+ # {
1633
+ # count: 1, # required
1634
+ # options: [
1635
+ # {
1636
+ # name: "String", # required
1637
+ # value: "String",
1638
+ # },
1639
+ # ],
1640
+ # type: "RADIO_UNIT", # required, accepts RADIO_UNIT, DEVICE_IDENTIFIER
1641
+ # },
1642
+ # ],
1643
+ # }
1644
+ #
1645
+ # @!attribute [rw] options
1646
+ # The options of the plan.
1647
+ # @return [Array<Types::NameValuePair>]
1648
+ #
1649
+ # @!attribute [rw] resource_definitions
1650
+ # The resource definitions of the plan.
1651
+ # @return [Array<Types::NetworkResourceDefinition>]
1652
+ #
1653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/SitePlan AWS API Documentation
1654
+ #
1655
+ class SitePlan < Struct.new(
1656
+ :options,
1657
+ :resource_definitions)
1658
+ SENSITIVE = []
1659
+ include Aws::Structure
1660
+ end
1661
+
1662
+ # @note When making an API call, you may pass TagResourceRequest
1663
+ # data as a hash:
1664
+ #
1665
+ # {
1666
+ # resource_arn: "Arn", # required
1667
+ # tags: { # required
1668
+ # "TagKey" => "TagValue",
1669
+ # },
1670
+ # }
1671
+ #
1672
+ # @!attribute [rw] resource_arn
1673
+ # The Amazon Resource Name (ARN) of the resource.
1674
+ # @return [String]
1675
+ #
1676
+ # @!attribute [rw] tags
1677
+ # The tags to add to the resource.
1678
+ # @return [Hash<String,String>]
1679
+ #
1680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/TagResourceRequest AWS API Documentation
1681
+ #
1682
+ class TagResourceRequest < Struct.new(
1683
+ :resource_arn,
1684
+ :tags)
1685
+ SENSITIVE = [:tags]
1686
+ include Aws::Structure
1687
+ end
1688
+
1689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/TagResourceResponse AWS API Documentation
1690
+ #
1691
+ class TagResourceResponse < Aws::EmptyStructure; end
1692
+
1693
+ # The request was denied due to request throttling.
1694
+ #
1695
+ # @!attribute [rw] message
1696
+ # @return [String]
1697
+ #
1698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ThrottlingException AWS API Documentation
1699
+ #
1700
+ class ThrottlingException < Struct.new(
1701
+ :message)
1702
+ SENSITIVE = []
1703
+ include Aws::Structure
1704
+ end
1705
+
1706
+ # Information about tracking a shipment.
1707
+ #
1708
+ # @!attribute [rw] tracking_number
1709
+ # The tracking number of the shipment.
1710
+ # @return [String]
1711
+ #
1712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/TrackingInformation AWS API Documentation
1713
+ #
1714
+ class TrackingInformation < Struct.new(
1715
+ :tracking_number)
1716
+ SENSITIVE = []
1717
+ include Aws::Structure
1718
+ end
1719
+
1720
+ # @note When making an API call, you may pass UntagResourceRequest
1721
+ # data as a hash:
1722
+ #
1723
+ # {
1724
+ # resource_arn: "Arn", # required
1725
+ # tag_keys: ["TagKey"], # required
1726
+ # }
1727
+ #
1728
+ # @!attribute [rw] resource_arn
1729
+ # The Amazon Resource Name (ARN) of the resource.
1730
+ # @return [String]
1731
+ #
1732
+ # @!attribute [rw] tag_keys
1733
+ # The tag keys.
1734
+ # @return [Array<String>]
1735
+ #
1736
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/UntagResourceRequest AWS API Documentation
1737
+ #
1738
+ class UntagResourceRequest < Struct.new(
1739
+ :resource_arn,
1740
+ :tag_keys)
1741
+ SENSITIVE = [:tag_keys]
1742
+ include Aws::Structure
1743
+ end
1744
+
1745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/UntagResourceResponse AWS API Documentation
1746
+ #
1747
+ class UntagResourceResponse < Aws::EmptyStructure; end
1748
+
1749
+ # @note When making an API call, you may pass UpdateNetworkSitePlanRequest
1750
+ # data as a hash:
1751
+ #
1752
+ # {
1753
+ # client_token: "ClientToken",
1754
+ # network_site_arn: "Arn", # required
1755
+ # pending_plan: { # required
1756
+ # options: [
1757
+ # {
1758
+ # name: "String", # required
1759
+ # value: "String",
1760
+ # },
1761
+ # ],
1762
+ # resource_definitions: [
1763
+ # {
1764
+ # count: 1, # required
1765
+ # options: [
1766
+ # {
1767
+ # name: "String", # required
1768
+ # value: "String",
1769
+ # },
1770
+ # ],
1771
+ # type: "RADIO_UNIT", # required, accepts RADIO_UNIT, DEVICE_IDENTIFIER
1772
+ # },
1773
+ # ],
1774
+ # },
1775
+ # }
1776
+ #
1777
+ # @!attribute [rw] client_token
1778
+ # Unique, case-sensitive identifier that you provide to ensure the
1779
+ # idempotency of the request. For more information, see [How to ensure
1780
+ # idempotency][1].
1781
+ #
1782
+ #
1783
+ #
1784
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
1785
+ # @return [String]
1786
+ #
1787
+ # @!attribute [rw] network_site_arn
1788
+ # The Amazon Resource Name (ARN) of the network site.
1789
+ # @return [String]
1790
+ #
1791
+ # @!attribute [rw] pending_plan
1792
+ # The pending plan.
1793
+ # @return [Types::SitePlan]
1794
+ #
1795
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/UpdateNetworkSitePlanRequest AWS API Documentation
1796
+ #
1797
+ class UpdateNetworkSitePlanRequest < Struct.new(
1798
+ :client_token,
1799
+ :network_site_arn,
1800
+ :pending_plan)
1801
+ SENSITIVE = []
1802
+ include Aws::Structure
1803
+ end
1804
+
1805
+ # @note When making an API call, you may pass UpdateNetworkSiteRequest
1806
+ # data as a hash:
1807
+ #
1808
+ # {
1809
+ # client_token: "ClientToken",
1810
+ # description: "Description",
1811
+ # network_site_arn: "Arn", # required
1812
+ # }
1813
+ #
1814
+ # @!attribute [rw] client_token
1815
+ # Unique, case-sensitive identifier that you provide to ensure the
1816
+ # idempotency of the request. For more information, see [How to ensure
1817
+ # idempotency][1].
1818
+ #
1819
+ #
1820
+ #
1821
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
1822
+ # @return [String]
1823
+ #
1824
+ # @!attribute [rw] description
1825
+ # The description.
1826
+ # @return [String]
1827
+ #
1828
+ # @!attribute [rw] network_site_arn
1829
+ # The Amazon Resource Name (ARN) of the network site.
1830
+ # @return [String]
1831
+ #
1832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/UpdateNetworkSiteRequest AWS API Documentation
1833
+ #
1834
+ class UpdateNetworkSiteRequest < Struct.new(
1835
+ :client_token,
1836
+ :description,
1837
+ :network_site_arn)
1838
+ SENSITIVE = []
1839
+ include Aws::Structure
1840
+ end
1841
+
1842
+ # @!attribute [rw] network_site
1843
+ # Information about the network site.
1844
+ # @return [Types::NetworkSite]
1845
+ #
1846
+ # @!attribute [rw] tags
1847
+ # The network site tags.
1848
+ # @return [Hash<String,String>]
1849
+ #
1850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/UpdateNetworkSiteResponse AWS API Documentation
1851
+ #
1852
+ class UpdateNetworkSiteResponse < Struct.new(
1853
+ :network_site,
1854
+ :tags)
1855
+ SENSITIVE = [:tags]
1856
+ include Aws::Structure
1857
+ end
1858
+
1859
+ # The request failed validation.
1860
+ #
1861
+ # @!attribute [rw] field_list
1862
+ # The list of fields that caused the error, if applicable.
1863
+ # @return [Array<Types::ValidationExceptionField>]
1864
+ #
1865
+ # @!attribute [rw] message
1866
+ # Description of the error.
1867
+ # @return [String]
1868
+ #
1869
+ # @!attribute [rw] reason
1870
+ # Reason the request failed validation.
1871
+ # @return [String]
1872
+ #
1873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ValidationException AWS API Documentation
1874
+ #
1875
+ class ValidationException < Struct.new(
1876
+ :field_list,
1877
+ :message,
1878
+ :reason)
1879
+ SENSITIVE = []
1880
+ include Aws::Structure
1881
+ end
1882
+
1883
+ # Information about a field that failed validation.
1884
+ #
1885
+ # @!attribute [rw] message
1886
+ # The message about the validation failure.
1887
+ # @return [String]
1888
+ #
1889
+ # @!attribute [rw] name
1890
+ # The field name that failed validation.
1891
+ # @return [String]
1892
+ #
1893
+ # @see http://docs.aws.amazon.com/goto/WebAPI/privatenetworks-2021-12-03/ValidationExceptionField AWS API Documentation
1894
+ #
1895
+ class ValidationExceptionField < Struct.new(
1896
+ :message,
1897
+ :name)
1898
+ SENSITIVE = []
1899
+ include Aws::Structure
1900
+ end
1901
+
1902
+ end
1903
+ end