groundstation.d.ts
42.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class GroundStation extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: GroundStation.Types.ClientConfiguration)
config: Config & GroundStation.Types.ClientConfiguration;
/**
* Cancels a contact with a specified contact ID.
*/
cancelContact(params: GroundStation.Types.CancelContactRequest, callback?: (err: AWSError, data: GroundStation.Types.ContactIdResponse) => void): Request<GroundStation.Types.ContactIdResponse, AWSError>;
/**
* Cancels a contact with a specified contact ID.
*/
cancelContact(callback?: (err: AWSError, data: GroundStation.Types.ContactIdResponse) => void): Request<GroundStation.Types.ContactIdResponse, AWSError>;
/**
* Creates a Config with the specified configData parameters. Only one type of configData can be specified.
*/
createConfig(params: GroundStation.Types.CreateConfigRequest, callback?: (err: AWSError, data: GroundStation.Types.ConfigIdResponse) => void): Request<GroundStation.Types.ConfigIdResponse, AWSError>;
/**
* Creates a Config with the specified configData parameters. Only one type of configData can be specified.
*/
createConfig(callback?: (err: AWSError, data: GroundStation.Types.ConfigIdResponse) => void): Request<GroundStation.Types.ConfigIdResponse, AWSError>;
/**
* Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects. The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact. When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.
*/
createDataflowEndpointGroup(params: GroundStation.Types.CreateDataflowEndpointGroupRequest, callback?: (err: AWSError, data: GroundStation.Types.DataflowEndpointGroupIdResponse) => void): Request<GroundStation.Types.DataflowEndpointGroupIdResponse, AWSError>;
/**
* Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects. The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact. When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.
*/
createDataflowEndpointGroup(callback?: (err: AWSError, data: GroundStation.Types.DataflowEndpointGroupIdResponse) => void): Request<GroundStation.Types.DataflowEndpointGroupIdResponse, AWSError>;
/**
* Creates a mission profile. dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.
*/
createMissionProfile(params: GroundStation.Types.CreateMissionProfileRequest, callback?: (err: AWSError, data: GroundStation.Types.MissionProfileIdResponse) => void): Request<GroundStation.Types.MissionProfileIdResponse, AWSError>;
/**
* Creates a mission profile. dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.
*/
createMissionProfile(callback?: (err: AWSError, data: GroundStation.Types.MissionProfileIdResponse) => void): Request<GroundStation.Types.MissionProfileIdResponse, AWSError>;
/**
* Deletes a Config.
*/
deleteConfig(params: GroundStation.Types.DeleteConfigRequest, callback?: (err: AWSError, data: GroundStation.Types.ConfigIdResponse) => void): Request<GroundStation.Types.ConfigIdResponse, AWSError>;
/**
* Deletes a Config.
*/
deleteConfig(callback?: (err: AWSError, data: GroundStation.Types.ConfigIdResponse) => void): Request<GroundStation.Types.ConfigIdResponse, AWSError>;
/**
* Deletes a dataflow endpoint group.
*/
deleteDataflowEndpointGroup(params: GroundStation.Types.DeleteDataflowEndpointGroupRequest, callback?: (err: AWSError, data: GroundStation.Types.DataflowEndpointGroupIdResponse) => void): Request<GroundStation.Types.DataflowEndpointGroupIdResponse, AWSError>;
/**
* Deletes a dataflow endpoint group.
*/
deleteDataflowEndpointGroup(callback?: (err: AWSError, data: GroundStation.Types.DataflowEndpointGroupIdResponse) => void): Request<GroundStation.Types.DataflowEndpointGroupIdResponse, AWSError>;
/**
* Deletes a mission profile.
*/
deleteMissionProfile(params: GroundStation.Types.DeleteMissionProfileRequest, callback?: (err: AWSError, data: GroundStation.Types.MissionProfileIdResponse) => void): Request<GroundStation.Types.MissionProfileIdResponse, AWSError>;
/**
* Deletes a mission profile.
*/
deleteMissionProfile(callback?: (err: AWSError, data: GroundStation.Types.MissionProfileIdResponse) => void): Request<GroundStation.Types.MissionProfileIdResponse, AWSError>;
/**
* Describes an existing contact.
*/
describeContact(params: GroundStation.Types.DescribeContactRequest, callback?: (err: AWSError, data: GroundStation.Types.DescribeContactResponse) => void): Request<GroundStation.Types.DescribeContactResponse, AWSError>;
/**
* Describes an existing contact.
*/
describeContact(callback?: (err: AWSError, data: GroundStation.Types.DescribeContactResponse) => void): Request<GroundStation.Types.DescribeContactResponse, AWSError>;
/**
* Returns Config information. Only one Config response can be returned.
*/
getConfig(params: GroundStation.Types.GetConfigRequest, callback?: (err: AWSError, data: GroundStation.Types.GetConfigResponse) => void): Request<GroundStation.Types.GetConfigResponse, AWSError>;
/**
* Returns Config information. Only one Config response can be returned.
*/
getConfig(callback?: (err: AWSError, data: GroundStation.Types.GetConfigResponse) => void): Request<GroundStation.Types.GetConfigResponse, AWSError>;
/**
* Returns the dataflow endpoint group.
*/
getDataflowEndpointGroup(params: GroundStation.Types.GetDataflowEndpointGroupRequest, callback?: (err: AWSError, data: GroundStation.Types.GetDataflowEndpointGroupResponse) => void): Request<GroundStation.Types.GetDataflowEndpointGroupResponse, AWSError>;
/**
* Returns the dataflow endpoint group.
*/
getDataflowEndpointGroup(callback?: (err: AWSError, data: GroundStation.Types.GetDataflowEndpointGroupResponse) => void): Request<GroundStation.Types.GetDataflowEndpointGroupResponse, AWSError>;
/**
* Returns the number of minutes used by account.
*/
getMinuteUsage(params: GroundStation.Types.GetMinuteUsageRequest, callback?: (err: AWSError, data: GroundStation.Types.GetMinuteUsageResponse) => void): Request<GroundStation.Types.GetMinuteUsageResponse, AWSError>;
/**
* Returns the number of minutes used by account.
*/
getMinuteUsage(callback?: (err: AWSError, data: GroundStation.Types.GetMinuteUsageResponse) => void): Request<GroundStation.Types.GetMinuteUsageResponse, AWSError>;
/**
* Returns a mission profile.
*/
getMissionProfile(params: GroundStation.Types.GetMissionProfileRequest, callback?: (err: AWSError, data: GroundStation.Types.GetMissionProfileResponse) => void): Request<GroundStation.Types.GetMissionProfileResponse, AWSError>;
/**
* Returns a mission profile.
*/
getMissionProfile(callback?: (err: AWSError, data: GroundStation.Types.GetMissionProfileResponse) => void): Request<GroundStation.Types.GetMissionProfileResponse, AWSError>;
/**
* Returns a satellite.
*/
getSatellite(params: GroundStation.Types.GetSatelliteRequest, callback?: (err: AWSError, data: GroundStation.Types.GetSatelliteResponse) => void): Request<GroundStation.Types.GetSatelliteResponse, AWSError>;
/**
* Returns a satellite.
*/
getSatellite(callback?: (err: AWSError, data: GroundStation.Types.GetSatelliteResponse) => void): Request<GroundStation.Types.GetSatelliteResponse, AWSError>;
/**
* Returns a list of Config objects.
*/
listConfigs(params: GroundStation.Types.ListConfigsRequest, callback?: (err: AWSError, data: GroundStation.Types.ListConfigsResponse) => void): Request<GroundStation.Types.ListConfigsResponse, AWSError>;
/**
* Returns a list of Config objects.
*/
listConfigs(callback?: (err: AWSError, data: GroundStation.Types.ListConfigsResponse) => void): Request<GroundStation.Types.ListConfigsResponse, AWSError>;
/**
* Returns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
*/
listContacts(params: GroundStation.Types.ListContactsRequest, callback?: (err: AWSError, data: GroundStation.Types.ListContactsResponse) => void): Request<GroundStation.Types.ListContactsResponse, AWSError>;
/**
* Returns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
*/
listContacts(callback?: (err: AWSError, data: GroundStation.Types.ListContactsResponse) => void): Request<GroundStation.Types.ListContactsResponse, AWSError>;
/**
* Returns a list of DataflowEndpoint groups.
*/
listDataflowEndpointGroups(params: GroundStation.Types.ListDataflowEndpointGroupsRequest, callback?: (err: AWSError, data: GroundStation.Types.ListDataflowEndpointGroupsResponse) => void): Request<GroundStation.Types.ListDataflowEndpointGroupsResponse, AWSError>;
/**
* Returns a list of DataflowEndpoint groups.
*/
listDataflowEndpointGroups(callback?: (err: AWSError, data: GroundStation.Types.ListDataflowEndpointGroupsResponse) => void): Request<GroundStation.Types.ListDataflowEndpointGroupsResponse, AWSError>;
/**
* Returns a list of ground stations.
*/
listGroundStations(params: GroundStation.Types.ListGroundStationsRequest, callback?: (err: AWSError, data: GroundStation.Types.ListGroundStationsResponse) => void): Request<GroundStation.Types.ListGroundStationsResponse, AWSError>;
/**
* Returns a list of ground stations.
*/
listGroundStations(callback?: (err: AWSError, data: GroundStation.Types.ListGroundStationsResponse) => void): Request<GroundStation.Types.ListGroundStationsResponse, AWSError>;
/**
* Returns a list of mission profiles.
*/
listMissionProfiles(params: GroundStation.Types.ListMissionProfilesRequest, callback?: (err: AWSError, data: GroundStation.Types.ListMissionProfilesResponse) => void): Request<GroundStation.Types.ListMissionProfilesResponse, AWSError>;
/**
* Returns a list of mission profiles.
*/
listMissionProfiles(callback?: (err: AWSError, data: GroundStation.Types.ListMissionProfilesResponse) => void): Request<GroundStation.Types.ListMissionProfilesResponse, AWSError>;
/**
* Returns a list of satellites.
*/
listSatellites(params: GroundStation.Types.ListSatellitesRequest, callback?: (err: AWSError, data: GroundStation.Types.ListSatellitesResponse) => void): Request<GroundStation.Types.ListSatellitesResponse, AWSError>;
/**
* Returns a list of satellites.
*/
listSatellites(callback?: (err: AWSError, data: GroundStation.Types.ListSatellitesResponse) => void): Request<GroundStation.Types.ListSatellitesResponse, AWSError>;
/**
* Returns a list of tags for a specified resource.
*/
listTagsForResource(params: GroundStation.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: GroundStation.Types.ListTagsForResourceResponse) => void): Request<GroundStation.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of tags for a specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: GroundStation.Types.ListTagsForResourceResponse) => void): Request<GroundStation.Types.ListTagsForResourceResponse, AWSError>;
/**
* Reserves a contact using specified parameters.
*/
reserveContact(params: GroundStation.Types.ReserveContactRequest, callback?: (err: AWSError, data: GroundStation.Types.ContactIdResponse) => void): Request<GroundStation.Types.ContactIdResponse, AWSError>;
/**
* Reserves a contact using specified parameters.
*/
reserveContact(callback?: (err: AWSError, data: GroundStation.Types.ContactIdResponse) => void): Request<GroundStation.Types.ContactIdResponse, AWSError>;
/**
* Assigns a tag to a resource.
*/
tagResource(params: GroundStation.Types.TagResourceRequest, callback?: (err: AWSError, data: GroundStation.Types.TagResourceResponse) => void): Request<GroundStation.Types.TagResourceResponse, AWSError>;
/**
* Assigns a tag to a resource.
*/
tagResource(callback?: (err: AWSError, data: GroundStation.Types.TagResourceResponse) => void): Request<GroundStation.Types.TagResourceResponse, AWSError>;
/**
* Deassigns a resource tag.
*/
untagResource(params: GroundStation.Types.UntagResourceRequest, callback?: (err: AWSError, data: GroundStation.Types.UntagResourceResponse) => void): Request<GroundStation.Types.UntagResourceResponse, AWSError>;
/**
* Deassigns a resource tag.
*/
untagResource(callback?: (err: AWSError, data: GroundStation.Types.UntagResourceResponse) => void): Request<GroundStation.Types.UntagResourceResponse, AWSError>;
/**
* Updates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.
*/
updateConfig(params: GroundStation.Types.UpdateConfigRequest, callback?: (err: AWSError, data: GroundStation.Types.ConfigIdResponse) => void): Request<GroundStation.Types.ConfigIdResponse, AWSError>;
/**
* Updates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.
*/
updateConfig(callback?: (err: AWSError, data: GroundStation.Types.ConfigIdResponse) => void): Request<GroundStation.Types.ConfigIdResponse, AWSError>;
/**
* Updates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts.
*/
updateMissionProfile(params: GroundStation.Types.UpdateMissionProfileRequest, callback?: (err: AWSError, data: GroundStation.Types.MissionProfileIdResponse) => void): Request<GroundStation.Types.MissionProfileIdResponse, AWSError>;
/**
* Updates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts.
*/
updateMissionProfile(callback?: (err: AWSError, data: GroundStation.Types.MissionProfileIdResponse) => void): Request<GroundStation.Types.MissionProfileIdResponse, AWSError>;
}
declare namespace GroundStation {
export type AngleUnits = "DEGREE_ANGLE"|"RADIAN"|string;
export interface AntennaDemodDecodeDetails {
/**
* Name of an antenna demod decode output node used in a contact.
*/
outputNode?: String;
}
export interface AntennaDownlinkConfig {
/**
* Object that describes a spectral Config.
*/
spectrumConfig: SpectrumConfig;
}
export interface AntennaDownlinkDemodDecodeConfig {
/**
* Information about the decode Config.
*/
decodeConfig: DecodeConfig;
/**
* Information about the demodulation Config.
*/
demodulationConfig: DemodulationConfig;
/**
* Information about the spectral Config.
*/
spectrumConfig: SpectrumConfig;
}
export interface AntennaUplinkConfig {
/**
* Information about the uplink spectral Config.
*/
spectrumConfig: UplinkSpectrumConfig;
/**
* EIRP of the target.
*/
targetEirp: Eirp;
/**
* Whether or not uplink transmit is disabled.
*/
transmitDisabled?: Boolean;
}
export type BandwidthUnits = "GHz"|"MHz"|"kHz"|string;
export type Boolean = boolean;
export interface CancelContactRequest {
/**
* UUID of a contact.
*/
contactId: String;
}
export type ConfigArn = string;
export type ConfigCapabilityType = "antenna-downlink"|"antenna-downlink-demod-decode"|"antenna-uplink"|"dataflow-endpoint"|"tracking"|"uplink-echo"|string;
export interface ConfigDetails {
/**
* Details for antenna demod decode Config in a contact.
*/
antennaDemodDecodeDetails?: AntennaDemodDecodeDetails;
endpointDetails?: EndpointDetails;
}
export interface ConfigIdResponse {
/**
* ARN of a Config.
*/
configArn?: ConfigArn;
/**
* UUID of a Config.
*/
configId?: String;
/**
* Type of a Config.
*/
configType?: ConfigCapabilityType;
}
export type ConfigList = ConfigListItem[];
export interface ConfigListItem {
/**
* ARN of a Config.
*/
configArn?: ConfigArn;
/**
* UUID of a Config.
*/
configId?: String;
/**
* Type of a Config.
*/
configType?: ConfigCapabilityType;
/**
* Name of a Config.
*/
name?: String;
}
export interface ConfigTypeData {
/**
* Information about how AWS Ground Station should configure an antenna for downlink during a contact.
*/
antennaDownlinkConfig?: AntennaDownlinkConfig;
/**
* Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
*/
antennaDownlinkDemodDecodeConfig?: AntennaDownlinkDemodDecodeConfig;
/**
* Information about how AWS Ground Station should configure an antenna for uplink during a contact.
*/
antennaUplinkConfig?: AntennaUplinkConfig;
/**
* Information about the dataflow endpoint Config.
*/
dataflowEndpointConfig?: DataflowEndpointConfig;
/**
* Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
*/
trackingConfig?: TrackingConfig;
/**
* Information about an uplink echo Config. Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig is used in a contact.
*/
uplinkEchoConfig?: UplinkEchoConfig;
}
export interface ContactData {
/**
* UUID of a contact.
*/
contactId?: String;
/**
* Status of a contact.
*/
contactStatus?: ContactStatus;
/**
* End time of a contact.
*/
endTime?: Timestamp;
/**
* Error message of a contact.
*/
errorMessage?: String;
/**
* Name of a ground station.
*/
groundStation?: String;
/**
* Maximum elevation angle of a contact.
*/
maximumElevation?: Elevation;
/**
* ARN of a mission profile.
*/
missionProfileArn?: MissionProfileArn;
/**
* Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
*/
postPassEndTime?: Timestamp;
/**
* Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
*/
prePassStartTime?: Timestamp;
/**
* Region of a contact.
*/
region?: String;
/**
* ARN of a satellite.
*/
satelliteArn?: satelliteArn;
/**
* Start time of a contact.
*/
startTime?: Timestamp;
/**
* Tags assigned to a contact.
*/
tags?: TagsMap;
}
export interface ContactIdResponse {
/**
* UUID of a contact.
*/
contactId?: String;
}
export type ContactList = ContactData[];
export type ContactStatus = "AVAILABLE"|"AWS_CANCELLED"|"CANCELLED"|"CANCELLING"|"COMPLETED"|"FAILED"|"FAILED_TO_SCHEDULE"|"PASS"|"POSTPASS"|"PREPASS"|"SCHEDULED"|"SCHEDULING"|string;
export interface CreateConfigRequest {
/**
* Parameters of a Config.
*/
configData: ConfigTypeData;
/**
* Name of a Config.
*/
name: SafeName;
/**
* Tags assigned to a Config.
*/
tags?: TagsMap;
}
export interface CreateDataflowEndpointGroupRequest {
/**
* Endpoint details of each endpoint in the dataflow endpoint group.
*/
endpointDetails: EndpointDetailsList;
/**
* Tags of a dataflow endpoint group.
*/
tags?: TagsMap;
}
export interface CreateMissionProfileRequest {
/**
* Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
*/
contactPostPassDurationSeconds?: DurationInSeconds;
/**
* Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
*/
contactPrePassDurationSeconds?: DurationInSeconds;
/**
* A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
*/
dataflowEdges: DataflowEdgeList;
/**
* Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
*/
minimumViableContactDurationSeconds: DurationInSeconds;
/**
* Name of a mission profile.
*/
name: SafeName;
/**
* Tags assigned to a mission profile.
*/
tags?: TagsMap;
/**
* ARN of a tracking Config.
*/
trackingConfigArn: ConfigArn;
}
export type Criticality = "PREFERRED"|"REMOVED"|"REQUIRED"|string;
export interface DataflowDetail {
destination?: Destination;
source?: Source;
}
export type DataflowEdge = ConfigArn[];
export type DataflowEdgeList = DataflowEdge[];
export interface DataflowEndpoint {
/**
* Socket address of a dataflow endpoint.
*/
address?: SocketAddress;
/**
* Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
*/
mtu?: DataflowEndpointmtuInteger;
/**
* Name of a dataflow endpoint.
*/
name?: SafeName;
/**
* Status of a dataflow endpoint.
*/
status?: EndpointStatus;
}
export interface DataflowEndpointConfig {
/**
* Name of a dataflow endpoint.
*/
dataflowEndpointName: String;
/**
* Region of a dataflow endpoint.
*/
dataflowEndpointRegion?: String;
}
export type DataflowEndpointGroupArn = string;
export interface DataflowEndpointGroupIdResponse {
/**
* UUID of a dataflow endpoint group.
*/
dataflowEndpointGroupId?: String;
}
export type DataflowEndpointGroupList = DataflowEndpointListItem[];
export interface DataflowEndpointListItem {
/**
* ARN of a dataflow endpoint group.
*/
dataflowEndpointGroupArn?: DataflowEndpointGroupArn;
/**
* UUID of a dataflow endpoint group.
*/
dataflowEndpointGroupId?: String;
}
export type DataflowEndpointmtuInteger = number;
export type DataflowList = DataflowDetail[];
export interface DecodeConfig {
/**
* Unvalidated JSON of a decode Config.
*/
unvalidatedJSON: JsonString;
}
export interface DeleteConfigRequest {
/**
* UUID of a Config.
*/
configId: String;
/**
* Type of a Config.
*/
configType: ConfigCapabilityType;
}
export interface DeleteDataflowEndpointGroupRequest {
/**
* UUID of a dataflow endpoint group.
*/
dataflowEndpointGroupId: String;
}
export interface DeleteMissionProfileRequest {
/**
* UUID of a mission profile.
*/
missionProfileId: String;
}
export interface DemodulationConfig {
/**
* Unvalidated JSON of a demodulation Config.
*/
unvalidatedJSON: JsonString;
}
export interface DescribeContactRequest {
/**
* UUID of a contact.
*/
contactId: String;
}
export interface DescribeContactResponse {
/**
* UUID of a contact.
*/
contactId?: String;
/**
* Status of a contact.
*/
contactStatus?: ContactStatus;
/**
* List describing source and destination details for each dataflow edge.
*/
dataflowList?: DataflowList;
/**
* End time of a contact.
*/
endTime?: Timestamp;
/**
* Error message for a contact.
*/
errorMessage?: String;
/**
* Ground station for a contact.
*/
groundStation?: String;
/**
* Maximum elevation angle of a contact.
*/
maximumElevation?: Elevation;
/**
* ARN of a mission profile.
*/
missionProfileArn?: MissionProfileArn;
/**
* Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
*/
postPassEndTime?: Timestamp;
/**
* Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
*/
prePassStartTime?: Timestamp;
/**
* Region of a contact.
*/
region?: String;
/**
* ARN of a satellite.
*/
satelliteArn?: satelliteArn;
/**
* Start time of a contact.
*/
startTime?: Timestamp;
/**
* Tags assigned to a contact.
*/
tags?: TagsMap;
}
export interface Destination {
/**
* Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
*/
configDetails?: ConfigDetails;
/**
* UUID of a Config.
*/
configId?: String;
/**
* Type of a Config.
*/
configType?: ConfigCapabilityType;
/**
* Region of a dataflow destination.
*/
dataflowDestinationRegion?: String;
}
export type Double = number;
export type DurationInSeconds = number;
export interface Eirp {
/**
* Units of an EIRP.
*/
units: EirpUnits;
/**
* Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
*/
value: Double;
}
export type EirpUnits = "dBW"|string;
export interface Elevation {
/**
* Elevation angle units.
*/
unit: AngleUnits;
/**
* Elevation angle value.
*/
value: Double;
}
export interface EndpointDetails {
/**
* A dataflow endpoint.
*/
endpoint?: DataflowEndpoint;
/**
* Endpoint security details.
*/
securityDetails?: SecurityDetails;
}
export type EndpointDetailsList = EndpointDetails[];
export type EndpointStatus = "created"|"creating"|"deleted"|"deleting"|"failed"|string;
export interface Frequency {
/**
* Frequency units.
*/
units: FrequencyUnits;
/**
* Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
*/
value: Double;
}
export interface FrequencyBandwidth {
/**
* Frequency bandwidth units.
*/
units: BandwidthUnits;
/**
* Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations: For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz. For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz. For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
*/
value: Double;
}
export type FrequencyUnits = "GHz"|"MHz"|"kHz"|string;
export interface GetConfigRequest {
/**
* UUID of a Config.
*/
configId: String;
/**
* Type of a Config.
*/
configType: ConfigCapabilityType;
}
export interface GetConfigResponse {
/**
* ARN of a Config
*/
configArn: ConfigArn;
/**
* Data elements in a Config.
*/
configData: ConfigTypeData;
/**
* UUID of a Config.
*/
configId: String;
/**
* Type of a Config.
*/
configType?: ConfigCapabilityType;
/**
* Name of a Config.
*/
name: String;
/**
* Tags assigned to a Config.
*/
tags?: TagsMap;
}
export interface GetDataflowEndpointGroupRequest {
/**
* UUID of a dataflow endpoint group.
*/
dataflowEndpointGroupId: String;
}
export interface GetDataflowEndpointGroupResponse {
/**
* ARN of a dataflow endpoint group.
*/
dataflowEndpointGroupArn?: DataflowEndpointGroupArn;
/**
* UUID of a dataflow endpoint group.
*/
dataflowEndpointGroupId?: String;
/**
* Details of a dataflow endpoint.
*/
endpointsDetails?: EndpointDetailsList;
/**
* Tags assigned to a dataflow endpoint group.
*/
tags?: TagsMap;
}
export interface GetMinuteUsageRequest {
/**
* The month being requested, with a value of 1-12.
*/
month: Integer;
/**
* The year being requested, in the format of YYYY.
*/
year: Integer;
}
export interface GetMinuteUsageResponse {
/**
* Estimated number of minutes remaining for an account, specific to the month being requested.
*/
estimatedMinutesRemaining?: Integer;
/**
* Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.
*/
isReservedMinutesCustomer?: Boolean;
/**
* Total number of reserved minutes allocated, specific to the month being requested.
*/
totalReservedMinuteAllocation?: Integer;
/**
* Total scheduled minutes for an account, specific to the month being requested.
*/
totalScheduledMinutes?: Integer;
/**
* Upcoming minutes scheduled for an account, specific to the month being requested.
*/
upcomingMinutesScheduled?: Integer;
}
export interface GetMissionProfileRequest {
/**
* UUID of a mission profile.
*/
missionProfileId: String;
}
export interface GetMissionProfileResponse {
/**
* Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
*/
contactPostPassDurationSeconds?: DurationInSeconds;
/**
* Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
*/
contactPrePassDurationSeconds?: DurationInSeconds;
/**
* A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
*/
dataflowEdges?: DataflowEdgeList;
/**
* Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
*/
minimumViableContactDurationSeconds?: DurationInSeconds;
/**
* ARN of a mission profile.
*/
missionProfileArn?: MissionProfileArn;
/**
* UUID of a mission profile.
*/
missionProfileId?: String;
/**
* Name of a mission profile.
*/
name?: String;
/**
* Region of a mission profile.
*/
region?: String;
/**
* Tags assigned to a mission profile.
*/
tags?: TagsMap;
/**
* ARN of a tracking Config.
*/
trackingConfigArn?: ConfigArn;
}
export interface GetSatelliteRequest {
/**
* UUID of a satellite.
*/
satelliteId: String;
}
export interface GetSatelliteResponse {
/**
* A list of ground stations to which the satellite is on-boarded.
*/
groundStations?: GroundStationIdList;
/**
* NORAD satellite ID number.
*/
noradSatelliteID?: noradSatelliteID;
/**
* ARN of a satellite.
*/
satelliteArn?: satelliteArn;
/**
* UUID of a satellite.
*/
satelliteId?: Uuid;
}
export interface GroundStationData {
/**
* UUID of a ground station.
*/
groundStationId?: String;
/**
* Name of a ground station.
*/
groundStationName?: String;
/**
* Ground station Region.
*/
region?: String;
}
export type GroundStationIdList = String[];
export type GroundStationList = GroundStationData[];
export type Integer = number;
export type JsonString = string;
export interface ListConfigsRequest {
/**
* Maximum number of Configs returned.
*/
maxResults?: Integer;
/**
* Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.
*/
nextToken?: String;
}
export interface ListConfigsResponse {
/**
* List of Config items.
*/
configList?: ConfigList;
/**
* Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.
*/
nextToken?: String;
}
export interface ListContactsRequest {
/**
* End time of a contact.
*/
endTime: Timestamp;
/**
* Name of a ground station.
*/
groundStation?: String;
/**
* Maximum number of contacts returned.
*/
maxResults?: Integer;
/**
* ARN of a mission profile.
*/
missionProfileArn?: MissionProfileArn;
/**
* Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
*/
nextToken?: String;
/**
* ARN of a satellite.
*/
satelliteArn?: satelliteArn;
/**
* Start time of a contact.
*/
startTime: Timestamp;
/**
* Status of a contact reservation.
*/
statusList: StatusList;
}
export interface ListContactsResponse {
/**
* List of contacts.
*/
contactList?: ContactList;
/**
* Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
*/
nextToken?: String;
}
export interface ListDataflowEndpointGroupsRequest {
/**
* Maximum number of dataflow endpoint groups returned.
*/
maxResults?: Integer;
/**
* Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
*/
nextToken?: String;
}
export interface ListDataflowEndpointGroupsResponse {
/**
* A list of dataflow endpoint groups.
*/
dataflowEndpointGroupList?: DataflowEndpointGroupList;
/**
* Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
*/
nextToken?: String;
}
export interface ListGroundStationsRequest {
/**
* Maximum number of ground stations returned.
*/
maxResults?: Integer;
/**
* Next token that can be supplied in the next call to get the next page of ground stations.
*/
nextToken?: String;
/**
* Satellite ID to retrieve on-boarded ground stations.
*/
satelliteId?: String;
}
export interface ListGroundStationsResponse {
/**
* List of ground stations.
*/
groundStationList?: GroundStationList;
/**
* Next token that can be supplied in the next call to get the next page of ground stations.
*/
nextToken?: String;
}
export interface ListMissionProfilesRequest {
/**
* Maximum number of mission profiles returned.
*/
maxResults?: Integer;
/**
* Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.
*/
nextToken?: String;
}
export interface ListMissionProfilesResponse {
/**
* List of mission profiles.
*/
missionProfileList?: MissionProfileList;
/**
* Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.
*/
nextToken?: String;
}
export interface ListSatellitesRequest {
/**
* Maximum number of satellites returned.
*/
maxResults?: Integer;
/**
* Next token that can be supplied in the next call to get the next page of satellites.
*/
nextToken?: String;
}
export interface ListSatellitesResponse {
/**
* Next token that can be supplied in the next call to get the next page of satellites.
*/
nextToken?: String;
/**
* List of satellites.
*/
satellites?: SatelliteList;
}
export interface ListTagsForResourceRequest {
/**
* ARN of a resource.
*/
resourceArn: String;
}
export interface ListTagsForResourceResponse {
/**
* Tags assigned to a resource.
*/
tags?: TagsMap;
}
export type MissionProfileArn = string;
export interface MissionProfileIdResponse {
/**
* UUID of a mission profile.
*/
missionProfileId?: String;
}
export type MissionProfileList = MissionProfileListItem[];
export interface MissionProfileListItem {
/**
* ARN of a mission profile.
*/
missionProfileArn?: MissionProfileArn;
/**
* UUID of a mission profile.
*/
missionProfileId?: String;
/**
* Name of a mission profile.
*/
name?: String;
/**
* Region of a mission profile.
*/
region?: String;
}
export type Polarization = "LEFT_HAND"|"NONE"|"RIGHT_HAND"|string;
export interface ReserveContactRequest {
/**
* End time of a contact.
*/
endTime: Timestamp;
/**
* Name of a ground station.
*/
groundStation: String;
/**
* ARN of a mission profile.
*/
missionProfileArn: MissionProfileArn;
/**
* ARN of a satellite
*/
satelliteArn: satelliteArn;
/**
* Start time of a contact.
*/
startTime: Timestamp;
/**
* Tags assigned to a contact.
*/
tags?: TagsMap;
}
export type RoleArn = string;
export type SafeName = string;
export type SatelliteList = SatelliteListItem[];
export interface SatelliteListItem {
/**
* A list of ground stations to which the satellite is on-boarded.
*/
groundStations?: GroundStationIdList;
/**
* NORAD satellite ID number.
*/
noradSatelliteID?: noradSatelliteID;
/**
* ARN of a satellite.
*/
satelliteArn?: satelliteArn;
/**
* UUID of a satellite.
*/
satelliteId?: Uuid;
}
export interface SecurityDetails {
/**
* ARN to a role needed for connecting streams to your instances.
*/
roleArn: RoleArn;
/**
* The security groups to attach to the elastic network interfaces.
*/
securityGroupIds: SecurityGroupIdList;
/**
* A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
*/
subnetIds: SubnetList;
}
export type SecurityGroupIdList = String[];
export interface SocketAddress {
/**
* Name of a socket address.
*/
name: String;
/**
* Port of a socket address.
*/
port: Integer;
}
export interface Source {
/**
* Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
*/
configDetails?: ConfigDetails;
/**
* UUID of a Config.
*/
configId?: String;
/**
* Type of a Config.
*/
configType?: ConfigCapabilityType;
/**
* Region of a dataflow source.
*/
dataflowSourceRegion?: String;
}
export interface SpectrumConfig {
/**
* Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations: For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz. For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz. For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
*/
bandwidth: FrequencyBandwidth;
/**
* Center frequency of a spectral Config. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
*/
centerFrequency: Frequency;
/**
* Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
*/
polarization?: Polarization;
}
export type StatusList = ContactStatus[];
export type String = string;
export type SubnetList = String[];
export type TagKeys = String[];
export interface TagResourceRequest {
/**
* ARN of a resource tag.
*/
resourceArn: String;
/**
* Tags assigned to a resource.
*/
tags: TagsMap;
}
export interface TagResourceResponse {
}
export type TagsMap = {[key: string]: String};
export type Timestamp = Date;
export interface TrackingConfig {
/**
* Current setting for autotrack.
*/
autotrack: Criticality;
}
export interface UntagResourceRequest {
/**
* ARN of a resource.
*/
resourceArn: String;
/**
* Keys of a resource tag.
*/
tagKeys: TagKeys;
}
export interface UntagResourceResponse {
}
export interface UpdateConfigRequest {
/**
* Parameters of a Config.
*/
configData: ConfigTypeData;
/**
* UUID of a Config.
*/
configId: String;
/**
* Type of a Config.
*/
configType: ConfigCapabilityType;
/**
* Name of a Config.
*/
name: SafeName;
}
export interface UpdateMissionProfileRequest {
/**
* Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
*/
contactPostPassDurationSeconds?: DurationInSeconds;
/**
* Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
*/
contactPrePassDurationSeconds?: DurationInSeconds;
/**
* A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
*/
dataflowEdges?: DataflowEdgeList;
/**
* Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
*/
minimumViableContactDurationSeconds?: DurationInSeconds;
/**
* UUID of a mission profile.
*/
missionProfileId: String;
/**
* Name of a mission profile.
*/
name?: SafeName;
/**
* ARN of a tracking Config.
*/
trackingConfigArn?: ConfigArn;
}
export interface UplinkEchoConfig {
/**
* ARN of an uplink Config.
*/
antennaUplinkConfigArn: ConfigArn;
/**
* Whether or not an uplink Config is enabled.
*/
enabled: Boolean;
}
export interface UplinkSpectrumConfig {
/**
* Center frequency of an uplink spectral Config. Valid values are between 2025 to 2120 MHz.
*/
centerFrequency: Frequency;
/**
* Polarization of an uplink spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
*/
polarization?: Polarization;
}
export type Uuid = string;
export type noradSatelliteID = number;
export type satelliteArn = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2019-05-23"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the GroundStation client.
*/
export import Types = GroundStation;
}
export = GroundStation;